blob: 305ecea9217071208147ed84755c745b6299606e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Ingo Molnar5b825c32017-02-02 17:54:15 +010011#include <linux/cred.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/module.h>
13#include <linux/slab.h>
14#include <linux/errno.h>
Trond Myklebust25337fd2008-03-12 14:40:14 -040015#include <linux/hash.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/sunrpc/clnt.h>
Chuck Lever6a1a1e32012-07-11 16:31:08 -040017#include <linux/sunrpc/gss_api.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/spinlock.h>
19
Jeff Laytonf895b252014-11-17 16:58:04 -050020#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070021# define RPCDBG_FACILITY RPCDBG_AUTH
22#endif
23
Trond Myklebust241269b2010-07-31 14:29:08 -040024#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
Trond Myklebustfc1b3562007-06-09 16:15:46 -040033static DEFINE_SPINLOCK(rpc_authflavor_lock);
Trond Myklebustf1c0a862007-06-23 20:17:58 -040034static const struct rpc_authops *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 &authnull_ops, /* AUTH_NULL */
36 &authunix_ops, /* AUTH_UNIX */
37 NULL, /* others can be loadable modules */
38};
39
Trond Myklebuste092bdc2007-06-23 19:45:36 -040040static LIST_HEAD(cred_unused);
Trond Myklebustf5c21872007-06-25 17:11:20 -040041static unsigned long number_cred_unused;
Trond Myklebuste092bdc2007-06-23 19:45:36 -040042
Miquel van Smoorenburgdb5fe262010-09-12 19:55:26 -040043#define MAX_HASHTABLE_BITS (14)
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100044static int param_set_hashtbl_sz(const char *val, const struct kernel_param *kp)
Trond Myklebust241269b2010-07-31 14:29:08 -040045{
46 unsigned long num;
47 unsigned int nbits;
48 int ret;
49
50 if (!val)
51 goto out_inval;
Daniel Walter00cfaa92014-06-21 13:06:38 +010052 ret = kstrtoul(val, 0, &num);
Dan Carpenter1a54c0c2018-07-12 15:30:08 +030053 if (ret)
Trond Myklebust241269b2010-07-31 14:29:08 -040054 goto out_inval;
Frank Sorenson34ae6852016-06-27 15:17:19 -040055 nbits = fls(num - 1);
Trond Myklebust241269b2010-07-31 14:29:08 -040056 if (nbits > MAX_HASHTABLE_BITS || nbits < 2)
57 goto out_inval;
58 *(unsigned int *)kp->arg = nbits;
59 return 0;
60out_inval:
61 return -EINVAL;
62}
63
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100064static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
Trond Myklebust241269b2010-07-31 14:29:08 -040065{
66 unsigned int nbits;
67
68 nbits = *(unsigned int *)kp->arg;
69 return sprintf(buffer, "%u", 1U << nbits);
70}
71
72#define param_check_hashtbl_sz(name, p) __param_check(name, p, unsigned int);
73
Luis R. Rodriguez9c278472015-05-27 11:09:38 +093074static const struct kernel_param_ops param_ops_hashtbl_sz = {
Stephen Rothwell8e4e15d2010-08-04 12:11:22 +100075 .set = param_set_hashtbl_sz,
76 .get = param_get_hashtbl_sz,
77};
78
Trond Myklebust241269b2010-07-31 14:29:08 -040079module_param_named(auth_hashtable_size, auth_hashbits, hashtbl_sz, 0644);
80MODULE_PARM_DESC(auth_hashtable_size, "RPC credential cache hashtable size");
81
Trond Myklebustbae67462014-07-21 13:32:42 -040082static unsigned long auth_max_cred_cachesize = ULONG_MAX;
83module_param(auth_max_cred_cachesize, ulong, 0644);
84MODULE_PARM_DESC(auth_max_cred_cachesize, "RPC credential maximum total cache size");
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086static u32
87pseudoflavor_to_flavor(u32 flavor) {
Chuck Lever1c74a242013-03-22 12:53:08 -040088 if (flavor > RPC_AUTH_MAXFLAVOR)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 return RPC_AUTH_GSS;
90 return flavor;
91}
92
93int
Trond Myklebustf1c0a862007-06-23 20:17:58 -040094rpcauth_register(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095{
96 rpc_authflavor_t flavor;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040097 int ret = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
100 return -EINVAL;
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400101 spin_lock(&rpc_authflavor_lock);
102 if (auth_flavors[flavor] == NULL) {
103 auth_flavors[flavor] = ops;
104 ret = 0;
105 }
106 spin_unlock(&rpc_authflavor_lock);
107 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400109EXPORT_SYMBOL_GPL(rpcauth_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111int
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400112rpcauth_unregister(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 rpc_authflavor_t flavor;
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400115 int ret = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
118 return -EINVAL;
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400119 spin_lock(&rpc_authflavor_lock);
120 if (auth_flavors[flavor] == ops) {
121 auth_flavors[flavor] = NULL;
122 ret = 0;
123 }
124 spin_unlock(&rpc_authflavor_lock);
125 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400127EXPORT_SYMBOL_GPL(rpcauth_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400129/**
Chuck Lever9568c5e2013-03-16 15:54:43 -0400130 * rpcauth_get_pseudoflavor - check if security flavor is supported
131 * @flavor: a security flavor
132 * @info: a GSS mech OID, quality of protection, and service value
133 *
134 * Verifies that an appropriate kernel module is available or already loaded.
135 * Returns an equivalent pseudoflavor, or RPC_AUTH_MAXFLAVOR if "flavor" is
136 * not supported locally.
137 */
138rpc_authflavor_t
139rpcauth_get_pseudoflavor(rpc_authflavor_t flavor, struct rpcsec_gss_info *info)
140{
141 const struct rpc_authops *ops;
142 rpc_authflavor_t pseudoflavor;
143
144 ops = auth_flavors[flavor];
145 if (ops == NULL)
146 request_module("rpc-auth-%u", flavor);
147 spin_lock(&rpc_authflavor_lock);
148 ops = auth_flavors[flavor];
149 if (ops == NULL || !try_module_get(ops->owner)) {
150 spin_unlock(&rpc_authflavor_lock);
151 return RPC_AUTH_MAXFLAVOR;
152 }
153 spin_unlock(&rpc_authflavor_lock);
154
155 pseudoflavor = flavor;
156 if (ops->info2flavor != NULL)
157 pseudoflavor = ops->info2flavor(info);
158
159 module_put(ops->owner);
160 return pseudoflavor;
161}
162EXPORT_SYMBOL_GPL(rpcauth_get_pseudoflavor);
163
164/**
Chuck Levera77c8062013-03-16 15:55:10 -0400165 * rpcauth_get_gssinfo - find GSS tuple matching a GSS pseudoflavor
166 * @pseudoflavor: GSS pseudoflavor to match
167 * @info: rpcsec_gss_info structure to fill in
168 *
169 * Returns zero and fills in "info" if pseudoflavor matches a
170 * supported mechanism.
171 */
172int
173rpcauth_get_gssinfo(rpc_authflavor_t pseudoflavor, struct rpcsec_gss_info *info)
174{
175 rpc_authflavor_t flavor = pseudoflavor_to_flavor(pseudoflavor);
176 const struct rpc_authops *ops;
177 int result;
178
Chuck Lever1c74a242013-03-22 12:53:08 -0400179 if (flavor >= RPC_AUTH_MAXFLAVOR)
180 return -EINVAL;
181
Chuck Levera77c8062013-03-16 15:55:10 -0400182 ops = auth_flavors[flavor];
183 if (ops == NULL)
184 request_module("rpc-auth-%u", flavor);
185 spin_lock(&rpc_authflavor_lock);
186 ops = auth_flavors[flavor];
187 if (ops == NULL || !try_module_get(ops->owner)) {
188 spin_unlock(&rpc_authflavor_lock);
189 return -ENOENT;
190 }
191 spin_unlock(&rpc_authflavor_lock);
192
193 result = -ENOENT;
194 if (ops->flavor2info != NULL)
195 result = ops->flavor2info(pseudoflavor, info);
196
197 module_put(ops->owner);
198 return result;
199}
200EXPORT_SYMBOL_GPL(rpcauth_get_gssinfo);
201
202/**
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400203 * rpcauth_list_flavors - discover registered flavors and pseudoflavors
204 * @array: array to fill in
205 * @size: size of "array"
206 *
207 * Returns the number of array items filled in, or a negative errno.
208 *
209 * The returned array is not sorted by any policy. Callers should not
210 * rely on the order of the items in the returned array.
211 */
212int
213rpcauth_list_flavors(rpc_authflavor_t *array, int size)
214{
215 rpc_authflavor_t flavor;
216 int result = 0;
217
218 spin_lock(&rpc_authflavor_lock);
219 for (flavor = 0; flavor < RPC_AUTH_MAXFLAVOR; flavor++) {
220 const struct rpc_authops *ops = auth_flavors[flavor];
221 rpc_authflavor_t pseudos[4];
222 int i, len;
223
224 if (result >= size) {
225 result = -ENOMEM;
226 break;
227 }
228
229 if (ops == NULL)
230 continue;
231 if (ops->list_pseudoflavors == NULL) {
232 array[result++] = ops->au_flavor;
233 continue;
234 }
235 len = ops->list_pseudoflavors(pseudos, ARRAY_SIZE(pseudos));
236 if (len < 0) {
237 result = len;
238 break;
239 }
240 for (i = 0; i < len; i++) {
241 if (result >= size) {
242 result = -ENOMEM;
243 break;
244 }
245 array[result++] = pseudos[i];
246 }
247 }
248 spin_unlock(&rpc_authflavor_lock);
249
250 dprintk("RPC: %s returns %d\n", __func__, result);
251 return result;
252}
253EXPORT_SYMBOL_GPL(rpcauth_list_flavors);
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255struct rpc_auth *
Sargun Dhillon82b98ca2018-07-05 16:48:50 +0000256rpcauth_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
258 struct rpc_auth *auth;
Trond Myklebustf1c0a862007-06-23 20:17:58 -0400259 const struct rpc_authops *ops;
Trond Myklebustc2190662013-08-26 19:23:04 -0400260 u32 flavor = pseudoflavor_to_flavor(args->pseudoflavor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500262 auth = ERR_PTR(-EINVAL);
263 if (flavor >= RPC_AUTH_MAXFLAVOR)
264 goto out;
265
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500266 if ((ops = auth_flavors[flavor]) == NULL)
267 request_module("rpc-auth-%u", flavor);
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400268 spin_lock(&rpc_authflavor_lock);
269 ops = auth_flavors[flavor];
270 if (ops == NULL || !try_module_get(ops->owner)) {
271 spin_unlock(&rpc_authflavor_lock);
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500272 goto out;
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400273 }
274 spin_unlock(&rpc_authflavor_lock);
Trond Myklebustc2190662013-08-26 19:23:04 -0400275 auth = ops->create(args, clnt);
Trond Myklebustfc1b3562007-06-09 16:15:46 -0400276 module_put(ops->owner);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000277 if (IS_ERR(auth))
278 return auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (clnt->cl_auth)
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400280 rpcauth_release(clnt->cl_auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 clnt->cl_auth = auth;
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500282
283out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 return auth;
285}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400286EXPORT_SYMBOL_GPL(rpcauth_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288void
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400289rpcauth_release(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 if (!atomic_dec_and_test(&auth->au_count))
292 return;
293 auth->au_ops->destroy(auth);
294}
295
296static DEFINE_SPINLOCK(rpc_credcache_lock);
297
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400298static void
299rpcauth_unhash_cred_locked(struct rpc_cred *cred)
300{
301 hlist_del_rcu(&cred->cr_hash);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100302 smp_mb__before_atomic();
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400303 clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
304}
305
Trond Myklebustf0380f32009-12-03 08:10:17 -0500306static int
Trond Myklebust9499b432007-06-24 15:57:57 -0400307rpcauth_unhash_cred(struct rpc_cred *cred)
308{
309 spinlock_t *cache_lock;
Trond Myklebustf0380f32009-12-03 08:10:17 -0500310 int ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400311
312 cache_lock = &cred->cr_auth->au_credcache->lock;
313 spin_lock(cache_lock);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500314 ret = atomic_read(&cred->cr_count) == 0;
315 if (ret)
Trond Myklebust9499b432007-06-24 15:57:57 -0400316 rpcauth_unhash_cred_locked(cred);
317 spin_unlock(cache_lock);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500318 return ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400319}
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321/*
322 * Initialize RPC credential cache
323 */
324int
Trond Myklebustf5c21872007-06-25 17:11:20 -0400325rpcauth_init_credcache(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326{
327 struct rpc_cred_cache *new;
Trond Myklebust988664a2010-07-31 14:29:07 -0400328 unsigned int hashsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Kris Katterjohn8b3a7002006-01-11 15:56:43 -0800330 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 if (!new)
Trond Myklebust241269b2010-07-31 14:29:08 -0400332 goto out_nocache;
333 new->hashbits = auth_hashbits;
Trond Myklebust988664a2010-07-31 14:29:07 -0400334 hashsize = 1U << new->hashbits;
Trond Myklebust241269b2010-07-31 14:29:08 -0400335 new->hashtable = kcalloc(hashsize, sizeof(new->hashtable[0]), GFP_KERNEL);
336 if (!new->hashtable)
337 goto out_nohashtbl;
Trond Myklebust9499b432007-06-24 15:57:57 -0400338 spin_lock_init(&new->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 auth->au_credcache = new;
340 return 0;
Trond Myklebust241269b2010-07-31 14:29:08 -0400341out_nohashtbl:
342 kfree(new);
343out_nocache:
344 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400346EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348/*
Andy Adamson4de6caa2013-08-14 11:59:15 -0400349 * Setup a credential key lifetime timeout notification
350 */
351int
352rpcauth_key_timeout_notify(struct rpc_auth *auth, struct rpc_cred *cred)
353{
354 if (!cred->cr_auth->au_ops->key_timeout)
355 return 0;
356 return cred->cr_auth->au_ops->key_timeout(auth, cred);
357}
358EXPORT_SYMBOL_GPL(rpcauth_key_timeout_notify);
359
360bool
Scott Mayhewce52914e2016-06-07 15:14:48 -0400361rpcauth_cred_key_to_expire(struct rpc_auth *auth, struct rpc_cred *cred)
Andy Adamson4de6caa2013-08-14 11:59:15 -0400362{
Scott Mayhewce52914e2016-06-07 15:14:48 -0400363 if (auth->au_flags & RPCAUTH_AUTH_NO_CRKEY_TIMEOUT)
364 return false;
Andy Adamson4de6caa2013-08-14 11:59:15 -0400365 if (!cred->cr_ops->crkey_to_expire)
366 return false;
367 return cred->cr_ops->crkey_to_expire(cred);
368}
369EXPORT_SYMBOL_GPL(rpcauth_cred_key_to_expire);
370
Jeff Laytona0337d12014-06-21 20:52:16 -0400371char *
372rpcauth_stringify_acceptor(struct rpc_cred *cred)
373{
374 if (!cred->cr_ops->crstringify_acceptor)
375 return NULL;
376 return cred->cr_ops->crstringify_acceptor(cred);
377}
378EXPORT_SYMBOL_GPL(rpcauth_stringify_acceptor);
379
Andy Adamson4de6caa2013-08-14 11:59:15 -0400380/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 * Destroy a list of credentials
382 */
383static inline
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400384void rpcauth_destroy_credlist(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
386 struct rpc_cred *cred;
387
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400388 while (!list_empty(head)) {
389 cred = list_entry(head->next, struct rpc_cred, cr_lru);
390 list_del_init(&cred->cr_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 put_rpccred(cred);
392 }
393}
394
395/*
396 * Clear the RPC credential cache, and delete those credentials
397 * that are not referenced.
398 */
399void
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400400rpcauth_clear_credcache(struct rpc_cred_cache *cache)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400402 LIST_HEAD(free);
403 struct hlist_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 struct rpc_cred *cred;
Trond Myklebust988664a2010-07-31 14:29:07 -0400405 unsigned int hashsize = 1U << cache->hashbits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 int i;
407
408 spin_lock(&rpc_credcache_lock);
Trond Myklebust9499b432007-06-24 15:57:57 -0400409 spin_lock(&cache->lock);
Trond Myklebust988664a2010-07-31 14:29:07 -0400410 for (i = 0; i < hashsize; i++) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400411 head = &cache->hashtable[i];
412 while (!hlist_empty(head)) {
413 cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
414 get_rpccred(cred);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400415 if (!list_empty(&cred->cr_lru)) {
416 list_del(&cred->cr_lru);
417 number_cred_unused--;
418 }
419 list_add_tail(&cred->cr_lru, &free);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400420 rpcauth_unhash_cred_locked(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422 }
Trond Myklebust9499b432007-06-24 15:57:57 -0400423 spin_unlock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 spin_unlock(&rpc_credcache_lock);
425 rpcauth_destroy_credlist(&free);
426}
427
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400428/*
429 * Destroy the RPC credential cache
430 */
431void
432rpcauth_destroy_credcache(struct rpc_auth *auth)
433{
434 struct rpc_cred_cache *cache = auth->au_credcache;
435
436 if (cache) {
437 auth->au_credcache = NULL;
438 rpcauth_clear_credcache(cache);
Trond Myklebust241269b2010-07-31 14:29:08 -0400439 kfree(cache->hashtable);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400440 kfree(cache);
441 }
442}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400443EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400444
Trond Myklebustd2b83142008-04-14 18:13:37 -0400445
446#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448/*
449 * Remove stale credentials. Avoid sleeping inside the loop.
450 */
Dave Chinner70534a72013-08-28 10:18:14 +1000451static long
Trond Myklebustf5c21872007-06-25 17:11:20 -0400452rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
Trond Myklebust9499b432007-06-24 15:57:57 -0400454 spinlock_t *cache_lock;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400455 struct rpc_cred *cred, *next;
Trond Myklebustd2b83142008-04-14 18:13:37 -0400456 unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
Dave Chinner70534a72013-08-28 10:18:14 +1000457 long freed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Trond Myklebusteac0d182008-10-28 15:21:41 -0400459 list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
460
Trond Myklebust20673402010-05-13 12:51:06 -0400461 if (nr_to_scan-- == 0)
462 break;
Trond Myklebust93a05e62010-05-13 12:51:06 -0400463 /*
464 * Enforce a 60 second garbage collection moratorium
465 * Note that the cred_unused list must be time-ordered.
466 */
Trond Myklebust3d7b0892010-04-22 15:35:55 -0400467 if (time_in_range(cred->cr_expire, expired, jiffies) &&
NeilBrown4c3ffd02017-01-06 14:19:58 +1100468 test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
469 freed = SHRINK_STOP;
Dave Chinner70534a72013-08-28 10:18:14 +1000470 break;
NeilBrown4c3ffd02017-01-06 14:19:58 +1100471 }
Trond Myklebusteac0d182008-10-28 15:21:41 -0400472
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400473 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400474 number_cred_unused--;
Dave Chinner70534a72013-08-28 10:18:14 +1000475 freed++;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400476 if (atomic_read(&cred->cr_count) != 0)
477 continue;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400478
Trond Myklebust9499b432007-06-24 15:57:57 -0400479 cache_lock = &cred->cr_auth->au_credcache->lock;
480 spin_lock(cache_lock);
481 if (atomic_read(&cred->cr_count) == 0) {
482 get_rpccred(cred);
483 list_add_tail(&cred->cr_lru, free);
484 rpcauth_unhash_cred_locked(cred);
485 }
486 spin_unlock(cache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 }
Dave Chinner70534a72013-08-28 10:18:14 +1000488 return freed;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400489}
490
Trond Myklebustbae67462014-07-21 13:32:42 -0400491static unsigned long
492rpcauth_cache_do_shrink(int nr_to_scan)
493{
494 LIST_HEAD(free);
495 unsigned long freed;
496
497 spin_lock(&rpc_credcache_lock);
498 freed = rpcauth_prune_expired(&free, nr_to_scan);
499 spin_unlock(&rpc_credcache_lock);
500 rpcauth_destroy_credlist(&free);
501
502 return freed;
503}
504
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400505/*
Trond Myklebustf5c21872007-06-25 17:11:20 -0400506 * Run memory cache shrinker.
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400507 */
Dave Chinner70534a72013-08-28 10:18:14 +1000508static unsigned long
509rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
510
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400511{
Dave Chinner70534a72013-08-28 10:18:14 +1000512 if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
513 return SHRINK_STOP;
514
515 /* nothing left, don't come back */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400516 if (list_empty(&cred_unused))
Dave Chinner70534a72013-08-28 10:18:14 +1000517 return SHRINK_STOP;
518
Trond Myklebustbae67462014-07-21 13:32:42 -0400519 return rpcauth_cache_do_shrink(sc->nr_to_scan);
Dave Chinner70534a72013-08-28 10:18:14 +1000520}
521
522static unsigned long
523rpcauth_cache_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
524
525{
NeilBrown4c3ffd02017-01-06 14:19:58 +1100526 return number_cred_unused * sysctl_vfs_cache_pressure / 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527}
528
Trond Myklebustbae67462014-07-21 13:32:42 -0400529static void
530rpcauth_cache_enforce_limit(void)
531{
532 unsigned long diff;
533 unsigned int nr_to_scan;
534
535 if (number_cred_unused <= auth_max_cred_cachesize)
536 return;
537 diff = number_cred_unused - auth_max_cred_cachesize;
538 nr_to_scan = 100;
539 if (diff < nr_to_scan)
540 nr_to_scan = diff;
541 rpcauth_cache_do_shrink(nr_to_scan);
542}
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544/*
545 * Look up a process' credentials in the authentication cache
546 */
547struct rpc_cred *
548rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
Jeff Layton3c6e0bc2016-04-21 20:51:54 -0400549 int flags, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400551 LIST_HEAD(free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 struct rpc_cred_cache *cache = auth->au_credcache;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400553 struct rpc_cred *cred = NULL,
554 *entry, *new;
Trond Myklebust25337fd2008-03-12 14:40:14 -0400555 unsigned int nr;
556
Frank Sorenson66cbd4b2016-09-29 10:44:41 -0500557 nr = auth->au_ops->hash_cred(acred, cache->hashbits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400559 rcu_read_lock();
Sasha Levinb67bfe02013-02-27 17:06:00 -0800560 hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400561 if (!entry->cr_ops->crmatch(acred, entry, flags))
562 continue;
NeilBrownbd956082014-07-14 11:28:20 +1000563 if (flags & RPCAUTH_LOOKUP_RCU) {
564 if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) &&
565 !test_bit(RPCAUTH_CRED_NEW, &entry->cr_flags))
566 cred = entry;
567 break;
568 }
Trond Myklebust9499b432007-06-24 15:57:57 -0400569 spin_lock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400570 if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
Trond Myklebust9499b432007-06-24 15:57:57 -0400571 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400572 continue;
573 }
574 cred = get_rpccred(entry);
Trond Myklebust9499b432007-06-24 15:57:57 -0400575 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400576 break;
577 }
578 rcu_read_unlock();
579
Trond Myklebust9499b432007-06-24 15:57:57 -0400580 if (cred != NULL)
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400581 goto found;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400582
NeilBrownbd956082014-07-14 11:28:20 +1000583 if (flags & RPCAUTH_LOOKUP_RCU)
584 return ERR_PTR(-ECHILD);
585
Jeff Layton3c6e0bc2016-04-21 20:51:54 -0400586 new = auth->au_ops->crcreate(auth, acred, flags, gfp);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400587 if (IS_ERR(new)) {
588 cred = new;
589 goto out;
590 }
591
Trond Myklebust9499b432007-06-24 15:57:57 -0400592 spin_lock(&cache->lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800593 hlist_for_each_entry(entry, &cache->hashtable[nr], cr_hash) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400594 if (!entry->cr_ops->crmatch(acred, entry, flags))
595 continue;
596 cred = get_rpccred(entry);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400597 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400599 if (cred == NULL) {
Trond Myklebust5fe47552007-06-23 19:55:31 -0400600 cred = new;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400601 set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
602 hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
603 } else
604 list_add_tail(&new->cr_lru, &free);
Trond Myklebust9499b432007-06-24 15:57:57 -0400605 spin_unlock(&cache->lock);
Trond Myklebustbae67462014-07-21 13:32:42 -0400606 rpcauth_cache_enforce_limit();
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400607found:
Joe Perchesf64f9e72009-11-29 16:55:45 -0800608 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
609 cred->cr_ops->cr_init != NULL &&
610 !(flags & RPCAUTH_LOOKUP_NEW)) {
Trond Myklebustfba3bad2006-02-01 12:19:27 -0500611 int res = cred->cr_ops->cr_init(auth, cred);
612 if (res < 0) {
613 put_rpccred(cred);
614 cred = ERR_PTR(res);
615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400617 rpcauth_destroy_credlist(&free);
618out:
619 return cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400621EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623struct rpc_cred *
Trond Myklebust8a317762006-02-01 12:18:36 -0500624rpcauth_lookupcred(struct rpc_auth *auth, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{
David Howells86a264a2008-11-14 10:39:18 +1100626 struct auth_cred acred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 struct rpc_cred *ret;
David Howells86a264a2008-11-14 10:39:18 +1100628 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Chuck Lever46121cf2007-01-31 12:14:08 -0500630 dprintk("RPC: looking up %s cred\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 auth->au_ops->au_name);
David Howells86a264a2008-11-14 10:39:18 +1100632
633 memset(&acred, 0, sizeof(acred));
634 acred.uid = cred->fsuid;
635 acred.gid = cred->fsgid;
NeilBrown122a8cd2014-08-04 16:24:00 +1000636 acred.group_info = cred->group_info;
Trond Myklebust8a317762006-02-01 12:18:36 -0500637 ret = auth->au_ops->lookup_cred(auth, &acred, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return ret;
639}
Andy Adamson66b06862014-06-12 15:02:32 -0400640EXPORT_SYMBOL_GPL(rpcauth_lookupcred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Trond Myklebust5fe47552007-06-23 19:55:31 -0400642void
643rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
644 struct rpc_auth *auth, const struct rpc_credops *ops)
645{
646 INIT_HLIST_NODE(&cred->cr_hash);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400647 INIT_LIST_HEAD(&cred->cr_lru);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400648 atomic_set(&cred->cr_count, 1);
649 cred->cr_auth = auth;
650 cred->cr_ops = ops;
651 cred->cr_expire = jiffies;
Trond Myklebust5fe47552007-06-23 19:55:31 -0400652 cred->cr_uid = acred->uid;
653}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400654EXPORT_SYMBOL_GPL(rpcauth_init_cred);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400655
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400656struct rpc_cred *
Trond Myklebust5d351752009-09-15 13:32:13 -0400657rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred, int lookupflags)
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400658{
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400659 dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
660 cred->cr_auth->au_ops->au_name, cred);
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400661 return get_rpccred(cred);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400662}
Trond Myklebust5c691042008-03-12 16:21:07 -0400663EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400664
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400665static struct rpc_cred *
Trond Myklebust5d351752009-09-15 13:32:13 -0400666rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400668 struct rpc_auth *auth = task->tk_client->cl_auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 struct auth_cred acred = {
Eric W. Biedermanbf37f792013-02-01 15:55:38 -0800670 .uid = GLOBAL_ROOT_UID,
671 .gid = GLOBAL_ROOT_GID,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Chuck Lever46121cf2007-01-31 12:14:08 -0500674 dprintk("RPC: %5u looking up %s cred\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400675 task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400676 return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
Trond Myklebustaf093832008-03-12 12:12:16 -0400677}
678
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400679static struct rpc_cred *
Trond Myklebust5d351752009-09-15 13:32:13 -0400680rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
Trond Myklebustaf093832008-03-12 12:12:16 -0400681{
682 struct rpc_auth *auth = task->tk_client->cl_auth;
Trond Myklebustaf093832008-03-12 12:12:16 -0400683
684 dprintk("RPC: %5u looking up %s cred\n",
685 task->tk_pid, auth->au_ops->au_name);
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400686 return rpcauth_lookupcred(auth, lookupflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687}
688
Trond Myklebusta17c2152010-07-31 14:29:08 -0400689static int
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400690rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400692 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400693 struct rpc_cred *new;
Trond Myklebust5d351752009-09-15 13:32:13 -0400694 int lookupflags = 0;
695
696 if (flags & RPC_TASK_ASYNC)
697 lookupflags |= RPCAUTH_LOOKUP_NEW;
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400698 if (cred != NULL)
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400699 new = cred->cr_ops->crbind(task, cred, lookupflags);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400700 else if (flags & RPC_TASK_ROOTCREDS)
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400701 new = rpcauth_bind_root_cred(task, lookupflags);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400702 else
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400703 new = rpcauth_bind_new_cred(task, lookupflags);
704 if (IS_ERR(new))
705 return PTR_ERR(new);
Trond Myklebust9a8f6b52016-05-16 17:42:42 -0400706 put_rpccred(req->rq_cred);
Trond Myklebusta17c2152010-07-31 14:29:08 -0400707 req->rq_cred = new;
Trond Myklebust8572b8e2010-07-31 14:29:08 -0400708 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709}
710
711void
712put_rpccred(struct rpc_cred *cred)
713{
Trond Myklebust9a8f6b52016-05-16 17:42:42 -0400714 if (cred == NULL)
715 return;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400716 /* Fast path for unhashed credentials */
Trond Myklebustf0380f32009-12-03 08:10:17 -0500717 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) == 0) {
718 if (atomic_dec_and_test(&cred->cr_count))
719 cred->cr_ops->crdestroy(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 return;
Trond Myklebustf0380f32009-12-03 08:10:17 -0500721 }
722
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400723 if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
724 return;
Trond Myklebustf5c21872007-06-25 17:11:20 -0400725 if (!list_empty(&cred->cr_lru)) {
726 number_cred_unused--;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400727 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400728 }
Trond Myklebust5f707eb2008-10-28 15:21:42 -0400729 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
Trond Myklebustf0380f32009-12-03 08:10:17 -0500730 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
731 cred->cr_expire = jiffies;
732 list_add_tail(&cred->cr_lru, &cred_unused);
733 number_cred_unused++;
734 goto out_nodestroy;
735 }
736 if (!rpcauth_unhash_cred(cred)) {
737 /* We were hashed and someone looked us up... */
738 goto out_nodestroy;
739 }
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400740 }
741 spin_unlock(&rpc_credcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 cred->cr_ops->crdestroy(cred);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500743 return;
744out_nodestroy:
745 spin_unlock(&rpc_credcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400747EXPORT_SYMBOL_GPL(put_rpccred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700749__be32 *
750rpcauth_marshcred(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400752 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Chuck Lever46121cf2007-01-31 12:14:08 -0500754 dprintk("RPC: %5u marshaling %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400755 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 return cred->cr_ops->crmarshal(task, p);
758}
759
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700760__be32 *
761rpcauth_checkverf(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400763 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Chuck Lever46121cf2007-01-31 12:14:08 -0500765 dprintk("RPC: %5u validating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400766 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return cred->cr_ops->crvalidate(task, p);
769}
770
Chuck Lever9f06c712010-12-14 14:59:18 +0000771static void rpcauth_wrap_req_encode(kxdreproc_t encode, struct rpc_rqst *rqstp,
772 __be32 *data, void *obj)
773{
774 struct xdr_stream xdr;
775
776 xdr_init_encode(&xdr, &rqstp->rq_snd_buf, data);
777 encode(rqstp, &xdr, obj);
778}
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780int
Chuck Lever9f06c712010-12-14 14:59:18 +0000781rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700782 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400784 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
Chuck Lever46121cf2007-01-31 12:14:08 -0500786 dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 task->tk_pid, cred->cr_ops->cr_name, cred);
788 if (cred->cr_ops->crwrap_req)
789 return cred->cr_ops->crwrap_req(task, encode, rqstp, data, obj);
790 /* By default, we encode the arguments normally. */
Chuck Lever9f06c712010-12-14 14:59:18 +0000791 rpcauth_wrap_req_encode(encode, rqstp, data, obj);
792 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793}
794
Chuck Leverbf269552010-12-14 14:59:29 +0000795static int
796rpcauth_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
797 __be32 *data, void *obj)
798{
799 struct xdr_stream xdr;
800
801 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, data);
802 return decode(rqstp, &xdr, obj);
803}
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805int
Chuck Leverbf269552010-12-14 14:59:29 +0000806rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700807 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400809 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Chuck Lever46121cf2007-01-31 12:14:08 -0500811 dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 task->tk_pid, cred->cr_ops->cr_name, cred);
813 if (cred->cr_ops->crunwrap_resp)
814 return cred->cr_ops->crunwrap_resp(task, decode, rqstp,
815 data, obj);
816 /* By default, we decode the arguments normally. */
Chuck Leverbf269552010-12-14 14:59:29 +0000817 return rpcauth_unwrap_req_decode(decode, rqstp, data, obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818}
819
820int
821rpcauth_refreshcred(struct rpc_task *task)
822{
Trond Myklebust9a84d382010-10-24 18:00:46 -0400823 struct rpc_cred *cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 int err;
825
Trond Myklebusta17c2152010-07-31 14:29:08 -0400826 cred = task->tk_rqstp->rq_cred;
827 if (cred == NULL) {
828 err = rpcauth_bindcred(task, task->tk_msg.rpc_cred, task->tk_flags);
829 if (err < 0)
830 goto out;
831 cred = task->tk_rqstp->rq_cred;
Joe Perchesf81c6222011-06-03 11:51:19 +0000832 }
Chuck Lever46121cf2007-01-31 12:14:08 -0500833 dprintk("RPC: %5u refreshing %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400834 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500835
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 err = cred->cr_ops->crrefresh(task);
Trond Myklebusta17c2152010-07-31 14:29:08 -0400837out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 if (err < 0)
839 task->tk_status = err;
840 return err;
841}
842
843void
844rpcauth_invalcred(struct rpc_task *task)
845{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400846 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400847
Chuck Lever46121cf2007-01-31 12:14:08 -0500848 dprintk("RPC: %5u invalidating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400849 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400850 if (cred)
851 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
854int
855rpcauth_uptodatecred(struct rpc_task *task)
856{
Trond Myklebusta17c2152010-07-31 14:29:08 -0400857 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400858
859 return cred == NULL ||
860 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
Trond Myklebustf5c21872007-06-25 17:11:20 -0400862
Rusty Russell8e1f9362007-07-17 04:03:17 -0700863static struct shrinker rpc_cred_shrinker = {
Dave Chinner70534a72013-08-28 10:18:14 +1000864 .count_objects = rpcauth_cache_shrink_count,
865 .scan_objects = rpcauth_cache_shrink_scan,
Rusty Russell8e1f9362007-07-17 04:03:17 -0700866 .seeks = DEFAULT_SEEKS,
867};
Trond Myklebustf5c21872007-06-25 17:11:20 -0400868
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400869int __init rpcauth_init_module(void)
Trond Myklebustf5c21872007-06-25 17:11:20 -0400870{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400871 int err;
872
873 err = rpc_init_authunix();
874 if (err < 0)
875 goto out1;
876 err = rpc_init_generic_auth();
877 if (err < 0)
878 goto out2;
Kinglong Mee28644862017-02-07 21:46:39 +0800879 err = register_shrinker(&rpc_cred_shrinker);
880 if (err < 0)
881 goto out3;
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400882 return 0;
Kinglong Mee28644862017-02-07 21:46:39 +0800883out3:
884 rpc_destroy_generic_auth();
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400885out2:
886 rpc_destroy_authunix();
887out1:
888 return err;
Trond Myklebustf5c21872007-06-25 17:11:20 -0400889}
890
Stephen Rothwellc135e842010-09-29 14:16:57 +1000891void rpcauth_remove_module(void)
Trond Myklebustf5c21872007-06-25 17:11:20 -0400892{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400893 rpc_destroy_authunix();
894 rpc_destroy_generic_auth();
Rusty Russell8e1f9362007-07-17 04:03:17 -0700895 unregister_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400896}