1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/sunrpc/auth.h
5 * Declarations for the RPC client authentication machinery.
7 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
10 #ifndef _LINUX_SUNRPC_AUTH_H
11 #define _LINUX_SUNRPC_AUTH_H
15 #include <linux/sunrpc/sched.h>
16 #include <linux/sunrpc/msg_prot.h>
17 #include <linux/sunrpc/xdr.h>
19 #include <linux/atomic.h>
20 #include <linux/rcupdate.h>
21 #include <linux/uidgid.h>
22 #include <linux/utsname.h>
25 * Maximum size of AUTH_NONE authentication information, in XDR words.
27 #define NUL_CALLSLACK (4)
28 #define NUL_REPLYSLACK (2)
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.
34 #define UNX_MAXNODENAME __NEW_UTS_LEN
35 #define UNX_CALLSLACK (21 + XDR_QUADLEN(UNX_MAXNODENAME))
36 #define UNX_NGROUPS 16
38 struct rpcsec_gss_info;
40 /* auth_cred ac_flags bits */
42 RPC_CRED_KEY_EXPIRE_SOON = 1, /* underlying cred key will expire soon */
43 RPC_CRED_NOTIFY_TIMEOUT = 2, /* nofity generic cred when underlying
44 key will expire soon */
48 const struct cred *cred;
49 const char *principal; /* If present, this is a machine credential */
50 unsigned long ac_flags;
54 * Client user credentials
59 struct hlist_node cr_hash; /* hash chain */
60 struct list_head cr_lru; /* lru garbage collection */
61 struct rcu_head cr_rcu;
62 struct rpc_auth * cr_auth;
63 const struct rpc_credops *cr_ops;
64 unsigned long cr_expire; /* when to gc */
65 unsigned long cr_flags; /* various flags */
66 refcount_t cr_count; /* ref count */
67 const struct cred *cr_cred;
73 #define RPCAUTH_CRED_NEW 0
74 #define RPCAUTH_CRED_UPTODATE 1
75 #define RPCAUTH_CRED_HASHED 2
76 #define RPCAUTH_CRED_NEGATIVE 3
78 /* rpc_auth au_flags */
79 #define RPCAUTH_AUTH_NO_CRKEY_TIMEOUT 0x0001 /* underlying cred has no key timeout */
82 * Client authentication handle
84 struct rpc_cred_cache;
87 unsigned int au_cslack; /* call cred size estimate */
88 /* guess at number of u32's auth adds before
89 * reply data; normally the verifier size: */
90 unsigned int au_rslack;
91 /* for gss, used to calculate au_rslack: */
92 unsigned int au_verfsize;
94 unsigned int au_flags; /* various flags */
95 const struct rpc_authops *au_ops; /* operations */
96 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
97 * differ from the flavor in
98 * au_ops->au_flavor in gss
100 refcount_t au_count; /* Reference counter */
102 struct rpc_cred_cache * au_credcache;
103 /* per-flavor data */
106 /* rpc_auth au_flags */
107 #define RPCAUTH_AUTH_DATATOUCH 0x00000002
109 struct rpc_auth_create_args {
110 rpc_authflavor_t pseudoflavor;
111 const char *target_name;
114 /* Flags for rpcauth_lookupcred() */
115 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
116 #define RPCAUTH_LOOKUP_RCU 0x02 /* lock-less lookup */
119 * Client authentication ops
122 struct module *owner;
123 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
125 struct rpc_auth * (*create)(const struct rpc_auth_create_args *,
127 void (*destroy)(struct rpc_auth *);
129 int (*hash_cred)(struct auth_cred *, unsigned int);
130 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
131 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int, gfp_t);
132 int (*list_pseudoflavors)(rpc_authflavor_t *, int);
133 rpc_authflavor_t (*info2flavor)(struct rpcsec_gss_info *);
134 int (*flavor2info)(rpc_authflavor_t,
135 struct rpcsec_gss_info *);
136 int (*key_timeout)(struct rpc_auth *,
141 const char * cr_name; /* Name of the auth flavour */
142 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
143 void (*crdestroy)(struct rpc_cred *);
145 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
146 struct rpc_cred * (*crbind)(struct rpc_task *, struct rpc_cred *, int);
147 __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
148 int (*crrefresh)(struct rpc_task *);
149 __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
150 int (*crwrap_req)(struct rpc_task *, kxdreproc_t,
151 void *, __be32 *, void *);
152 int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t,
153 void *, __be32 *, void *);
154 int (*crkey_timeout)(struct rpc_cred *);
155 bool (*crkey_to_expire)(struct rpc_cred *);
156 char * (*crstringify_acceptor)(struct rpc_cred *);
157 bool (*crneed_reencode)(struct rpc_task *);
160 extern const struct rpc_authops authunix_ops;
161 extern const struct rpc_authops authnull_ops;
163 int __init rpc_init_authunix(void);
164 int __init rpc_init_generic_auth(void);
165 int __init rpcauth_init_module(void);
166 void rpcauth_remove_module(void);
167 void rpc_destroy_generic_auth(void);
168 void rpc_destroy_authunix(void);
170 struct rpc_cred * rpc_lookup_cred(void);
171 struct rpc_cred * rpc_lookup_cred_nonblock(void);
172 struct rpc_cred * rpc_lookup_generic_cred(struct auth_cred *, int, gfp_t);
173 struct rpc_cred * rpc_lookup_machine_cred(const char *service_name);
174 int rpcauth_register(const struct rpc_authops *);
175 int rpcauth_unregister(const struct rpc_authops *);
176 struct rpc_auth * rpcauth_create(const struct rpc_auth_create_args *,
178 void rpcauth_release(struct rpc_auth *);
179 rpc_authflavor_t rpcauth_get_pseudoflavor(rpc_authflavor_t,
180 struct rpcsec_gss_info *);
181 int rpcauth_get_gssinfo(rpc_authflavor_t,
182 struct rpcsec_gss_info *);
183 int rpcauth_list_flavors(rpc_authflavor_t *, int);
184 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int, gfp_t);
185 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
186 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
187 struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
188 void put_rpccred(struct rpc_cred *);
189 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
190 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
191 int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj);
192 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj);
193 bool rpcauth_xmit_need_reencode(struct rpc_task *task);
194 int rpcauth_refreshcred(struct rpc_task *);
195 void rpcauth_invalcred(struct rpc_task *);
196 int rpcauth_uptodatecred(struct rpc_task *);
197 int rpcauth_init_credcache(struct rpc_auth *);
198 void rpcauth_destroy_credcache(struct rpc_auth *);
199 void rpcauth_clear_credcache(struct rpc_cred_cache *);
200 int rpcauth_key_timeout_notify(struct rpc_auth *,
202 bool rpcauth_cred_key_to_expire(struct rpc_auth *, struct rpc_cred *);
203 char * rpcauth_stringify_acceptor(struct rpc_cred *);
206 struct rpc_cred *get_rpccred(struct rpc_cred *cred)
208 if (cred != NULL && refcount_inc_not_zero(&cred->cr_count))
214 * get_rpccred_rcu - get a reference to a cred using rcu-protected pointer
215 * @cred: cred of which to take a reference
217 * In some cases, we may have a pointer to a credential to which we
218 * want to take a reference, but don't already have one. Because these
219 * objects are freed using RCU, we can access the cr_count while its
220 * on its way to destruction and only take a reference if it's not already
223 static inline struct rpc_cred *
224 get_rpccred_rcu(struct rpc_cred *cred)
226 return get_rpccred(cred);
229 #endif /* __KERNEL__ */
230 #endif /* _LINUX_SUNRPC_AUTH_H */