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