1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * linux/net/sunrpc/auth.c
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Generic RPC client authentication API.
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/types.h>
11*4882a593Smuzhiyun #include <linux/sched.h>
12*4882a593Smuzhiyun #include <linux/cred.h>
13*4882a593Smuzhiyun #include <linux/module.h>
14*4882a593Smuzhiyun #include <linux/slab.h>
15*4882a593Smuzhiyun #include <linux/errno.h>
16*4882a593Smuzhiyun #include <linux/hash.h>
17*4882a593Smuzhiyun #include <linux/sunrpc/clnt.h>
18*4882a593Smuzhiyun #include <linux/sunrpc/gss_api.h>
19*4882a593Smuzhiyun #include <linux/spinlock.h>
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #include <trace/events/sunrpc.h>
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #define RPC_CREDCACHE_DEFAULT_HASHBITS (4)
24*4882a593Smuzhiyun struct rpc_cred_cache {
25*4882a593Smuzhiyun struct hlist_head *hashtable;
26*4882a593Smuzhiyun unsigned int hashbits;
27*4882a593Smuzhiyun spinlock_t lock;
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun static unsigned int auth_hashbits = RPC_CREDCACHE_DEFAULT_HASHBITS;
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun static const struct rpc_authops __rcu *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
33*4882a593Smuzhiyun [RPC_AUTH_NULL] = (const struct rpc_authops __force __rcu *)&authnull_ops,
34*4882a593Smuzhiyun [RPC_AUTH_UNIX] = (const struct rpc_authops __force __rcu *)&authunix_ops,
35*4882a593Smuzhiyun NULL, /* others can be loadable modules */
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun static LIST_HEAD(cred_unused);
39*4882a593Smuzhiyun static unsigned long number_cred_unused;
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun static struct cred machine_cred = {
42*4882a593Smuzhiyun .usage = ATOMIC_INIT(1),
43*4882a593Smuzhiyun #ifdef CONFIG_DEBUG_CREDENTIALS
44*4882a593Smuzhiyun .magic = CRED_MAGIC,
45*4882a593Smuzhiyun #endif
46*4882a593Smuzhiyun };
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun /*
49*4882a593Smuzhiyun * Return the machine_cred pointer to be used whenever
50*4882a593Smuzhiyun * the a generic machine credential is needed.
51*4882a593Smuzhiyun */
rpc_machine_cred(void)52*4882a593Smuzhiyun const struct cred *rpc_machine_cred(void)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun return &machine_cred;
55*4882a593Smuzhiyun }
56*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpc_machine_cred);
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun #define MAX_HASHTABLE_BITS (14)
param_set_hashtbl_sz(const char * val,const struct kernel_param * kp)59*4882a593Smuzhiyun static int param_set_hashtbl_sz(const char *val, const struct kernel_param *kp)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun unsigned long num;
62*4882a593Smuzhiyun unsigned int nbits;
63*4882a593Smuzhiyun int ret;
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun if (!val)
66*4882a593Smuzhiyun goto out_inval;
67*4882a593Smuzhiyun ret = kstrtoul(val, 0, &num);
68*4882a593Smuzhiyun if (ret)
69*4882a593Smuzhiyun goto out_inval;
70*4882a593Smuzhiyun nbits = fls(num - 1);
71*4882a593Smuzhiyun if (nbits > MAX_HASHTABLE_BITS || nbits < 2)
72*4882a593Smuzhiyun goto out_inval;
73*4882a593Smuzhiyun *(unsigned int *)kp->arg = nbits;
74*4882a593Smuzhiyun return 0;
75*4882a593Smuzhiyun out_inval:
76*4882a593Smuzhiyun return -EINVAL;
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun
param_get_hashtbl_sz(char * buffer,const struct kernel_param * kp)79*4882a593Smuzhiyun static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
80*4882a593Smuzhiyun {
81*4882a593Smuzhiyun unsigned int nbits;
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun nbits = *(unsigned int *)kp->arg;
84*4882a593Smuzhiyun return sprintf(buffer, "%u\n", 1U << nbits);
85*4882a593Smuzhiyun }
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun #define param_check_hashtbl_sz(name, p) __param_check(name, p, unsigned int);
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun static const struct kernel_param_ops param_ops_hashtbl_sz = {
90*4882a593Smuzhiyun .set = param_set_hashtbl_sz,
91*4882a593Smuzhiyun .get = param_get_hashtbl_sz,
92*4882a593Smuzhiyun };
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun module_param_named(auth_hashtable_size, auth_hashbits, hashtbl_sz, 0644);
95*4882a593Smuzhiyun MODULE_PARM_DESC(auth_hashtable_size, "RPC credential cache hashtable size");
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun static unsigned long auth_max_cred_cachesize = ULONG_MAX;
98*4882a593Smuzhiyun module_param(auth_max_cred_cachesize, ulong, 0644);
99*4882a593Smuzhiyun MODULE_PARM_DESC(auth_max_cred_cachesize, "RPC credential maximum total cache size");
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun static u32
pseudoflavor_to_flavor(u32 flavor)102*4882a593Smuzhiyun pseudoflavor_to_flavor(u32 flavor) {
103*4882a593Smuzhiyun if (flavor > RPC_AUTH_MAXFLAVOR)
104*4882a593Smuzhiyun return RPC_AUTH_GSS;
105*4882a593Smuzhiyun return flavor;
106*4882a593Smuzhiyun }
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun int
rpcauth_register(const struct rpc_authops * ops)109*4882a593Smuzhiyun rpcauth_register(const struct rpc_authops *ops)
110*4882a593Smuzhiyun {
111*4882a593Smuzhiyun const struct rpc_authops *old;
112*4882a593Smuzhiyun rpc_authflavor_t flavor;
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
115*4882a593Smuzhiyun return -EINVAL;
116*4882a593Smuzhiyun old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], NULL, ops);
117*4882a593Smuzhiyun if (old == NULL || old == ops)
118*4882a593Smuzhiyun return 0;
119*4882a593Smuzhiyun return -EPERM;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_register);
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun int
rpcauth_unregister(const struct rpc_authops * ops)124*4882a593Smuzhiyun rpcauth_unregister(const struct rpc_authops *ops)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun const struct rpc_authops *old;
127*4882a593Smuzhiyun rpc_authflavor_t flavor;
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
130*4882a593Smuzhiyun return -EINVAL;
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], ops, NULL);
133*4882a593Smuzhiyun if (old == ops || old == NULL)
134*4882a593Smuzhiyun return 0;
135*4882a593Smuzhiyun return -EPERM;
136*4882a593Smuzhiyun }
137*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_unregister);
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun static const struct rpc_authops *
rpcauth_get_authops(rpc_authflavor_t flavor)140*4882a593Smuzhiyun rpcauth_get_authops(rpc_authflavor_t flavor)
141*4882a593Smuzhiyun {
142*4882a593Smuzhiyun const struct rpc_authops *ops;
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun if (flavor >= RPC_AUTH_MAXFLAVOR)
145*4882a593Smuzhiyun return NULL;
146*4882a593Smuzhiyun
147*4882a593Smuzhiyun rcu_read_lock();
148*4882a593Smuzhiyun ops = rcu_dereference(auth_flavors[flavor]);
149*4882a593Smuzhiyun if (ops == NULL) {
150*4882a593Smuzhiyun rcu_read_unlock();
151*4882a593Smuzhiyun request_module("rpc-auth-%u", flavor);
152*4882a593Smuzhiyun rcu_read_lock();
153*4882a593Smuzhiyun ops = rcu_dereference(auth_flavors[flavor]);
154*4882a593Smuzhiyun if (ops == NULL)
155*4882a593Smuzhiyun goto out;
156*4882a593Smuzhiyun }
157*4882a593Smuzhiyun if (!try_module_get(ops->owner))
158*4882a593Smuzhiyun ops = NULL;
159*4882a593Smuzhiyun out:
160*4882a593Smuzhiyun rcu_read_unlock();
161*4882a593Smuzhiyun return ops;
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun
164*4882a593Smuzhiyun static void
rpcauth_put_authops(const struct rpc_authops * ops)165*4882a593Smuzhiyun rpcauth_put_authops(const struct rpc_authops *ops)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun module_put(ops->owner);
168*4882a593Smuzhiyun }
169*4882a593Smuzhiyun
170*4882a593Smuzhiyun /**
171*4882a593Smuzhiyun * rpcauth_get_pseudoflavor - check if security flavor is supported
172*4882a593Smuzhiyun * @flavor: a security flavor
173*4882a593Smuzhiyun * @info: a GSS mech OID, quality of protection, and service value
174*4882a593Smuzhiyun *
175*4882a593Smuzhiyun * Verifies that an appropriate kernel module is available or already loaded.
176*4882a593Smuzhiyun * Returns an equivalent pseudoflavor, or RPC_AUTH_MAXFLAVOR if "flavor" is
177*4882a593Smuzhiyun * not supported locally.
178*4882a593Smuzhiyun */
179*4882a593Smuzhiyun rpc_authflavor_t
rpcauth_get_pseudoflavor(rpc_authflavor_t flavor,struct rpcsec_gss_info * info)180*4882a593Smuzhiyun rpcauth_get_pseudoflavor(rpc_authflavor_t flavor, struct rpcsec_gss_info *info)
181*4882a593Smuzhiyun {
182*4882a593Smuzhiyun const struct rpc_authops *ops = rpcauth_get_authops(flavor);
183*4882a593Smuzhiyun rpc_authflavor_t pseudoflavor;
184*4882a593Smuzhiyun
185*4882a593Smuzhiyun if (!ops)
186*4882a593Smuzhiyun return RPC_AUTH_MAXFLAVOR;
187*4882a593Smuzhiyun pseudoflavor = flavor;
188*4882a593Smuzhiyun if (ops->info2flavor != NULL)
189*4882a593Smuzhiyun pseudoflavor = ops->info2flavor(info);
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun rpcauth_put_authops(ops);
192*4882a593Smuzhiyun return pseudoflavor;
193*4882a593Smuzhiyun }
194*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_get_pseudoflavor);
195*4882a593Smuzhiyun
196*4882a593Smuzhiyun /**
197*4882a593Smuzhiyun * rpcauth_get_gssinfo - find GSS tuple matching a GSS pseudoflavor
198*4882a593Smuzhiyun * @pseudoflavor: GSS pseudoflavor to match
199*4882a593Smuzhiyun * @info: rpcsec_gss_info structure to fill in
200*4882a593Smuzhiyun *
201*4882a593Smuzhiyun * Returns zero and fills in "info" if pseudoflavor matches a
202*4882a593Smuzhiyun * supported mechanism.
203*4882a593Smuzhiyun */
204*4882a593Smuzhiyun int
rpcauth_get_gssinfo(rpc_authflavor_t pseudoflavor,struct rpcsec_gss_info * info)205*4882a593Smuzhiyun rpcauth_get_gssinfo(rpc_authflavor_t pseudoflavor, struct rpcsec_gss_info *info)
206*4882a593Smuzhiyun {
207*4882a593Smuzhiyun rpc_authflavor_t flavor = pseudoflavor_to_flavor(pseudoflavor);
208*4882a593Smuzhiyun const struct rpc_authops *ops;
209*4882a593Smuzhiyun int result;
210*4882a593Smuzhiyun
211*4882a593Smuzhiyun ops = rpcauth_get_authops(flavor);
212*4882a593Smuzhiyun if (ops == NULL)
213*4882a593Smuzhiyun return -ENOENT;
214*4882a593Smuzhiyun
215*4882a593Smuzhiyun result = -ENOENT;
216*4882a593Smuzhiyun if (ops->flavor2info != NULL)
217*4882a593Smuzhiyun result = ops->flavor2info(pseudoflavor, info);
218*4882a593Smuzhiyun
219*4882a593Smuzhiyun rpcauth_put_authops(ops);
220*4882a593Smuzhiyun return result;
221*4882a593Smuzhiyun }
222*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_get_gssinfo);
223*4882a593Smuzhiyun
224*4882a593Smuzhiyun struct rpc_auth *
rpcauth_create(const struct rpc_auth_create_args * args,struct rpc_clnt * clnt)225*4882a593Smuzhiyun rpcauth_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
226*4882a593Smuzhiyun {
227*4882a593Smuzhiyun struct rpc_auth *auth = ERR_PTR(-EINVAL);
228*4882a593Smuzhiyun const struct rpc_authops *ops;
229*4882a593Smuzhiyun u32 flavor = pseudoflavor_to_flavor(args->pseudoflavor);
230*4882a593Smuzhiyun
231*4882a593Smuzhiyun ops = rpcauth_get_authops(flavor);
232*4882a593Smuzhiyun if (ops == NULL)
233*4882a593Smuzhiyun goto out;
234*4882a593Smuzhiyun
235*4882a593Smuzhiyun auth = ops->create(args, clnt);
236*4882a593Smuzhiyun
237*4882a593Smuzhiyun rpcauth_put_authops(ops);
238*4882a593Smuzhiyun if (IS_ERR(auth))
239*4882a593Smuzhiyun return auth;
240*4882a593Smuzhiyun if (clnt->cl_auth)
241*4882a593Smuzhiyun rpcauth_release(clnt->cl_auth);
242*4882a593Smuzhiyun clnt->cl_auth = auth;
243*4882a593Smuzhiyun
244*4882a593Smuzhiyun out:
245*4882a593Smuzhiyun return auth;
246*4882a593Smuzhiyun }
247*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_create);
248*4882a593Smuzhiyun
249*4882a593Smuzhiyun void
rpcauth_release(struct rpc_auth * auth)250*4882a593Smuzhiyun rpcauth_release(struct rpc_auth *auth)
251*4882a593Smuzhiyun {
252*4882a593Smuzhiyun if (!refcount_dec_and_test(&auth->au_count))
253*4882a593Smuzhiyun return;
254*4882a593Smuzhiyun auth->au_ops->destroy(auth);
255*4882a593Smuzhiyun }
256*4882a593Smuzhiyun
257*4882a593Smuzhiyun static DEFINE_SPINLOCK(rpc_credcache_lock);
258*4882a593Smuzhiyun
259*4882a593Smuzhiyun /*
260*4882a593Smuzhiyun * On success, the caller is responsible for freeing the reference
261*4882a593Smuzhiyun * held by the hashtable
262*4882a593Smuzhiyun */
263*4882a593Smuzhiyun static bool
rpcauth_unhash_cred_locked(struct rpc_cred * cred)264*4882a593Smuzhiyun rpcauth_unhash_cred_locked(struct rpc_cred *cred)
265*4882a593Smuzhiyun {
266*4882a593Smuzhiyun if (!test_and_clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
267*4882a593Smuzhiyun return false;
268*4882a593Smuzhiyun hlist_del_rcu(&cred->cr_hash);
269*4882a593Smuzhiyun return true;
270*4882a593Smuzhiyun }
271*4882a593Smuzhiyun
272*4882a593Smuzhiyun static bool
rpcauth_unhash_cred(struct rpc_cred * cred)273*4882a593Smuzhiyun rpcauth_unhash_cred(struct rpc_cred *cred)
274*4882a593Smuzhiyun {
275*4882a593Smuzhiyun spinlock_t *cache_lock;
276*4882a593Smuzhiyun bool ret;
277*4882a593Smuzhiyun
278*4882a593Smuzhiyun if (!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
279*4882a593Smuzhiyun return false;
280*4882a593Smuzhiyun cache_lock = &cred->cr_auth->au_credcache->lock;
281*4882a593Smuzhiyun spin_lock(cache_lock);
282*4882a593Smuzhiyun ret = rpcauth_unhash_cred_locked(cred);
283*4882a593Smuzhiyun spin_unlock(cache_lock);
284*4882a593Smuzhiyun return ret;
285*4882a593Smuzhiyun }
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun /*
288*4882a593Smuzhiyun * Initialize RPC credential cache
289*4882a593Smuzhiyun */
290*4882a593Smuzhiyun int
rpcauth_init_credcache(struct rpc_auth * auth)291*4882a593Smuzhiyun rpcauth_init_credcache(struct rpc_auth *auth)
292*4882a593Smuzhiyun {
293*4882a593Smuzhiyun struct rpc_cred_cache *new;
294*4882a593Smuzhiyun unsigned int hashsize;
295*4882a593Smuzhiyun
296*4882a593Smuzhiyun new = kmalloc(sizeof(*new), GFP_KERNEL);
297*4882a593Smuzhiyun if (!new)
298*4882a593Smuzhiyun goto out_nocache;
299*4882a593Smuzhiyun new->hashbits = auth_hashbits;
300*4882a593Smuzhiyun hashsize = 1U << new->hashbits;
301*4882a593Smuzhiyun new->hashtable = kcalloc(hashsize, sizeof(new->hashtable[0]), GFP_KERNEL);
302*4882a593Smuzhiyun if (!new->hashtable)
303*4882a593Smuzhiyun goto out_nohashtbl;
304*4882a593Smuzhiyun spin_lock_init(&new->lock);
305*4882a593Smuzhiyun auth->au_credcache = new;
306*4882a593Smuzhiyun return 0;
307*4882a593Smuzhiyun out_nohashtbl:
308*4882a593Smuzhiyun kfree(new);
309*4882a593Smuzhiyun out_nocache:
310*4882a593Smuzhiyun return -ENOMEM;
311*4882a593Smuzhiyun }
312*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
313*4882a593Smuzhiyun
314*4882a593Smuzhiyun char *
rpcauth_stringify_acceptor(struct rpc_cred * cred)315*4882a593Smuzhiyun rpcauth_stringify_acceptor(struct rpc_cred *cred)
316*4882a593Smuzhiyun {
317*4882a593Smuzhiyun if (!cred->cr_ops->crstringify_acceptor)
318*4882a593Smuzhiyun return NULL;
319*4882a593Smuzhiyun return cred->cr_ops->crstringify_acceptor(cred);
320*4882a593Smuzhiyun }
321*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_stringify_acceptor);
322*4882a593Smuzhiyun
323*4882a593Smuzhiyun /*
324*4882a593Smuzhiyun * Destroy a list of credentials
325*4882a593Smuzhiyun */
326*4882a593Smuzhiyun static inline
rpcauth_destroy_credlist(struct list_head * head)327*4882a593Smuzhiyun void rpcauth_destroy_credlist(struct list_head *head)
328*4882a593Smuzhiyun {
329*4882a593Smuzhiyun struct rpc_cred *cred;
330*4882a593Smuzhiyun
331*4882a593Smuzhiyun while (!list_empty(head)) {
332*4882a593Smuzhiyun cred = list_entry(head->next, struct rpc_cred, cr_lru);
333*4882a593Smuzhiyun list_del_init(&cred->cr_lru);
334*4882a593Smuzhiyun put_rpccred(cred);
335*4882a593Smuzhiyun }
336*4882a593Smuzhiyun }
337*4882a593Smuzhiyun
338*4882a593Smuzhiyun static void
rpcauth_lru_add_locked(struct rpc_cred * cred)339*4882a593Smuzhiyun rpcauth_lru_add_locked(struct rpc_cred *cred)
340*4882a593Smuzhiyun {
341*4882a593Smuzhiyun if (!list_empty(&cred->cr_lru))
342*4882a593Smuzhiyun return;
343*4882a593Smuzhiyun number_cred_unused++;
344*4882a593Smuzhiyun list_add_tail(&cred->cr_lru, &cred_unused);
345*4882a593Smuzhiyun }
346*4882a593Smuzhiyun
347*4882a593Smuzhiyun static void
rpcauth_lru_add(struct rpc_cred * cred)348*4882a593Smuzhiyun rpcauth_lru_add(struct rpc_cred *cred)
349*4882a593Smuzhiyun {
350*4882a593Smuzhiyun if (!list_empty(&cred->cr_lru))
351*4882a593Smuzhiyun return;
352*4882a593Smuzhiyun spin_lock(&rpc_credcache_lock);
353*4882a593Smuzhiyun rpcauth_lru_add_locked(cred);
354*4882a593Smuzhiyun spin_unlock(&rpc_credcache_lock);
355*4882a593Smuzhiyun }
356*4882a593Smuzhiyun
357*4882a593Smuzhiyun static void
rpcauth_lru_remove_locked(struct rpc_cred * cred)358*4882a593Smuzhiyun rpcauth_lru_remove_locked(struct rpc_cred *cred)
359*4882a593Smuzhiyun {
360*4882a593Smuzhiyun if (list_empty(&cred->cr_lru))
361*4882a593Smuzhiyun return;
362*4882a593Smuzhiyun number_cred_unused--;
363*4882a593Smuzhiyun list_del_init(&cred->cr_lru);
364*4882a593Smuzhiyun }
365*4882a593Smuzhiyun
366*4882a593Smuzhiyun static void
rpcauth_lru_remove(struct rpc_cred * cred)367*4882a593Smuzhiyun rpcauth_lru_remove(struct rpc_cred *cred)
368*4882a593Smuzhiyun {
369*4882a593Smuzhiyun if (list_empty(&cred->cr_lru))
370*4882a593Smuzhiyun return;
371*4882a593Smuzhiyun spin_lock(&rpc_credcache_lock);
372*4882a593Smuzhiyun rpcauth_lru_remove_locked(cred);
373*4882a593Smuzhiyun spin_unlock(&rpc_credcache_lock);
374*4882a593Smuzhiyun }
375*4882a593Smuzhiyun
376*4882a593Smuzhiyun /*
377*4882a593Smuzhiyun * Clear the RPC credential cache, and delete those credentials
378*4882a593Smuzhiyun * that are not referenced.
379*4882a593Smuzhiyun */
380*4882a593Smuzhiyun void
rpcauth_clear_credcache(struct rpc_cred_cache * cache)381*4882a593Smuzhiyun rpcauth_clear_credcache(struct rpc_cred_cache *cache)
382*4882a593Smuzhiyun {
383*4882a593Smuzhiyun LIST_HEAD(free);
384*4882a593Smuzhiyun struct hlist_head *head;
385*4882a593Smuzhiyun struct rpc_cred *cred;
386*4882a593Smuzhiyun unsigned int hashsize = 1U << cache->hashbits;
387*4882a593Smuzhiyun int i;
388*4882a593Smuzhiyun
389*4882a593Smuzhiyun spin_lock(&rpc_credcache_lock);
390*4882a593Smuzhiyun spin_lock(&cache->lock);
391*4882a593Smuzhiyun for (i = 0; i < hashsize; i++) {
392*4882a593Smuzhiyun head = &cache->hashtable[i];
393*4882a593Smuzhiyun while (!hlist_empty(head)) {
394*4882a593Smuzhiyun cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
395*4882a593Smuzhiyun rpcauth_unhash_cred_locked(cred);
396*4882a593Smuzhiyun /* Note: We now hold a reference to cred */
397*4882a593Smuzhiyun rpcauth_lru_remove_locked(cred);
398*4882a593Smuzhiyun list_add_tail(&cred->cr_lru, &free);
399*4882a593Smuzhiyun }
400*4882a593Smuzhiyun }
401*4882a593Smuzhiyun spin_unlock(&cache->lock);
402*4882a593Smuzhiyun spin_unlock(&rpc_credcache_lock);
403*4882a593Smuzhiyun rpcauth_destroy_credlist(&free);
404*4882a593Smuzhiyun }
405*4882a593Smuzhiyun
406*4882a593Smuzhiyun /*
407*4882a593Smuzhiyun * Destroy the RPC credential cache
408*4882a593Smuzhiyun */
409*4882a593Smuzhiyun void
rpcauth_destroy_credcache(struct rpc_auth * auth)410*4882a593Smuzhiyun rpcauth_destroy_credcache(struct rpc_auth *auth)
411*4882a593Smuzhiyun {
412*4882a593Smuzhiyun struct rpc_cred_cache *cache = auth->au_credcache;
413*4882a593Smuzhiyun
414*4882a593Smuzhiyun if (cache) {
415*4882a593Smuzhiyun auth->au_credcache = NULL;
416*4882a593Smuzhiyun rpcauth_clear_credcache(cache);
417*4882a593Smuzhiyun kfree(cache->hashtable);
418*4882a593Smuzhiyun kfree(cache);
419*4882a593Smuzhiyun }
420*4882a593Smuzhiyun }
421*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
422*4882a593Smuzhiyun
423*4882a593Smuzhiyun
424*4882a593Smuzhiyun #define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
425*4882a593Smuzhiyun
426*4882a593Smuzhiyun /*
427*4882a593Smuzhiyun * Remove stale credentials. Avoid sleeping inside the loop.
428*4882a593Smuzhiyun */
429*4882a593Smuzhiyun static long
rpcauth_prune_expired(struct list_head * free,int nr_to_scan)430*4882a593Smuzhiyun rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
431*4882a593Smuzhiyun {
432*4882a593Smuzhiyun struct rpc_cred *cred, *next;
433*4882a593Smuzhiyun unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
434*4882a593Smuzhiyun long freed = 0;
435*4882a593Smuzhiyun
436*4882a593Smuzhiyun list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
437*4882a593Smuzhiyun
438*4882a593Smuzhiyun if (nr_to_scan-- == 0)
439*4882a593Smuzhiyun break;
440*4882a593Smuzhiyun if (refcount_read(&cred->cr_count) > 1) {
441*4882a593Smuzhiyun rpcauth_lru_remove_locked(cred);
442*4882a593Smuzhiyun continue;
443*4882a593Smuzhiyun }
444*4882a593Smuzhiyun /*
445*4882a593Smuzhiyun * Enforce a 60 second garbage collection moratorium
446*4882a593Smuzhiyun * Note that the cred_unused list must be time-ordered.
447*4882a593Smuzhiyun */
448*4882a593Smuzhiyun if (time_in_range(cred->cr_expire, expired, jiffies))
449*4882a593Smuzhiyun continue;
450*4882a593Smuzhiyun if (!rpcauth_unhash_cred(cred))
451*4882a593Smuzhiyun continue;
452*4882a593Smuzhiyun
453*4882a593Smuzhiyun rpcauth_lru_remove_locked(cred);
454*4882a593Smuzhiyun freed++;
455*4882a593Smuzhiyun list_add_tail(&cred->cr_lru, free);
456*4882a593Smuzhiyun }
457*4882a593Smuzhiyun return freed ? freed : SHRINK_STOP;
458*4882a593Smuzhiyun }
459*4882a593Smuzhiyun
460*4882a593Smuzhiyun static unsigned long
rpcauth_cache_do_shrink(int nr_to_scan)461*4882a593Smuzhiyun rpcauth_cache_do_shrink(int nr_to_scan)
462*4882a593Smuzhiyun {
463*4882a593Smuzhiyun LIST_HEAD(free);
464*4882a593Smuzhiyun unsigned long freed;
465*4882a593Smuzhiyun
466*4882a593Smuzhiyun spin_lock(&rpc_credcache_lock);
467*4882a593Smuzhiyun freed = rpcauth_prune_expired(&free, nr_to_scan);
468*4882a593Smuzhiyun spin_unlock(&rpc_credcache_lock);
469*4882a593Smuzhiyun rpcauth_destroy_credlist(&free);
470*4882a593Smuzhiyun
471*4882a593Smuzhiyun return freed;
472*4882a593Smuzhiyun }
473*4882a593Smuzhiyun
474*4882a593Smuzhiyun /*
475*4882a593Smuzhiyun * Run memory cache shrinker.
476*4882a593Smuzhiyun */
477*4882a593Smuzhiyun static unsigned long
rpcauth_cache_shrink_scan(struct shrinker * shrink,struct shrink_control * sc)478*4882a593Smuzhiyun rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
479*4882a593Smuzhiyun
480*4882a593Smuzhiyun {
481*4882a593Smuzhiyun if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
482*4882a593Smuzhiyun return SHRINK_STOP;
483*4882a593Smuzhiyun
484*4882a593Smuzhiyun /* nothing left, don't come back */
485*4882a593Smuzhiyun if (list_empty(&cred_unused))
486*4882a593Smuzhiyun return SHRINK_STOP;
487*4882a593Smuzhiyun
488*4882a593Smuzhiyun return rpcauth_cache_do_shrink(sc->nr_to_scan);
489*4882a593Smuzhiyun }
490*4882a593Smuzhiyun
491*4882a593Smuzhiyun static unsigned long
rpcauth_cache_shrink_count(struct shrinker * shrink,struct shrink_control * sc)492*4882a593Smuzhiyun rpcauth_cache_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
493*4882a593Smuzhiyun
494*4882a593Smuzhiyun {
495*4882a593Smuzhiyun return number_cred_unused * sysctl_vfs_cache_pressure / 100;
496*4882a593Smuzhiyun }
497*4882a593Smuzhiyun
498*4882a593Smuzhiyun static void
rpcauth_cache_enforce_limit(void)499*4882a593Smuzhiyun rpcauth_cache_enforce_limit(void)
500*4882a593Smuzhiyun {
501*4882a593Smuzhiyun unsigned long diff;
502*4882a593Smuzhiyun unsigned int nr_to_scan;
503*4882a593Smuzhiyun
504*4882a593Smuzhiyun if (number_cred_unused <= auth_max_cred_cachesize)
505*4882a593Smuzhiyun return;
506*4882a593Smuzhiyun diff = number_cred_unused - auth_max_cred_cachesize;
507*4882a593Smuzhiyun nr_to_scan = 100;
508*4882a593Smuzhiyun if (diff < nr_to_scan)
509*4882a593Smuzhiyun nr_to_scan = diff;
510*4882a593Smuzhiyun rpcauth_cache_do_shrink(nr_to_scan);
511*4882a593Smuzhiyun }
512*4882a593Smuzhiyun
513*4882a593Smuzhiyun /*
514*4882a593Smuzhiyun * Look up a process' credentials in the authentication cache
515*4882a593Smuzhiyun */
516*4882a593Smuzhiyun struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth * auth,struct auth_cred * acred,int flags,gfp_t gfp)517*4882a593Smuzhiyun rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
518*4882a593Smuzhiyun int flags, gfp_t gfp)
519*4882a593Smuzhiyun {
520*4882a593Smuzhiyun LIST_HEAD(free);
521*4882a593Smuzhiyun struct rpc_cred_cache *cache = auth->au_credcache;
522*4882a593Smuzhiyun struct rpc_cred *cred = NULL,
523*4882a593Smuzhiyun *entry, *new;
524*4882a593Smuzhiyun unsigned int nr;
525*4882a593Smuzhiyun
526*4882a593Smuzhiyun nr = auth->au_ops->hash_cred(acred, cache->hashbits);
527*4882a593Smuzhiyun
528*4882a593Smuzhiyun rcu_read_lock();
529*4882a593Smuzhiyun hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
530*4882a593Smuzhiyun if (!entry->cr_ops->crmatch(acred, entry, flags))
531*4882a593Smuzhiyun continue;
532*4882a593Smuzhiyun cred = get_rpccred(entry);
533*4882a593Smuzhiyun if (cred)
534*4882a593Smuzhiyun break;
535*4882a593Smuzhiyun }
536*4882a593Smuzhiyun rcu_read_unlock();
537*4882a593Smuzhiyun
538*4882a593Smuzhiyun if (cred != NULL)
539*4882a593Smuzhiyun goto found;
540*4882a593Smuzhiyun
541*4882a593Smuzhiyun new = auth->au_ops->crcreate(auth, acred, flags, gfp);
542*4882a593Smuzhiyun if (IS_ERR(new)) {
543*4882a593Smuzhiyun cred = new;
544*4882a593Smuzhiyun goto out;
545*4882a593Smuzhiyun }
546*4882a593Smuzhiyun
547*4882a593Smuzhiyun spin_lock(&cache->lock);
548*4882a593Smuzhiyun hlist_for_each_entry(entry, &cache->hashtable[nr], cr_hash) {
549*4882a593Smuzhiyun if (!entry->cr_ops->crmatch(acred, entry, flags))
550*4882a593Smuzhiyun continue;
551*4882a593Smuzhiyun cred = get_rpccred(entry);
552*4882a593Smuzhiyun if (cred)
553*4882a593Smuzhiyun break;
554*4882a593Smuzhiyun }
555*4882a593Smuzhiyun if (cred == NULL) {
556*4882a593Smuzhiyun cred = new;
557*4882a593Smuzhiyun set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
558*4882a593Smuzhiyun refcount_inc(&cred->cr_count);
559*4882a593Smuzhiyun hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
560*4882a593Smuzhiyun } else
561*4882a593Smuzhiyun list_add_tail(&new->cr_lru, &free);
562*4882a593Smuzhiyun spin_unlock(&cache->lock);
563*4882a593Smuzhiyun rpcauth_cache_enforce_limit();
564*4882a593Smuzhiyun found:
565*4882a593Smuzhiyun if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
566*4882a593Smuzhiyun cred->cr_ops->cr_init != NULL &&
567*4882a593Smuzhiyun !(flags & RPCAUTH_LOOKUP_NEW)) {
568*4882a593Smuzhiyun int res = cred->cr_ops->cr_init(auth, cred);
569*4882a593Smuzhiyun if (res < 0) {
570*4882a593Smuzhiyun put_rpccred(cred);
571*4882a593Smuzhiyun cred = ERR_PTR(res);
572*4882a593Smuzhiyun }
573*4882a593Smuzhiyun }
574*4882a593Smuzhiyun rpcauth_destroy_credlist(&free);
575*4882a593Smuzhiyun out:
576*4882a593Smuzhiyun return cred;
577*4882a593Smuzhiyun }
578*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
579*4882a593Smuzhiyun
580*4882a593Smuzhiyun struct rpc_cred *
rpcauth_lookupcred(struct rpc_auth * auth,int flags)581*4882a593Smuzhiyun rpcauth_lookupcred(struct rpc_auth *auth, int flags)
582*4882a593Smuzhiyun {
583*4882a593Smuzhiyun struct auth_cred acred;
584*4882a593Smuzhiyun struct rpc_cred *ret;
585*4882a593Smuzhiyun const struct cred *cred = current_cred();
586*4882a593Smuzhiyun
587*4882a593Smuzhiyun memset(&acred, 0, sizeof(acred));
588*4882a593Smuzhiyun acred.cred = cred;
589*4882a593Smuzhiyun ret = auth->au_ops->lookup_cred(auth, &acred, flags);
590*4882a593Smuzhiyun return ret;
591*4882a593Smuzhiyun }
592*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_lookupcred);
593*4882a593Smuzhiyun
594*4882a593Smuzhiyun void
rpcauth_init_cred(struct rpc_cred * cred,const struct auth_cred * acred,struct rpc_auth * auth,const struct rpc_credops * ops)595*4882a593Smuzhiyun rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
596*4882a593Smuzhiyun struct rpc_auth *auth, const struct rpc_credops *ops)
597*4882a593Smuzhiyun {
598*4882a593Smuzhiyun INIT_HLIST_NODE(&cred->cr_hash);
599*4882a593Smuzhiyun INIT_LIST_HEAD(&cred->cr_lru);
600*4882a593Smuzhiyun refcount_set(&cred->cr_count, 1);
601*4882a593Smuzhiyun cred->cr_auth = auth;
602*4882a593Smuzhiyun cred->cr_flags = 0;
603*4882a593Smuzhiyun cred->cr_ops = ops;
604*4882a593Smuzhiyun cred->cr_expire = jiffies;
605*4882a593Smuzhiyun cred->cr_cred = get_cred(acred->cred);
606*4882a593Smuzhiyun }
607*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_init_cred);
608*4882a593Smuzhiyun
609*4882a593Smuzhiyun static struct rpc_cred *
rpcauth_bind_root_cred(struct rpc_task * task,int lookupflags)610*4882a593Smuzhiyun rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
611*4882a593Smuzhiyun {
612*4882a593Smuzhiyun struct rpc_auth *auth = task->tk_client->cl_auth;
613*4882a593Smuzhiyun struct auth_cred acred = {
614*4882a593Smuzhiyun .cred = get_task_cred(&init_task),
615*4882a593Smuzhiyun };
616*4882a593Smuzhiyun struct rpc_cred *ret;
617*4882a593Smuzhiyun
618*4882a593Smuzhiyun ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
619*4882a593Smuzhiyun put_cred(acred.cred);
620*4882a593Smuzhiyun return ret;
621*4882a593Smuzhiyun }
622*4882a593Smuzhiyun
623*4882a593Smuzhiyun static struct rpc_cred *
rpcauth_bind_machine_cred(struct rpc_task * task,int lookupflags)624*4882a593Smuzhiyun rpcauth_bind_machine_cred(struct rpc_task *task, int lookupflags)
625*4882a593Smuzhiyun {
626*4882a593Smuzhiyun struct rpc_auth *auth = task->tk_client->cl_auth;
627*4882a593Smuzhiyun struct auth_cred acred = {
628*4882a593Smuzhiyun .principal = task->tk_client->cl_principal,
629*4882a593Smuzhiyun .cred = init_task.cred,
630*4882a593Smuzhiyun };
631*4882a593Smuzhiyun
632*4882a593Smuzhiyun if (!acred.principal)
633*4882a593Smuzhiyun return NULL;
634*4882a593Smuzhiyun return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
635*4882a593Smuzhiyun }
636*4882a593Smuzhiyun
637*4882a593Smuzhiyun static struct rpc_cred *
rpcauth_bind_new_cred(struct rpc_task * task,int lookupflags)638*4882a593Smuzhiyun rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
639*4882a593Smuzhiyun {
640*4882a593Smuzhiyun struct rpc_auth *auth = task->tk_client->cl_auth;
641*4882a593Smuzhiyun
642*4882a593Smuzhiyun return rpcauth_lookupcred(auth, lookupflags);
643*4882a593Smuzhiyun }
644*4882a593Smuzhiyun
645*4882a593Smuzhiyun static int
rpcauth_bindcred(struct rpc_task * task,const struct cred * cred,int flags)646*4882a593Smuzhiyun rpcauth_bindcred(struct rpc_task *task, const struct cred *cred, int flags)
647*4882a593Smuzhiyun {
648*4882a593Smuzhiyun struct rpc_rqst *req = task->tk_rqstp;
649*4882a593Smuzhiyun struct rpc_cred *new = NULL;
650*4882a593Smuzhiyun int lookupflags = 0;
651*4882a593Smuzhiyun struct rpc_auth *auth = task->tk_client->cl_auth;
652*4882a593Smuzhiyun struct auth_cred acred = {
653*4882a593Smuzhiyun .cred = cred,
654*4882a593Smuzhiyun };
655*4882a593Smuzhiyun
656*4882a593Smuzhiyun if (flags & RPC_TASK_ASYNC)
657*4882a593Smuzhiyun lookupflags |= RPCAUTH_LOOKUP_NEW;
658*4882a593Smuzhiyun if (task->tk_op_cred)
659*4882a593Smuzhiyun /* Task must use exactly this rpc_cred */
660*4882a593Smuzhiyun new = get_rpccred(task->tk_op_cred);
661*4882a593Smuzhiyun else if (cred != NULL && cred != &machine_cred)
662*4882a593Smuzhiyun new = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
663*4882a593Smuzhiyun else if (cred == &machine_cred)
664*4882a593Smuzhiyun new = rpcauth_bind_machine_cred(task, lookupflags);
665*4882a593Smuzhiyun
666*4882a593Smuzhiyun /* If machine cred couldn't be bound, try a root cred */
667*4882a593Smuzhiyun if (new)
668*4882a593Smuzhiyun ;
669*4882a593Smuzhiyun else if (cred == &machine_cred || (flags & RPC_TASK_ROOTCREDS))
670*4882a593Smuzhiyun new = rpcauth_bind_root_cred(task, lookupflags);
671*4882a593Smuzhiyun else if (flags & RPC_TASK_NULLCREDS)
672*4882a593Smuzhiyun new = authnull_ops.lookup_cred(NULL, NULL, 0);
673*4882a593Smuzhiyun else
674*4882a593Smuzhiyun new = rpcauth_bind_new_cred(task, lookupflags);
675*4882a593Smuzhiyun if (IS_ERR(new))
676*4882a593Smuzhiyun return PTR_ERR(new);
677*4882a593Smuzhiyun put_rpccred(req->rq_cred);
678*4882a593Smuzhiyun req->rq_cred = new;
679*4882a593Smuzhiyun return 0;
680*4882a593Smuzhiyun }
681*4882a593Smuzhiyun
682*4882a593Smuzhiyun void
put_rpccred(struct rpc_cred * cred)683*4882a593Smuzhiyun put_rpccred(struct rpc_cred *cred)
684*4882a593Smuzhiyun {
685*4882a593Smuzhiyun if (cred == NULL)
686*4882a593Smuzhiyun return;
687*4882a593Smuzhiyun rcu_read_lock();
688*4882a593Smuzhiyun if (refcount_dec_and_test(&cred->cr_count))
689*4882a593Smuzhiyun goto destroy;
690*4882a593Smuzhiyun if (refcount_read(&cred->cr_count) != 1 ||
691*4882a593Smuzhiyun !test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
692*4882a593Smuzhiyun goto out;
693*4882a593Smuzhiyun if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
694*4882a593Smuzhiyun cred->cr_expire = jiffies;
695*4882a593Smuzhiyun rpcauth_lru_add(cred);
696*4882a593Smuzhiyun /* Race breaker */
697*4882a593Smuzhiyun if (unlikely(!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags)))
698*4882a593Smuzhiyun rpcauth_lru_remove(cred);
699*4882a593Smuzhiyun } else if (rpcauth_unhash_cred(cred)) {
700*4882a593Smuzhiyun rpcauth_lru_remove(cred);
701*4882a593Smuzhiyun if (refcount_dec_and_test(&cred->cr_count))
702*4882a593Smuzhiyun goto destroy;
703*4882a593Smuzhiyun }
704*4882a593Smuzhiyun out:
705*4882a593Smuzhiyun rcu_read_unlock();
706*4882a593Smuzhiyun return;
707*4882a593Smuzhiyun destroy:
708*4882a593Smuzhiyun rcu_read_unlock();
709*4882a593Smuzhiyun cred->cr_ops->crdestroy(cred);
710*4882a593Smuzhiyun }
711*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(put_rpccred);
712*4882a593Smuzhiyun
713*4882a593Smuzhiyun /**
714*4882a593Smuzhiyun * rpcauth_marshcred - Append RPC credential to end of @xdr
715*4882a593Smuzhiyun * @task: controlling RPC task
716*4882a593Smuzhiyun * @xdr: xdr_stream containing initial portion of RPC Call header
717*4882a593Smuzhiyun *
718*4882a593Smuzhiyun * On success, an appropriate verifier is added to @xdr, @xdr is
719*4882a593Smuzhiyun * updated to point past the verifier, and zero is returned.
720*4882a593Smuzhiyun * Otherwise, @xdr is in an undefined state and a negative errno
721*4882a593Smuzhiyun * is returned.
722*4882a593Smuzhiyun */
rpcauth_marshcred(struct rpc_task * task,struct xdr_stream * xdr)723*4882a593Smuzhiyun int rpcauth_marshcred(struct rpc_task *task, struct xdr_stream *xdr)
724*4882a593Smuzhiyun {
725*4882a593Smuzhiyun const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
726*4882a593Smuzhiyun
727*4882a593Smuzhiyun return ops->crmarshal(task, xdr);
728*4882a593Smuzhiyun }
729*4882a593Smuzhiyun
730*4882a593Smuzhiyun /**
731*4882a593Smuzhiyun * rpcauth_wrap_req_encode - XDR encode the RPC procedure
732*4882a593Smuzhiyun * @task: controlling RPC task
733*4882a593Smuzhiyun * @xdr: stream where on-the-wire bytes are to be marshalled
734*4882a593Smuzhiyun *
735*4882a593Smuzhiyun * On success, @xdr contains the encoded and wrapped message.
736*4882a593Smuzhiyun * Otherwise, @xdr is in an undefined state.
737*4882a593Smuzhiyun */
rpcauth_wrap_req_encode(struct rpc_task * task,struct xdr_stream * xdr)738*4882a593Smuzhiyun int rpcauth_wrap_req_encode(struct rpc_task *task, struct xdr_stream *xdr)
739*4882a593Smuzhiyun {
740*4882a593Smuzhiyun kxdreproc_t encode = task->tk_msg.rpc_proc->p_encode;
741*4882a593Smuzhiyun
742*4882a593Smuzhiyun encode(task->tk_rqstp, xdr, task->tk_msg.rpc_argp);
743*4882a593Smuzhiyun return 0;
744*4882a593Smuzhiyun }
745*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_wrap_req_encode);
746*4882a593Smuzhiyun
747*4882a593Smuzhiyun /**
748*4882a593Smuzhiyun * rpcauth_wrap_req - XDR encode and wrap the RPC procedure
749*4882a593Smuzhiyun * @task: controlling RPC task
750*4882a593Smuzhiyun * @xdr: stream where on-the-wire bytes are to be marshalled
751*4882a593Smuzhiyun *
752*4882a593Smuzhiyun * On success, @xdr contains the encoded and wrapped message,
753*4882a593Smuzhiyun * and zero is returned. Otherwise, @xdr is in an undefined
754*4882a593Smuzhiyun * state and a negative errno is returned.
755*4882a593Smuzhiyun */
rpcauth_wrap_req(struct rpc_task * task,struct xdr_stream * xdr)756*4882a593Smuzhiyun int rpcauth_wrap_req(struct rpc_task *task, struct xdr_stream *xdr)
757*4882a593Smuzhiyun {
758*4882a593Smuzhiyun const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
759*4882a593Smuzhiyun
760*4882a593Smuzhiyun return ops->crwrap_req(task, xdr);
761*4882a593Smuzhiyun }
762*4882a593Smuzhiyun
763*4882a593Smuzhiyun /**
764*4882a593Smuzhiyun * rpcauth_checkverf - Validate verifier in RPC Reply header
765*4882a593Smuzhiyun * @task: controlling RPC task
766*4882a593Smuzhiyun * @xdr: xdr_stream containing RPC Reply header
767*4882a593Smuzhiyun *
768*4882a593Smuzhiyun * On success, @xdr is updated to point past the verifier and
769*4882a593Smuzhiyun * zero is returned. Otherwise, @xdr is in an undefined state
770*4882a593Smuzhiyun * and a negative errno is returned.
771*4882a593Smuzhiyun */
772*4882a593Smuzhiyun int
rpcauth_checkverf(struct rpc_task * task,struct xdr_stream * xdr)773*4882a593Smuzhiyun rpcauth_checkverf(struct rpc_task *task, struct xdr_stream *xdr)
774*4882a593Smuzhiyun {
775*4882a593Smuzhiyun const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
776*4882a593Smuzhiyun
777*4882a593Smuzhiyun return ops->crvalidate(task, xdr);
778*4882a593Smuzhiyun }
779*4882a593Smuzhiyun
780*4882a593Smuzhiyun /**
781*4882a593Smuzhiyun * rpcauth_unwrap_resp_decode - Invoke XDR decode function
782*4882a593Smuzhiyun * @task: controlling RPC task
783*4882a593Smuzhiyun * @xdr: stream where the Reply message resides
784*4882a593Smuzhiyun *
785*4882a593Smuzhiyun * Returns zero on success; otherwise a negative errno is returned.
786*4882a593Smuzhiyun */
787*4882a593Smuzhiyun int
rpcauth_unwrap_resp_decode(struct rpc_task * task,struct xdr_stream * xdr)788*4882a593Smuzhiyun rpcauth_unwrap_resp_decode(struct rpc_task *task, struct xdr_stream *xdr)
789*4882a593Smuzhiyun {
790*4882a593Smuzhiyun kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
791*4882a593Smuzhiyun
792*4882a593Smuzhiyun return decode(task->tk_rqstp, xdr, task->tk_msg.rpc_resp);
793*4882a593Smuzhiyun }
794*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(rpcauth_unwrap_resp_decode);
795*4882a593Smuzhiyun
796*4882a593Smuzhiyun /**
797*4882a593Smuzhiyun * rpcauth_unwrap_resp - Invoke unwrap and decode function for the cred
798*4882a593Smuzhiyun * @task: controlling RPC task
799*4882a593Smuzhiyun * @xdr: stream where the Reply message resides
800*4882a593Smuzhiyun *
801*4882a593Smuzhiyun * Returns zero on success; otherwise a negative errno is returned.
802*4882a593Smuzhiyun */
803*4882a593Smuzhiyun int
rpcauth_unwrap_resp(struct rpc_task * task,struct xdr_stream * xdr)804*4882a593Smuzhiyun rpcauth_unwrap_resp(struct rpc_task *task, struct xdr_stream *xdr)
805*4882a593Smuzhiyun {
806*4882a593Smuzhiyun const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
807*4882a593Smuzhiyun
808*4882a593Smuzhiyun return ops->crunwrap_resp(task, xdr);
809*4882a593Smuzhiyun }
810*4882a593Smuzhiyun
811*4882a593Smuzhiyun bool
rpcauth_xmit_need_reencode(struct rpc_task * task)812*4882a593Smuzhiyun rpcauth_xmit_need_reencode(struct rpc_task *task)
813*4882a593Smuzhiyun {
814*4882a593Smuzhiyun struct rpc_cred *cred = task->tk_rqstp->rq_cred;
815*4882a593Smuzhiyun
816*4882a593Smuzhiyun if (!cred || !cred->cr_ops->crneed_reencode)
817*4882a593Smuzhiyun return false;
818*4882a593Smuzhiyun return cred->cr_ops->crneed_reencode(task);
819*4882a593Smuzhiyun }
820*4882a593Smuzhiyun
821*4882a593Smuzhiyun int
rpcauth_refreshcred(struct rpc_task * task)822*4882a593Smuzhiyun rpcauth_refreshcred(struct rpc_task *task)
823*4882a593Smuzhiyun {
824*4882a593Smuzhiyun struct rpc_cred *cred;
825*4882a593Smuzhiyun int err;
826*4882a593Smuzhiyun
827*4882a593Smuzhiyun cred = task->tk_rqstp->rq_cred;
828*4882a593Smuzhiyun if (cred == NULL) {
829*4882a593Smuzhiyun err = rpcauth_bindcred(task, task->tk_msg.rpc_cred, task->tk_flags);
830*4882a593Smuzhiyun if (err < 0)
831*4882a593Smuzhiyun goto out;
832*4882a593Smuzhiyun cred = task->tk_rqstp->rq_cred;
833*4882a593Smuzhiyun }
834*4882a593Smuzhiyun
835*4882a593Smuzhiyun err = cred->cr_ops->crrefresh(task);
836*4882a593Smuzhiyun out:
837*4882a593Smuzhiyun if (err < 0)
838*4882a593Smuzhiyun task->tk_status = err;
839*4882a593Smuzhiyun return err;
840*4882a593Smuzhiyun }
841*4882a593Smuzhiyun
842*4882a593Smuzhiyun void
rpcauth_invalcred(struct rpc_task * task)843*4882a593Smuzhiyun rpcauth_invalcred(struct rpc_task *task)
844*4882a593Smuzhiyun {
845*4882a593Smuzhiyun struct rpc_cred *cred = task->tk_rqstp->rq_cred;
846*4882a593Smuzhiyun
847*4882a593Smuzhiyun if (cred)
848*4882a593Smuzhiyun clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
849*4882a593Smuzhiyun }
850*4882a593Smuzhiyun
851*4882a593Smuzhiyun int
rpcauth_uptodatecred(struct rpc_task * task)852*4882a593Smuzhiyun rpcauth_uptodatecred(struct rpc_task *task)
853*4882a593Smuzhiyun {
854*4882a593Smuzhiyun struct rpc_cred *cred = task->tk_rqstp->rq_cred;
855*4882a593Smuzhiyun
856*4882a593Smuzhiyun return cred == NULL ||
857*4882a593Smuzhiyun test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
858*4882a593Smuzhiyun }
859*4882a593Smuzhiyun
860*4882a593Smuzhiyun static struct shrinker rpc_cred_shrinker = {
861*4882a593Smuzhiyun .count_objects = rpcauth_cache_shrink_count,
862*4882a593Smuzhiyun .scan_objects = rpcauth_cache_shrink_scan,
863*4882a593Smuzhiyun .seeks = DEFAULT_SEEKS,
864*4882a593Smuzhiyun };
865*4882a593Smuzhiyun
rpcauth_init_module(void)866*4882a593Smuzhiyun int __init rpcauth_init_module(void)
867*4882a593Smuzhiyun {
868*4882a593Smuzhiyun int err;
869*4882a593Smuzhiyun
870*4882a593Smuzhiyun err = rpc_init_authunix();
871*4882a593Smuzhiyun if (err < 0)
872*4882a593Smuzhiyun goto out1;
873*4882a593Smuzhiyun err = register_shrinker(&rpc_cred_shrinker);
874*4882a593Smuzhiyun if (err < 0)
875*4882a593Smuzhiyun goto out2;
876*4882a593Smuzhiyun return 0;
877*4882a593Smuzhiyun out2:
878*4882a593Smuzhiyun rpc_destroy_authunix();
879*4882a593Smuzhiyun out1:
880*4882a593Smuzhiyun return err;
881*4882a593Smuzhiyun }
882*4882a593Smuzhiyun
rpcauth_remove_module(void)883*4882a593Smuzhiyun void rpcauth_remove_module(void)
884*4882a593Smuzhiyun {
885*4882a593Smuzhiyun rpc_destroy_authunix();
886*4882a593Smuzhiyun unregister_shrinker(&rpc_cred_shrinker);
887*4882a593Smuzhiyun }
888