blob: 95afe79dd9d74ea14568f63a73a082ac31f9b887 [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 Myklebustf0380f32009-12-03 08:10:17 -0500126static int
Trond Myklebust9499b432007-06-24 15:57:57 -0400127rpcauth_unhash_cred(struct rpc_cred *cred)
128{
129 spinlock_t *cache_lock;
Trond Myklebustf0380f32009-12-03 08:10:17 -0500130 int ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400131
132 cache_lock = &cred->cr_auth->au_credcache->lock;
133 spin_lock(cache_lock);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500134 ret = atomic_read(&cred->cr_count) == 0;
135 if (ret)
Trond Myklebust9499b432007-06-24 15:57:57 -0400136 rpcauth_unhash_cred_locked(cred);
137 spin_unlock(cache_lock);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500138 return ret;
Trond Myklebust9499b432007-06-24 15:57:57 -0400139}
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141/*
142 * Initialize RPC credential cache
143 */
144int
Trond Myklebustf5c21872007-06-25 17:11:20 -0400145rpcauth_init_credcache(struct rpc_auth *auth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
147 struct rpc_cred_cache *new;
148 int i;
149
Kris Katterjohn8b3a7002006-01-11 15:56:43 -0800150 new = kmalloc(sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 if (!new)
152 return -ENOMEM;
153 for (i = 0; i < RPC_CREDCACHE_NR; i++)
154 INIT_HLIST_HEAD(&new->hashtable[i]);
Trond Myklebust9499b432007-06-24 15:57:57 -0400155 spin_lock_init(&new->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 auth->au_credcache = new;
157 return 0;
158}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400159EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/*
162 * Destroy a list of credentials
163 */
164static inline
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400165void rpcauth_destroy_credlist(struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
167 struct rpc_cred *cred;
168
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400169 while (!list_empty(head)) {
170 cred = list_entry(head->next, struct rpc_cred, cr_lru);
171 list_del_init(&cred->cr_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 put_rpccred(cred);
173 }
174}
175
176/*
177 * Clear the RPC credential cache, and delete those credentials
178 * that are not referenced.
179 */
180void
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400181rpcauth_clear_credcache(struct rpc_cred_cache *cache)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400183 LIST_HEAD(free);
184 struct hlist_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 struct rpc_cred *cred;
186 int i;
187
188 spin_lock(&rpc_credcache_lock);
Trond Myklebust9499b432007-06-24 15:57:57 -0400189 spin_lock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 for (i = 0; i < RPC_CREDCACHE_NR; i++) {
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400191 head = &cache->hashtable[i];
192 while (!hlist_empty(head)) {
193 cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
194 get_rpccred(cred);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400195 if (!list_empty(&cred->cr_lru)) {
196 list_del(&cred->cr_lru);
197 number_cred_unused--;
198 }
199 list_add_tail(&cred->cr_lru, &free);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400200 rpcauth_unhash_cred_locked(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
202 }
Trond Myklebust9499b432007-06-24 15:57:57 -0400203 spin_unlock(&cache->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 spin_unlock(&rpc_credcache_lock);
205 rpcauth_destroy_credlist(&free);
206}
207
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400208/*
209 * Destroy the RPC credential cache
210 */
211void
212rpcauth_destroy_credcache(struct rpc_auth *auth)
213{
214 struct rpc_cred_cache *cache = auth->au_credcache;
215
216 if (cache) {
217 auth->au_credcache = NULL;
218 rpcauth_clear_credcache(cache);
219 kfree(cache);
220 }
221}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400222EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
Trond Myklebust3ab9bb72007-06-09 15:41:42 -0400223
Trond Myklebustd2b83142008-04-14 18:13:37 -0400224
225#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
228 * Remove stale credentials. Avoid sleeping inside the loop.
229 */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400230static int
231rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
Trond Myklebust9499b432007-06-24 15:57:57 -0400233 spinlock_t *cache_lock;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400234 struct rpc_cred *cred, *next;
Trond Myklebustd2b83142008-04-14 18:13:37 -0400235 unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Trond Myklebusteac0d182008-10-28 15:21:41 -0400237 list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
238
239 /* Enforce a 60 second garbage collection moratorium */
Trond Myklebust3d7b0892010-04-22 15:35:55 -0400240 if (time_in_range(cred->cr_expire, expired, jiffies) &&
Trond Myklebusteac0d182008-10-28 15:21:41 -0400241 test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0)
242 continue;
243
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400244 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400245 number_cred_unused--;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400246 if (atomic_read(&cred->cr_count) != 0)
247 continue;
Trond Myklebusteac0d182008-10-28 15:21:41 -0400248
Trond Myklebust9499b432007-06-24 15:57:57 -0400249 cache_lock = &cred->cr_auth->au_credcache->lock;
250 spin_lock(cache_lock);
251 if (atomic_read(&cred->cr_count) == 0) {
252 get_rpccred(cred);
253 list_add_tail(&cred->cr_lru, free);
254 rpcauth_unhash_cred_locked(cred);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400255 nr_to_scan--;
Trond Myklebust9499b432007-06-24 15:57:57 -0400256 }
257 spin_unlock(cache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400258 if (nr_to_scan == 0)
259 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 }
Trond Myklebustf5c21872007-06-25 17:11:20 -0400261 return nr_to_scan;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400262}
263
264/*
Trond Myklebustf5c21872007-06-25 17:11:20 -0400265 * Run memory cache shrinker.
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400266 */
Trond Myklebustf5c21872007-06-25 17:11:20 -0400267static int
268rpcauth_cache_shrinker(int nr_to_scan, gfp_t gfp_mask)
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400269{
Trond Myklebustf5c21872007-06-25 17:11:20 -0400270 LIST_HEAD(free);
271 int res;
272
273 if (list_empty(&cred_unused))
274 return 0;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400275 spin_lock(&rpc_credcache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400276 nr_to_scan = rpcauth_prune_expired(&free, nr_to_scan);
277 res = (number_cred_unused / 100) * sysctl_vfs_cache_pressure;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400278 spin_unlock(&rpc_credcache_lock);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400279 rpcauth_destroy_credlist(&free);
280 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
283/*
284 * Look up a process' credentials in the authentication cache
285 */
286struct rpc_cred *
287rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
Trond Myklebust8a317762006-02-01 12:18:36 -0500288 int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400290 LIST_HEAD(free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct rpc_cred_cache *cache = auth->au_credcache;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400292 struct hlist_node *pos;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400293 struct rpc_cred *cred = NULL,
294 *entry, *new;
Trond Myklebust25337fd2008-03-12 14:40:14 -0400295 unsigned int nr;
296
297 nr = hash_long(acred->uid, RPC_CREDCACHE_HASHBITS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400299 rcu_read_lock();
300 hlist_for_each_entry_rcu(entry, pos, &cache->hashtable[nr], cr_hash) {
301 if (!entry->cr_ops->crmatch(acred, entry, flags))
302 continue;
Trond Myklebust9499b432007-06-24 15:57:57 -0400303 spin_lock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400304 if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
Trond Myklebust9499b432007-06-24 15:57:57 -0400305 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400306 continue;
307 }
308 cred = get_rpccred(entry);
Trond Myklebust9499b432007-06-24 15:57:57 -0400309 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400310 break;
311 }
312 rcu_read_unlock();
313
Trond Myklebust9499b432007-06-24 15:57:57 -0400314 if (cred != NULL)
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400315 goto found;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400316
317 new = auth->au_ops->crcreate(auth, acred, flags);
318 if (IS_ERR(new)) {
319 cred = new;
320 goto out;
321 }
322
Trond Myklebust9499b432007-06-24 15:57:57 -0400323 spin_lock(&cache->lock);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400324 hlist_for_each_entry(entry, pos, &cache->hashtable[nr], cr_hash) {
325 if (!entry->cr_ops->crmatch(acred, entry, flags))
326 continue;
327 cred = get_rpccred(entry);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400328 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400330 if (cred == NULL) {
Trond Myklebust5fe47552007-06-23 19:55:31 -0400331 cred = new;
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400332 set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
333 hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
334 } else
335 list_add_tail(&new->cr_lru, &free);
Trond Myklebust9499b432007-06-24 15:57:57 -0400336 spin_unlock(&cache->lock);
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400337found:
Joe Perchesf64f9e72009-11-29 16:55:45 -0800338 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
339 cred->cr_ops->cr_init != NULL &&
340 !(flags & RPCAUTH_LOOKUP_NEW)) {
Trond Myklebustfba3bad2006-02-01 12:19:27 -0500341 int res = cred->cr_ops->cr_init(auth, cred);
342 if (res < 0) {
343 put_rpccred(cred);
344 cred = ERR_PTR(res);
345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 }
Trond Myklebust31be5bf2007-06-24 15:55:26 -0400347 rpcauth_destroy_credlist(&free);
348out:
349 return cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400351EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353struct rpc_cred *
Trond Myklebust8a317762006-02-01 12:18:36 -0500354rpcauth_lookupcred(struct rpc_auth *auth, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
David Howells86a264a2008-11-14 10:39:18 +1100356 struct auth_cred acred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 struct rpc_cred *ret;
David Howells86a264a2008-11-14 10:39:18 +1100358 const struct cred *cred = current_cred();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Chuck Lever46121cf2007-01-31 12:14:08 -0500360 dprintk("RPC: looking up %s cred\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 auth->au_ops->au_name);
David Howells86a264a2008-11-14 10:39:18 +1100362
363 memset(&acred, 0, sizeof(acred));
364 acred.uid = cred->fsuid;
365 acred.gid = cred->fsgid;
366 acred.group_info = get_group_info(((struct cred *)cred)->group_info);
367
Trond Myklebust8a317762006-02-01 12:18:36 -0500368 ret = auth->au_ops->lookup_cred(auth, &acred, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 put_group_info(acred.group_info);
370 return ret;
371}
372
Trond Myklebust5fe47552007-06-23 19:55:31 -0400373void
374rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
375 struct rpc_auth *auth, const struct rpc_credops *ops)
376{
377 INIT_HLIST_NODE(&cred->cr_hash);
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400378 INIT_LIST_HEAD(&cred->cr_lru);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400379 atomic_set(&cred->cr_count, 1);
380 cred->cr_auth = auth;
381 cred->cr_ops = ops;
382 cred->cr_expire = jiffies;
383#ifdef RPC_DEBUG
384 cred->cr_magic = RPCAUTH_CRED_MAGIC;
385#endif
386 cred->cr_uid = acred->uid;
387}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400388EXPORT_SYMBOL_GPL(rpcauth_init_cred);
Trond Myklebust5fe47552007-06-23 19:55:31 -0400389
Trond Myklebust5c691042008-03-12 16:21:07 -0400390void
Trond Myklebust5d351752009-09-15 13:32:13 -0400391rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred, int lookupflags)
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400392{
393 task->tk_msg.rpc_cred = get_rpccred(cred);
394 dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
395 cred->cr_auth->au_ops->au_name, cred);
396}
Trond Myklebust5c691042008-03-12 16:21:07 -0400397EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400398
399static void
Trond Myklebust5d351752009-09-15 13:32:13 -0400400rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400402 struct rpc_auth *auth = task->tk_client->cl_auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 struct auth_cred acred = {
Trond Myklebustaf093832008-03-12 12:12:16 -0400404 .uid = 0,
405 .gid = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 };
407 struct rpc_cred *ret;
408
Chuck Lever46121cf2007-01-31 12:14:08 -0500409 dprintk("RPC: %5u looking up %s cred\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400410 task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
Trond Myklebust5d351752009-09-15 13:32:13 -0400411 ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (!IS_ERR(ret))
413 task->tk_msg.rpc_cred = ret;
414 else
415 task->tk_status = PTR_ERR(ret);
Trond Myklebustaf093832008-03-12 12:12:16 -0400416}
417
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400418static void
Trond Myklebust5d351752009-09-15 13:32:13 -0400419rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
Trond Myklebustaf093832008-03-12 12:12:16 -0400420{
421 struct rpc_auth *auth = task->tk_client->cl_auth;
422 struct rpc_cred *ret;
423
424 dprintk("RPC: %5u looking up %s cred\n",
425 task->tk_pid, auth->au_ops->au_name);
Trond Myklebust5d351752009-09-15 13:32:13 -0400426 ret = rpcauth_lookupcred(auth, lookupflags);
Trond Myklebustaf093832008-03-12 12:12:16 -0400427 if (!IS_ERR(ret))
428 task->tk_msg.rpc_cred = ret;
429 else
430 task->tk_status = PTR_ERR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
433void
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400434rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
Trond Myklebust5d351752009-09-15 13:32:13 -0400436 int lookupflags = 0;
437
438 if (flags & RPC_TASK_ASYNC)
439 lookupflags |= RPCAUTH_LOOKUP_NEW;
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400440 if (cred != NULL)
Trond Myklebust5d351752009-09-15 13:32:13 -0400441 cred->cr_ops->crbind(task, cred, lookupflags);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400442 else if (flags & RPC_TASK_ROOTCREDS)
Trond Myklebust5d351752009-09-15 13:32:13 -0400443 rpcauth_bind_root_cred(task, lookupflags);
Trond Myklebust4ccda2c2008-03-12 16:20:55 -0400444 else
Trond Myklebust5d351752009-09-15 13:32:13 -0400445 rpcauth_bind_new_cred(task, lookupflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446}
447
448void
449put_rpccred(struct rpc_cred *cred)
450{
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400451 /* Fast path for unhashed credentials */
Trond Myklebustf0380f32009-12-03 08:10:17 -0500452 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) == 0) {
453 if (atomic_dec_and_test(&cred->cr_count))
454 cred->cr_ops->crdestroy(cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 return;
Trond Myklebustf0380f32009-12-03 08:10:17 -0500456 }
457
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400458 if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
459 return;
Trond Myklebustf5c21872007-06-25 17:11:20 -0400460 if (!list_empty(&cred->cr_lru)) {
461 number_cred_unused--;
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400462 list_del_init(&cred->cr_lru);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400463 }
Trond Myklebust5f707eb2008-10-28 15:21:42 -0400464 if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
Trond Myklebustf0380f32009-12-03 08:10:17 -0500465 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
466 cred->cr_expire = jiffies;
467 list_add_tail(&cred->cr_lru, &cred_unused);
468 number_cred_unused++;
469 goto out_nodestroy;
470 }
471 if (!rpcauth_unhash_cred(cred)) {
472 /* We were hashed and someone looked us up... */
473 goto out_nodestroy;
474 }
Trond Myklebuste092bdc2007-06-23 19:45:36 -0400475 }
476 spin_unlock(&rpc_credcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 cred->cr_ops->crdestroy(cred);
Trond Myklebustf0380f32009-12-03 08:10:17 -0500478 return;
479out_nodestroy:
480 spin_unlock(&rpc_credcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400482EXPORT_SYMBOL_GPL(put_rpccred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484void
485rpcauth_unbindcred(struct rpc_task *task)
486{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 struct rpc_cred *cred = task->tk_msg.rpc_cred;
488
Chuck Lever46121cf2007-01-31 12:14:08 -0500489 dprintk("RPC: %5u releasing %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400490 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492 put_rpccred(cred);
493 task->tk_msg.rpc_cred = NULL;
494}
495
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700496__be32 *
497rpcauth_marshcred(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 marshaling %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->crmarshal(task, p);
505}
506
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700507__be32 *
508rpcauth_checkverf(struct rpc_task *task, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 struct rpc_cred *cred = task->tk_msg.rpc_cred;
511
Chuck Lever46121cf2007-01-31 12:14:08 -0500512 dprintk("RPC: %5u validating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400513 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 return cred->cr_ops->crvalidate(task, p);
516}
517
518int
519rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700520 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 struct rpc_cred *cred = task->tk_msg.rpc_cred;
523
Chuck Lever46121cf2007-01-31 12:14:08 -0500524 dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 task->tk_pid, cred->cr_ops->cr_name, cred);
526 if (cred->cr_ops->crwrap_req)
527 return cred->cr_ops->crwrap_req(task, encode, rqstp, data, obj);
528 /* By default, we encode the arguments normally. */
Trond Myklebust88a9fe82008-12-23 15:21:31 -0500529 return encode(rqstp, data, obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530}
531
532int
533rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp,
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700534 __be32 *data, void *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535{
536 struct rpc_cred *cred = task->tk_msg.rpc_cred;
537
Chuck Lever46121cf2007-01-31 12:14:08 -0500538 dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 task->tk_pid, cred->cr_ops->cr_name, cred);
540 if (cred->cr_ops->crunwrap_resp)
541 return cred->cr_ops->crunwrap_resp(task, decode, rqstp,
542 data, obj);
543 /* By default, we decode the arguments normally. */
Trond Myklebust88a9fe82008-12-23 15:21:31 -0500544 return decode(rqstp, data, obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
546
547int
548rpcauth_refreshcred(struct rpc_task *task)
549{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 struct rpc_cred *cred = task->tk_msg.rpc_cred;
551 int err;
552
Chuck Lever46121cf2007-01-31 12:14:08 -0500553 dprintk("RPC: %5u refreshing %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400554 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Chuck Lever0bbacc42005-11-01 16:53:32 -0500555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 err = cred->cr_ops->crrefresh(task);
557 if (err < 0)
558 task->tk_status = err;
559 return err;
560}
561
562void
563rpcauth_invalcred(struct rpc_task *task)
564{
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400565 struct rpc_cred *cred = task->tk_msg.rpc_cred;
566
Chuck Lever46121cf2007-01-31 12:14:08 -0500567 dprintk("RPC: %5u invalidating %s cred %p\n",
Trond Myklebust1be27f32007-06-27 14:29:04 -0400568 task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400569 if (cred)
570 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
573int
574rpcauth_uptodatecred(struct rpc_task *task)
575{
Trond Myklebustfc432dd2007-06-25 10:15:15 -0400576 struct rpc_cred *cred = task->tk_msg.rpc_cred;
577
578 return cred == NULL ||
579 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580}
Trond Myklebustf5c21872007-06-25 17:11:20 -0400581
Rusty Russell8e1f9362007-07-17 04:03:17 -0700582static struct shrinker rpc_cred_shrinker = {
583 .shrink = rpcauth_cache_shrinker,
584 .seeks = DEFAULT_SEEKS,
585};
Trond Myklebustf5c21872007-06-25 17:11:20 -0400586
587void __init rpcauth_init_module(void)
588{
589 rpc_init_authunix();
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400590 rpc_init_generic_auth();
Rusty Russell8e1f9362007-07-17 04:03:17 -0700591 register_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400592}
593
594void __exit rpcauth_remove_module(void)
595{
Rusty Russell8e1f9362007-07-17 04:03:17 -0700596 unregister_shrinker(&rpc_cred_shrinker);
Trond Myklebustf5c21872007-06-25 17:11:20 -0400597}