blob: a9f0d17fdb0d64dce0bd0829ee58b31f024d1a0c [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/net/sunrpc/auth.c
4 *
5 * Generic RPC client authentication API.
6 *
7 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
8 */
9
10#include <linux/types.h>
11#include <linux/sched.h>
Ingo Molnar5b825c32017-02-02 17:54:15 +010012#include <linux/cred.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/module.h>
14#include <linux/slab.h>
15#include <linux/errno.h>
Trond Myklebust25337fd2008-03-12 14:40:14 -040016#include <linux/hash.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/sunrpc/clnt.h>
Chuck Lever6a1a1e32012-07-11 16:31:08 -040018#include <linux/sunrpc/gss_api.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/spinlock.h>
20
Chuck Levera0584ee2019-02-11 11:24:58 -050021#include <trace/events/sunrpc.h>
22
Trond Myklebust241269b2010-07-31 14:29:08 -040023#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
Trond Myklebust4e4c3be2018-09-27 13:12:44 -040032static const struct rpc_authops __rcu *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
33 [RPC_AUTH_NULL] = (const struct rpc_authops __force __rcu *)&authnull_ops,
34 [RPC_AUTH_UNIX] = (const struct rpc_authops __force __rcu *)&authunix_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 NULL, /* others can be loadable modules */
36};
37
Trond Myklebuste092bdc2007-06-23 19:45:36 -040038static LIST_HEAD(cred_unused);
Trond Myklebustf5c21872007-06-25 17:11:20 -040039static unsigned long number_cred_unused;
Trond Myklebuste092bdc2007-06-23 19:45:36 -040040
NeilBrowna52458b2018-12-03 11:30:31 +110041static struct cred machine_cred = {
42 .usage = ATOMIC_INIT(1),
Santosh kumar pradhane7f45092019-01-09 22:08:26 +053043#ifdef CONFIG_DEBUG_CREDENTIALS
44 .magic = CRED_MAGIC,
45#endif
NeilBrown5e169232018-12-03 11:30:30 +110046};
47
48/*
49 * Return the machine_cred pointer to be used whenever
50 * the a generic machine credential is needed.
51 */
NeilBrowna52458b2018-12-03 11:30:31 +110052const struct cred *rpc_machine_cred(void)
NeilBrown5e169232018-12-03 11:30:30 +110053{
54 return &machine_cred;
55}
56EXPORT_SYMBOL_GPL(rpc_machine_cred);
57
Miquel van Smoorenburgdb5fe262010-09-12 19:55:26 -040058#define MAX_HASHTABLE_BITS (14)
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100059static int param_set_hashtbl_sz(const char *val, const struct kernel_param *kp)
Trond Myklebust241269b2010-07-31 14:29:08 -040060{
61 unsigned long num;
62 unsigned int nbits;
63 int ret;
64
65 if (!val)
66 goto out_inval;
Daniel Walter00cfaa92014-06-21 13:06:38 +010067 ret = kstrtoul(val, 0, &num);
Dan Carpenter1a54c0c2018-07-12 15:30:08 +030068 if (ret)
Trond Myklebust241269b2010-07-31 14:29:08 -040069 goto out_inval;
Frank Sorenson34ae6852016-06-27 15:17:19 -040070 nbits = fls(num - 1);
Trond Myklebust241269b2010-07-31 14:29:08 -040071 if (nbits > MAX_HASHTABLE_BITS || nbits < 2)
72 goto out_inval;
73 *(unsigned int *)kp->arg = nbits;
74 return 0;
75out_inval:
76 return -EINVAL;
77}
78
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100079static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
Trond Myklebust241269b2010-07-31 14:29:08 -040080{
81 unsigned int nbits;
82
83 nbits = *(unsigned int *)kp->arg;
Xiongfeng Wang2ac3ddc2020-05-08 09:33:00 +080084 return sprintf(buffer, "%u\n", 1U << nbits);
Trond Myklebust241269b2010-07-31 14:29:08 -040085}
86
87#define param_check_hashtbl_sz(name, p) __param_check(name, p, unsigned int);
88
Luis R. Rodriguez9c278472015-05-27 11:09:38 +093089static const struct kernel_param_ops param_ops_hashtbl_sz = {
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100090 .set = param_set_hashtbl_sz,
91 .get = param_get_hashtbl_sz,
92};
93
Trond Myklebust241269b2010-07-31 14:29:08 -040094module_param_named(auth_hashtable_size, auth_hashbits, hashtbl_sz, 0644);
95MODULE_PARM_DESC(auth_hashtable_size, "RPC credential cache hashtable size");
96
Trond Myklebustbae67462014-07-21 13:32:42 -040097static unsigned long auth_max_cred_cachesize = ULONG_MAX;
98module_param(auth_max_cred_cachesize, ulong, 0644);
99MODULE_PARM_DESC(auth_max_cred_cachesize, "RPC credential maximum total cache size");
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101static u32
102pseudoflavor_to_flavor(u32 flavor) {
Chuck Lever1c74a242013-03-22 12:53:08 -0400103 if (flavor > RPC_AUTH_MAXFLAVOR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 return RPC_AUTH_GSS;
105 return flavor;
106}
107
108int
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400109rpcauth_register(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400111 const struct rpc_authops *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 rpc_authflavor_t flavor;
113
114 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
115 return -EINVAL;
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400116 old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], NULL, ops);
117 if (old == NULL || old == ops)
118 return 0;
119 return -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400121EXPORT_SYMBOL_GPL(rpcauth_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123int
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400124rpcauth_unregister(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400126 const struct rpc_authops *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 rpc_authflavor_t flavor;
128
129 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
130 return -EINVAL;
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400131
132 old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], ops, NULL);
133 if (old == ops || old == NULL)
134 return 0;
135 return -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400137EXPORT_SYMBOL_GPL(rpcauth_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400139static const struct rpc_authops *
140rpcauth_get_authops(rpc_authflavor_t flavor)
141{
142 const struct rpc_authops *ops;
143
144 if (flavor >= RPC_AUTH_MAXFLAVOR)
145 return NULL;
146
147 rcu_read_lock();
148 ops = rcu_dereference(auth_flavors[flavor]);
149 if (ops == NULL) {
150 rcu_read_unlock();
151 request_module("rpc-auth-%u", flavor);
152 rcu_read_lock();
153 ops = rcu_dereference(auth_flavors[flavor]);
154 if (ops == NULL)
155 goto out;
156 }
157 if (!try_module_get(ops->owner))
158 ops = NULL;
159out:
160 rcu_read_unlock();
161 return ops;
162}
163
164static void
165rpcauth_put_authops(const struct rpc_authops *ops)
166{
167 module_put(ops->owner);
168}
169
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400170/**
Chuck Lever9568c5e2013-03-16 15:54:43 -0400171 * rpcauth_get_pseudoflavor - check if security flavor is supported
172 * @flavor: a security flavor
173 * @info: a GSS mech OID, quality of protection, and service value
174 *
175 * Verifies that an appropriate kernel module is available or already loaded.
176 * Returns an equivalent pseudoflavor, or RPC_AUTH_MAXFLAVOR if "flavor" is
177 * not supported locally.
178 */
179rpc_authflavor_t
180rpcauth_get_pseudoflavor(rpc_authflavor_t flavor, struct rpcsec_gss_info *info)
181{
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400182 const struct rpc_authops *ops = rpcauth_get_authops(flavor);
Chuck Lever9568c5e2013-03-16 15:54:43 -0400183 rpc_authflavor_t pseudoflavor;
184
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400185 if (!ops)
Chuck Lever9568c5e2013-03-16 15:54:43 -0400186 return RPC_AUTH_MAXFLAVOR;
Chuck Lever9568c5e2013-03-16 15:54:43 -0400187 pseudoflavor = flavor;
188 if (ops->info2flavor != NULL)
189 pseudoflavor = ops->info2flavor(info);
190
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400191 rpcauth_put_authops(ops);
Chuck Lever9568c5e2013-03-16 15:54:43 -0400192 return pseudoflavor;
193}
194EXPORT_SYMBOL_GPL(rpcauth_get_pseudoflavor);
195
196/**
Chuck Levera77c8062013-03-16 15:55:10 -0400197 * rpcauth_get_gssinfo - find GSS tuple matching a GSS pseudoflavor
198 * @pseudoflavor: GSS pseudoflavor to match
199 * @info: rpcsec_gss_info structure to fill in
200 *
201 * Returns zero and fills in "info" if pseudoflavor matches a
202 * supported mechanism.
203 */
204int
205rpcauth_get_gssinfo(rpc_authflavor_t pseudoflavor, struct rpcsec_gss_info *info)
206{
207 rpc_authflavor_t flavor = pseudoflavor_to_flavor(pseudoflavor);
208 const struct rpc_authops *ops;
209 int result;
210
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400211 ops = rpcauth_get_authops(flavor);
Chuck Levera77c8062013-03-16 15:55:10 -0400212 if (ops == NULL)
Chuck Levera77c8062013-03-16 15:55:10 -0400213 return -ENOENT;
Chuck Levera77c8062013-03-16 15:55:10 -0400214
215 result = -ENOENT;
216 if (ops->flavor2info != NULL)
217 result = ops->flavor2info(pseudoflavor, info);
218
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400219 rpcauth_put_authops(ops);
Chuck Levera77c8062013-03-16 15:55:10 -0400220 return result;
221}
222EXPORT_SYMBOL_GPL(rpcauth_get_gssinfo);
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224struct rpc_auth *
Sargun Dhillon82b98ca2018-07-05 16:48:50 +0000225rpcauth_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400227 struct rpc_auth *auth = ERR_PTR(-EINVAL);
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400228 const struct rpc_authops *ops;
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400229 u32 flavor = pseudoflavor_to_flavor(args->pseudoflavor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400231 ops = rpcauth_get_authops(flavor);
232 if (ops == NULL)
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500233 goto out;
234
Trond Myklebustc2190662013-08-26 19:23:04 -0400235 auth = ops->create(args, clnt);
Trond Myklebust4e4c3be2018-09-27 13:12:44 -0400236
237 rpcauth_put_authops(ops);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000238 if (IS_ERR(auth))
239 return auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 if (clnt->cl_auth)
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400241 rpcauth_release(clnt->cl_auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 clnt->cl_auth = auth;
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500243
244out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 return auth;
246}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400247EXPORT_SYMBOL_GPL(rpcauth_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249void
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400250rpcauth_release(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
Trond Myklebust331bc712018-10-14 10:40:29 -0400252 if (!refcount_dec_and_test(&auth->au_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 return;
254 auth->au_ops->destroy(auth);
255}
256
257static DEFINE_SPINLOCK(rpc_credcache_lock);
258
Trond Myklebust95cd6232018-10-11 16:11:09 -0400259/*
260 * On success, the caller is responsible for freeing the reference
261 * held by the hashtable
262 */
263static bool
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400264rpcauth_unhash_cred_locked(struct rpc_cred *cred)
265{
Trond Myklebust95cd6232018-10-11 16:11:09 -0400266 if (!test_and_clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
267 return false;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400268 hlist_del_rcu(&cred->cr_hash);
Trond Myklebust95cd6232018-10-11 16:11:09 -0400269 return true;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400270}
271
Trond Myklebust95cd6232018-10-11 16:11:09 -0400272static bool
Trond Myklebust9499b432007-06-24 15:57:57 -0400273rpcauth_unhash_cred(struct rpc_cred *cred)
274{
275 spinlock_t *cache_lock;
Trond Myklebust95cd6232018-10-11 16:11:09 -0400276 bool ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400277
Trond Myklebust95cd6232018-10-11 16:11:09 -0400278 if (!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
279 return false;
Trond Myklebust9499b432007-06-24 15:57:57 -0400280 cache_lock = &cred->cr_auth->au_credcache->lock;
281 spin_lock(cache_lock);
Trond Myklebust95cd6232018-10-11 16:11:09 -0400282 ret = rpcauth_unhash_cred_locked(cred);
Trond Myklebust9499b432007-06-24 15:57:57 -0400283 spin_unlock(cache_lock);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500284 return ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400285}
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287/*
288 * Initialize RPC credential cache
289 */
290int
Trond Myklebustf5c21872007-06-25 17:11:20 -0400291rpcauth_init_credcache(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
293 struct rpc_cred_cache *new;
Trond Myklebust988664a2010-07-31 14:29:07 -0400294 unsigned int hashsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Kris Katterjohn8b3a7002006-01-11 15:56:43 -0800296 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 if (!new)
Trond Myklebust241269b2010-07-31 14:29:08 -0400298 goto out_nocache;
299 new->hashbits = auth_hashbits;
Trond Myklebust988664a2010-07-31 14:29:07 -0400300 hashsize = 1U << new->hashbits;
Trond Myklebust241269b2010-07-31 14:29:08 -0400301 new->hashtable = kcalloc(hashsize, sizeof(new->hashtable[0]), GFP_KERNEL);
302 if (!new->hashtable)
303 goto out_nohashtbl;
Trond Myklebust9499b432007-06-24 15:57:57 -0400304 spin_lock_init(&new->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 auth->au_credcache = new;
306 return 0;
Trond Myklebust241269b2010-07-31 14:29:08 -0400307out_nohashtbl:
308 kfree(new);
309out_nocache:
310 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400312EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Jeff Laytona0337d12014-06-21 20:52:16 -0400314char *
315rpcauth_stringify_acceptor(struct rpc_cred *cred)
316{
317 if (!cred->cr_ops->crstringify_acceptor)
318 return NULL;
319 return cred->cr_ops->crstringify_acceptor(cred);
320}
321EXPORT_SYMBOL_GPL(rpcauth_stringify_acceptor);
322
Andy Adamson4de6caa2013-08-14 11:59:15 -0400323/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * Destroy a list of credentials
325 */
326static inline
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400327void rpcauth_destroy_credlist(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
329 struct rpc_cred *cred;
330
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400331 while (!list_empty(head)) {
332 cred = list_entry(head->next, struct rpc_cred, cr_lru);
333 list_del_init(&cred->cr_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 put_rpccred(cred);
335 }
336}
337
Trond Myklebust95cd6232018-10-11 16:11:09 -0400338static void
339rpcauth_lru_add_locked(struct rpc_cred *cred)
340{
341 if (!list_empty(&cred->cr_lru))
342 return;
343 number_cred_unused++;
344 list_add_tail(&cred->cr_lru, &cred_unused);
345}
346
347static void
348rpcauth_lru_add(struct rpc_cred *cred)
349{
350 if (!list_empty(&cred->cr_lru))
351 return;
352 spin_lock(&rpc_credcache_lock);
353 rpcauth_lru_add_locked(cred);
354 spin_unlock(&rpc_credcache_lock);
355}
356
357static void
358rpcauth_lru_remove_locked(struct rpc_cred *cred)
359{
360 if (list_empty(&cred->cr_lru))
361 return;
362 number_cred_unused--;
363 list_del_init(&cred->cr_lru);
364}
365
366static void
367rpcauth_lru_remove(struct rpc_cred *cred)
368{
369 if (list_empty(&cred->cr_lru))
370 return;
371 spin_lock(&rpc_credcache_lock);
372 rpcauth_lru_remove_locked(cred);
373 spin_unlock(&rpc_credcache_lock);
374}
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376/*
377 * Clear the RPC credential cache, and delete those credentials
378 * that are not referenced.
379 */
380void
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400381rpcauth_clear_credcache(struct rpc_cred_cache *cache)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400383 LIST_HEAD(free);
384 struct hlist_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 struct rpc_cred *cred;
Trond Myklebust988664a2010-07-31 14:29:07 -0400386 unsigned int hashsize = 1U << cache->hashbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 int i;
388
389 spin_lock(&rpc_credcache_lock);
Trond Myklebust9499b432007-06-24 15:57:57 -0400390 spin_lock(&cache->lock);
Trond Myklebust988664a2010-07-31 14:29:07 -0400391 for (i = 0; i < hashsize; i++) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400392 head = &cache->hashtable[i];
393 while (!hlist_empty(head)) {
394 cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400395 rpcauth_unhash_cred_locked(cred);
Trond Myklebust95cd6232018-10-11 16:11:09 -0400396 /* Note: We now hold a reference to cred */
397 rpcauth_lru_remove_locked(cred);
398 list_add_tail(&cred->cr_lru, &free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 }
400 }
Trond Myklebust9499b432007-06-24 15:57:57 -0400401 spin_unlock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 spin_unlock(&rpc_credcache_lock);
403 rpcauth_destroy_credlist(&free);
404}
405
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400406/*
407 * Destroy the RPC credential cache
408 */
409void
410rpcauth_destroy_credcache(struct rpc_auth *auth)
411{
412 struct rpc_cred_cache *cache = auth->au_credcache;
413
414 if (cache) {
415 auth->au_credcache = NULL;
416 rpcauth_clear_credcache(cache);
Trond Myklebust241269b2010-07-31 14:29:08 -0400417 kfree(cache->hashtable);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400418 kfree(cache);
419 }
420}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400421EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400422
Trond Myklebustd2b83142008-04-14 18:13:37 -0400423
424#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426/*
427 * Remove stale credentials. Avoid sleeping inside the loop.
428 */
Dave Chinner70534a72013-08-28 10:18:14 +1000429static long
Trond Myklebustf5c21872007-06-25 17:11:20 -0400430rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431{
Trond Myklebusteac0d182008-10-28 15:21:41 -0400432 struct rpc_cred *cred, *next;
Trond Myklebustd2b83142008-04-14 18:13:37 -0400433 unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
Dave Chinner70534a72013-08-28 10:18:14 +1000434 long freed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Trond Myklebusteac0d182008-10-28 15:21:41 -0400436 list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
437
Trond Myklebust20673402010-05-13 12:51:06 -0400438 if (nr_to_scan-- == 0)
439 break;
Trond Myklebust79b18182018-10-14 10:34:31 -0400440 if (refcount_read(&cred->cr_count) > 1) {
Trond Myklebust95cd6232018-10-11 16:11:09 -0400441 rpcauth_lru_remove_locked(cred);
442 continue;
443 }
Trond Myklebust93a05e62010-05-13 12:51:06 -0400444 /*
445 * Enforce a 60 second garbage collection moratorium
446 * Note that the cred_unused list must be time-ordered.
447 */
Trond Myklebust95cd6232018-10-11 16:11:09 -0400448 if (!time_in_range(cred->cr_expire, expired, jiffies))
449 continue;
450 if (!rpcauth_unhash_cred(cred))
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400451 continue;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400452
Trond Myklebust95cd6232018-10-11 16:11:09 -0400453 rpcauth_lru_remove_locked(cred);
454 freed++;
455 list_add_tail(&cred->cr_lru, free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 }
Trond Myklebust95cd6232018-10-11 16:11:09 -0400457 return freed ? freed : SHRINK_STOP;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400458}
459
Trond Myklebustbae67462014-07-21 13:32:42 -0400460static unsigned long
461rpcauth_cache_do_shrink(int nr_to_scan)
462{
463 LIST_HEAD(free);
464 unsigned long freed;
465
466 spin_lock(&rpc_credcache_lock);
467 freed = rpcauth_prune_expired(&free, nr_to_scan);
468 spin_unlock(&rpc_credcache_lock);
469 rpcauth_destroy_credlist(&free);
470
471 return freed;
472}
473
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400474/*
Trond Myklebustf5c21872007-06-25 17:11:20 -0400475 * Run memory cache shrinker.
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400476 */
Dave Chinner70534a72013-08-28 10:18:14 +1000477static unsigned long
478rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
479
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400480{
Dave Chinner70534a72013-08-28 10:18:14 +1000481 if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
482 return SHRINK_STOP;
483
484 /* nothing left, don't come back */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400485 if (list_empty(&cred_unused))
Dave Chinner70534a72013-08-28 10:18:14 +1000486 return SHRINK_STOP;
487
Trond Myklebustbae67462014-07-21 13:32:42 -0400488 return rpcauth_cache_do_shrink(sc->nr_to_scan);
Dave Chinner70534a72013-08-28 10:18:14 +1000489}
490
491static unsigned long
492rpcauth_cache_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
493
494{
NeilBrown4c3ffd02017-01-06 14:19:58 +1100495 return number_cred_unused * sysctl_vfs_cache_pressure / 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
Trond Myklebustbae67462014-07-21 13:32:42 -0400498static void
499rpcauth_cache_enforce_limit(void)
500{
501 unsigned long diff;
502 unsigned int nr_to_scan;
503
504 if (number_cred_unused <= auth_max_cred_cachesize)
505 return;
506 diff = number_cred_unused - auth_max_cred_cachesize;
507 nr_to_scan = 100;
508 if (diff < nr_to_scan)
509 nr_to_scan = diff;
510 rpcauth_cache_do_shrink(nr_to_scan);
511}
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513/*
514 * Look up a process' credentials in the authentication cache
515 */
516struct rpc_cred *
517rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
Jeff Layton3c6e0bc2016-04-21 20:51:54 -0400518 int flags, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400520 LIST_HEAD(free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 struct rpc_cred_cache *cache = auth->au_credcache;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400522 struct rpc_cred *cred = NULL,
523 *entry, *new;
Trond Myklebust25337fd2008-03-12 14:40:14 -0400524 unsigned int nr;
525
Frank Sorenson66cbd4b2016-09-29 10:44:41 -0500526 nr = auth->au_ops->hash_cred(acred, cache->hashbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400528 rcu_read_lock();
Sasha Levinb67bfe02013-02-27 17:06:00 -0800529 hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400530 if (!entry->cr_ops->crmatch(acred, entry, flags))
531 continue;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400532 cred = get_rpccred(entry);
Trond Myklebust07d02a62018-10-12 13:28:26 -0400533 if (cred)
534 break;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400535 }
536 rcu_read_unlock();
537
Trond Myklebust9499b432007-06-24 15:57:57 -0400538 if (cred != NULL)
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400539 goto found;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400540
Jeff Layton3c6e0bc2016-04-21 20:51:54 -0400541 new = auth->au_ops->crcreate(auth, acred, flags, gfp);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400542 if (IS_ERR(new)) {
543 cred = new;
544 goto out;
545 }
546
Trond Myklebust9499b432007-06-24 15:57:57 -0400547 spin_lock(&cache->lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800548 hlist_for_each_entry(entry, &cache->hashtable[nr], cr_hash) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400549 if (!entry->cr_ops->crmatch(acred, entry, flags))
550 continue;
551 cred = get_rpccred(entry);
Trond Myklebust07d02a62018-10-12 13:28:26 -0400552 if (cred)
553 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400555 if (cred == NULL) {
Trond Myklebust5fe47552007-06-23 19:55:31 -0400556 cred = new;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400557 set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
Trond Myklebust79b18182018-10-14 10:34:31 -0400558 refcount_inc(&cred->cr_count);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400559 hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
560 } else
561 list_add_tail(&new->cr_lru, &free);
Trond Myklebust9499b432007-06-24 15:57:57 -0400562 spin_unlock(&cache->lock);
Trond Myklebustbae67462014-07-21 13:32:42 -0400563 rpcauth_cache_enforce_limit();
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400564found:
Joe Perchesf64f9e72009-11-29 16:55:45 -0800565 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
566 cred->cr_ops->cr_init != NULL &&
567 !(flags & RPCAUTH_LOOKUP_NEW)) {
Trond Myklebustfba3bad2006-02-01 12:19:27 -0500568 int res = cred->cr_ops->cr_init(auth, cred);
569 if (res < 0) {
570 put_rpccred(cred);
571 cred = ERR_PTR(res);
572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400574 rpcauth_destroy_credlist(&free);
575out:
576 return cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400578EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580struct rpc_cred *
Trond Myklebust8a317762006-02-01 12:18:36 -0500581rpcauth_lookupcred(struct rpc_auth *auth, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
David Howells86a264a2008-11-14 10:39:18 +1100583 struct auth_cred acred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 struct rpc_cred *ret;
David Howells86a264a2008-11-14 10:39:18 +1100585 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
David Howells86a264a2008-11-14 10:39:18 +1100587 memset(&acred, 0, sizeof(acred));
NeilBrown97f68c6b2018-12-03 11:30:30 +1100588 acred.cred = cred;
Trond Myklebust8a317762006-02-01 12:18:36 -0500589 ret = auth->au_ops->lookup_cred(auth, &acred, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return ret;
591}
Andy Adamson66b06862014-06-12 15:02:32 -0400592EXPORT_SYMBOL_GPL(rpcauth_lookupcred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Trond Myklebust5fe47552007-06-23 19:55:31 -0400594void
595rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
596 struct rpc_auth *auth, const struct rpc_credops *ops)
597{
598 INIT_HLIST_NODE(&cred->cr_hash);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400599 INIT_LIST_HEAD(&cred->cr_lru);
Trond Myklebust79b18182018-10-14 10:34:31 -0400600 refcount_set(&cred->cr_count, 1);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400601 cred->cr_auth = auth;
NeilBrown2edd8d72018-12-03 11:30:31 +1100602 cred->cr_flags = 0;
Trond Myklebust5fe47552007-06-23 19:55:31 -0400603 cred->cr_ops = ops;
604 cred->cr_expire = jiffies;
NeilBrown97f68c6b2018-12-03 11:30:30 +1100605 cred->cr_cred = get_cred(acred->cred);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400606}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400607EXPORT_SYMBOL_GPL(rpcauth_init_cred);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400608
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400609static struct rpc_cred *
Trond Myklebust5d351752009-09-15 13:32:13 -0400610rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400612 struct rpc_auth *auth = task->tk_client->cl_auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 struct auth_cred acred = {
NeilBrown97f68c6b2018-12-03 11:30:30 +1100614 .cred = get_task_cred(&init_task),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 };
NeilBrown97f68c6b2018-12-03 11:30:30 +1100616 struct rpc_cred *ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
NeilBrown97f68c6b2018-12-03 11:30:30 +1100618 ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
619 put_cred(acred.cred);
620 return ret;
Trond Myklebustaf093832008-03-12 12:12:16 -0400621}
622
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400623static struct rpc_cred *
NeilBrown5e169232018-12-03 11:30:30 +1100624rpcauth_bind_machine_cred(struct rpc_task *task, int lookupflags)
625{
626 struct rpc_auth *auth = task->tk_client->cl_auth;
627 struct auth_cred acred = {
628 .principal = task->tk_client->cl_principal,
629 .cred = init_task.cred,
630 };
631
632 if (!acred.principal)
633 return NULL;
NeilBrown5e169232018-12-03 11:30:30 +1100634 return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
635}
636
637static struct rpc_cred *
Trond Myklebust5d351752009-09-15 13:32:13 -0400638rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
Trond Myklebustaf093832008-03-12 12:12:16 -0400639{
640 struct rpc_auth *auth = task->tk_client->cl_auth;
Trond Myklebustaf093832008-03-12 12:12:16 -0400641
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400642 return rpcauth_lookupcred(auth, lookupflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
644
Trond Myklebusta17c2152010-07-31 14:29:08 -0400645static int
NeilBrowna52458b2018-12-03 11:30:31 +1100646rpcauth_bindcred(struct rpc_task *task, const struct cred *cred, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400648 struct rpc_rqst *req = task->tk_rqstp;
NeilBrown5e169232018-12-03 11:30:30 +1100649 struct rpc_cred *new = NULL;
Trond Myklebust5d351752009-09-15 13:32:13 -0400650 int lookupflags = 0;
NeilBrowna52458b2018-12-03 11:30:31 +1100651 struct rpc_auth *auth = task->tk_client->cl_auth;
652 struct auth_cred acred = {
653 .cred = cred,
654 };
Trond Myklebust5d351752009-09-15 13:32:13 -0400655
656 if (flags & RPC_TASK_ASYNC)
657 lookupflags |= RPCAUTH_LOOKUP_NEW;
NeilBrown1de7eea2018-12-03 11:30:30 +1100658 if (task->tk_op_cred)
659 /* Task must use exactly this rpc_cred */
NeilBrownd6efccd2018-12-03 11:30:31 +1100660 new = get_rpccred(task->tk_op_cred);
NeilBrown1de7eea2018-12-03 11:30:30 +1100661 else if (cred != NULL && cred != &machine_cred)
NeilBrowna52458b2018-12-03 11:30:31 +1100662 new = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
NeilBrown5e169232018-12-03 11:30:30 +1100663 else if (cred == &machine_cred)
664 new = rpcauth_bind_machine_cred(task, lookupflags);
665
666 /* If machine cred couldn't be bound, try a root cred */
667 if (new)
668 ;
669 else if (cred == &machine_cred || (flags & RPC_TASK_ROOTCREDS))
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400670 new = rpcauth_bind_root_cred(task, lookupflags);
NeilBrowna68a72e2018-12-03 11:30:30 +1100671 else if (flags & RPC_TASK_NULLCREDS)
672 new = authnull_ops.lookup_cred(NULL, NULL, 0);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400673 else
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400674 new = rpcauth_bind_new_cred(task, lookupflags);
675 if (IS_ERR(new))
676 return PTR_ERR(new);
Trond Myklebust9a8f6b52016-05-16 17:42:42 -0400677 put_rpccred(req->rq_cred);
Trond Myklebusta17c2152010-07-31 14:29:08 -0400678 req->rq_cred = new;
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400679 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
681
682void
683put_rpccred(struct rpc_cred *cred)
684{
Trond Myklebust9a8f6b52016-05-16 17:42:42 -0400685 if (cred == NULL)
686 return;
Trond Myklebust95cd6232018-10-11 16:11:09 -0400687 rcu_read_lock();
Trond Myklebust79b18182018-10-14 10:34:31 -0400688 if (refcount_dec_and_test(&cred->cr_count))
Trond Myklebust95cd6232018-10-11 16:11:09 -0400689 goto destroy;
Trond Myklebust79b18182018-10-14 10:34:31 -0400690 if (refcount_read(&cred->cr_count) != 1 ||
Trond Myklebust95cd6232018-10-11 16:11:09 -0400691 !test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
692 goto out;
693 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
694 cred->cr_expire = jiffies;
695 rpcauth_lru_add(cred);
696 /* Race breaker */
697 if (unlikely(!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags)))
698 rpcauth_lru_remove(cred);
699 } else if (rpcauth_unhash_cred(cred)) {
700 rpcauth_lru_remove(cred);
Trond Myklebust79b18182018-10-14 10:34:31 -0400701 if (refcount_dec_and_test(&cred->cr_count))
Trond Myklebust95cd6232018-10-11 16:11:09 -0400702 goto destroy;
Trond Myklebustf0380f32009-12-03 08:10:17 -0500703 }
Trond Myklebust95cd6232018-10-11 16:11:09 -0400704out:
705 rcu_read_unlock();
Trond Myklebustf0380f32009-12-03 08:10:17 -0500706 return;
Trond Myklebust95cd6232018-10-11 16:11:09 -0400707destroy:
708 rcu_read_unlock();
709 cred->cr_ops->crdestroy(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400711EXPORT_SYMBOL_GPL(put_rpccred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Chuck Levere8680a22019-02-11 11:24:48 -0500713/**
714 * rpcauth_marshcred - Append RPC credential to end of @xdr
715 * @task: controlling RPC task
716 * @xdr: xdr_stream containing initial portion of RPC Call header
717 *
718 * On success, an appropriate verifier is added to @xdr, @xdr is
719 * updated to point past the verifier, and zero is returned.
720 * Otherwise, @xdr is in an undefined state and a negative errno
721 * is returned.
722 */
723int rpcauth_marshcred(struct rpc_task *task, struct xdr_stream *xdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Chuck Levere8680a22019-02-11 11:24:48 -0500725 const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Chuck Levere8680a22019-02-11 11:24:48 -0500727 return ops->crmarshal(task, xdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729
Chuck Levere8680a22019-02-11 11:24:48 -0500730/**
731 * rpcauth_wrap_req_encode - XDR encode the RPC procedure
732 * @task: controlling RPC task
733 * @xdr: stream where on-the-wire bytes are to be marshalled
734 *
735 * On success, @xdr contains the encoded and wrapped message.
736 * Otherwise, @xdr is in an undefined state.
737 */
738int rpcauth_wrap_req_encode(struct rpc_task *task, struct xdr_stream *xdr)
Chuck Lever9f06c712010-12-14 14:59:18 +0000739{
Chuck Levere8680a22019-02-11 11:24:48 -0500740 kxdreproc_t encode = task->tk_msg.rpc_proc->p_encode;
Chuck Lever9f06c712010-12-14 14:59:18 +0000741
Chuck Levere8680a22019-02-11 11:24:48 -0500742 encode(task->tk_rqstp, xdr, task->tk_msg.rpc_argp);
Chuck Lever9f06c712010-12-14 14:59:18 +0000743 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744}
Chuck Levere8680a22019-02-11 11:24:48 -0500745EXPORT_SYMBOL_GPL(rpcauth_wrap_req_encode);
746
747/**
748 * rpcauth_wrap_req - XDR encode and wrap the RPC procedure
749 * @task: controlling RPC task
750 * @xdr: stream where on-the-wire bytes are to be marshalled
751 *
752 * On success, @xdr contains the encoded and wrapped message,
753 * and zero is returned. Otherwise, @xdr is in an undefined
754 * state and a negative errno is returned.
755 */
756int rpcauth_wrap_req(struct rpc_task *task, struct xdr_stream *xdr)
757{
758 const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
759
760 return ops->crwrap_req(task, xdr);
761}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Chuck Levera0584ee2019-02-11 11:24:58 -0500763/**
764 * rpcauth_checkverf - Validate verifier in RPC Reply header
765 * @task: controlling RPC task
766 * @xdr: xdr_stream containing RPC Reply header
767 *
768 * On success, @xdr is updated to point past the verifier and
769 * zero is returned. Otherwise, @xdr is in an undefined state
770 * and a negative errno is returned.
771 */
772int
773rpcauth_checkverf(struct rpc_task *task, struct xdr_stream *xdr)
Chuck Leverbf269552010-12-14 14:59:29 +0000774{
Chuck Levera0584ee2019-02-11 11:24:58 -0500775 const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
Chuck Leverbf269552010-12-14 14:59:29 +0000776
Chuck Levera0584ee2019-02-11 11:24:58 -0500777 return ops->crvalidate(task, xdr);
Chuck Leverbf269552010-12-14 14:59:29 +0000778}
779
Chuck Levera0584ee2019-02-11 11:24:58 -0500780/**
781 * rpcauth_unwrap_resp_decode - Invoke XDR decode function
782 * @task: controlling RPC task
783 * @xdr: stream where the Reply message resides
784 *
785 * Returns zero on success; otherwise a negative errno is returned.
786 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787int
Chuck Levera0584ee2019-02-11 11:24:58 -0500788rpcauth_unwrap_resp_decode(struct rpc_task *task, struct xdr_stream *xdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
Chuck Levera0584ee2019-02-11 11:24:58 -0500790 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Chuck Levera0584ee2019-02-11 11:24:58 -0500792 return decode(task->tk_rqstp, xdr, task->tk_msg.rpc_resp);
793}
794EXPORT_SYMBOL_GPL(rpcauth_unwrap_resp_decode);
795
796/**
797 * rpcauth_unwrap_resp - Invoke unwrap and decode function for the cred
798 * @task: controlling RPC task
799 * @xdr: stream where the Reply message resides
800 *
801 * Returns zero on success; otherwise a negative errno is returned.
802 */
803int
804rpcauth_unwrap_resp(struct rpc_task *task, struct xdr_stream *xdr)
805{
806 const struct rpc_credops *ops = task->tk_rqstp->rq_cred->cr_ops;
807
808 return ops->crunwrap_resp(task, xdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
810
Trond Myklebust3021a5bb2018-08-14 13:50:21 -0400811bool
812rpcauth_xmit_need_reencode(struct rpc_task *task)
813{
814 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
815
816 if (!cred || !cred->cr_ops->crneed_reencode)
817 return false;
818 return cred->cr_ops->crneed_reencode(task);
819}
820
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821int
822rpcauth_refreshcred(struct rpc_task *task)
823{
Trond Myklebust9a84d382010-10-24 18:00:46 -0400824 struct rpc_cred *cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 int err;
826
Trond Myklebusta17c2152010-07-31 14:29:08 -0400827 cred = task->tk_rqstp->rq_cred;
828 if (cred == NULL) {
829 err = rpcauth_bindcred(task, task->tk_msg.rpc_cred, task->tk_flags);
830 if (err < 0)
831 goto out;
832 cred = task->tk_rqstp->rq_cred;
Joe Perchesf81c6222011-06-03 11:51:19 +0000833 }
Chuck Lever0bbacc42005-11-01 16:53:32 -0500834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 err = cred->cr_ops->crrefresh(task);
Trond Myklebusta17c2152010-07-31 14:29:08 -0400836out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 if (err < 0)
838 task->tk_status = err;
839 return err;
840}
841
842void
843rpcauth_invalcred(struct rpc_task *task)
844{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400845 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400846
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400847 if (cred)
848 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849}
850
851int
852rpcauth_uptodatecred(struct rpc_task *task)
853{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400854 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400855
856 return cred == NULL ||
857 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858}
Trond Myklebustf5c21872007-06-25 17:11:20 -0400859
Rusty Russell8e1f9362007-07-17 04:03:17 -0700860static struct shrinker rpc_cred_shrinker = {
Dave Chinner70534a72013-08-28 10:18:14 +1000861 .count_objects = rpcauth_cache_shrink_count,
862 .scan_objects = rpcauth_cache_shrink_scan,
Rusty Russell8e1f9362007-07-17 04:03:17 -0700863 .seeks = DEFAULT_SEEKS,
864};
Trond Myklebustf5c21872007-06-25 17:11:20 -0400865
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400866int __init rpcauth_init_module(void)
Trond Myklebustf5c21872007-06-25 17:11:20 -0400867{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400868 int err;
869
870 err = rpc_init_authunix();
871 if (err < 0)
872 goto out1;
Kinglong Mee28644862017-02-07 21:46:39 +0800873 err = register_shrinker(&rpc_cred_shrinker);
874 if (err < 0)
NeilBrown89a4f752018-12-03 11:30:31 +1100875 goto out2;
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400876 return 0;
877out2:
878 rpc_destroy_authunix();
879out1:
880 return err;
Trond Myklebustf5c21872007-06-25 17:11:20 -0400881}
882
Stephen Rothwellc135e842010-09-29 14:16:57 +1000883void rpcauth_remove_module(void)
Trond Myklebustf5c21872007-06-25 17:11:20 -0400884{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400885 rpc_destroy_authunix();
Rusty Russell8e1f9362007-07-17 04:03:17 -0700886 unregister_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400887}