auth.c 20.1 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 19 20 21 22
#include <linux/spinlock.h>

#ifdef RPC_DEBUG
# 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 51 52 53 54 55 56 57 58 59 60 61 62 63 64
{
	unsigned long num;
	unsigned int nbits;
	int ret;

	if (!val)
		goto out_inval;
	ret = strict_strtoul(val, 0, &num);
	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");

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

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

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

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

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
116 117 118 119 120 121 122
	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 已提交
123
}
124
EXPORT_SYMBOL_GPL(rpcauth_unregister);
L
Linus Torvalds 已提交
125

126 127 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
/**
 * 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);

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/**
 * 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;

176 177 178
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;

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

259 260 261 262 263 264
	auth = ERR_PTR(-EINVAL);
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		goto out;

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

out:
L
Linus Torvalds 已提交
281 282
	return auth;
}
283
EXPORT_SYMBOL_GPL(rpcauth_create);
L
Linus Torvalds 已提交
284 285

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

static DEFINE_SPINLOCK(rpc_credcache_lock);

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

303
static int
304 305 306
rpcauth_unhash_cred(struct rpc_cred *cred)
{
	spinlock_t *cache_lock;
307
	int ret;
308 309 310

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

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

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

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
/*
 * 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);

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

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

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

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

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

440 441 442

#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

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

454 455
	list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {

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

466
		list_del_init(&cred->cr_lru);
467
		number_cred_unused--;
468
		freed++;
469 470
		if (atomic_read(&cred->cr_count) != 0)
			continue;
471

472 473 474 475 476 477 478 479
		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 已提交
480
	}
481
	return freed;
L
Linus Torvalds 已提交
482 483 484
}

/*
485
 * Run memory cache shrinker.
L
Linus Torvalds 已提交
486
 */
487 488 489
static unsigned long
rpcauth_cache_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)

L
Linus Torvalds 已提交
490
{
491
	LIST_HEAD(free);
492 493 494 495
	unsigned long freed;

	if ((sc->gfp_mask & GFP_KERNEL) != GFP_KERNEL)
		return SHRINK_STOP;
496

497
	/* nothing left, don't come back */
498
	if (list_empty(&cred_unused))
499 500
		return SHRINK_STOP;

501
	spin_lock(&rpc_credcache_lock);
502
	freed = rpcauth_prune_expired(&free, sc->nr_to_scan);
503
	spin_unlock(&rpc_credcache_lock);
504
	rpcauth_destroy_credlist(&free);
505 506 507 508 509 510 511 512 513

	return freed;
}

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 已提交
514 515 516 517 518 519 520
}

/*
 * Look up a process' credentials in the authentication cache
 */
struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
521
		int flags)
L
Linus Torvalds 已提交
522
{
523
	LIST_HEAD(free);
L
Linus Torvalds 已提交
524
	struct rpc_cred_cache *cache = auth->au_credcache;
525 526
	struct rpc_cred	*cred = NULL,
			*entry, *new;
527 528
	unsigned int nr;

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

531
	rcu_read_lock();
532
	hlist_for_each_entry_rcu(entry, &cache->hashtable[nr], cr_hash) {
533 534
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
535
		spin_lock(&cache->lock);
536
		if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
537
			spin_unlock(&cache->lock);
538 539
			continue;
		}
540
		cred = get_rpccred(entry);
541
		spin_unlock(&cache->lock);
542
		break;
L
Linus Torvalds 已提交
543
	}
544 545
	rcu_read_unlock();

546
	if (cred != NULL)
547
		goto found;
L
Linus Torvalds 已提交
548

549 550 551 552 553
	new = auth->au_ops->crcreate(auth, acred, flags);
	if (IS_ERR(new)) {
		cred = new;
		goto out;
	}
L
Linus Torvalds 已提交
554

555
	spin_lock(&cache->lock);
556
	hlist_for_each_entry(entry, &cache->hashtable[nr], cr_hash) {
557 558 559 560 561 562
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
		cred = get_rpccred(entry);
		break;
	}
	if (cred == NULL) {
563
		cred = new;
564 565 566 567
		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);
568
	spin_unlock(&cache->lock);
569
found:
570 571 572
	if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
	    cred->cr_ops->cr_init != NULL &&
	    !(flags & RPCAUTH_LOOKUP_NEW)) {
573 574 575 576 577
		int res = cred->cr_ops->cr_init(auth, cred);
		if (res < 0) {
			put_rpccred(cred);
			cred = ERR_PTR(res);
		}
L
Linus Torvalds 已提交
578
	}
579 580 581
	rpcauth_destroy_credlist(&free);
out:
	return cred;
L
Linus Torvalds 已提交
582
}
583
EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
L
Linus Torvalds 已提交
584 585

struct rpc_cred *
586
rpcauth_lookupcred(struct rpc_auth *auth, int flags)
L
Linus Torvalds 已提交
587
{
588
	struct auth_cred acred;
L
Linus Torvalds 已提交
589
	struct rpc_cred *ret;
590
	const struct cred *cred = current_cred();
L
Linus Torvalds 已提交
591

592
	dprintk("RPC:       looking up %s cred\n",
L
Linus Torvalds 已提交
593
		auth->au_ops->au_name);
594 595 596 597 598 599

	memset(&acred, 0, sizeof(acred));
	acred.uid = cred->fsuid;
	acred.gid = cred->fsgid;
	acred.group_info = get_group_info(((struct cred *)cred)->group_info);

600
	ret = auth->au_ops->lookup_cred(auth, &acred, flags);
L
Linus Torvalds 已提交
601 602 603
	put_group_info(acred.group_info);
	return ret;
}
604
EXPORT_SYMBOL_GPL(rpcauth_lookupcred);
L
Linus Torvalds 已提交
605

606 607 608 609 610
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);
611
	INIT_LIST_HEAD(&cred->cr_lru);
612 613 614 615 616 617 618 619 620
	atomic_set(&cred->cr_count, 1);
	cred->cr_auth = auth;
	cred->cr_ops = ops;
	cred->cr_expire = jiffies;
#ifdef RPC_DEBUG
	cred->cr_magic = RPCAUTH_CRED_MAGIC;
#endif
	cred->cr_uid = acred->uid;
}
621
EXPORT_SYMBOL_GPL(rpcauth_init_cred);
622

623
struct rpc_cred *
624
rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred, int lookupflags)
625 626 627
{
	dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
			cred->cr_auth->au_ops->au_name, cred);
628
	return get_rpccred(cred);
629
}
630
EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
631

632
static struct rpc_cred *
633
rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
L
Linus Torvalds 已提交
634
{
635
	struct rpc_auth *auth = task->tk_client->cl_auth;
L
Linus Torvalds 已提交
636
	struct auth_cred acred = {
637 638
		.uid = GLOBAL_ROOT_UID,
		.gid = GLOBAL_ROOT_GID,
L
Linus Torvalds 已提交
639 640
	};

641
	dprintk("RPC: %5u looking up %s cred\n",
642
		task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
643
	return auth->au_ops->lookup_cred(auth, &acred, lookupflags);
644 645
}

646
static struct rpc_cred *
647
rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
648 649 650 651 652
{
	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);
653
	return rpcauth_lookupcred(auth, lookupflags);
L
Linus Torvalds 已提交
654 655
}

656
static int
657
rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
L
Linus Torvalds 已提交
658
{
659
	struct rpc_rqst *req = task->tk_rqstp;
660
	struct rpc_cred *new;
661 662 663 664
	int lookupflags = 0;

	if (flags & RPC_TASK_ASYNC)
		lookupflags |= RPCAUTH_LOOKUP_NEW;
665
	if (cred != NULL)
666
		new = cred->cr_ops->crbind(task, cred, lookupflags);
667
	else if (flags & RPC_TASK_ROOTCREDS)
668
		new = rpcauth_bind_root_cred(task, lookupflags);
669
	else
670 671 672
		new = rpcauth_bind_new_cred(task, lookupflags);
	if (IS_ERR(new))
		return PTR_ERR(new);
673 674 675
	if (req->rq_cred != NULL)
		put_rpccred(req->rq_cred);
	req->rq_cred = new;
676
	return 0;
L
Linus Torvalds 已提交
677 678 679 680 681
}

void
put_rpccred(struct rpc_cred *cred)
{
682
	/* Fast path for unhashed credentials */
683 684 685
	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 已提交
686
		return;
687 688
	}

689 690
	if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
		return;
691 692
	if (!list_empty(&cred->cr_lru)) {
		number_cred_unused--;
693
		list_del_init(&cred->cr_lru);
694
	}
695
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
696 697 698 699 700 701 702 703 704 705
		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;
		}
706 707
	}
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
708
	cred->cr_ops->crdestroy(cred);
709 710 711
	return;
out_nodestroy:
	spin_unlock(&rpc_credcache_lock);
L
Linus Torvalds 已提交
712
}
713
EXPORT_SYMBOL_GPL(put_rpccred);
L
Linus Torvalds 已提交
714

715 716
__be32 *
rpcauth_marshcred(struct rpc_task *task, __be32 *p)
L
Linus Torvalds 已提交
717
{
718
	struct rpc_cred	*cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
719

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

L
Linus Torvalds 已提交
723 724 725
	return cred->cr_ops->crmarshal(task, p);
}

726 727
__be32 *
rpcauth_checkverf(struct rpc_task *task, __be32 *p)
L
Linus Torvalds 已提交
728
{
729
	struct rpc_cred	*cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
730

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

L
Linus Torvalds 已提交
734 735 736
	return cred->cr_ops->crvalidate(task, p);
}

737 738 739 740 741 742 743 744 745
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 已提交
746
int
747
rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp,
748
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
749
{
750
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
751

752
	dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
L
Linus Torvalds 已提交
753 754 755 756
			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. */
757 758
	rpcauth_wrap_req_encode(encode, rqstp, data, obj);
	return 0;
L
Linus Torvalds 已提交
759 760
}

761 762 763 764 765 766 767 768 769 770
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 已提交
771
int
772
rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp,
773
		__be32 *data, void *obj)
L
Linus Torvalds 已提交
774
{
775
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
L
Linus Torvalds 已提交
776

777
	dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
L
Linus Torvalds 已提交
778 779 780 781 782
			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. */
783
	return rpcauth_unwrap_req_decode(decode, rqstp, data, obj);
L
Linus Torvalds 已提交
784 785 786 787 788
}

int
rpcauth_refreshcred(struct rpc_task *task)
{
789
	struct rpc_cred	*cred;
L
Linus Torvalds 已提交
790 791
	int err;

792 793 794 795 796 797
	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 已提交
798
	}
799
	dprintk("RPC: %5u refreshing %s cred %p\n",
800
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
801

L
Linus Torvalds 已提交
802
	err = cred->cr_ops->crrefresh(task);
803
out:
L
Linus Torvalds 已提交
804 805 806 807 808 809 810 811
	if (err < 0)
		task->tk_status = err;
	return err;
}

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

814
	dprintk("RPC: %5u invalidating %s cred %p\n",
815
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
816 817
	if (cred)
		clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
L
Linus Torvalds 已提交
818 819 820 821 822
}

int
rpcauth_uptodatecred(struct rpc_task *task)
{
823
	struct rpc_cred *cred = task->tk_rqstp->rq_cred;
824 825 826

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

829
static struct shrinker rpc_cred_shrinker = {
830 831
	.count_objects = rpcauth_cache_shrink_count,
	.scan_objects = rpcauth_cache_shrink_scan,
832 833
	.seeks = DEFAULT_SEEKS,
};
834

835
int __init rpcauth_init_module(void)
836
{
837 838 839 840 841 842 843 844
	int err;

	err = rpc_init_authunix();
	if (err < 0)
		goto out1;
	err = rpc_init_generic_auth();
	if (err < 0)
		goto out2;
845
	register_shrinker(&rpc_cred_shrinker);
846 847 848 849 850
	return 0;
out2:
	rpc_destroy_authunix();
out1:
	return err;
851 852
}

853
void rpcauth_remove_module(void)
854
{
855 856
	rpc_destroy_authunix();
	rpc_destroy_generic_auth();
857
	unregister_shrinker(&rpc_cred_shrinker);
858
}