[deliverable/linux.git] / net / sunrpc / auth.c

/*
 * 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>
#include <linux/hash.h>
#include <linux/sunrpc/clnt.h>
#include <linux/spinlock.h>

#ifdef RPC_DEBUG
# define RPCDBG_FACILITY	RPCDBG_AUTH
#endif

static DEFINE_SPINLOCK(rpc_authflavor_lock);
static const struct rpc_authops *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
	&authnull_ops,		/* AUTH_NULL */
	&authunix_ops,		/* AUTH_UNIX */
	NULL,			/* others can be loadable modules */
};

static LIST_HEAD(cred_unused);
static unsigned long number_cred_unused;

static u32
pseudoflavor_to_flavor(u32 flavor) {
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		return RPC_AUTH_GSS;
	return flavor;
}

int
rpcauth_register(const struct rpc_authops *ops)
{
	rpc_authflavor_t flavor;
	int ret = -EPERM;

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
	spin_lock(&rpc_authflavor_lock);
	if (auth_flavors[flavor] == NULL) {
		auth_flavors[flavor] = ops;
		ret = 0;
	}
	spin_unlock(&rpc_authflavor_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(rpcauth_register);

int
rpcauth_unregister(const struct rpc_authops *ops)
{
	rpc_authflavor_t flavor;
	int ret = -EPERM;

	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
		return -EINVAL;
	spin_lock(&rpc_authflavor_lock);
	if (auth_flavors[flavor] == ops) {
		auth_flavors[flavor] = NULL;
		ret = 0;
	}
	spin_unlock(&rpc_authflavor_lock);
	return ret;
}
EXPORT_SYMBOL_GPL(rpcauth_unregister);

struct rpc_auth *
rpcauth_create(rpc_authflavor_t pseudoflavor, struct rpc_clnt *clnt)
{
	struct rpc_auth		*auth;
	const struct rpc_authops *ops;
	u32			flavor = pseudoflavor_to_flavor(pseudoflavor);

	auth = ERR_PTR(-EINVAL);
	if (flavor >= RPC_AUTH_MAXFLAVOR)
		goto out;

	if ((ops = auth_flavors[flavor]) == 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);
		goto out;
	}
	spin_unlock(&rpc_authflavor_lock);
	auth = ops->create(clnt, pseudoflavor);
	module_put(ops->owner);
	if (IS_ERR(auth))
		return auth;
	if (clnt->cl_auth)
		rpcauth_release(clnt->cl_auth);
	clnt->cl_auth = auth;

out:
	return auth;
}
EXPORT_SYMBOL_GPL(rpcauth_create);

void
rpcauth_release(struct rpc_auth *auth)
{
	if (!atomic_dec_and_test(&auth->au_count))
		return;
	auth->au_ops->destroy(auth);
}

static DEFINE_SPINLOCK(rpc_credcache_lock);

static void
rpcauth_unhash_cred_locked(struct rpc_cred *cred)
{
	hlist_del_rcu(&cred->cr_hash);
	smp_mb__before_clear_bit();
	clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
}

static int
rpcauth_unhash_cred(struct rpc_cred *cred)
{
	spinlock_t *cache_lock;
	int ret;

	cache_lock = &cred->cr_auth->au_credcache->lock;
	spin_lock(cache_lock);
	ret = atomic_read(&cred->cr_count) == 0;
	if (ret)
		rpcauth_unhash_cred_locked(cred);
	spin_unlock(cache_lock);
	return ret;
}

/*
 * Initialize RPC credential cache
 */
int
rpcauth_init_credcache(struct rpc_auth *auth)
{
	struct rpc_cred_cache *new;
	int i;

	new = kmalloc(sizeof(*new), GFP_KERNEL);
	if (!new)
		return -ENOMEM;
	for (i = 0; i < RPC_CREDCACHE_NR; i++)
		INIT_HLIST_HEAD(&new->hashtable[i]);
	spin_lock_init(&new->lock);
	auth->au_credcache = new;
	return 0;
}
EXPORT_SYMBOL_GPL(rpcauth_init_credcache);

/*
 * Destroy a list of credentials
 */
static inline
void rpcauth_destroy_credlist(struct list_head *head)
{
	struct rpc_cred *cred;

	while (!list_empty(head)) {
		cred = list_entry(head->next, struct rpc_cred, cr_lru);
		list_del_init(&cred->cr_lru);
		put_rpccred(cred);
	}
}

/*
 * Clear the RPC credential cache, and delete those credentials
 * that are not referenced.
 */
void
rpcauth_clear_credcache(struct rpc_cred_cache *cache)
{
	LIST_HEAD(free);
	struct hlist_head *head;
	struct rpc_cred	*cred;
	int		i;

	spin_lock(&rpc_credcache_lock);
	spin_lock(&cache->lock);
	for (i = 0; i < RPC_CREDCACHE_NR; i++) {
		head = &cache->hashtable[i];
		while (!hlist_empty(head)) {
			cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
			get_rpccred(cred);
			if (!list_empty(&cred->cr_lru)) {
				list_del(&cred->cr_lru);
				number_cred_unused--;
			}
			list_add_tail(&cred->cr_lru, &free);
			rpcauth_unhash_cred_locked(cred);
		}
	}
	spin_unlock(&cache->lock);
	spin_unlock(&rpc_credcache_lock);
	rpcauth_destroy_credlist(&free);
}

/*
 * 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);
		kfree(cache);
	}
}
EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);


#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)

/*
 * Remove stale credentials. Avoid sleeping inside the loop.
 */
static int
rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
{
	spinlock_t *cache_lock;
	struct rpc_cred *cred, *next;
	unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;

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

		/*
		 * Enforce a 60 second garbage collection moratorium
		 * Note that the cred_unused list must be time-ordered.
		 */
		if (time_in_range(cred->cr_expire, expired, jiffies) &&
		    test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0)
			return 0;

		list_del_init(&cred->cr_lru);
		number_cred_unused--;
		if (atomic_read(&cred->cr_count) != 0)
			continue;

		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);
			nr_to_scan--;
		}
		spin_unlock(cache_lock);
		if (nr_to_scan == 0)
			break;
	}
	return (number_cred_unused / 100) * sysctl_vfs_cache_pressure;
}

/*
 * Run memory cache shrinker.
 */
static int
rpcauth_cache_shrinker(int nr_to_scan, gfp_t gfp_mask)
{
	LIST_HEAD(free);
	int res;

	if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
		return (nr_to_scan == 0) ? 0 : -1;
	if (list_empty(&cred_unused))
		return 0;
	spin_lock(&rpc_credcache_lock);
	res = rpcauth_prune_expired(&free, nr_to_scan);
	spin_unlock(&rpc_credcache_lock);
	rpcauth_destroy_credlist(&free);
	return res;
}

/*
 * Look up a process' credentials in the authentication cache
 */
struct rpc_cred *
rpcauth_lookup_credcache(struct rpc_auth *auth, struct auth_cred * acred,
		int flags)
{
	LIST_HEAD(free);
	struct rpc_cred_cache *cache = auth->au_credcache;
	struct hlist_node *pos;
	struct rpc_cred	*cred = NULL,
			*entry, *new;
	unsigned int nr;

	nr = hash_long(acred->uid, RPC_CREDCACHE_HASHBITS);

	rcu_read_lock();
	hlist_for_each_entry_rcu(entry, pos, &cache->hashtable[nr], cr_hash) {
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
		spin_lock(&cache->lock);
		if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
			spin_unlock(&cache->lock);
			continue;
		}
		cred = get_rpccred(entry);
		spin_unlock(&cache->lock);
		break;
	}
	rcu_read_unlock();

	if (cred != NULL)
		goto found;

	new = auth->au_ops->crcreate(auth, acred, flags);
	if (IS_ERR(new)) {
		cred = new;
		goto out;
	}

	spin_lock(&cache->lock);
	hlist_for_each_entry(entry, pos, &cache->hashtable[nr], cr_hash) {
		if (!entry->cr_ops->crmatch(acred, entry, flags))
			continue;
		cred = get_rpccred(entry);
		break;
	}
	if (cred == NULL) {
		cred = new;
		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);
	spin_unlock(&cache->lock);
found:
	if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
	    cred->cr_ops->cr_init != NULL &&
	    !(flags & RPCAUTH_LOOKUP_NEW)) {
		int res = cred->cr_ops->cr_init(auth, cred);
		if (res < 0) {
			put_rpccred(cred);
			cred = ERR_PTR(res);
		}
	}
	rpcauth_destroy_credlist(&free);
out:
	return cred;
}
EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);

struct rpc_cred *
rpcauth_lookupcred(struct rpc_auth *auth, int flags)
{
	struct auth_cred acred;
	struct rpc_cred *ret;
	const struct cred *cred = current_cred();

	dprintk("RPC:       looking up %s cred\n",
		auth->au_ops->au_name);

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

	ret = auth->au_ops->lookup_cred(auth, &acred, flags);
	put_group_info(acred.group_info);
	return ret;
}

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);
	INIT_LIST_HEAD(&cred->cr_lru);
	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;
}
EXPORT_SYMBOL_GPL(rpcauth_init_cred);

void
rpcauth_generic_bind_cred(struct rpc_task *task, struct rpc_cred *cred, int lookupflags)
{
	task->tk_msg.rpc_cred = get_rpccred(cred);
	dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
			cred->cr_auth->au_ops->au_name, cred);
}
EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);

static void
rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
{
	struct rpc_auth *auth = task->tk_client->cl_auth;
	struct auth_cred acred = {
		.uid = 0,
		.gid = 0,
	};
	struct rpc_cred *ret;

	dprintk("RPC: %5u looking up %s cred\n",
		task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
	ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
	if (!IS_ERR(ret))
		task->tk_msg.rpc_cred = ret;
	else
		task->tk_status = PTR_ERR(ret);
}

static void
rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
{
	struct rpc_auth *auth = task->tk_client->cl_auth;
	struct rpc_cred *ret;

	dprintk("RPC: %5u looking up %s cred\n",
		task->tk_pid, auth->au_ops->au_name);
	ret = rpcauth_lookupcred(auth, lookupflags);
	if (!IS_ERR(ret))
		task->tk_msg.rpc_cred = ret;
	else
		task->tk_status = PTR_ERR(ret);
}

void
rpcauth_bindcred(struct rpc_task *task, struct rpc_cred *cred, int flags)
{
	int lookupflags = 0;

	if (flags & RPC_TASK_ASYNC)
		lookupflags |= RPCAUTH_LOOKUP_NEW;
	if (cred != NULL)
		cred->cr_ops->crbind(task, cred, lookupflags);
	else if (flags & RPC_TASK_ROOTCREDS)
		rpcauth_bind_root_cred(task, lookupflags);
	else
		rpcauth_bind_new_cred(task, lookupflags);
}

void
put_rpccred(struct rpc_cred *cred)
{
	/* Fast path for unhashed credentials */
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) == 0) {
		if (atomic_dec_and_test(&cred->cr_count))
			cred->cr_ops->crdestroy(cred);
		return;
	}

	if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
		return;
	if (!list_empty(&cred->cr_lru)) {
		number_cred_unused--;
		list_del_init(&cred->cr_lru);
	}
	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
		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;
		}
	}
	spin_unlock(&rpc_credcache_lock);
	cred->cr_ops->crdestroy(cred);
	return;
out_nodestroy:
	spin_unlock(&rpc_credcache_lock);
}
EXPORT_SYMBOL_GPL(put_rpccred);

void
rpcauth_unbindcred(struct rpc_task *task)
{
	struct rpc_cred	*cred = task->tk_msg.rpc_cred;

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

	put_rpccred(cred);
	task->tk_msg.rpc_cred = NULL;
}

__be32 *
rpcauth_marshcred(struct rpc_task *task, __be32 *p)
{
	struct rpc_cred	*cred = task->tk_msg.rpc_cred;

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

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

__be32 *
rpcauth_checkverf(struct rpc_task *task, __be32 *p)
{
	struct rpc_cred	*cred = task->tk_msg.rpc_cred;

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

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

int
rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp,
		__be32 *data, void *obj)
{
	struct rpc_cred *cred = task->tk_msg.rpc_cred;

	dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
			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. */
	return encode(rqstp, data, obj);
}

int
rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp,
		__be32 *data, void *obj)
{
	struct rpc_cred *cred = task->tk_msg.rpc_cred;

	dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
			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. */
	return decode(rqstp, data, obj);
}

int
rpcauth_refreshcred(struct rpc_task *task)
{
	struct rpc_cred	*cred = task->tk_msg.rpc_cred;
	int err;

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

	err = cred->cr_ops->crrefresh(task);
	if (err < 0)
		task->tk_status = err;
	return err;
}

void
rpcauth_invalcred(struct rpc_task *task)
{
	struct rpc_cred *cred = task->tk_msg.rpc_cred;

	dprintk("RPC: %5u invalidating %s cred %p\n",
		task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
	if (cred)
		clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
}

int
rpcauth_uptodatecred(struct rpc_task *task)
{
	struct rpc_cred *cred = task->tk_msg.rpc_cred;

	return cred == NULL ||
		test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
}

static struct shrinker rpc_cred_shrinker = {
	.shrink = rpcauth_cache_shrinker,
	.seeks = DEFAULT_SEEKS,
};

void __init rpcauth_init_module(void)
{
	rpc_init_authunix();
	rpc_init_generic_auth();
	register_shrinker(&rpc_cred_shrinker);
}

void __exit rpcauth_remove_module(void)
{
	unregister_shrinker(&rpc_cred_shrinker);
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/net/sunrpc/auth.c
	3	*
	4	* Generic RPC client authentication API.
	5	*
	6	* Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
	7	*/
	8
	9	#include <linux/types.h>
	10	#include <linux/sched.h>
	11	#include <linux/module.h>
	12	#include <linux/slab.h>
	13	#include <linux/errno.h>
25337fdc	14	#include <linux/hash.h>
1da177e4 LT	15	#include <linux/sunrpc/clnt.h>
	16	#include <linux/spinlock.h>
	17
	18	#ifdef RPC_DEBUG
	19	# define RPCDBG_FACILITY RPCDBG_AUTH
	20	#endif
	21
fc1b356f	22	static DEFINE_SPINLOCK(rpc_authflavor_lock);
f1c0a861	23	static const struct rpc_authops *auth_flavors[RPC_AUTH_MAXFLAVOR] = {
1da177e4 LT	24	&authnull_ops, /* AUTH_NULL */
	25	&authunix_ops, /* AUTH_UNIX */
	26	NULL, /* others can be loadable modules */
	27	};
	28
e092bdcd	29	static LIST_HEAD(cred_unused);
f5c2187c	30	static unsigned long number_cred_unused;
e092bdcd	31
1da177e4 LT	32	static u32
	33	pseudoflavor_to_flavor(u32 flavor) {
	34	if (flavor >= RPC_AUTH_MAXFLAVOR)
	35	return RPC_AUTH_GSS;
	36	return flavor;
	37	}
	38
	39	int
f1c0a861	40	rpcauth_register(const struct rpc_authops *ops)
1da177e4 LT	41	{
1da177e4 LT	42	rpc_authflavor_t flavor;
fc1b356f	43	int ret = -EPERM;
1da177e4 LT	44
	45	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
	46	return -EINVAL;
fc1b356f TM	47	spin_lock(&rpc_authflavor_lock);
	48	if (auth_flavors[flavor] == NULL) {
	49	auth_flavors[flavor] = ops;
	50	ret = 0;
	51	}
	52	spin_unlock(&rpc_authflavor_lock);
	53	return ret;
1da177e4	54	}
e8914c65	55	EXPORT_SYMBOL_GPL(rpcauth_register);
1da177e4 LT	56
1da177e4 LT	57	int
f1c0a861	58	rpcauth_unregister(const struct rpc_authops *ops)
1da177e4 LT	59	{
1da177e4 LT	60	rpc_authflavor_t flavor;
fc1b356f	61	int ret = -EPERM;
1da177e4 LT	62
	63	if ((flavor = ops->au_flavor) >= RPC_AUTH_MAXFLAVOR)
	64	return -EINVAL;
fc1b356f TM	65	spin_lock(&rpc_authflavor_lock);
	66	if (auth_flavors[flavor] == ops) {
	67	auth_flavors[flavor] = NULL;
	68	ret = 0;
	69	}
	70	spin_unlock(&rpc_authflavor_lock);
	71	return ret;
1da177e4	72	}
e8914c65	73	EXPORT_SYMBOL_GPL(rpcauth_unregister);
1da177e4 LT	74
	75	struct rpc_auth *
	76	rpcauth_create(rpc_authflavor_t pseudoflavor, struct rpc_clnt *clnt)
	77	{
	78	struct rpc_auth *auth;
f1c0a861	79	const struct rpc_authops *ops;
1da177e4 LT	80	u32 flavor = pseudoflavor_to_flavor(pseudoflavor);
1da177e4 LT	81
f344f6df OK	82	auth = ERR_PTR(-EINVAL);
	83	if (flavor >= RPC_AUTH_MAXFLAVOR)
	84	goto out;
	85
f344f6df OK	86	if ((ops = auth_flavors[flavor]) == NULL)
f344f6df OK	87	request_module("rpc-auth-%u", flavor);
fc1b356f TM	88	spin_lock(&rpc_authflavor_lock);
	89	ops = auth_flavors[flavor];
	90	if (ops == NULL \|\| !try_module_get(ops->owner)) {
	91	spin_unlock(&rpc_authflavor_lock);
f344f6df	92	goto out;
fc1b356f TM	93	}
fc1b356f TM	94	spin_unlock(&rpc_authflavor_lock);
1da177e4	95	auth = ops->create(clnt, pseudoflavor);
fc1b356f	96	module_put(ops->owner);
6a19275a BF	97	if (IS_ERR(auth))
6a19275a BF	98	return auth;
1da177e4	99	if (clnt->cl_auth)
de7a8ce3	100	rpcauth_release(clnt->cl_auth);
1da177e4	101	clnt->cl_auth = auth;
f344f6df OK	102
f344f6df OK	103	out:
1da177e4 LT	104	return auth;
1da177e4 LT	105	}
e8914c65	106	EXPORT_SYMBOL_GPL(rpcauth_create);
1da177e4 LT	107
1da177e4 LT	108	void
de7a8ce3	109	rpcauth_release(struct rpc_auth *auth)
1da177e4 LT	110	{
	111	if (!atomic_dec_and_test(&auth->au_count))
	112	return;
	113	auth->au_ops->destroy(auth);
	114	}
	115
	116	static DEFINE_SPINLOCK(rpc_credcache_lock);
	117
31be5bf1 TM	118	static void
	119	rpcauth_unhash_cred_locked(struct rpc_cred *cred)
	120	{
	121	hlist_del_rcu(&cred->cr_hash);
	122	smp_mb__before_clear_bit();
	123	clear_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
	124	}
	125
f0380f3d	126	static int
9499b434 TM	127	rpcauth_unhash_cred(struct rpc_cred *cred)
	128	{
	129	spinlock_t *cache_lock;
f0380f3d	130	int ret;
9499b434 TM	131
	132	cache_lock = &cred->cr_auth->au_credcache->lock;
	133	spin_lock(cache_lock);
f0380f3d TM	134	ret = atomic_read(&cred->cr_count) == 0;
f0380f3d TM	135	if (ret)
9499b434 TM	136	rpcauth_unhash_cred_locked(cred);
9499b434 TM	137	spin_unlock(cache_lock);
f0380f3d	138	return ret;
9499b434 TM	139	}
9499b434 TM	140
1da177e4 LT	141	/*
	142	* Initialize RPC credential cache
	143	*/
	144	int
f5c2187c	145	rpcauth_init_credcache(struct rpc_auth *auth)
1da177e4 LT	146	{
	147	struct rpc_cred_cache *new;
	148	int i;
	149
8b3a7005	150	new = kmalloc(sizeof(*new), GFP_KERNEL);
1da177e4 LT	151	if (!new)
	152	return -ENOMEM;
	153	for (i = 0; i < RPC_CREDCACHE_NR; i++)
	154	INIT_HLIST_HEAD(&new->hashtable[i]);
9499b434	155	spin_lock_init(&new->lock);
1da177e4 LT	156	auth->au_credcache = new;
	157	return 0;
	158	}
e8914c65	159	EXPORT_SYMBOL_GPL(rpcauth_init_credcache);
1da177e4 LT	160
	161	/*
	162	* Destroy a list of credentials
	163	*/
	164	static inline
e092bdcd	165	void rpcauth_destroy_credlist(struct list_head *head)
1da177e4 LT	166	{
	167	struct rpc_cred *cred;
	168
e092bdcd TM	169	while (!list_empty(head)) {
	170	cred = list_entry(head->next, struct rpc_cred, cr_lru);
	171	list_del_init(&cred->cr_lru);
1da177e4 LT	172	put_rpccred(cred);
	173	}
	174	}
	175
	176	/*
	177	* Clear the RPC credential cache, and delete those credentials
	178	* that are not referenced.
	179	*/
	180	void
3ab9bb72	181	rpcauth_clear_credcache(struct rpc_cred_cache *cache)
1da177e4	182	{
e092bdcd TM	183	LIST_HEAD(free);
e092bdcd TM	184	struct hlist_head *head;
1da177e4 LT	185	struct rpc_cred *cred;
	186	int i;
	187
	188	spin_lock(&rpc_credcache_lock);
9499b434	189	spin_lock(&cache->lock);
1da177e4	190	for (i = 0; i < RPC_CREDCACHE_NR; i++) {
e092bdcd TM	191	head = &cache->hashtable[i];
	192	while (!hlist_empty(head)) {
	193	cred = hlist_entry(head->first, struct rpc_cred, cr_hash);
	194	get_rpccred(cred);
f5c2187c TM	195	if (!list_empty(&cred->cr_lru)) {
	196	list_del(&cred->cr_lru);
	197	number_cred_unused--;
	198	}
	199	list_add_tail(&cred->cr_lru, &free);
31be5bf1	200	rpcauth_unhash_cred_locked(cred);
1da177e4 LT	201	}
1da177e4 LT	202	}
9499b434	203	spin_unlock(&cache->lock);
1da177e4 LT	204	spin_unlock(&rpc_credcache_lock);
	205	rpcauth_destroy_credlist(&free);
	206	}
	207
3ab9bb72 TM	208	/*
	209	* Destroy the RPC credential cache
	210	*/
	211	void
	212	rpcauth_destroy_credcache(struct rpc_auth *auth)
	213	{
	214	struct rpc_cred_cache *cache = auth->au_credcache;
	215
	216	if (cache) {
	217	auth->au_credcache = NULL;
	218	rpcauth_clear_credcache(cache);
	219	kfree(cache);
	220	}
	221	}
e8914c65	222	EXPORT_SYMBOL_GPL(rpcauth_destroy_credcache);
3ab9bb72	223
d2b83141 TM	224
	225	#define RPC_AUTH_EXPIRY_MORATORIUM (60 * HZ)
	226
e092bdcd TM	227	/*
	228	* Remove stale credentials. Avoid sleeping inside the loop.
	229	*/
f5c2187c TM	230	static int
f5c2187c TM	231	rpcauth_prune_expired(struct list_head *free, int nr_to_scan)
1da177e4	232	{
9499b434	233	spinlock_t *cache_lock;
eac0d18d	234	struct rpc_cred cred, next;
d2b83141	235	unsigned long expired = jiffies - RPC_AUTH_EXPIRY_MORATORIUM;
e092bdcd	236
eac0d18d TM	237	list_for_each_entry_safe(cred, next, &cred_unused, cr_lru) {
eac0d18d TM	238
93a05e65 TM	239	/*
	240	* Enforce a 60 second garbage collection moratorium
	241	* Note that the cred_unused list must be time-ordered.
	242	*/
3d7b0894	243	if (time_in_range(cred->cr_expire, expired, jiffies) &&
eac0d18d	244	test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0)
93a05e65	245	return 0;
eac0d18d	246
e092bdcd	247	list_del_init(&cred->cr_lru);
f5c2187c	248	number_cred_unused--;
e092bdcd TM	249	if (atomic_read(&cred->cr_count) != 0)
e092bdcd TM	250	continue;
eac0d18d	251
9499b434 TM	252	cache_lock = &cred->cr_auth->au_credcache->lock;
	253	spin_lock(cache_lock);
	254	if (atomic_read(&cred->cr_count) == 0) {
	255	get_rpccred(cred);
	256	list_add_tail(&cred->cr_lru, free);
	257	rpcauth_unhash_cred_locked(cred);
f5c2187c	258	nr_to_scan--;
9499b434 TM	259	}
9499b434 TM	260	spin_unlock(cache_lock);
f5c2187c TM	261	if (nr_to_scan == 0)
f5c2187c TM	262	break;
1da177e4	263	}
93a05e65	264	return (number_cred_unused / 100) * sysctl_vfs_cache_pressure;
1da177e4 LT	265	}
	266
	267	/*
f5c2187c	268	* Run memory cache shrinker.
1da177e4	269	*/
f5c2187c TM	270	static int
f5c2187c TM	271	rpcauth_cache_shrinker(int nr_to_scan, gfp_t gfp_mask)
1da177e4	272	{
f5c2187c TM	273	LIST_HEAD(free);
	274	int res;
	275
d300a41e TM	276	if ((gfp_mask & GFP_KERNEL) != GFP_KERNEL)
d300a41e TM	277	return (nr_to_scan == 0) ? 0 : -1;
f5c2187c TM	278	if (list_empty(&cred_unused))
f5c2187c TM	279	return 0;
31be5bf1	280	spin_lock(&rpc_credcache_lock);
93a05e65	281	res = rpcauth_prune_expired(&free, nr_to_scan);
31be5bf1	282	spin_unlock(&rpc_credcache_lock);
f5c2187c TM	283	rpcauth_destroy_credlist(&free);
f5c2187c TM	284	return res;
1da177e4 LT	285	}
	286
	287	/*
	288	* Look up a process' credentials in the authentication cache
	289	*/
	290	struct rpc_cred *
	291	rpcauth_lookup_credcache(struct rpc_auth auth, struct auth_cred acred,
8a317760	292	int flags)
1da177e4	293	{
e092bdcd	294	LIST_HEAD(free);
1da177e4	295	struct rpc_cred_cache *cache = auth->au_credcache;
e092bdcd	296	struct hlist_node *pos;
31be5bf1 TM	297	struct rpc_cred *cred = NULL,
31be5bf1 TM	298	entry, new;
25337fdc TM	299	unsigned int nr;
	300
	301	nr = hash_long(acred->uid, RPC_CREDCACHE_HASHBITS);
1da177e4	302
31be5bf1 TM	303	rcu_read_lock();
31be5bf1 TM	304	hlist_for_each_entry_rcu(entry, pos, &cache->hashtable[nr], cr_hash) {
e092bdcd TM	305	if (!entry->cr_ops->crmatch(acred, entry, flags))
e092bdcd TM	306	continue;
9499b434	307	spin_lock(&cache->lock);
31be5bf1	308	if (test_bit(RPCAUTH_CRED_HASHED, &entry->cr_flags) == 0) {
9499b434	309	spin_unlock(&cache->lock);
31be5bf1 TM	310	continue;
31be5bf1 TM	311	}
e092bdcd	312	cred = get_rpccred(entry);
9499b434	313	spin_unlock(&cache->lock);
e092bdcd	314	break;
1da177e4	315	}
31be5bf1 TM	316	rcu_read_unlock();
31be5bf1 TM	317
9499b434	318	if (cred != NULL)
31be5bf1	319	goto found;
1da177e4	320
31be5bf1 TM	321	new = auth->au_ops->crcreate(auth, acred, flags);
	322	if (IS_ERR(new)) {
	323	cred = new;
	324	goto out;
	325	}
1da177e4	326
9499b434	327	spin_lock(&cache->lock);
31be5bf1 TM	328	hlist_for_each_entry(entry, pos, &cache->hashtable[nr], cr_hash) {
	329	if (!entry->cr_ops->crmatch(acred, entry, flags))
	330	continue;
	331	cred = get_rpccred(entry);
	332	break;
	333	}
	334	if (cred == NULL) {
5fe4755e	335	cred = new;
31be5bf1 TM	336	set_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags);
	337	hlist_add_head_rcu(&cred->cr_hash, &cache->hashtable[nr]);
	338	} else
	339	list_add_tail(&new->cr_lru, &free);
9499b434	340	spin_unlock(&cache->lock);
31be5bf1	341	found:
f64f9e71 JP	342	if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
	343	cred->cr_ops->cr_init != NULL &&
	344	!(flags & RPCAUTH_LOOKUP_NEW)) {
fba3bad4 TM	345	int res = cred->cr_ops->cr_init(auth, cred);
	346	if (res < 0) {
	347	put_rpccred(cred);
	348	cred = ERR_PTR(res);
	349	}
1da177e4	350	}
31be5bf1 TM	351	rpcauth_destroy_credlist(&free);
	352	out:
	353	return cred;
1da177e4	354	}
e8914c65	355	EXPORT_SYMBOL_GPL(rpcauth_lookup_credcache);
1da177e4 LT	356
1da177e4 LT	357	struct rpc_cred *
8a317760	358	rpcauth_lookupcred(struct rpc_auth *auth, int flags)
1da177e4	359	{
86a264ab	360	struct auth_cred acred;
1da177e4	361	struct rpc_cred *ret;
86a264ab	362	const struct cred *cred = current_cred();
1da177e4	363
46121cf7	364	dprintk("RPC: looking up %s cred\n",
1da177e4	365	auth->au_ops->au_name);
86a264ab DH	366
	367	memset(&acred, 0, sizeof(acred));
	368	acred.uid = cred->fsuid;
	369	acred.gid = cred->fsgid;
	370	acred.group_info = get_group_info(((struct cred *)cred)->group_info);
	371
8a317760	372	ret = auth->au_ops->lookup_cred(auth, &acred, flags);
1da177e4 LT	373	put_group_info(acred.group_info);
	374	return ret;
	375	}
	376
5fe4755e TM	377	void
	378	rpcauth_init_cred(struct rpc_cred cred, const struct auth_cred acred,
	379	struct rpc_auth auth, const struct rpc_credops ops)
	380	{
	381	INIT_HLIST_NODE(&cred->cr_hash);
e092bdcd	382	INIT_LIST_HEAD(&cred->cr_lru);
5fe4755e TM	383	atomic_set(&cred->cr_count, 1);
	384	cred->cr_auth = auth;
	385	cred->cr_ops = ops;
	386	cred->cr_expire = jiffies;
	387	#ifdef RPC_DEBUG
	388	cred->cr_magic = RPCAUTH_CRED_MAGIC;
	389	#endif
	390	cred->cr_uid = acred->uid;
	391	}
e8914c65	392	EXPORT_SYMBOL_GPL(rpcauth_init_cred);
5fe4755e	393
5c691044	394	void
5d351754	395	rpcauth_generic_bind_cred(struct rpc_task task, struct rpc_cred cred, int lookupflags)
4ccda2cd TM	396	{
	397	task->tk_msg.rpc_cred = get_rpccred(cred);
	398	dprintk("RPC: %5u holding %s cred %p\n", task->tk_pid,
	399	cred->cr_auth->au_ops->au_name, cred);
	400	}
5c691044	401	EXPORT_SYMBOL_GPL(rpcauth_generic_bind_cred);
4ccda2cd TM	402
4ccda2cd TM	403	static void
5d351754	404	rpcauth_bind_root_cred(struct rpc_task *task, int lookupflags)
1da177e4	405	{
1be27f36	406	struct rpc_auth *auth = task->tk_client->cl_auth;
1da177e4	407	struct auth_cred acred = {
af093835 TM	408	.uid = 0,
af093835 TM	409	.gid = 0,
1da177e4 LT	410	};
	411	struct rpc_cred *ret;
	412
46121cf7	413	dprintk("RPC: %5u looking up %s cred\n",
1be27f36	414	task->tk_pid, task->tk_client->cl_auth->au_ops->au_name);
5d351754	415	ret = auth->au_ops->lookup_cred(auth, &acred, lookupflags);
af093835 TM	416	if (!IS_ERR(ret))
	417	task->tk_msg.rpc_cred = ret;
	418	else
	419	task->tk_status = PTR_ERR(ret);
	420	}
	421
4ccda2cd	422	static void
5d351754	423	rpcauth_bind_new_cred(struct rpc_task *task, int lookupflags)
af093835 TM	424	{
	425	struct rpc_auth *auth = task->tk_client->cl_auth;
	426	struct rpc_cred *ret;
	427
	428	dprintk("RPC: %5u looking up %s cred\n",
	429	task->tk_pid, auth->au_ops->au_name);
5d351754	430	ret = rpcauth_lookupcred(auth, lookupflags);
1da177e4 LT	431	if (!IS_ERR(ret))
	432	task->tk_msg.rpc_cred = ret;
	433	else
	434	task->tk_status = PTR_ERR(ret);
1da177e4 LT	435	}
	436
	437	void
4ccda2cd	438	rpcauth_bindcred(struct rpc_task task, struct rpc_cred cred, int flags)
1da177e4	439	{
5d351754 TM	440	int lookupflags = 0;
	441
	442	if (flags & RPC_TASK_ASYNC)
	443	lookupflags \|= RPCAUTH_LOOKUP_NEW;
4ccda2cd	444	if (cred != NULL)
5d351754	445	cred->cr_ops->crbind(task, cred, lookupflags);
4ccda2cd	446	else if (flags & RPC_TASK_ROOTCREDS)
5d351754	447	rpcauth_bind_root_cred(task, lookupflags);
4ccda2cd	448	else
5d351754	449	rpcauth_bind_new_cred(task, lookupflags);
1da177e4 LT	450	}
	451
	452	void
	453	put_rpccred(struct rpc_cred *cred)
	454	{
e092bdcd	455	/* Fast path for unhashed credentials */
f0380f3d TM	456	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) == 0) {
	457	if (atomic_dec_and_test(&cred->cr_count))
	458	cred->cr_ops->crdestroy(cred);
1da177e4	459	return;
f0380f3d TM	460	}
f0380f3d TM	461
e092bdcd TM	462	if (!atomic_dec_and_lock(&cred->cr_count, &rpc_credcache_lock))
e092bdcd TM	463	return;
f5c2187c TM	464	if (!list_empty(&cred->cr_lru)) {
f5c2187c TM	465	number_cred_unused--;
e092bdcd	466	list_del_init(&cred->cr_lru);
f5c2187c	467	}
5f707eb4	468	if (test_bit(RPCAUTH_CRED_HASHED, &cred->cr_flags) != 0) {
f0380f3d TM	469	if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0) {
	470	cred->cr_expire = jiffies;
	471	list_add_tail(&cred->cr_lru, &cred_unused);
	472	number_cred_unused++;
	473	goto out_nodestroy;
	474	}
	475	if (!rpcauth_unhash_cred(cred)) {
	476	/* We were hashed and someone looked us up... */
	477	goto out_nodestroy;
	478	}
e092bdcd TM	479	}
e092bdcd TM	480	spin_unlock(&rpc_credcache_lock);
1da177e4	481	cred->cr_ops->crdestroy(cred);
f0380f3d TM	482	return;
	483	out_nodestroy:
	484	spin_unlock(&rpc_credcache_lock);
1da177e4	485	}
e8914c65	486	EXPORT_SYMBOL_GPL(put_rpccred);
1da177e4 LT	487
	488	void
	489	rpcauth_unbindcred(struct rpc_task *task)
	490	{
1da177e4 LT	491	struct rpc_cred *cred = task->tk_msg.rpc_cred;
1da177e4 LT	492
46121cf7	493	dprintk("RPC: %5u releasing %s cred %p\n",
1be27f36	494	task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
1da177e4 LT	495
	496	put_rpccred(cred);
	497	task->tk_msg.rpc_cred = NULL;
	498	}
	499
d8ed029d AD	500	__be32 *
d8ed029d AD	501	rpcauth_marshcred(struct rpc_task task, __be32 p)
1da177e4	502	{
1da177e4 LT	503	struct rpc_cred *cred = task->tk_msg.rpc_cred;
1da177e4 LT	504
46121cf7	505	dprintk("RPC: %5u marshaling %s cred %p\n",
1be27f36	506	task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
0bbacc40	507
1da177e4 LT	508	return cred->cr_ops->crmarshal(task, p);
	509	}
	510
d8ed029d AD	511	__be32 *
d8ed029d AD	512	rpcauth_checkverf(struct rpc_task task, __be32 p)
1da177e4	513	{
1da177e4 LT	514	struct rpc_cred *cred = task->tk_msg.rpc_cred;
1da177e4 LT	515
46121cf7	516	dprintk("RPC: %5u validating %s cred %p\n",
1be27f36	517	task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
0bbacc40	518
1da177e4 LT	519	return cred->cr_ops->crvalidate(task, p);
	520	}
	521
	522	int
	523	rpcauth_wrap_req(struct rpc_task task, kxdrproc_t encode, void rqstp,
d8ed029d	524	__be32 data, void obj)
1da177e4 LT	525	{
	526	struct rpc_cred *cred = task->tk_msg.rpc_cred;
	527
46121cf7	528	dprintk("RPC: %5u using %s cred %p to wrap rpc data\n",
1da177e4 LT	529	task->tk_pid, cred->cr_ops->cr_name, cred);
	530	if (cred->cr_ops->crwrap_req)
	531	return cred->cr_ops->crwrap_req(task, encode, rqstp, data, obj);
	532	/* By default, we encode the arguments normally. */
88a9fe8c	533	return encode(rqstp, data, obj);
1da177e4 LT	534	}
	535
	536	int
	537	rpcauth_unwrap_resp(struct rpc_task task, kxdrproc_t decode, void rqstp,
d8ed029d	538	__be32 data, void obj)
1da177e4 LT	539	{
	540	struct rpc_cred *cred = task->tk_msg.rpc_cred;
	541
46121cf7	542	dprintk("RPC: %5u using %s cred %p to unwrap rpc data\n",
1da177e4 LT	543	task->tk_pid, cred->cr_ops->cr_name, cred);
	544	if (cred->cr_ops->crunwrap_resp)
	545	return cred->cr_ops->crunwrap_resp(task, decode, rqstp,
	546	data, obj);
	547	/* By default, we decode the arguments normally. */
88a9fe8c	548	return decode(rqstp, data, obj);
1da177e4 LT	549	}
	550
	551	int
	552	rpcauth_refreshcred(struct rpc_task *task)
	553	{
1da177e4 LT	554	struct rpc_cred *cred = task->tk_msg.rpc_cred;
	555	int err;
	556
46121cf7	557	dprintk("RPC: %5u refreshing %s cred %p\n",
1be27f36	558	task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
0bbacc40	559
1da177e4 LT	560	err = cred->cr_ops->crrefresh(task);
	561	if (err < 0)
	562	task->tk_status = err;
	563	return err;
	564	}
	565
	566	void
	567	rpcauth_invalcred(struct rpc_task *task)
	568	{
fc432dd9 TM	569	struct rpc_cred *cred = task->tk_msg.rpc_cred;
fc432dd9 TM	570
46121cf7	571	dprintk("RPC: %5u invalidating %s cred %p\n",
1be27f36	572	task->tk_pid, cred->cr_auth->au_ops->au_name, cred);
fc432dd9 TM	573	if (cred)
fc432dd9 TM	574	clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1da177e4 LT	575	}
	576
	577	int
	578	rpcauth_uptodatecred(struct rpc_task *task)
	579	{
fc432dd9 TM	580	struct rpc_cred *cred = task->tk_msg.rpc_cred;
	581
	582	return cred == NULL \|\|
	583	test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0;
1da177e4	584	}
f5c2187c	585
8e1f936b RR	586	static struct shrinker rpc_cred_shrinker = {
	587	.shrink = rpcauth_cache_shrinker,
	588	.seeks = DEFAULT_SEEKS,
	589	};
f5c2187c TM	590
	591	void __init rpcauth_init_module(void)
	592	{
	593	rpc_init_authunix();
9a559efd	594	rpc_init_generic_auth();
8e1f936b	595	register_shrinker(&rpc_cred_shrinker);
f5c2187c TM	596	}
	597
	598	void __exit rpcauth_remove_module(void)
	599	{
8e1f936b	600	unregister_shrinker(&rpc_cred_shrinker);
f5c2187c	601	}