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