1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/include/linux/sunrpc/auth.h 4 * 5 * Declarations for the RPC client authentication machinery. 6 * 7 * Copyright (C) 1996, Olaf Kirch <[email protected]> 8 */ 9 10 #ifndef _LINUX_SUNRPC_AUTH_H 11 #define _LINUX_SUNRPC_AUTH_H 12 13 #ifdef __KERNEL__ 14 15 #include <linux/sunrpc/sched.h> 16 #include <linux/sunrpc/msg_prot.h> 17 #include <linux/sunrpc/xdr.h> 18 19 #include <linux/atomic.h> 20 #include <linux/rcupdate.h> 21 #include <linux/uidgid.h> 22 #include <linux/utsname.h> 23 24 /* 25 * Maximum size of AUTH_NONE authentication information, in XDR words. 26 */ 27 #define NUL_CALLSLACK (4) 28 #define NUL_REPLYSLACK (2) 29 30 /* 31 * Size of the nodename buffer. RFC1831 specifies a hard limit of 255 bytes, 32 * but Linux hostnames are actually limited to __NEW_UTS_LEN bytes. 33 */ 34 #define UNX_MAXNODENAME __NEW_UTS_LEN 35 #define UNX_CALLSLACK (21 + XDR_QUADLEN(UNX_MAXNODENAME)) 36 #define UNX_NGROUPS 16 37 38 struct rpcsec_gss_info; 39 40 struct auth_cred { 41 const struct cred *cred; 42 const char *principal; /* If present, this is a machine credential */ 43 }; 44 45 /* 46 * Client user credentials 47 */ 48 struct rpc_auth; 49 struct rpc_credops; 50 struct rpc_cred { 51 struct hlist_node cr_hash; /* hash chain */ 52 struct list_head cr_lru; /* lru garbage collection */ 53 struct rcu_head cr_rcu; 54 struct rpc_auth * cr_auth; 55 const struct rpc_credops *cr_ops; 56 unsigned long cr_expire; /* when to gc */ 57 unsigned long cr_flags; /* various flags */ 58 refcount_t cr_count; /* ref count */ 59 const struct cred *cr_cred; 60 61 kuid_t cr_uid; 62 63 /* per-flavor data */ 64 }; 65 #define RPCAUTH_CRED_NEW 0 66 #define RPCAUTH_CRED_UPTODATE 1 67 #define RPCAUTH_CRED_HASHED 2 68 #define RPCAUTH_CRED_NEGATIVE 3 69 70 const struct cred *rpc_machine_cred(void); 71 72 /* 73 * Client authentication handle 74 */ 75 struct rpc_cred_cache; 76 struct rpc_authops; 77 struct rpc_auth { 78 unsigned int au_cslack; /* call cred size estimate */ 79 /* guess at number of u32's auth adds before 80 * reply data; normally the verifier size: */ 81 unsigned int au_rslack; 82 /* for gss, used to calculate au_rslack: */ 83 unsigned int au_verfsize; 84 85 unsigned int au_flags; /* various flags */ 86 const struct rpc_authops *au_ops; /* operations */ 87 rpc_authflavor_t au_flavor; /* pseudoflavor (note may 88 * differ from the flavor in 89 * au_ops->au_flavor in gss 90 * case) */ 91 refcount_t au_count; /* Reference counter */ 92 93 struct rpc_cred_cache * au_credcache; 94 /* per-flavor data */ 95 }; 96 97 /* rpc_auth au_flags */ 98 #define RPCAUTH_AUTH_DATATOUCH 0x00000002 99 100 struct rpc_auth_create_args { 101 rpc_authflavor_t pseudoflavor; 102 const char *target_name; 103 }; 104 105 /* Flags for rpcauth_lookupcred() */ 106 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */ 107 108 /* 109 * Client authentication ops 110 */ 111 struct rpc_authops { 112 struct module *owner; 113 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */ 114 char * au_name; 115 struct rpc_auth * (*create)(const struct rpc_auth_create_args *, 116 struct rpc_clnt *); 117 void (*destroy)(struct rpc_auth *); 118 119 int (*hash_cred)(struct auth_cred *, unsigned int); 120 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int); 121 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int, gfp_t); 122 int (*list_pseudoflavors)(rpc_authflavor_t *, int); 123 rpc_authflavor_t (*info2flavor)(struct rpcsec_gss_info *); 124 int (*flavor2info)(rpc_authflavor_t, 125 struct rpcsec_gss_info *); 126 int (*key_timeout)(struct rpc_auth *, 127 struct rpc_cred *); 128 }; 129 130 struct rpc_credops { 131 const char * cr_name; /* Name of the auth flavour */ 132 int (*cr_init)(struct rpc_auth *, struct rpc_cred *); 133 void (*crdestroy)(struct rpc_cred *); 134 135 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int); 136 __be32 * (*crmarshal)(struct rpc_task *, __be32 *); 137 int (*crrefresh)(struct rpc_task *); 138 __be32 * (*crvalidate)(struct rpc_task *, __be32 *); 139 int (*crwrap_req)(struct rpc_task *, kxdreproc_t, 140 void *, __be32 *, void *); 141 int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t, 142 void *, __be32 *, void *); 143 int (*crkey_timeout)(struct rpc_cred *); 144 char * (*crstringify_acceptor)(struct rpc_cred *); 145 bool (*crneed_reencode)(struct rpc_task *); 146 }; 147 148 extern const struct rpc_authops authunix_ops; 149 extern const struct rpc_authops authnull_ops; 150 151 int __init rpc_init_authunix(void); 152 int __init rpcauth_init_module(void); 153 void rpcauth_remove_module(void); 154 void rpc_destroy_authunix(void); 155 156 int rpcauth_register(const struct rpc_authops *); 157 int rpcauth_unregister(const struct rpc_authops *); 158 struct rpc_auth * rpcauth_create(const struct rpc_auth_create_args *, 159 struct rpc_clnt *); 160 void rpcauth_release(struct rpc_auth *); 161 rpc_authflavor_t rpcauth_get_pseudoflavor(rpc_authflavor_t, 162 struct rpcsec_gss_info *); 163 int rpcauth_get_gssinfo(rpc_authflavor_t, 164 struct rpcsec_gss_info *); 165 int rpcauth_list_flavors(rpc_authflavor_t *, int); 166 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int, gfp_t); 167 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *); 168 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int); 169 void put_rpccred(struct rpc_cred *); 170 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *); 171 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *); 172 int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj); 173 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj); 174 bool rpcauth_xmit_need_reencode(struct rpc_task *task); 175 int rpcauth_refreshcred(struct rpc_task *); 176 void rpcauth_invalcred(struct rpc_task *); 177 int rpcauth_uptodatecred(struct rpc_task *); 178 int rpcauth_init_credcache(struct rpc_auth *); 179 void rpcauth_destroy_credcache(struct rpc_auth *); 180 void rpcauth_clear_credcache(struct rpc_cred_cache *); 181 char * rpcauth_stringify_acceptor(struct rpc_cred *); 182 183 static inline 184 struct rpc_cred *get_rpccred(struct rpc_cred *cred) 185 { 186 if (cred != NULL && refcount_inc_not_zero(&cred->cr_count)) 187 return cred; 188 return NULL; 189 } 190 191 #endif /* __KERNEL__ */ 192 #endif /* _LINUX_SUNRPC_AUTH_H */ 193