auth.c 20.3 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>

20 21 22 23 24 25 26 27 28
#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;

29 30 31
static const struct rpc_authops __rcu *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
	[RPC_AUTH_NULL] = (const struct rpc_authops __force __rcu *)&authnull_ops,
	[RPC_AUTH_UNIX] = (const struct rpc_authops __force __rcu *)&authunix_ops,
L
Linus Torvalds 已提交
32 33 34
	NULL,			/* others can be loadable modules */
};

35
static LIST_HEAD(cred_unused);
36
static unsigned long number_cred_unused;
37

38 39
static struct cred machine_cred = {
	.usage = ATOMIC_INIT(1),
40 41 42
#ifdef CONFIG_DEBUG_CREDENTIALS
	.magic = CRED_MAGIC,
#endif
43 44 45 46 47 48
};

/*
 * Return the machine_cred pointer to be used whenever
 * the a generic machine credential is needed.
 */
49
const struct cred *rpc_machine_cred(void)
50 51 52 53 54
{
	return &machine_cred;
}
EXPORT_SYMBOL_GPL(rpc_machine_cred);

55
#define MAX_HASHTABLE_BITS (14)
56
static int param_set_hashtbl_sz(const char *val, const struct kernel_param *kp)
57 58 59 60 61 62 63
{
	unsigned long num;
	unsigned int nbits;
	int ret;

	if (!val)
		goto out_inval;
D
Daniel Walter 已提交
64
	ret = kstrtoul(val, 0, &num);
65
	if (ret)
66
		goto out_inval;
67
	nbits = fls(num - 1);
68 69 70 71 72 73 74 75
	if (nbits > MAX_HASHTABLE_BITS || nbits < 2)
		goto out_inval;
	*(unsigned int *)kp->arg = nbits;
	return 0;
out_inval:
	return -EINVAL;
}

76
static int param_get_hashtbl_sz(char *buffer, const struct kernel_param *kp)
77 78 79 80 81 82 83 84 85
{
	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);

86
static const struct kernel_param_ops param_ops_hashtbl_sz = {
87 88 89 90
	.set = param_set_hashtbl_sz,
	.get = param_get_hashtbl_sz,
};

91 92 93
module_param_named(auth_hashtable_size, auth_hashbits, hashtbl_sz, 0644);
MODULE_PARM_DESC(auth_hashtable_size, "RPC credential cache hashtable size");

94 95 96 97
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 已提交
98 99
static u32
pseudoflavor_to_flavor(u32 flavor) {
100
	if (flavor > RPC_AUTH_MAXFLAVOR)
L
Linus Torvalds 已提交
101 102 103 104 105
		return RPC_AUTH_GSS;
	return flavor;
}

int
106
rpcauth_register(const struct rpc_authops *ops)
L
Linus Torvalds 已提交
107
{
108
	const struct rpc_authops *old;
L
Linus Torvalds 已提交
109 110 111 112
	rpc_authflavor_t flavor;

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
113 114 115 116
	old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], NULL, ops);
	if (old == NULL || old == ops)
		return 0;
	return -EPERM;
L
Linus Torvalds 已提交
117
}
118
EXPORT_SYMBOL_GPL(rpcauth_register);
L
Linus Torvalds 已提交
119 120

int
121
rpcauth_unregister(const struct rpc_authops *ops)
L
Linus Torvalds 已提交
122
{
123
	const struct rpc_authops *old;
L
Linus Torvalds 已提交
124 125 126 127
	rpc_authflavor_t flavor;

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
128 129 130 131 132

	old = cmpxchg((const struct rpc_authops ** __force)&auth_flavors[flavor], ops, NULL);
	if (old == ops || old == NULL)
		return 0;
	return -EPERM;
L
Linus Torvalds 已提交
133
}
134
EXPORT_SYMBOL_GPL(rpcauth_unregister);
L
Linus Torvalds 已提交
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 165 166
static const struct rpc_authops *
rpcauth_get_authops(rpc_authflavor_t flavor)
{
	const struct rpc_authops *ops;

	if (flavor >= RPC_AUTH_MAXFLAVOR)
		return NULL;

	rcu_read_lock();
	ops = rcu_dereference(auth_flavors[flavor]);
	if (ops == NULL) {
		rcu_read_unlock();
		request_module("rpc-auth-%u", flavor);
		rcu_read_lock();
		ops = rcu_dereference(auth_flavors[flavor]);
		if (ops == NULL)
			goto out;
	}
	if (!try_module_get(ops->owner))
		ops = NULL;
out:
	rcu_read_unlock();
	return ops;
}

static void
rpcauth_put_authops(const struct rpc_authops *ops)
{
	module_put(ops->owner);
}

167 168 169 170 171 172 173 174 175 176 177 178
/**
 * 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)
{
179
	const struct rpc_authops *ops = rpcauth_get_authops(flavor);
180 181
	rpc_authflavor_t pseudoflavor;

182
	if (!ops)
183 184 185 186 187
		return RPC_AUTH_MAXFLAVOR;
	pseudoflavor = flavor;
	if (ops->info2flavor != NULL)
		pseudoflavor = ops->info2flavor(info);

188
	rpcauth_put_authops(ops);
189 190 191 192
	return pseudoflavor;
}
EXPORT_SYMBOL_GPL(rpcauth_get_pseudoflavor);

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
/**
 * 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;

208
	ops = rpcauth_get_authops(flavor);
209 210 211 212 213 214 215
	if (ops == NULL)
		return -ENOENT;

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

216
	rpcauth_put_authops(ops);
217 218 219 220
	return result;
}
EXPORT_SYMBOL_GPL(rpcauth_get_gssinfo);

C
Chuck Lever 已提交
221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * 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)
{
234 235 236
	const struct rpc_authops *ops;
	rpc_authflavor_t flavor, pseudos[4];
	int i, len, result = 0;
C
Chuck Lever 已提交
237

238
	rcu_read_lock();
C
Chuck Lever 已提交
239
	for (flavor = 0; flavor < RPC_AUTH_MAXFLAVOR; flavor++) {
240
		ops = rcu_dereference(auth_flavors[flavor]);
C
Chuck Lever 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
		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];
		}
	}
265
	rcu_read_unlock();
C
Chuck Lever 已提交
266 267 268 269
	return result;
}
EXPORT_SYMBOL_GPL(rpcauth_list_flavors);

L
Linus Torvalds 已提交
270
struct rpc_auth *
271
rpcauth_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
272
{
273
	struct rpc_auth	*auth = ERR_PTR(-EINVAL);
274
	const struct rpc_authops *ops;
275
	u32 flavor = pseudoflavor_to_flavor(args->pseudoflavor);
L
Linus Torvalds 已提交
276

277 278
	ops = rpcauth_get_authops(flavor);
	if (ops == NULL)
279 280
		goto out;

281
	auth = ops->create(args, clnt);
282 283

	rpcauth_put_authops(ops);
284 285
	if (IS_ERR(auth))
		return auth;
L
Linus Torvalds 已提交
286
	if (clnt->cl_auth)
287
		rpcauth_release(clnt->cl_auth);
L
Linus Torvalds 已提交
288
	clnt->cl_auth = auth;
289 290

out:
L
Linus Torvalds 已提交
291 292
	return auth;
}
293
EXPORT_SYMBOL_GPL(rpcauth_create);
L
Linus Torvalds 已提交
294 295

void
296
rpcauth_release(struct rpc_auth *auth)
L
Linus Torvalds 已提交
297
{
298
	if (!refcount_dec_and_test(&auth->au_count))
L
Linus Torvalds 已提交
299 300 301 302 303 304
		return;
	auth->au_ops->destroy(auth);
}

static DEFINE_SPINLOCK(rpc_credcache_lock);

305 306 307 308 309
/*
 * On success, the caller is responsible for freeing the reference
 * held by the hashtable
 */
static bool
310 311
rpcauth_unhash_cred_locked(struct rpc_cred *cred)
{
312 313
	if (!test_and_clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
		return false;
314
	hlist_del_rcu(&cred->cr_hash);
315
	return true;
316 317
}

318
static bool
319 320 321
rpcauth_unhash_cred(struct rpc_cred *cred)
{
	spinlock_t *cache_lock;
322
	bool ret;
323

324 325
	if (!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
		return false;
326 327
	cache_lock = &cred->cr_auth->au_credcache->lock;
	spin_lock(cache_lock);
328
	ret = rpcauth_unhash_cred_locked(cred);
329
	spin_unlock(cache_lock);
330
	return ret;
331 332
}

L
Linus Torvalds 已提交
333 334 335 336
/*
 * Initialize RPC credential cache
 */
int
337
rpcauth_init_credcache(struct rpc_auth *auth)
L
Linus Torvalds 已提交
338 339
{
	struct rpc_cred_cache *new;
340
	unsigned int hashsize;
L
Linus Torvalds 已提交
341

342
	new = kmalloc(sizeof(*new), GFP_KERNEL);
L
Linus Torvalds 已提交
343
	if (!new)
344 345
		goto out_nocache;
	new->hashbits = auth_hashbits;
346
	hashsize = 1U << new->hashbits;
347 348 349
	new->hashtable = kcalloc(hashsize, sizeof(new->hashtable[0]), GFP_KERNEL);
	if (!new->hashtable)
		goto out_nohashtbl;
350
	spin_lock_init(&new->lock);
L
Linus Torvalds 已提交
351 352
	auth->au_credcache = new;
	return 0;
353 354 355 356
out_nohashtbl:
	kfree(new);
out_nocache:
	return -ENOMEM;
L
Linus Torvalds 已提交
357
}
358
EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
L
Linus Torvalds 已提交
359

360 361 362 363 364 365 366 367 368
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 已提交
369 370 371 372
/*
 * Destroy a list of credentials
 */
static inline
373
void rpcauth_destroy_credlist(struct list_head *head)
L
Linus Torvalds 已提交
374 375 376
{
	struct rpc_cred *cred;

377 378 379
	while (!list_empty(head)) {
		cred = list_entry(head->next, struct rpc_cred, cr_lru);
		list_del_init(&cred->cr_lru);
L
Linus Torvalds 已提交
380 381 382 383
		put_rpccred(cred);
	}
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
static void
rpcauth_lru_add_locked(struct rpc_cred *cred)
{
	if (!list_empty(&cred->cr_lru))
		return;
	number_cred_unused++;
	list_add_tail(&cred->cr_lru, &cred_unused);
}

static void
rpcauth_lru_add(struct rpc_cred *cred)
{
	if (!list_empty(&cred->cr_lru))
		return;
	spin_lock(&rpc_credcache_lock);
	rpcauth_lru_add_locked(cred);
	spin_unlock(&rpc_credcache_lock);
}

static void
rpcauth_lru_remove_locked(struct rpc_cred *cred)
{
	if (list_empty(&cred->cr_lru))
		return;
	number_cred_unused--;
	list_del_init(&cred->cr_lru);
}

static void
rpcauth_lru_remove(struct rpc_cred *cred)
{
	if (list_empty(&cred->cr_lru))
		return;
	spin_lock(&rpc_credcache_lock);
	rpcauth_lru_remove_locked(cred);
	spin_unlock(&rpc_credcache_lock);
}

L
Linus Torvalds 已提交
422 423 424 425 426
/*
 * Clear the RPC credential cache, and delete those credentials
 * that are not referenced.
 */
void
427
rpcauth_clear_credcache(struct rpc_cred_cache *cache)
L
Linus Torvalds 已提交
428
{
429 430
	LIST_HEAD(free);
	struct hlist_head *head;
L
Linus Torvalds 已提交
431
	struct rpc_cred	*cred;
432
	unsigned int hashsize = 1U << cache->hashbits;
L
Linus Torvalds 已提交
433 434 435
	int		i;

	spin_lock(&rpc_credcache_lock);
436
	spin_lock(&cache->lock);
437
	for (i = 0; i < hashsize; i++) {
438 439 440
		head = &cache->hashtable[i];
		while (!hlist_empty(head)) {
			cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
441
			rpcauth_unhash_cred_locked(cred);
442 443 444
			/* Note: We now hold a reference to cred */
			rpcauth_lru_remove_locked(cred);
			list_add_tail(&cred->cr_lru, &free);
L
Linus Torvalds 已提交
445 446
		}
	}
447
	spin_unlock(&cache->lock);
L
Linus Torvalds 已提交
448 449 450 451
	spin_unlock(&rpc_credcache_lock);
	rpcauth_destroy_credlist(&free);
}

452 453 454 455 456 457 458 459 460 461 462
/*
 * 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);
463
		kfree(cache->hashtable);
464 465 466
		kfree(cache);
	}
}
467
EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
468

469 470 471

#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

472 473 474
/*
 * Remove stale credentials. Avoid sleeping inside the loop.
 */
475
static long
476
rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
L
Linus Torvalds 已提交
477
{
478
	struct rpc_cred *cred, *next;
479
	unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
480
	long freed = 0;
481

482 483
	list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {

484 485
		if (nr_to_scan-- == 0)
			break;
486
		if (refcount_read(&cred->cr_count) > 1) {
487 488 489
			rpcauth_lru_remove_locked(cred);
			continue;
		}
490 491 492 493
		/*
		 * Enforce a 60 second garbage collection moratorium
		 * Note that the cred_unused list must be time-ordered.
		 */
494 495 496
		if (!time_in_range(cred->cr_expire, expired, jiffies))
			continue;
		if (!rpcauth_unhash_cred(cred))
497
			continue;
498

499 500 501
		rpcauth_lru_remove_locked(cred);
		freed++;
		list_add_tail(&cred->cr_lru, free);
L
Linus Torvalds 已提交
502
	}
503
	return freed ? freed : SHRINK_STOP;
L
Linus Torvalds 已提交
504 505
}

506 507 508 509 510 511 512 513 514 515 516 517 518 519
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 已提交
520
/*
521
 * Run memory cache shrinker.
L
Linus Torvalds 已提交
522
 */
523 524 525
static unsigned long
rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)

L
Linus Torvalds 已提交
526
{
527 528
	if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
		return SHRINK_STOP;
529

530
	/* nothing left, don't come back */
531
	if (list_empty(&cred_unused))
532 533
		return SHRINK_STOP;

534
	return rpcauth_cache_do_shrink(sc->nr_to_scan);
535 536 537 538 539 540
}

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

{
541
	return number_cred_unused * sysctl_vfs_cache_pressure / 100;
L
Linus Torvalds 已提交
542 543
}

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
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 已提交
559 560 561 562 563
/*
 * Look up a process' credentials in the authentication cache
 */
struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
564
		int flags, gfp_t gfp)
L
Linus Torvalds 已提交
565
{
566
	LIST_HEAD(free);
L
Linus Torvalds 已提交
567
	struct rpc_cred_cache *cache = auth->au_credcache;
568 569
	struct rpc_cred	*cred = NULL,
			*entry, *new;
570 571
	unsigned int nr;

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

574
	rcu_read_lock();
575
	hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
576 577 578
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
		cred = get_rpccred(entry);
T
Trond Myklebust 已提交
579 580
		if (cred)
			break;
L
Linus Torvalds 已提交
581
	}
582 583
	rcu_read_unlock();

584
	if (cred != NULL)
585
		goto found;
L
Linus Torvalds 已提交
586

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

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

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

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

640 641 642 643 644
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);
645
	INIT_LIST_HEAD(&cred->cr_lru);
646
	refcount_set(&cred->cr_count, 1);
647
	cred->cr_auth = auth;
N
NeilBrown 已提交
648
	cred->cr_flags = 0;
649 650
	cred->cr_ops = ops;
	cred->cr_expire = jiffies;
651
	cred->cr_cred = get_cred(acred->cred);
652
}
653
EXPORT_SYMBOL_GPL(rpcauth_init_cred);
654

655
static struct rpc_cred *
656
rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
L
Linus Torvalds 已提交
657
{
658
	struct rpc_auth *auth = task->tk_client->cl_auth;
L
Linus Torvalds 已提交
659
	struct auth_cred acred = {
660
		.cred = get_task_cred(&init_task),
L
Linus Torvalds 已提交
661
	};
662
	struct rpc_cred *ret;
L
Linus Torvalds 已提交
663

664 665 666
	ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
	put_cred(acred.cred);
	return ret;
667 668
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682
static struct rpc_cred *
rpcauth_bind_machine_cred(struct rpc_task *task, int lookupflags)
{
	struct rpc_auth *auth = task->tk_client->cl_auth;
	struct auth_cred acred = {
		.principal = task->tk_client->cl_principal,
		.cred = init_task.cred,
	};

	if (!acred.principal)
		return NULL;
	return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
}

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

688
	return rpcauth_lookupcred(auth, lookupflags);
L
Linus Torvalds 已提交
689 690
}

691
static int
692
rpcauth_bindcred(struct rpc_task *task, const struct cred *cred, int flags)
L
Linus Torvalds 已提交
693
{
694
	struct rpc_rqst *req = task->tk_rqstp;
695
	struct rpc_cred *new = NULL;
696
	int lookupflags = 0;
697 698 699 700
	struct rpc_auth *auth = task->tk_client->cl_auth;
	struct auth_cred acred = {
		.cred = cred,
	};
701 702 703

	if (flags & RPC_TASK_ASYNC)
		lookupflags |= RPCAUTH_LOOKUP_NEW;
704 705
	if (task->tk_op_cred)
		/* Task must use exactly this rpc_cred */
706
		new = get_rpccred(task->tk_op_cred);
707
	else if (cred != NULL && cred != &machine_cred)
708
		new = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
709 710 711 712 713 714 715
	else if (cred == &machine_cred)
		new = rpcauth_bind_machine_cred(task, lookupflags);

	/* If machine cred couldn't be bound, try a root cred */
	if (new)
		;
	else if (cred == &machine_cred || (flags & RPC_TASK_ROOTCREDS))
716
		new = rpcauth_bind_root_cred(task, lookupflags);
717 718
	else if (flags & RPC_TASK_NULLCREDS)
		new = authnull_ops.lookup_cred(NULL, NULL, 0);
719
	else
720 721 722
		new = rpcauth_bind_new_cred(task, lookupflags);
	if (IS_ERR(new))
		return PTR_ERR(new);
723
	put_rpccred(req->rq_cred);
724
	req->rq_cred = new;
725
	return 0;
L
Linus Torvalds 已提交
726 727 728 729 730
}

void
put_rpccred(struct rpc_cred *cred)
{
731 732
	if (cred == NULL)
		return;
733
	rcu_read_lock();
734
	if (refcount_dec_and_test(&cred->cr_count))
735
		goto destroy;
736
	if (refcount_read(&cred->cr_count) != 1 ||
737 738 739 740 741 742 743 744 745 746
	    !test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags))
		goto out;
	if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
		cred->cr_expire = jiffies;
		rpcauth_lru_add(cred);
		/* Race breaker */
		if (unlikely(!test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags)))
			rpcauth_lru_remove(cred);
	} else if (rpcauth_unhash_cred(cred)) {
		rpcauth_lru_remove(cred);
747
		if (refcount_dec_and_test(&cred->cr_count))
748
			goto destroy;
749
	}
750 751
out:
	rcu_read_unlock();
752
	return;
753 754 755
destroy:
	rcu_read_unlock();
	cred->cr_ops->crdestroy(cred);
L
Linus Torvalds 已提交
756
}
757
EXPORT_SYMBOL_GPL(put_rpccred);
L
Linus Torvalds 已提交
758

759 760
__be32 *
rpcauth_marshcred(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 765 766

	return cred->cr_ops->crmarshal(task, p);
}

767 768
__be32 *
rpcauth_checkverf(struct rpc_task *task, __be32 *p)
L
Linus Torvalds 已提交
769
{
770
	struct rpc_cred	*cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
771 772 773 774

	return cred->cr_ops->crvalidate(task, p);
}

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;

C
Chuck Lever 已提交
780
	xdr_init_encode(&xdr, &rqstp->rq_snd_buf, data, rqstp);
781 782 783
	encode(rqstp, &xdr, obj);
}

L
Linus Torvalds 已提交
784
int
785
rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp,
786
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
787
{
788
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
789 790 791 792

	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
static int
rpcauth_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
			  __be32 *data, void *obj)
{
	struct xdr_stream xdr;

C
Chuck Lever 已提交
803
	xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, data, rqstp);
804 805 806
	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 814 815 816

	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 823 824 825 826 827 828 829
bool
rpcauth_xmit_need_reencode(struct rpc_task *task)
{
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;

	if (!cred || !cred->cr_ops->crneed_reencode)
		return false;
	return cred->cr_ops->crneed_reencode(task);
}

L
Linus Torvalds 已提交
830 831 832
int
rpcauth_refreshcred(struct rpc_task *task)
{
833
	struct rpc_cred	*cred;
L
Linus Torvalds 已提交
834 835
	int err;

836 837 838 839 840 841
	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 已提交
842
	}
843

L
Linus Torvalds 已提交
844
	err = cred->cr_ops->crrefresh(task);
845
out:
L
Linus Torvalds 已提交
846 847 848 849 850 851 852 853
	if (err < 0)
		task->tk_status = err;
	return err;
}

void
rpcauth_invalcred(struct rpc_task *task)
{
854
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
855 856 857

	if (cred)
		clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
L
Linus Torvalds 已提交
858 859 860 861 862
}

int
rpcauth_uptodatecred(struct rpc_task *task)
{
863
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
864 865 866

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

869
static struct shrinker rpc_cred_shrinker = {
870 871
	.count_objects = rpcauth_cache_shrink_count,
	.scan_objects = rpcauth_cache_shrink_scan,
872 873
	.seeks = DEFAULT_SEEKS,
};
874

875
int __init rpcauth_init_module(void)
876
{
877 878 879 880 881
	int err;

	err = rpc_init_authunix();
	if (err < 0)
		goto out1;
882 883
	err = register_shrinker(&rpc_cred_shrinker);
	if (err < 0)
N
NeilBrown 已提交
884
		goto out2;
885 886 887 888 889
	return 0;
out2:
	rpc_destroy_authunix();
out1:
	return err;
890 891
}

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