blob: 0c431c277af5be352e3c65b9fa4de99e25086e9b [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>
11#include <linux/module.h>
12#include <linux/slab.h>
13#include <linux/errno.h>
Trond Myklebust25337fd2008-03-12 14:40:14 -040014#include <linux/hash.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/sunrpc/clnt.h>
16#include <linux/spinlock.h>
17
18#ifdef RPC_DEBUG
19# define RPCDBG_FACILITY RPCDBG_AUTH
20#endif
21
Trond Myklebustfc1b3562007-06-09 16:15:46 -040022static DEFINE_SPINLOCK(rpc_authflavor_lock);
Trond Myklebustf1c0a862007-06-23 20:17:58 -040023static const struct rpc_authops *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 &authnull_ops, /* AUTH_NULL */
25 &authunix_ops, /* AUTH_UNIX */
26 NULL, /* others can be loadable modules */
27};
28
Trond Myklebuste092bdc2007-06-23 19:45:36 -040029static LIST_HEAD(cred_unused);
Trond Myklebustf5c21872007-06-25 17:11:20 -040030static unsigned long number_cred_unused;
Trond Myklebuste092bdc2007-06-23 19:45:36 -040031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032static u32
33pseudoflavor_to_flavor(u32 flavor) {
34 if (flavor >= RPC_AUTH_MAXFLAVOR)
35 return RPC_AUTH_GSS;
36 return flavor;
37}
38
39int
Trond Myklebustf1c0a862007-06-23 20:17:58 -040040rpcauth_register(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070041{
42 rpc_authflavor_t flavor;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040043 int ret = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
46 return -EINVAL;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040047 spin_lock(&rpc_authflavor_lock);
48 if (auth_flavors[flavor] == NULL) {
49 auth_flavors[flavor] = ops;
50 ret = 0;
51 }
52 spin_unlock(&rpc_authflavor_lock);
53 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054}
Trond Myklebuste8914c62007-07-14 15:39:59 -040055EXPORT_SYMBOL_GPL(rpcauth_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57int
Trond Myklebustf1c0a862007-06-23 20:17:58 -040058rpcauth_unregister(const struct rpc_authops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059{
60 rpc_authflavor_t flavor;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040061 int ret = -EPERM;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63 if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
64 return -EINVAL;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040065 spin_lock(&rpc_authflavor_lock);
66 if (auth_flavors[flavor] == ops) {
67 auth_flavors[flavor] = NULL;
68 ret = 0;
69 }
70 spin_unlock(&rpc_authflavor_lock);
71 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072}
Trond Myklebuste8914c62007-07-14 15:39:59 -040073EXPORT_SYMBOL_GPL(rpcauth_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75struct rpc_auth *
76rpcauth_create(rpc_authflavor_t pseudoflavor, struct rpc_clnt *clnt)
77{
78 struct rpc_auth *auth;
Trond Myklebustf1c0a862007-06-23 20:17:58 -040079 const struct rpc_authops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 u32 flavor = pseudoflavor_to_flavor(pseudoflavor);
81
Olaf Kirchf344f6d2006-03-20 13:44:08 -050082 auth = ERR_PTR(-EINVAL);
83 if (flavor >= RPC_AUTH_MAXFLAVOR)
84 goto out;
85
Olaf Kirchf344f6d2006-03-20 13:44:08 -050086 if ((ops = auth_flavors[flavor]) == NULL)
87 request_module("rpc-auth-%u", flavor);
Trond Myklebustfc1b3562007-06-09 16:15:46 -040088 spin_lock(&rpc_authflavor_lock);
89 ops = auth_flavors[flavor];
90 if (ops == NULL || !try_module_get(ops->owner)) {
91 spin_unlock(&rpc_authflavor_lock);
Olaf Kirchf344f6d2006-03-20 13:44:08 -050092 goto out;
Trond Myklebustfc1b3562007-06-09 16:15:46 -040093 }
94 spin_unlock(&rpc_authflavor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 auth = ops->create(clnt, pseudoflavor);
Trond Myklebustfc1b3562007-06-09 16:15:46 -040096 module_put(ops->owner);
J. Bruce Fields6a192752005-06-22 17:16:23 +000097 if (IS_ERR(auth))
98 return auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 if (clnt->cl_auth)
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400100 rpcauth_release(clnt->cl_auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 clnt->cl_auth = auth;
Olaf Kirchf344f6d2006-03-20 13:44:08 -0500102
103out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 return auth;
105}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400106EXPORT_SYMBOL_GPL(rpcauth_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108void
Trond Myklebustde7a8ce2007-06-23 10:46:47 -0400109rpcauth_release(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
111 if (!atomic_dec_and_test(&auth->au_count))
112 return;
113 auth->au_ops->destroy(auth);
114}
115
116static DEFINE_SPINLOCK(rpc_credcache_lock);
117
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400118static void
119rpcauth_unhash_cred_locked(struct rpc_cred *cred)
120{
121 hlist_del_rcu(&cred->cr_hash);
122 smp_mb__before_clear_bit();
123 clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
124}
125
Trond Myklebust9499b432007-06-24 15:57:57 -0400126static void
127rpcauth_unhash_cred(struct rpc_cred *cred)
128{
129 spinlock_t *cache_lock;
130
131 cache_lock = &cred->cr_auth->au_credcache->lock;
132 spin_lock(cache_lock);
133 if (atomic_read(&cred->cr_count) == 0)
134 rpcauth_unhash_cred_locked(cred);
135 spin_unlock(cache_lock);
136}
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138/*
139 * Initialize RPC credential cache
140 */
141int
Trond Myklebustf5c21872007-06-25 17:11:20 -0400142rpcauth_init_credcache(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 struct rpc_cred_cache *new;
145 int i;
146
Kris Katterjohn8b3a7002006-01-11 15:56:43 -0800147 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 if (!new)
149 return -ENOMEM;
150 for (i = 0; i < RPC_CREDCACHE_NR; i++)
151 INIT_HLIST_HEAD(&new->hashtable[i]);
Trond Myklebust9499b432007-06-24 15:57:57 -0400152 spin_lock_init(&new->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 auth->au_credcache = new;
154 return 0;
155}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400156EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158/*
159 * Destroy a list of credentials
160 */
161static inline
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400162void rpcauth_destroy_credlist(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
164 struct rpc_cred *cred;
165
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400166 while (!list_empty(head)) {
167 cred = list_entry(head->next, struct rpc_cred, cr_lru);
168 list_del_init(&cred->cr_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 put_rpccred(cred);
170 }
171}
172
173/*
174 * Clear the RPC credential cache, and delete those credentials
175 * that are not referenced.
176 */
177void
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400178rpcauth_clear_credcache(struct rpc_cred_cache *cache)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400180 LIST_HEAD(free);
181 struct hlist_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 struct rpc_cred *cred;
183 int i;
184
185 spin_lock(&rpc_credcache_lock);
Trond Myklebust9499b432007-06-24 15:57:57 -0400186 spin_lock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 for (i = 0; i < RPC_CREDCACHE_NR; i++) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400188 head = &cache->hashtable[i];
189 while (!hlist_empty(head)) {
190 cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
191 get_rpccred(cred);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400192 if (!list_empty(&cred->cr_lru)) {
193 list_del(&cred->cr_lru);
194 number_cred_unused--;
195 }
196 list_add_tail(&cred->cr_lru, &free);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400197 rpcauth_unhash_cred_locked(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 }
199 }
Trond Myklebust9499b432007-06-24 15:57:57 -0400200 spin_unlock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 spin_unlock(&rpc_credcache_lock);
202 rpcauth_destroy_credlist(&free);
203}
204
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400205/*
206 * Destroy the RPC credential cache
207 */
208void
209rpcauth_destroy_credcache(struct rpc_auth *auth)
210{
211 struct rpc_cred_cache *cache = auth->au_credcache;
212
213 if (cache) {
214 auth->au_credcache = NULL;
215 rpcauth_clear_credcache(cache);
216 kfree(cache);
217 }
218}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400219EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400220
Trond Myklebustd2b83142008-04-14 18:13:37 -0400221
222#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224/*
225 * Remove stale credentials. Avoid sleeping inside the loop.
226 */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400227static int
228rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229{
Trond Myklebust9499b432007-06-24 15:57:57 -0400230 spinlock_t *cache_lock;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400231 struct rpc_cred *cred, *next;
Trond Myklebustd2b83142008-04-14 18:13:37 -0400232 unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Trond Myklebusteac0d182008-10-28 15:21:41 -0400234 list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
235
236 /* Enforce a 60 second garbage collection moratorium */
Peter Staubach64672d52008-12-23 15:21:56 -0500237 if (time_in_range_open(cred->cr_expire, expired, jiffies) &&
Trond Myklebusteac0d182008-10-28 15:21:41 -0400238 test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0)
239 continue;
240
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400241 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400242 number_cred_unused--;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400243 if (atomic_read(&cred->cr_count) != 0)
244 continue;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400245
Trond Myklebust9499b432007-06-24 15:57:57 -0400246 cache_lock = &cred->cr_auth->au_credcache->lock;
247 spin_lock(cache_lock);
248 if (atomic_read(&cred->cr_count) == 0) {
249 get_rpccred(cred);
250 list_add_tail(&cred->cr_lru, free);
251 rpcauth_unhash_cred_locked(cred);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400252 nr_to_scan--;
Trond Myklebust9499b432007-06-24 15:57:57 -0400253 }
254 spin_unlock(cache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400255 if (nr_to_scan == 0)
256 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 }
Trond Myklebustf5c21872007-06-25 17:11:20 -0400258 return nr_to_scan;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400259}
260
261/*
Trond Myklebustf5c21872007-06-25 17:11:20 -0400262 * Run memory cache shrinker.
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400263 */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400264static int
265rpcauth_cache_shrinker(int nr_to_scan, gfp_t gfp_mask)
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400266{
Trond Myklebustf5c21872007-06-25 17:11:20 -0400267 LIST_HEAD(free);
268 int res;
269
270 if (list_empty(&cred_unused))
271 return 0;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400272 spin_lock(&rpc_credcache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400273 nr_to_scan = rpcauth_prune_expired(&free, nr_to_scan);
274 res = (number_cred_unused / 100) * sysctl_vfs_cache_pressure;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400275 spin_unlock(&rpc_credcache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400276 rpcauth_destroy_credlist(&free);
277 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
280/*
281 * Look up a process' credentials in the authentication cache
282 */
283struct rpc_cred *
284rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
Trond Myklebust8a317762006-02-01 12:18:36 -0500285 int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400287 LIST_HEAD(free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct rpc_cred_cache *cache = auth->au_credcache;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400289 struct hlist_node *pos;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400290 struct rpc_cred *cred = NULL,
291 *entry, *new;
Trond Myklebust25337fd2008-03-12 14:40:14 -0400292 unsigned int nr;
293
294 nr = hash_long(acred->uid, RPC_CREDCACHE_HASHBITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400296 rcu_read_lock();
297 hlist_for_each_entry_rcu(entry, pos, &cache->hashtable[nr], cr_hash) {
298 if (!entry->cr_ops->crmatch(acred, entry, flags))
299 continue;
Trond Myklebust9499b432007-06-24 15:57:57 -0400300 spin_lock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400301 if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
Trond Myklebust9499b432007-06-24 15:57:57 -0400302 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400303 continue;
304 }
305 cred = get_rpccred(entry);
Trond Myklebust9499b432007-06-24 15:57:57 -0400306 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400307 break;
308 }
309 rcu_read_unlock();
310
Trond Myklebust9499b432007-06-24 15:57:57 -0400311 if (cred != NULL)
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400312 goto found;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400313
314 new = auth->au_ops->crcreate(auth, acred, flags);
315 if (IS_ERR(new)) {
316 cred = new;
317 goto out;
318 }
319
Trond Myklebust9499b432007-06-24 15:57:57 -0400320 spin_lock(&cache->lock);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400321 hlist_for_each_entry(entry, pos, &cache->hashtable[nr], cr_hash) {
322 if (!entry->cr_ops->crmatch(acred, entry, flags))
323 continue;
324 cred = get_rpccred(entry);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400325 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400327 if (cred == NULL) {
Trond Myklebust5fe47552007-06-23 19:55:31 -0400328 cred = new;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400329 set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
330 hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
331 } else
332 list_add_tail(&new->cr_lru, &free);
Trond Myklebust9499b432007-06-24 15:57:57 -0400333 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400334found:
335 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags)
Trond Myklebustfba3bad2006-02-01 12:19:27 -0500336 && cred->cr_ops->cr_init != NULL
337 && !(flags & RPCAUTH_LOOKUP_NEW)) {
338 int res = cred->cr_ops->cr_init(auth, cred);
339 if (res < 0) {
340 put_rpccred(cred);
341 cred = ERR_PTR(res);
342 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400344 rpcauth_destroy_credlist(&free);
345out:
346 return cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400348EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350struct rpc_cred *
Trond Myklebust8a317762006-02-01 12:18:36 -0500351rpcauth_lookupcred(struct rpc_auth *auth, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
David Howells86a264a2008-11-14 10:39:18 +1100353 struct auth_cred acred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 struct rpc_cred *ret;
David Howells86a264a2008-11-14 10:39:18 +1100355 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Chuck Lever46121cf2007-01-31 12:14:08 -0500357 dprintk("RPC: looking up %s cred\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 auth->au_ops->au_name);
David Howells86a264a2008-11-14 10:39:18 +1100359
360 memset(&acred, 0, sizeof(acred));
361 acred.uid = cred->fsuid;
362 acred.gid = cred->fsgid;
363 acred.group_info = get_group_info(((struct cred *)cred)->group_info);
364
Trond Myklebust8a317762006-02-01 12:18:36 -0500365 ret = auth->au_ops->lookup_cred(auth, &acred, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 put_group_info(acred.group_info);
367 return ret;
368}
369
Trond Myklebust5fe47552007-06-23 19:55:31 -0400370void
371rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
372 struct rpc_auth *auth, const struct rpc_credops *ops)
373{
374 INIT_HLIST_NODE(&cred->cr_hash);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400375 INIT_LIST_HEAD(&cred->cr_lru);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400376 atomic_set(&cred->cr_count, 1);
377 cred->cr_auth = auth;
378 cred->cr_ops = ops;
379 cred->cr_expire = jiffies;
380#ifdef RPC_DEBUG
381 cred->cr_magic = RPCAUTH_CRED_MAGIC;
382#endif
383 cred->cr_uid = acred->uid;
384}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400385EXPORT_SYMBOL_GPL(rpcauth_init_cred);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400386
Trond Myklebust5c691042008-03-12 16:21:07 -0400387void
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400388rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred)
389{
390 task->tk_msg.rpc_cred = get_rpccred(cred);
391 dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
392 cred->cr_auth->au_ops->au_name, cred);
393}
Trond Myklebust5c691042008-03-12 16:21:07 -0400394EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400395
396static void
Trond Myklebustaf093832008-03-12 12:12:16 -0400397rpcauth_bind_root_cred(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400399 struct rpc_auth *auth = task->tk_client->cl_auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 struct auth_cred acred = {
Trond Myklebustaf093832008-03-12 12:12:16 -0400401 .uid = 0,
402 .gid = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 };
404 struct rpc_cred *ret;
405
Chuck Lever46121cf2007-01-31 12:14:08 -0500406 dprintk("RPC: %5u looking up %s cred\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400407 task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
Trond Myklebustaf093832008-03-12 12:12:16 -0400408 ret = auth->au_ops->lookup_cred(auth, &acred, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 if (!IS_ERR(ret))
410 task->tk_msg.rpc_cred = ret;
411 else
412 task->tk_status = PTR_ERR(ret);
Trond Myklebustaf093832008-03-12 12:12:16 -0400413}
414
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400415static void
416rpcauth_bind_new_cred(struct rpc_task *task)
Trond Myklebustaf093832008-03-12 12:12:16 -0400417{
418 struct rpc_auth *auth = task->tk_client->cl_auth;
419 struct rpc_cred *ret;
420
421 dprintk("RPC: %5u looking up %s cred\n",
422 task->tk_pid, auth->au_ops->au_name);
423 ret = rpcauth_lookupcred(auth, 0);
424 if (!IS_ERR(ret))
425 task->tk_msg.rpc_cred = ret;
426 else
427 task->tk_status = PTR_ERR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428}
429
430void
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400431rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400433 if (cred != NULL)
Trond Myklebust5c691042008-03-12 16:21:07 -0400434 cred->cr_ops->crbind(task, cred);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400435 else if (flags & RPC_TASK_ROOTCREDS)
436 rpcauth_bind_root_cred(task);
437 else
438 rpcauth_bind_new_cred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439}
440
441void
442put_rpccred(struct rpc_cred *cred)
443{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400444 /* Fast path for unhashed credentials */
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400445 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0)
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400446 goto need_lock;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 if (!atomic_dec_and_test(&cred->cr_count))
449 return;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400450 goto out_destroy;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400451need_lock:
452 if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
453 return;
Trond Myklebustf5c21872007-06-25 17:11:20 -0400454 if (!list_empty(&cred->cr_lru)) {
455 number_cred_unused--;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400456 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400457 }
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400458 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
Trond Myklebust9499b432007-06-24 15:57:57 -0400459 rpcauth_unhash_cred(cred);
Trond Myklebust5f707eb2008-10-28 15:21:42 -0400460 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400461 cred->cr_expire = jiffies;
462 list_add_tail(&cred->cr_lru, &cred_unused);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400463 number_cred_unused++;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400464 spin_unlock(&rpc_credcache_lock);
465 return;
466 }
467 spin_unlock(&rpc_credcache_lock);
468out_destroy:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 cred->cr_ops->crdestroy(cred);
470}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400471EXPORT_SYMBOL_GPL(put_rpccred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473void
474rpcauth_unbindcred(struct rpc_task *task)
475{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 struct rpc_cred *cred = task->tk_msg.rpc_cred;
477
Chuck Lever46121cf2007-01-31 12:14:08 -0500478 dprintk("RPC: %5u releasing %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400479 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481 put_rpccred(cred);
482 task->tk_msg.rpc_cred = NULL;
483}
484
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700485__be32 *
486rpcauth_marshcred(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 struct rpc_cred *cred = task->tk_msg.rpc_cred;
489
Chuck Lever46121cf2007-01-31 12:14:08 -0500490 dprintk("RPC: %5u marshaling %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400491 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 return cred->cr_ops->crmarshal(task, p);
494}
495
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700496__be32 *
497rpcauth_checkverf(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 struct rpc_cred *cred = task->tk_msg.rpc_cred;
500
Chuck Lever46121cf2007-01-31 12:14:08 -0500501 dprintk("RPC: %5u validating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400502 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 return cred->cr_ops->crvalidate(task, p);
505}
506
507int
508rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700509 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
511 struct rpc_cred *cred = task->tk_msg.rpc_cred;
512
Chuck Lever46121cf2007-01-31 12:14:08 -0500513 dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 task->tk_pid, cred->cr_ops->cr_name, cred);
515 if (cred->cr_ops->crwrap_req)
516 return cred->cr_ops->crwrap_req(task, encode, rqstp, data, obj);
517 /* By default, we encode the arguments normally. */
Trond Myklebust88a9fe82008-12-23 15:21:31 -0500518 return encode(rqstp, data, obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
520
521int
522rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700523 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524{
525 struct rpc_cred *cred = task->tk_msg.rpc_cred;
526
Chuck Lever46121cf2007-01-31 12:14:08 -0500527 dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 task->tk_pid, cred->cr_ops->cr_name, cred);
529 if (cred->cr_ops->crunwrap_resp)
530 return cred->cr_ops->crunwrap_resp(task, decode, rqstp,
531 data, obj);
532 /* By default, we decode the arguments normally. */
Trond Myklebust88a9fe82008-12-23 15:21:31 -0500533 return decode(rqstp, data, obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
536int
537rpcauth_refreshcred(struct rpc_task *task)
538{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 struct rpc_cred *cred = task->tk_msg.rpc_cred;
540 int err;
541
Chuck Lever46121cf2007-01-31 12:14:08 -0500542 dprintk("RPC: %5u refreshing %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400543 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 err = cred->cr_ops->crrefresh(task);
546 if (err < 0)
547 task->tk_status = err;
548 return err;
549}
550
551void
552rpcauth_invalcred(struct rpc_task *task)
553{
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400554 struct rpc_cred *cred = task->tk_msg.rpc_cred;
555
Chuck Lever46121cf2007-01-31 12:14:08 -0500556 dprintk("RPC: %5u invalidating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400557 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400558 if (cred)
559 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560}
561
562int
563rpcauth_uptodatecred(struct rpc_task *task)
564{
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400565 struct rpc_cred *cred = task->tk_msg.rpc_cred;
566
567 return cred == NULL ||
568 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
Trond Myklebustf5c21872007-06-25 17:11:20 -0400570
Rusty Russell8e1f9362007-07-17 04:03:17 -0700571static struct shrinker rpc_cred_shrinker = {
572 .shrink = rpcauth_cache_shrinker,
573 .seeks = DEFAULT_SEEKS,
574};
Trond Myklebustf5c21872007-06-25 17:11:20 -0400575
576void __init rpcauth_init_module(void)
577{
578 rpc_init_authunix();
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400579 rpc_init_generic_auth();
Rusty Russell8e1f9362007-07-17 04:03:17 -0700580 register_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400581}
582
583void __exit rpcauth_remove_module(void)
584{
Rusty Russell8e1f9362007-07-17 04:03:17 -0700585 unregister_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400586}