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