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