1 /* 2 * linux/include/linux/sunrpc/auth.h 3 * 4 * Declarations for the RPC client authentication machinery. 5 * 6 * Copyright (C) 1996, Olaf Kirch <[email protected]> 7 */ 8 9 #ifndef _LINUX_SUNRPC_AUTH_H 10 #define _LINUX_SUNRPC_AUTH_H 11 12 #ifdef __KERNEL__ 13 14 #include <linux/sunrpc/sched.h> 15 #include <linux/sunrpc/msg_prot.h> 16 #include <linux/sunrpc/xdr.h> 17 18 #include <asm/atomic.h> 19 20 /* size of the nodename buffer */ 21 #define UNX_MAXNODENAME 32 22 23 /* Work around the lack of a VFS credential */ 24 struct auth_cred { 25 uid_t uid; 26 gid_t gid; 27 struct group_info *group_info; 28 }; 29 30 /* 31 * Client user credentials 32 */ 33 struct rpc_cred { 34 struct hlist_node cr_hash; /* hash chain */ 35 struct rpc_credops * cr_ops; 36 unsigned long cr_expire; /* when to gc */ 37 atomic_t cr_count; /* ref count */ 38 unsigned short cr_flags; /* various flags */ 39 #ifdef RPC_DEBUG 40 unsigned long cr_magic; /* 0x0f4aa4f0 */ 41 #endif 42 43 uid_t cr_uid; 44 45 /* per-flavor data */ 46 }; 47 #define RPCAUTH_CRED_NEW 0x0001 48 #define RPCAUTH_CRED_UPTODATE 0x0002 49 50 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0 51 52 /* 53 * Client authentication handle 54 */ 55 #define RPC_CREDCACHE_NR 8 56 #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1) 57 struct rpc_cred_cache { 58 struct hlist_head hashtable[RPC_CREDCACHE_NR]; 59 unsigned long nextgc; /* next garbage collection */ 60 unsigned long expire; /* cache expiry interval */ 61 }; 62 63 struct rpc_auth { 64 unsigned int au_cslack; /* call cred size estimate */ 65 /* guess at number of u32's auth adds before 66 * reply data; normally the verifier size: */ 67 unsigned int au_rslack; 68 /* for gss, used to calculate au_rslack: */ 69 unsigned int au_verfsize; 70 71 unsigned int au_flags; /* various flags */ 72 struct rpc_authops * au_ops; /* operations */ 73 rpc_authflavor_t au_flavor; /* pseudoflavor (note may 74 * differ from the flavor in 75 * au_ops->au_flavor in gss 76 * case) */ 77 atomic_t au_count; /* Reference counter */ 78 79 struct rpc_cred_cache * au_credcache; 80 /* per-flavor data */ 81 }; 82 83 /* Flags for rpcauth_lookupcred() */ 84 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */ 85 #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */ 86 87 /* 88 * Client authentication ops 89 */ 90 struct rpc_authops { 91 struct module *owner; 92 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */ 93 #ifdef RPC_DEBUG 94 char * au_name; 95 #endif 96 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t); 97 void (*destroy)(struct rpc_auth *); 98 99 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int); 100 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int); 101 }; 102 103 struct rpc_credops { 104 const char * cr_name; /* Name of the auth flavour */ 105 int (*cr_init)(struct rpc_auth *, struct rpc_cred *); 106 void (*crdestroy)(struct rpc_cred *); 107 108 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int); 109 __be32 * (*crmarshal)(struct rpc_task *, __be32 *); 110 int (*crrefresh)(struct rpc_task *); 111 __be32 * (*crvalidate)(struct rpc_task *, __be32 *); 112 int (*crwrap_req)(struct rpc_task *, kxdrproc_t, 113 void *, __be32 *, void *); 114 int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t, 115 void *, __be32 *, void *); 116 }; 117 118 extern struct rpc_authops authunix_ops; 119 extern struct rpc_authops authnull_ops; 120 #ifdef CONFIG_SUNRPC_SECURE 121 extern struct rpc_authops authdes_ops; 122 #endif 123 124 int rpcauth_register(struct rpc_authops *); 125 int rpcauth_unregister(struct rpc_authops *); 126 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *); 127 void rpcauth_destroy(struct rpc_auth *); 128 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int); 129 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int); 130 struct rpc_cred * rpcauth_bindcred(struct rpc_task *); 131 void rpcauth_holdcred(struct rpc_task *); 132 void put_rpccred(struct rpc_cred *); 133 void rpcauth_unbindcred(struct rpc_task *); 134 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *); 135 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *); 136 int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj); 137 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj); 138 int rpcauth_refreshcred(struct rpc_task *); 139 void rpcauth_invalcred(struct rpc_task *); 140 int rpcauth_uptodatecred(struct rpc_task *); 141 int rpcauth_init_credcache(struct rpc_auth *, unsigned long); 142 void rpcauth_free_credcache(struct rpc_auth *); 143 144 static inline 145 struct rpc_cred * get_rpccred(struct rpc_cred *cred) 146 { 147 atomic_inc(&cred->cr_count); 148 return cred; 149 } 150 151 #endif /* __KERNEL__ */ 152 #endif /* _LINUX_SUNRPC_AUTH_H */ 153