auth.c 20.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * 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>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/errno.h>
14
#include <linux/hash.h>
L
Linus Torvalds 已提交
15
#include <linux/sunrpc/clnt.h>
C
Chuck Lever 已提交
16
#include <linux/sunrpc/gss_api.h>
L
Linus Torvalds 已提交
17 18
#include <linux/spinlock.h>

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

23 24 25 26 27 28 29 30 31
#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;

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

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

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

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

65
static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
66 67 68 69 70 71 72 73 74
{
	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);

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

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

83 84 85 86
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 已提交
87 88
static u32
pseudoflavor_to_flavor(u32 flavor) {
89
	if (flavor > RPC_AUTH_MAXFLAVOR)
L
Linus Torvalds 已提交
90 91 92 93 94
		return RPC_AUTH_GSS;
	return flavor;
}

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

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
102 103 104 105 106 107 108
	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 已提交
109
}
110
EXPORT_SYMBOL_GPL(rpcauth_register);
L
Linus Torvalds 已提交
111 112

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

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
120 121 122 123 124 125 126
	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 已提交
127
}
128
EXPORT_SYMBOL_GPL(rpcauth_unregister);
L
Linus Torvalds 已提交
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 164
/**
 * 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);

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/**
 * 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;

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

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
	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 已提交
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 255
/**
 * 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 已提交
256
struct rpc_auth *
257
rpcauth_create(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
258 259
{
	struct rpc_auth		*auth;
260
	const struct rpc_authops *ops;
261
	u32			flavor = pseudoflavor_to_flavor(args->pseudoflavor);
L
Linus Torvalds 已提交
262

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

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

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

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

static DEFINE_SPINLOCK(rpc_credcache_lock);

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

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

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

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

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

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
/*
 * 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
rpcauth_cred_key_to_expire(struct rpc_cred *cred)
{
	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);

370 371 372 373 374 375 376 377 378
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 已提交
379 380 381 382
/*
 * Destroy a list of credentials
 */
static inline
383
void rpcauth_destroy_credlist(struct list_head *head)
L
Linus Torvalds 已提交
384 385 386
{
	struct rpc_cred *cred;

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

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

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

427 428 429 430 431 432 433 434 435 436 437
/*
 * 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);
438
		kfree(cache->hashtable);
439 440 441
		kfree(cache);
	}
}
442
EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
443

444 445 446

#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

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

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

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

470
		list_del_init(&cred->cr_lru);
471
		number_cred_unused--;
472
		freed++;
473 474
		if (atomic_read(&cred->cr_count) != 0)
			continue;
475

476 477 478 479 480 481 482 483
		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 已提交
484
	}
485
	return freed;
L
Linus Torvalds 已提交
486 487
}

488 489 490 491 492 493 494 495 496 497 498 499 500 501
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 已提交
502
/*
503
 * Run memory cache shrinker.
L
Linus Torvalds 已提交
504
 */
505 506 507
static unsigned long
rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)

L
Linus Torvalds 已提交
508
{
509 510
	if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
		return SHRINK_STOP;
511

512
	/* nothing left, don't come back */
513
	if (list_empty(&cred_unused))
514 515
		return SHRINK_STOP;

516
	return rpcauth_cache_do_shrink(sc->nr_to_scan);
517 518 519 520 521 522 523
}

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

{
	return (number_cred_unused / 100) * sysctl_vfs_cache_pressure;
L
Linus Torvalds 已提交
524 525
}

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
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 已提交
541 542 543 544 545
/*
 * Look up a process' credentials in the authentication cache
 */
struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
546
		int flags)
L
Linus Torvalds 已提交
547
{
548
	LIST_HEAD(free);
L
Linus Torvalds 已提交
549
	struct rpc_cred_cache *cache = auth->au_credcache;
550 551
	struct rpc_cred	*cred = NULL,
			*entry, *new;
552 553
	unsigned int nr;

554
	nr = hash_long(from_kuid(&init_user_ns, acred->uid), cache->hashbits);
L
Linus Torvalds 已提交
555

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

577
	if (cred != NULL)
578
		goto found;
L
Linus Torvalds 已提交
579

580 581 582
	if (flags & RPCAUTH_LOOKUP_RCU)
		return ERR_PTR(-ECHILD);

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

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

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

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

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

639 640 641 642 643
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);
644
	INIT_LIST_HEAD(&cred->cr_lru);
645 646 647 648
	atomic_set(&cred->cr_count, 1);
	cred->cr_auth = auth;
	cred->cr_ops = ops;
	cred->cr_expire = jiffies;
J
Jeff Layton 已提交
649
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
650 651 652 653
	cred->cr_magic = RPCAUTH_CRED_MAGIC;
#endif
	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 707 708
	if (req->rq_cred != NULL)
		put_rpccred(req->rq_cred);
	req->rq_cred = new;
709
	return 0;
L
Linus Torvalds 已提交
710 711 712 713 714
}

void
put_rpccred(struct rpc_cred *cred)
{
715
	/* Fast path for unhashed credentials */
716 717 718
	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 已提交
719
		return;
720 721
	}

722 723
	if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
		return;
724 725
	if (!list_empty(&cred->cr_lru)) {
		number_cred_unused--;
726
		list_del_init(&cred->cr_lru);
727
	}
728
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
729 730 731 732 733 734 735 736 737 738
		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;
		}
739 740
	}
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
741
	cred->cr_ops->crdestroy(cred);
742 743 744
	return;
out_nodestroy:
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
745
}
746
EXPORT_SYMBOL_GPL(put_rpccred);
L
Linus Torvalds 已提交
747

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

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

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

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

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

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

770 771 772 773 774 775 776 777 778
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 已提交
779
int
780
rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp,
781
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
782
{
783
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
784

785
	dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
L
Linus Torvalds 已提交
786 787 788 789
			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. */
790 791
	rpcauth_wrap_req_encode(encode, rqstp, data, obj);
	return 0;
L
Linus Torvalds 已提交
792 793
}

794 795 796 797 798 799 800 801 802 803
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 已提交
804
int
805
rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp,
806
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
807
{
808
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
809

810
	dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
L
Linus Torvalds 已提交
811 812 813 814 815
			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. */
816
	return rpcauth_unwrap_req_decode(decode, rqstp, data, obj);
L
Linus Torvalds 已提交
817 818 819 820 821
}

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

825 826 827 828 829 830
	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 已提交
831
	}
832
	dprintk("RPC: %5u refreshing %s cred %p\n",
833
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
834

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

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

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

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

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

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

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

	err = rpc_init_authunix();
	if (err < 0)
		goto out1;
	err = rpc_init_generic_auth();
	if (err < 0)
		goto out2;
878
	register_shrinker(&rpc_cred_shrinker);
879 880 881 882 883
	return 0;
out2:
	rpc_destroy_authunix();
out1:
	return err;
884 885
}

886
void rpcauth_remove_module(void)
887
{
888 889
	rpc_destroy_authunix();
	rpc_destroy_generic_auth();
890
	unregister_shrinker(&rpc_cred_shrinker);
891
}