auth.c 21.0 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
static const struct kernel_param_ops param_ops_hashtbl_sz = {
76 77 78 79
	.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
/*
 * 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
362
rpcauth_cred_key_to_expire(struct rpc_auth *auth, struct rpc_cred *cred)
363
{
364 365
	if (auth->au_flags & RPCAUTH_AUTH_NO_CRKEY_TIMEOUT)
		return false;
366 367 368 369 370 371
	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);

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

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

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

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

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

446 447 448

#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

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

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

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

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

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

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

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

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

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

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 已提交
526 527
}

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

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

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

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

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

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

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

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

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

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

641 642 643 644 645
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);
646
	INIT_LIST_HEAD(&cred->cr_lru);
647 648 649 650
	atomic_set(&cred->cr_count, 1);
	cred->cr_auth = auth;
	cred->cr_ops = ops;
	cred->cr_expire = jiffies;
J
Jeff Layton 已提交
651
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
652 653 654 655
	cred->cr_magic = RPCAUTH_CRED_MAGIC;
#endif
	cred->cr_uid = acred->uid;
}
656
EXPORT_SYMBOL_GPL(rpcauth_init_cred);
657

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

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

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

681
static struct rpc_cred *
682
rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
683 684 685 686 687
{
	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);
688
	return rpcauth_lookupcred(auth, lookupflags);
L
Linus Torvalds 已提交
689 690
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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