auth.c 21.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * linux/net/sunrpc/auth.c
 *
 * Generic RPC client authentication API.
 *
 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/types.h>
#include <linux/sched.h>
11
#include <linux/cred.h>
L
Linus Torvalds 已提交
12 13 14
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/errno.h>
15
#include <linux/hash.h>
L
Linus Torvalds 已提交
16
#include <linux/sunrpc/clnt.h>
C
Chuck Lever 已提交
17
#include <linux/sunrpc/gss_api.h>
L
Linus Torvalds 已提交
18 19
#include <linux/spinlock.h>

J
Jeff Layton 已提交
20
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
L
Linus Torvalds 已提交
21 22 23
# define RPCDBG_FACILITY	RPCDBG_AUTH
#endif

24 25 26 27 28 29 30 31 32
#define RPC_CREDCACHE_DEFAULT_HASHBITS	(4)
struct rpc_cred_cache {
	struct hlist_head	*hashtable;
	unsigned int		hashbits;
	spinlock_t		lock;
};

static unsigned int auth_hashbits = RPC_CREDCACHE_DEFAULT_HASHBITS;

33
static DEFINE_SPINLOCK(rpc_authflavor_lock);
34
static const struct rpc_authops *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
L
Linus Torvalds 已提交
35 36 37 38 39
	&authnull_ops,		/* AUTH_NULL */
	&authunix_ops,		/* AUTH_UNIX */
	NULL,			/* others can be loadable modules */
};

40
static LIST_HEAD(cred_unused);
41
static unsigned long number_cred_unused;
42

43
#define MAX_HASHTABLE_BITS (14)
44
static int param_set_hashtbl_sz(const char *val, const struct kernel_param *kp)
45 46 47 48 49 50 51
{
	unsigned long num;
	unsigned int nbits;
	int ret;

	if (!val)
		goto out_inval;
D
Daniel Walter 已提交
52
	ret = kstrtoul(val, 0, &num);
53 54
	if (ret == -EINVAL)
		goto out_inval;
55
	nbits = fls(num - 1);
56 57 58 59 60 61 62 63
	if (nbits > MAX_HASHTABLE_BITS || nbits < 2)
		goto out_inval;
	*(unsigned int *)kp->arg = nbits;
	return 0;
out_inval:
	return -EINVAL;
}

64
static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
65 66 67 68 69 70 71 72 73
{
	unsigned int nbits;

	nbits = *(unsigned int *)kp->arg;
	return sprintf(buffer, "%u", 1U << nbits);
}

#define param_check_hashtbl_sz(name, p) __param_check(name, p, unsigned int);

74
static const struct kernel_param_ops param_ops_hashtbl_sz = {
75 76 77 78
	.set = param_set_hashtbl_sz,
	.get = param_get_hashtbl_sz,
};

79 80 81
module_param_named(auth_hashtable_size, auth_hashbits, hashtbl_sz, 0644);
MODULE_PARM_DESC(auth_hashtable_size, "RPC credential cache hashtable size");

82 83 84 85
static unsigned long auth_max_cred_cachesize = ULONG_MAX;
module_param(auth_max_cred_cachesize, ulong, 0644);
MODULE_PARM_DESC(auth_max_cred_cachesize, "RPC credential maximum total cache size");

L
Linus Torvalds 已提交
86 87
static u32
pseudoflavor_to_flavor(u32 flavor) {
88
	if (flavor > RPC_AUTH_MAXFLAVOR)
L
Linus Torvalds 已提交
89 90 91 92 93
		return RPC_AUTH_GSS;
	return flavor;
}

int
94
rpcauth_register(const struct rpc_authops *ops)
L
Linus Torvalds 已提交
95 96
{
	rpc_authflavor_t flavor;
97
	int ret = -EPERM;
L
Linus Torvalds 已提交
98 99 100

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
101 102 103 104 105 106 107
	spin_lock(&rpc_authflavor_lock);
	if (auth_flavors[flavor] == NULL) {
		auth_flavors[flavor] = ops;
		ret = 0;
	}
	spin_unlock(&rpc_authflavor_lock);
	return ret;
L
Linus Torvalds 已提交
108
}
109
EXPORT_SYMBOL_GPL(rpcauth_register);
L
Linus Torvalds 已提交
110 111

int
112
rpcauth_unregister(const struct rpc_authops *ops)
L
Linus Torvalds 已提交
113 114
{
	rpc_authflavor_t flavor;
115
	int ret = -EPERM;
L
Linus Torvalds 已提交
116 117 118

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
119 120 121 122 123 124 125
	spin_lock(&rpc_authflavor_lock);
	if (auth_flavors[flavor] == ops) {
		auth_flavors[flavor] = NULL;
		ret = 0;
	}
	spin_unlock(&rpc_authflavor_lock);
	return ret;
L
Linus Torvalds 已提交
126
}
127
EXPORT_SYMBOL_GPL(rpcauth_unregister);
L
Linus Torvalds 已提交
128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/**
 * rpcauth_get_pseudoflavor - check if security flavor is supported
 * @flavor: a security flavor
 * @info: a GSS mech OID, quality of protection, and service value
 *
 * Verifies that an appropriate kernel module is available or already loaded.
 * Returns an equivalent pseudoflavor, or RPC_AUTH_MAXFLAVOR if "flavor" is
 * not supported locally.
 */
rpc_authflavor_t
rpcauth_get_pseudoflavor(rpc_authflavor_t flavor, struct rpcsec_gss_info *info)
{
	const struct rpc_authops *ops;
	rpc_authflavor_t pseudoflavor;

	ops = auth_flavors[flavor];
	if (ops == NULL)
		request_module("rpc-auth-%u", flavor);
	spin_lock(&rpc_authflavor_lock);
	ops = auth_flavors[flavor];
	if (ops == NULL || !try_module_get(ops->owner)) {
		spin_unlock(&rpc_authflavor_lock);
		return RPC_AUTH_MAXFLAVOR;
	}
	spin_unlock(&rpc_authflavor_lock);

	pseudoflavor = flavor;
	if (ops->info2flavor != NULL)
		pseudoflavor = ops->info2flavor(info);

	module_put(ops->owner);
	return pseudoflavor;
}
EXPORT_SYMBOL_GPL(rpcauth_get_pseudoflavor);

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
/**
 * rpcauth_get_gssinfo - find GSS tuple matching a GSS pseudoflavor
 * @pseudoflavor: GSS pseudoflavor to match
 * @info: rpcsec_gss_info structure to fill in
 *
 * Returns zero and fills in "info" if pseudoflavor matches a
 * supported mechanism.
 */
int
rpcauth_get_gssinfo(rpc_authflavor_t pseudoflavor, struct rpcsec_gss_info *info)
{
	rpc_authflavor_t flavor = pseudoflavor_to_flavor(pseudoflavor);
	const struct rpc_authops *ops;
	int result;

179 180 181
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
	ops = auth_flavors[flavor];
	if (ops == NULL)
		request_module("rpc-auth-%u", flavor);
	spin_lock(&rpc_authflavor_lock);
	ops = auth_flavors[flavor];
	if (ops == NULL || !try_module_get(ops->owner)) {
		spin_unlock(&rpc_authflavor_lock);
		return -ENOENT;
	}
	spin_unlock(&rpc_authflavor_lock);

	result = -ENOENT;
	if (ops->flavor2info != NULL)
		result = ops->flavor2info(pseudoflavor, info);

	module_put(ops->owner);
	return result;
}
EXPORT_SYMBOL_GPL(rpcauth_get_gssinfo);

C
Chuck Lever 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
/**
 * rpcauth_list_flavors - discover registered flavors and pseudoflavors
 * @array: array to fill in
 * @size: size of "array"
 *
 * Returns the number of array items filled in, or a negative errno.
 *
 * The returned array is not sorted by any policy.  Callers should not
 * rely on the order of the items in the returned array.
 */
int
rpcauth_list_flavors(rpc_authflavor_t *array, int size)
{
	rpc_authflavor_t flavor;
	int result = 0;

	spin_lock(&rpc_authflavor_lock);
	for (flavor = 0; flavor < RPC_AUTH_MAXFLAVOR; flavor++) {
		const struct rpc_authops *ops = auth_flavors[flavor];
		rpc_authflavor_t pseudos[4];
		int i, len;

		if (result >= size) {
			result = -ENOMEM;
			break;
		}

		if (ops == NULL)
			continue;
		if (ops->list_pseudoflavors == NULL) {
			array[result++] = ops->au_flavor;
			continue;
		}
		len = ops->list_pseudoflavors(pseudos, ARRAY_SIZE(pseudos));
		if (len < 0) {
			result = len;
			break;
		}
		for (i = 0; i < len; i++) {
			if (result >= size) {
				result = -ENOMEM;
				break;
			}
			array[result++] = pseudos[i];
		}
	}
	spin_unlock(&rpc_authflavor_lock);

	dprintk("RPC:       %s returns %d\n", __func__, result);
	return result;
}
EXPORT_SYMBOL_GPL(rpcauth_list_flavors);

L
Linus Torvalds 已提交
255
struct rpc_auth *
256
rpcauth_create(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
257 258
{
	struct rpc_auth		*auth;
259
	const struct rpc_authops *ops;
260
	u32			flavor = pseudoflavor_to_flavor(args->pseudoflavor);
L
Linus Torvalds 已提交
261

262 263 264 265 266 267
	auth = ERR_PTR(-EINVAL);
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		goto out;

	if ((ops = auth_flavors[flavor]) == NULL)
		request_module("rpc-auth-%u", flavor);
268 269 270 271
	spin_lock(&rpc_authflavor_lock);
	ops = auth_flavors[flavor];
	if (ops == NULL || !try_module_get(ops->owner)) {
		spin_unlock(&rpc_authflavor_lock);
272
		goto out;
273 274
	}
	spin_unlock(&rpc_authflavor_lock);
275
	auth = ops->create(args, clnt);
276
	module_put(ops->owner);
277 278
	if (IS_ERR(auth))
		return auth;
L
Linus Torvalds 已提交
279
	if (clnt->cl_auth)
280
		rpcauth_release(clnt->cl_auth);
L
Linus Torvalds 已提交
281
	clnt->cl_auth = auth;
282 283

out:
L
Linus Torvalds 已提交
284 285
	return auth;
}
286
EXPORT_SYMBOL_GPL(rpcauth_create);
L
Linus Torvalds 已提交
287 288

void
289
rpcauth_release(struct rpc_auth *auth)
L
Linus Torvalds 已提交
290 291 292 293 294 295 296 297
{
	if (!atomic_dec_and_test(&auth->au_count))
		return;
	auth->au_ops->destroy(auth);
}

static DEFINE_SPINLOCK(rpc_credcache_lock);

298 299 300 301
static void
rpcauth_unhash_cred_locked(struct rpc_cred *cred)
{
	hlist_del_rcu(&cred->cr_hash);
302
	smp_mb__before_atomic();
303 304 305
	clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
}

306
static int
307 308 309
rpcauth_unhash_cred(struct rpc_cred *cred)
{
	spinlock_t *cache_lock;
310
	int ret;
311 312 313

	cache_lock = &cred->cr_auth->au_credcache->lock;
	spin_lock(cache_lock);
314 315
	ret = atomic_read(&cred->cr_count) == 0;
	if (ret)
316 317
		rpcauth_unhash_cred_locked(cred);
	spin_unlock(cache_lock);
318
	return ret;
319 320
}

L
Linus Torvalds 已提交
321 322 323 324
/*
 * Initialize RPC credential cache
 */
int
325
rpcauth_init_credcache(struct rpc_auth *auth)
L
Linus Torvalds 已提交
326 327
{
	struct rpc_cred_cache *new;
328
	unsigned int hashsize;
L
Linus Torvalds 已提交
329

330
	new = kmalloc(sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
331
	if (!new)
332 333
		goto out_nocache;
	new->hashbits = auth_hashbits;
334
	hashsize = 1U << new->hashbits;
335 336 337
	new->hashtable = kcalloc(hashsize, sizeof(new->hashtable[0]), GFP_KERNEL);
	if (!new->hashtable)
		goto out_nohashtbl;
338
	spin_lock_init(&new->lock);
L
Linus Torvalds 已提交
339 340
	auth->au_credcache = new;
	return 0;
341 342 343 344
out_nohashtbl:
	kfree(new);
out_nocache:
	return -ENOMEM;
L
Linus Torvalds 已提交
345
}
346
EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
L
Linus Torvalds 已提交
347

348 349 350 351 352 353 354 355 356 357 358 359 360
/*
 * Setup a credential key lifetime timeout notification
 */
int
rpcauth_key_timeout_notify(struct rpc_auth *auth, struct rpc_cred *cred)
{
	if (!cred->cr_auth->au_ops->key_timeout)
		return 0;
	return cred->cr_auth->au_ops->key_timeout(auth, cred);
}
EXPORT_SYMBOL_GPL(rpcauth_key_timeout_notify);

bool
361
rpcauth_cred_key_to_expire(struct rpc_auth *auth, struct rpc_cred *cred)
362
{
363 364
	if (auth->au_flags & RPCAUTH_AUTH_NO_CRKEY_TIMEOUT)
		return false;
365 366 367 368 369 370
	if (!cred->cr_ops->crkey_to_expire)
		return false;
	return cred->cr_ops->crkey_to_expire(cred);
}
EXPORT_SYMBOL_GPL(rpcauth_cred_key_to_expire);

371 372 373 374 375 376 377 378 379
char *
rpcauth_stringify_acceptor(struct rpc_cred *cred)
{
	if (!cred->cr_ops->crstringify_acceptor)
		return NULL;
	return cred->cr_ops->crstringify_acceptor(cred);
}
EXPORT_SYMBOL_GPL(rpcauth_stringify_acceptor);

L
Linus Torvalds 已提交
380 381 382 383
/*
 * Destroy a list of credentials
 */
static inline
384
void rpcauth_destroy_credlist(struct list_head *head)
L
Linus Torvalds 已提交
385 386 387
{
	struct rpc_cred *cred;

388 389 390
	while (!list_empty(head)) {
		cred = list_entry(head->next, struct rpc_cred, cr_lru);
		list_del_init(&cred->cr_lru);
L
Linus Torvalds 已提交
391 392 393 394 395 396 397 398 399
		put_rpccred(cred);
	}
}

/*
 * Clear the RPC credential cache, and delete those credentials
 * that are not referenced.
 */
void
400
rpcauth_clear_credcache(struct rpc_cred_cache *cache)
L
Linus Torvalds 已提交
401
{
402 403
	LIST_HEAD(free);
	struct hlist_head *head;
L
Linus Torvalds 已提交
404
	struct rpc_cred	*cred;
405
	unsigned int hashsize = 1U << cache->hashbits;
L
Linus Torvalds 已提交
406 407 408
	int		i;

	spin_lock(&rpc_credcache_lock);
409
	spin_lock(&cache->lock);
410
	for (i = 0; i < hashsize; i++) {
411 412 413 414
		head = &cache->hashtable[i];
		while (!hlist_empty(head)) {
			cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
			get_rpccred(cred);
415 416 417 418 419
			if (!list_empty(&cred->cr_lru)) {
				list_del(&cred->cr_lru);
				number_cred_unused--;
			}
			list_add_tail(&cred->cr_lru, &free);
420
			rpcauth_unhash_cred_locked(cred);
L
Linus Torvalds 已提交
421 422
		}
	}
423
	spin_unlock(&cache->lock);
L
Linus Torvalds 已提交
424 425 426 427
	spin_unlock(&rpc_credcache_lock);
	rpcauth_destroy_credlist(&free);
}

428 429 430 431 432 433 434 435 436 437 438
/*
 * Destroy the RPC credential cache
 */
void
rpcauth_destroy_credcache(struct rpc_auth *auth)
{
	struct rpc_cred_cache *cache = auth->au_credcache;

	if (cache) {
		auth->au_credcache = NULL;
		rpcauth_clear_credcache(cache);
439
		kfree(cache->hashtable);
440 441 442
		kfree(cache);
	}
}
443
EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
444

445 446 447

#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

448 449 450
/*
 * Remove stale credentials. Avoid sleeping inside the loop.
 */
451
static long
452
rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
L
Linus Torvalds 已提交
453
{
454
	spinlock_t *cache_lock;
455
	struct rpc_cred *cred, *next;
456
	unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
457
	long freed = 0;
458

459 460
	list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {

461 462
		if (nr_to_scan-- == 0)
			break;
463 464 465 466
		/*
		 * Enforce a 60 second garbage collection moratorium
		 * Note that the cred_unused list must be time-ordered.
		 */
467
		if (time_in_range(cred->cr_expire, expired, jiffies) &&
468 469
		    test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
			freed = SHRINK_STOP;
470
			break;
471
		}
472

473
		list_del_init(&cred->cr_lru);
474
		number_cred_unused--;
475
		freed++;
476 477
		if (atomic_read(&cred->cr_count) != 0)
			continue;
478

479 480 481 482 483 484 485 486
		cache_lock = &cred->cr_auth->au_credcache->lock;
		spin_lock(cache_lock);
		if (atomic_read(&cred->cr_count) == 0) {
			get_rpccred(cred);
			list_add_tail(&cred->cr_lru, free);
			rpcauth_unhash_cred_locked(cred);
		}
		spin_unlock(cache_lock);
L
Linus Torvalds 已提交
487
	}
488
	return freed;
L
Linus Torvalds 已提交
489 490
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504
static unsigned long
rpcauth_cache_do_shrink(int nr_to_scan)
{
	LIST_HEAD(free);
	unsigned long freed;

	spin_lock(&rpc_credcache_lock);
	freed = rpcauth_prune_expired(&free, nr_to_scan);
	spin_unlock(&rpc_credcache_lock);
	rpcauth_destroy_credlist(&free);

	return freed;
}

L
Linus Torvalds 已提交
505
/*
506
 * Run memory cache shrinker.
L
Linus Torvalds 已提交
507
 */
508 509 510
static unsigned long
rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)

L
Linus Torvalds 已提交
511
{
512 513
	if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
		return SHRINK_STOP;
514

515
	/* nothing left, don't come back */
516
	if (list_empty(&cred_unused))
517 518
		return SHRINK_STOP;

519
	return rpcauth_cache_do_shrink(sc->nr_to_scan);
520 521 522 523 524 525
}

static unsigned long
rpcauth_cache_shrink_count(struct shrinker *shrink, struct shrink_control *sc)

{
526
	return number_cred_unused * sysctl_vfs_cache_pressure / 100;
L
Linus Torvalds 已提交
527 528
}

529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
static void
rpcauth_cache_enforce_limit(void)
{
	unsigned long diff;
	unsigned int nr_to_scan;

	if (number_cred_unused <= auth_max_cred_cachesize)
		return;
	diff = number_cred_unused - auth_max_cred_cachesize;
	nr_to_scan = 100;
	if (diff < nr_to_scan)
		nr_to_scan = diff;
	rpcauth_cache_do_shrink(nr_to_scan);
}

L
Linus Torvalds 已提交
544 545 546 547 548
/*
 * Look up a process' credentials in the authentication cache
 */
struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
549
		int flags, gfp_t gfp)
L
Linus Torvalds 已提交
550
{
551
	LIST_HEAD(free);
L
Linus Torvalds 已提交
552
	struct rpc_cred_cache *cache = auth->au_credcache;
553 554
	struct rpc_cred	*cred = NULL,
			*entry, *new;
555 556
	unsigned int nr;

557
	nr = auth->au_ops->hash_cred(acred, cache->hashbits);
L
Linus Torvalds 已提交
558

559
	rcu_read_lock();
560
	hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
561 562
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
563 564 565 566 567 568
		if (flags & RPCAUTH_LOOKUP_RCU) {
			if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) &&
			    !test_bit(RPCAUTH_CRED_NEW, &entry->cr_flags))
				cred = entry;
			break;
		}
569
		spin_lock(&cache->lock);
570
		if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
571
			spin_unlock(&cache->lock);
572 573
			continue;
		}
574
		cred = get_rpccred(entry);
575
		spin_unlock(&cache->lock);
576
		break;
L
Linus Torvalds 已提交
577
	}
578 579
	rcu_read_unlock();

580
	if (cred != NULL)
581
		goto found;
L
Linus Torvalds 已提交
582

583 584 585
	if (flags & RPCAUTH_LOOKUP_RCU)
		return ERR_PTR(-ECHILD);

586
	new = auth->au_ops->crcreate(auth, acred, flags, gfp);
587 588 589 590
	if (IS_ERR(new)) {
		cred = new;
		goto out;
	}
L
Linus Torvalds 已提交
591

592
	spin_lock(&cache->lock);
593
	hlist_for_each_entry(entry, &cache->hashtable[nr], cr_hash) {
594 595 596 597 598 599
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
		cred = get_rpccred(entry);
		break;
	}
	if (cred == NULL) {
600
		cred = new;
601 602 603 604
		set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
		hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
	} else
		list_add_tail(&new->cr_lru, &free);
605
	spin_unlock(&cache->lock);
606
	rpcauth_cache_enforce_limit();
607
found:
608 609 610
	if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
	    cred->cr_ops->cr_init != NULL &&
	    !(flags & RPCAUTH_LOOKUP_NEW)) {
611 612 613 614 615
		int res = cred->cr_ops->cr_init(auth, cred);
		if (res < 0) {
			put_rpccred(cred);
			cred = ERR_PTR(res);
		}
L
Linus Torvalds 已提交
616
	}
617 618 619
	rpcauth_destroy_credlist(&free);
out:
	return cred;
L
Linus Torvalds 已提交
620
}
621
EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
L
Linus Torvalds 已提交
622 623

struct rpc_cred *
624
rpcauth_lookupcred(struct rpc_auth *auth, int flags)
L
Linus Torvalds 已提交
625
{
626
	struct auth_cred acred;
L
Linus Torvalds 已提交
627
	struct rpc_cred *ret;
628
	const struct cred *cred = current_cred();
L
Linus Torvalds 已提交
629

630
	dprintk("RPC:       looking up %s cred\n",
L
Linus Torvalds 已提交
631
		auth->au_ops->au_name);
632 633 634 635

	memset(&acred, 0, sizeof(acred));
	acred.uid = cred->fsuid;
	acred.gid = cred->fsgid;
636
	acred.group_info = cred->group_info;
637
	ret = auth->au_ops->lookup_cred(auth, &acred, flags);
L
Linus Torvalds 已提交
638 639
	return ret;
}
640
EXPORT_SYMBOL_GPL(rpcauth_lookupcred);
L
Linus Torvalds 已提交
641

642 643 644 645 646
void
rpcauth_init_cred(struct rpc_cred *cred, const struct auth_cred *acred,
		  struct rpc_auth *auth, const struct rpc_credops *ops)
{
	INIT_HLIST_NODE(&cred->cr_hash);
647
	INIT_LIST_HEAD(&cred->cr_lru);
648 649 650 651 652 653
	atomic_set(&cred->cr_count, 1);
	cred->cr_auth = auth;
	cred->cr_ops = ops;
	cred->cr_expire = jiffies;
	cred->cr_uid = acred->uid;
}
654
EXPORT_SYMBOL_GPL(rpcauth_init_cred);
655

656
struct rpc_cred *
657
rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred, int lookupflags)
658 659 660
{
	dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
			cred->cr_auth->au_ops->au_name, cred);
661
	return get_rpccred(cred);
662
}
663
EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
664

665
static struct rpc_cred *
666
rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
L
Linus Torvalds 已提交
667
{
668
	struct rpc_auth *auth = task->tk_client->cl_auth;
L
Linus Torvalds 已提交
669
	struct auth_cred acred = {
670 671
		.uid = GLOBAL_ROOT_UID,
		.gid = GLOBAL_ROOT_GID,
L
Linus Torvalds 已提交
672 673
	};

674
	dprintk("RPC: %5u looking up %s cred\n",
675
		task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
676
	return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
677 678
}

679
static struct rpc_cred *
680
rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
681 682 683 684 685
{
	struct rpc_auth *auth = task->tk_client->cl_auth;

	dprintk("RPC: %5u looking up %s cred\n",
		task->tk_pid, auth->au_ops->au_name);
686
	return rpcauth_lookupcred(auth, lookupflags);
L
Linus Torvalds 已提交
687 688
}

689
static int
690
rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
L
Linus Torvalds 已提交
691
{
692
	struct rpc_rqst *req = task->tk_rqstp;
693
	struct rpc_cred *new;
694 695 696 697
	int lookupflags = 0;

	if (flags & RPC_TASK_ASYNC)
		lookupflags |= RPCAUTH_LOOKUP_NEW;
698
	if (cred != NULL)
699
		new = cred->cr_ops->crbind(task, cred, lookupflags);
700
	else if (flags & RPC_TASK_ROOTCREDS)
701
		new = rpcauth_bind_root_cred(task, lookupflags);
702
	else
703 704 705
		new = rpcauth_bind_new_cred(task, lookupflags);
	if (IS_ERR(new))
		return PTR_ERR(new);
706
	put_rpccred(req->rq_cred);
707
	req->rq_cred = new;
708
	return 0;
L
Linus Torvalds 已提交
709 710 711 712 713
}

void
put_rpccred(struct rpc_cred *cred)
{
714 715
	if (cred == NULL)
		return;
716
	/* Fast path for unhashed credentials */
717 718 719
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) == 0) {
		if (atomic_dec_and_test(&cred->cr_count))
			cred->cr_ops->crdestroy(cred);
L
Linus Torvalds 已提交
720
		return;
721 722
	}

723 724
	if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
		return;
725 726
	if (!list_empty(&cred->cr_lru)) {
		number_cred_unused--;
727
		list_del_init(&cred->cr_lru);
728
	}
729
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
730 731 732 733 734 735 736 737 738 739
		if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
			cred->cr_expire = jiffies;
			list_add_tail(&cred->cr_lru, &cred_unused);
			number_cred_unused++;
			goto out_nodestroy;
		}
		if (!rpcauth_unhash_cred(cred)) {
			/* We were hashed and someone looked us up... */
			goto out_nodestroy;
		}
740 741
	}
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
742
	cred->cr_ops->crdestroy(cred);
743 744 745
	return;
out_nodestroy:
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
746
}
747
EXPORT_SYMBOL_GPL(put_rpccred);
L
Linus Torvalds 已提交
748

749 750
__be32 *
rpcauth_marshcred(struct rpc_task *task, __be32 *p)
L
Linus Torvalds 已提交
751
{
752
	struct rpc_cred	*cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
753

754
	dprintk("RPC: %5u marshaling %s cred %p\n",
755
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
756

L
Linus Torvalds 已提交
757 758 759
	return cred->cr_ops->crmarshal(task, p);
}

760 761
__be32 *
rpcauth_checkverf(struct rpc_task *task, __be32 *p)
L
Linus Torvalds 已提交
762
{
763
	struct rpc_cred	*cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
764

765
	dprintk("RPC: %5u validating %s cred %p\n",
766
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
767

L
Linus Torvalds 已提交
768 769 770
	return cred->cr_ops->crvalidate(task, p);
}

771 772 773 774 775 776 777 778 779
static void rpcauth_wrap_req_encode(kxdreproc_t encode, struct rpc_rqst *rqstp,
				   __be32 *data, void *obj)
{
	struct xdr_stream xdr;

	xdr_init_encode(&xdr, &rqstp->rq_snd_buf, data);
	encode(rqstp, &xdr, obj);
}

L
Linus Torvalds 已提交
780
int
781
rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp,
782
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
783
{
784
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
785

786
	dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
L
Linus Torvalds 已提交
787 788 789 790
			task->tk_pid, cred->cr_ops->cr_name, cred);
	if (cred->cr_ops->crwrap_req)
		return cred->cr_ops->crwrap_req(task, encode, rqstp, data, obj);
	/* By default, we encode the arguments normally. */
791 792
	rpcauth_wrap_req_encode(encode, rqstp, data, obj);
	return 0;
L
Linus Torvalds 已提交
793 794
}

795 796 797 798 799 800 801 802 803 804
static int
rpcauth_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
			  __be32 *data, void *obj)
{
	struct xdr_stream xdr;

	xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, data);
	return decode(rqstp, &xdr, obj);
}

L
Linus Torvalds 已提交
805
int
806
rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp,
807
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
808
{
809
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
810

811
	dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
L
Linus Torvalds 已提交
812 813 814 815 816
			task->tk_pid, cred->cr_ops->cr_name, cred);
	if (cred->cr_ops->crunwrap_resp)
		return cred->cr_ops->crunwrap_resp(task, decode, rqstp,
						   data, obj);
	/* By default, we decode the arguments normally. */
817
	return rpcauth_unwrap_req_decode(decode, rqstp, data, obj);
L
Linus Torvalds 已提交
818 819 820 821 822
}

int
rpcauth_refreshcred(struct rpc_task *task)
{
823
	struct rpc_cred	*cred;
L
Linus Torvalds 已提交
824 825
	int err;

826 827 828 829 830 831
	cred = task->tk_rqstp->rq_cred;
	if (cred == NULL) {
		err = rpcauth_bindcred(task, task->tk_msg.rpc_cred, task->tk_flags);
		if (err < 0)
			goto out;
		cred = task->tk_rqstp->rq_cred;
J
Joe Perches 已提交
832
	}
833
	dprintk("RPC: %5u refreshing %s cred %p\n",
834
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
835

L
Linus Torvalds 已提交
836
	err = cred->cr_ops->crrefresh(task);
837
out:
L
Linus Torvalds 已提交
838 839 840 841 842 843 844 845
	if (err < 0)
		task->tk_status = err;
	return err;
}

void
rpcauth_invalcred(struct rpc_task *task)
{
846
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
847

848
	dprintk("RPC: %5u invalidating %s cred %p\n",
849
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
850 851
	if (cred)
		clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
L
Linus Torvalds 已提交
852 853 854 855 856
}

int
rpcauth_uptodatecred(struct rpc_task *task)
{
857
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
858 859 860

	return cred == NULL ||
		test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
L
Linus Torvalds 已提交
861
}
862

863
static struct shrinker rpc_cred_shrinker = {
864 865
	.count_objects = rpcauth_cache_shrink_count,
	.scan_objects = rpcauth_cache_shrink_scan,
866 867
	.seeks = DEFAULT_SEEKS,
};
868

869
int __init rpcauth_init_module(void)
870
{
871 872 873 874 875 876 877 878
	int err;

	err = rpc_init_authunix();
	if (err < 0)
		goto out1;
	err = rpc_init_generic_auth();
	if (err < 0)
		goto out2;
879 880 881
	err = register_shrinker(&rpc_cred_shrinker);
	if (err < 0)
		goto out3;
882
	return 0;
883 884
out3:
	rpc_destroy_generic_auth();
885 886 887 888
out2:
	rpc_destroy_authunix();
out1:
	return err;
889 890
}

891
void rpcauth_remove_module(void)
892
{
893 894
	rpc_destroy_authunix();
	rpc_destroy_generic_auth();
895
	unregister_shrinker(&rpc_cred_shrinker);
896
}