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 <linux/atomic.h> 19 #include <linux/rcupdate.h> 20 #include <linux/uidgid.h> 21 22 /* size of the nodename buffer */ 23 #define UNX_MAXNODENAME 32 24 25 /* Work around the lack of a VFS credential */ 26 struct auth_cred { 27 kuid_t uid; 28 kgid_t gid; 29 struct group_info *group_info; 30 const char *principal; 31 unsigned char machine_cred : 1; 32 }; 33 34 /* 35 * Client user credentials 36 */ 37 struct rpc_auth; 38 struct rpc_credops; 39 struct rpc_cred { 40 struct hlist_node cr_hash; /* hash chain */ 41 struct list_head cr_lru; /* lru garbage collection */ 42 struct rcu_head cr_rcu; 43 struct rpc_auth * cr_auth; 44 const struct rpc_credops *cr_ops; 45 #ifdef RPC_DEBUG 46 unsigned long cr_magic; /* 0x0f4aa4f0 */ 47 #endif 48 unsigned long cr_expire; /* when to gc */ 49 unsigned long cr_flags; /* various flags */ 50 atomic_t cr_count; /* ref count */ 51 52 kuid_t cr_uid; 53 54 /* per-flavor data */ 55 }; 56 #define RPCAUTH_CRED_NEW 0 57 #define RPCAUTH_CRED_UPTODATE 1 58 #define RPCAUTH_CRED_HASHED 2 59 #define RPCAUTH_CRED_NEGATIVE 3 60 61 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0 62 63 /* 64 * Client authentication handle 65 */ 66 struct rpc_cred_cache; 67 struct rpc_authops; 68 struct rpc_auth { 69 unsigned int au_cslack; /* call cred size estimate */ 70 /* guess at number of u32's auth adds before 71 * reply data; normally the verifier size: */ 72 unsigned int au_rslack; 73 /* for gss, used to calculate au_rslack: */ 74 unsigned int au_verfsize; 75 76 unsigned int au_flags; /* various flags */ 77 const struct rpc_authops *au_ops; /* operations */ 78 rpc_authflavor_t au_flavor; /* pseudoflavor (note may 79 * differ from the flavor in 80 * au_ops->au_flavor in gss 81 * case) */ 82 atomic_t au_count; /* Reference counter */ 83 84 struct rpc_cred_cache * au_credcache; 85 /* per-flavor data */ 86 }; 87 88 /* Flags for rpcauth_lookupcred() */ 89 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */ 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 char * au_name; 98 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t); 99 void (*destroy)(struct rpc_auth *); 100 101 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int); 102 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int); 103 int (*pipes_create)(struct rpc_auth *); 104 void (*pipes_destroy)(struct rpc_auth *); 105 int (*list_pseudoflavors)(rpc_authflavor_t *, int); 106 }; 107 108 struct rpc_credops { 109 const char * cr_name; /* Name of the auth flavour */ 110 int (*cr_init)(struct rpc_auth *, struct rpc_cred *); 111 void (*crdestroy)(struct rpc_cred *); 112 113 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int); 114 struct rpc_cred * (*crbind)(struct rpc_task *, struct rpc_cred *, int); 115 __be32 * (*crmarshal)(struct rpc_task *, __be32 *); 116 int (*crrefresh)(struct rpc_task *); 117 __be32 * (*crvalidate)(struct rpc_task *, __be32 *); 118 int (*crwrap_req)(struct rpc_task *, kxdreproc_t, 119 void *, __be32 *, void *); 120 int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t, 121 void *, __be32 *, void *); 122 }; 123 124 extern const struct rpc_authops authunix_ops; 125 extern const struct rpc_authops authnull_ops; 126 127 int __init rpc_init_authunix(void); 128 int __init rpc_init_generic_auth(void); 129 int __init rpcauth_init_module(void); 130 void rpcauth_remove_module(void); 131 void rpc_destroy_generic_auth(void); 132 void rpc_destroy_authunix(void); 133 134 struct rpc_cred * rpc_lookup_cred(void); 135 struct rpc_cred * rpc_lookup_machine_cred(const char *service_name); 136 int rpcauth_register(const struct rpc_authops *); 137 int rpcauth_unregister(const struct rpc_authops *); 138 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *); 139 void rpcauth_release(struct rpc_auth *); 140 int rpcauth_list_flavors(rpc_authflavor_t *, int); 141 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int); 142 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *); 143 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int); 144 struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int); 145 void put_rpccred(struct rpc_cred *); 146 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *); 147 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *); 148 int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj); 149 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj); 150 int rpcauth_refreshcred(struct rpc_task *); 151 void rpcauth_invalcred(struct rpc_task *); 152 int rpcauth_uptodatecred(struct rpc_task *); 153 int rpcauth_init_credcache(struct rpc_auth *); 154 void rpcauth_destroy_credcache(struct rpc_auth *); 155 void rpcauth_clear_credcache(struct rpc_cred_cache *); 156 157 static inline 158 struct rpc_cred * get_rpccred(struct rpc_cred *cred) 159 { 160 atomic_inc(&cred->cr_count); 161 return cred; 162 } 163 164 #endif /* __KERNEL__ */ 165 #endif /* _LINUX_SUNRPC_AUTH_H */ 166