xref: /openbmc/linux/security/keys/keyring.c (revision 3e30148c3d524a9c1c63ca28261bc24c457eb07a)
11da177e4SLinus Torvalds /* keyring.c: keyring handling
21da177e4SLinus Torvalds  *
3*3e30148cSDavid Howells  * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
41da177e4SLinus Torvalds  * Written by David Howells (dhowells@redhat.com)
51da177e4SLinus Torvalds  *
61da177e4SLinus Torvalds  * This program is free software; you can redistribute it and/or
71da177e4SLinus Torvalds  * modify it under the terms of the GNU General Public License
81da177e4SLinus Torvalds  * as published by the Free Software Foundation; either version
91da177e4SLinus Torvalds  * 2 of the License, or (at your option) any later version.
101da177e4SLinus Torvalds  */
111da177e4SLinus Torvalds 
121da177e4SLinus Torvalds #include <linux/module.h>
131da177e4SLinus Torvalds #include <linux/init.h>
141da177e4SLinus Torvalds #include <linux/sched.h>
151da177e4SLinus Torvalds #include <linux/slab.h>
161da177e4SLinus Torvalds #include <linux/seq_file.h>
171da177e4SLinus Torvalds #include <linux/err.h>
181da177e4SLinus Torvalds #include <asm/uaccess.h>
191da177e4SLinus Torvalds #include "internal.h"
201da177e4SLinus Torvalds 
211da177e4SLinus Torvalds /*
221da177e4SLinus Torvalds  * when plumbing the depths of the key tree, this sets a hard limit set on how
231da177e4SLinus Torvalds  * deep we're willing to go
241da177e4SLinus Torvalds  */
251da177e4SLinus Torvalds #define KEYRING_SEARCH_MAX_DEPTH 6
261da177e4SLinus Torvalds 
271da177e4SLinus Torvalds /*
281da177e4SLinus Torvalds  * we keep all named keyrings in a hash to speed looking them up
291da177e4SLinus Torvalds  */
301da177e4SLinus Torvalds #define KEYRING_NAME_HASH_SIZE	(1 << 5)
311da177e4SLinus Torvalds 
321da177e4SLinus Torvalds static struct list_head	keyring_name_hash[KEYRING_NAME_HASH_SIZE];
331da177e4SLinus Torvalds static DEFINE_RWLOCK(keyring_name_lock);
341da177e4SLinus Torvalds 
351da177e4SLinus Torvalds static inline unsigned keyring_hash(const char *desc)
361da177e4SLinus Torvalds {
371da177e4SLinus Torvalds 	unsigned bucket = 0;
381da177e4SLinus Torvalds 
391da177e4SLinus Torvalds 	for (; *desc; desc++)
401da177e4SLinus Torvalds 		bucket += (unsigned char) *desc;
411da177e4SLinus Torvalds 
421da177e4SLinus Torvalds 	return bucket & (KEYRING_NAME_HASH_SIZE - 1);
431da177e4SLinus Torvalds }
441da177e4SLinus Torvalds 
451da177e4SLinus Torvalds /*
461da177e4SLinus Torvalds  * the keyring type definition
471da177e4SLinus Torvalds  */
481da177e4SLinus Torvalds static int keyring_instantiate(struct key *keyring,
491da177e4SLinus Torvalds 			       const void *data, size_t datalen);
501da177e4SLinus Torvalds static int keyring_duplicate(struct key *keyring, const struct key *source);
511da177e4SLinus Torvalds static int keyring_match(const struct key *keyring, const void *criterion);
521da177e4SLinus Torvalds static void keyring_destroy(struct key *keyring);
531da177e4SLinus Torvalds static void keyring_describe(const struct key *keyring, struct seq_file *m);
541da177e4SLinus Torvalds static long keyring_read(const struct key *keyring,
551da177e4SLinus Torvalds 			 char __user *buffer, size_t buflen);
561da177e4SLinus Torvalds 
571da177e4SLinus Torvalds struct key_type key_type_keyring = {
581da177e4SLinus Torvalds 	.name		= "keyring",
591da177e4SLinus Torvalds 	.def_datalen	= sizeof(struct keyring_list),
601da177e4SLinus Torvalds 	.instantiate	= keyring_instantiate,
611da177e4SLinus Torvalds 	.duplicate	= keyring_duplicate,
621da177e4SLinus Torvalds 	.match		= keyring_match,
631da177e4SLinus Torvalds 	.destroy	= keyring_destroy,
641da177e4SLinus Torvalds 	.describe	= keyring_describe,
651da177e4SLinus Torvalds 	.read		= keyring_read,
661da177e4SLinus Torvalds };
671da177e4SLinus Torvalds 
681da177e4SLinus Torvalds /*
691da177e4SLinus Torvalds  * semaphore to serialise link/link calls to prevent two link calls in parallel
701da177e4SLinus Torvalds  * introducing a cycle
711da177e4SLinus Torvalds  */
721da177e4SLinus Torvalds DECLARE_RWSEM(keyring_serialise_link_sem);
731da177e4SLinus Torvalds 
741da177e4SLinus Torvalds /*****************************************************************************/
751da177e4SLinus Torvalds /*
761da177e4SLinus Torvalds  * publish the name of a keyring so that it can be found by name (if it has
771da177e4SLinus Torvalds  * one)
781da177e4SLinus Torvalds  */
791da177e4SLinus Torvalds void keyring_publish_name(struct key *keyring)
801da177e4SLinus Torvalds {
811da177e4SLinus Torvalds 	int bucket;
821da177e4SLinus Torvalds 
831da177e4SLinus Torvalds 	if (keyring->description) {
841da177e4SLinus Torvalds 		bucket = keyring_hash(keyring->description);
851da177e4SLinus Torvalds 
861da177e4SLinus Torvalds 		write_lock(&keyring_name_lock);
871da177e4SLinus Torvalds 
881da177e4SLinus Torvalds 		if (!keyring_name_hash[bucket].next)
891da177e4SLinus Torvalds 			INIT_LIST_HEAD(&keyring_name_hash[bucket]);
901da177e4SLinus Torvalds 
911da177e4SLinus Torvalds 		list_add_tail(&keyring->type_data.link,
921da177e4SLinus Torvalds 			      &keyring_name_hash[bucket]);
931da177e4SLinus Torvalds 
941da177e4SLinus Torvalds 		write_unlock(&keyring_name_lock);
951da177e4SLinus Torvalds 	}
961da177e4SLinus Torvalds 
971da177e4SLinus Torvalds } /* end keyring_publish_name() */
981da177e4SLinus Torvalds 
991da177e4SLinus Torvalds /*****************************************************************************/
1001da177e4SLinus Torvalds /*
1011da177e4SLinus Torvalds  * initialise a keyring
1021da177e4SLinus Torvalds  * - we object if we were given any data
1031da177e4SLinus Torvalds  */
1041da177e4SLinus Torvalds static int keyring_instantiate(struct key *keyring,
1051da177e4SLinus Torvalds 			       const void *data, size_t datalen)
1061da177e4SLinus Torvalds {
1071da177e4SLinus Torvalds 	int ret;
1081da177e4SLinus Torvalds 
1091da177e4SLinus Torvalds 	ret = -EINVAL;
1101da177e4SLinus Torvalds 	if (datalen == 0) {
1111da177e4SLinus Torvalds 		/* make the keyring available by name if it has one */
1121da177e4SLinus Torvalds 		keyring_publish_name(keyring);
1131da177e4SLinus Torvalds 		ret = 0;
1141da177e4SLinus Torvalds 	}
1151da177e4SLinus Torvalds 
1161da177e4SLinus Torvalds 	return ret;
1171da177e4SLinus Torvalds 
1181da177e4SLinus Torvalds } /* end keyring_instantiate() */
1191da177e4SLinus Torvalds 
1201da177e4SLinus Torvalds /*****************************************************************************/
1211da177e4SLinus Torvalds /*
1221da177e4SLinus Torvalds  * duplicate the list of subscribed keys from a source keyring into this one
1231da177e4SLinus Torvalds  */
1241da177e4SLinus Torvalds static int keyring_duplicate(struct key *keyring, const struct key *source)
1251da177e4SLinus Torvalds {
1261da177e4SLinus Torvalds 	struct keyring_list *sklist, *klist;
1271da177e4SLinus Torvalds 	unsigned max;
1281da177e4SLinus Torvalds 	size_t size;
1291da177e4SLinus Torvalds 	int loop, ret;
1301da177e4SLinus Torvalds 
1311da177e4SLinus Torvalds 	const unsigned limit =
1321da177e4SLinus Torvalds 		(PAGE_SIZE - sizeof(*klist)) / sizeof(struct key);
1331da177e4SLinus Torvalds 
1341da177e4SLinus Torvalds 	ret = 0;
1351da177e4SLinus Torvalds 
13676d8aeabSDavid Howells 	/* find out how many keys are currently linked */
13776d8aeabSDavid Howells 	rcu_read_lock();
13876d8aeabSDavid Howells 	sklist = rcu_dereference(source->payload.subscriptions);
13976d8aeabSDavid Howells 	max = 0;
14076d8aeabSDavid Howells 	if (sklist)
1411da177e4SLinus Torvalds 		max = sklist->nkeys;
14276d8aeabSDavid Howells 	rcu_read_unlock();
14376d8aeabSDavid Howells 
14476d8aeabSDavid Howells 	/* allocate a new payload and stuff load with key links */
14576d8aeabSDavid Howells 	if (max > 0) {
1461da177e4SLinus Torvalds 		BUG_ON(max > limit);
1471da177e4SLinus Torvalds 
1481da177e4SLinus Torvalds 		max = (max + 3) & ~3;
1491da177e4SLinus Torvalds 		if (max > limit)
1501da177e4SLinus Torvalds 			max = limit;
1511da177e4SLinus Torvalds 
1521da177e4SLinus Torvalds 		ret = -ENOMEM;
1531da177e4SLinus Torvalds 		size = sizeof(*klist) + sizeof(struct key) * max;
1541da177e4SLinus Torvalds 		klist = kmalloc(size, GFP_KERNEL);
1551da177e4SLinus Torvalds 		if (!klist)
1561da177e4SLinus Torvalds 			goto error;
1571da177e4SLinus Torvalds 
15876d8aeabSDavid Howells 		/* set links */
15976d8aeabSDavid Howells 		rcu_read_lock();
16076d8aeabSDavid Howells 		sklist = rcu_dereference(source->payload.subscriptions);
16176d8aeabSDavid Howells 
1621da177e4SLinus Torvalds 		klist->maxkeys = max;
1631da177e4SLinus Torvalds 		klist->nkeys = sklist->nkeys;
1641da177e4SLinus Torvalds 		memcpy(klist->keys,
1651da177e4SLinus Torvalds 		       sklist->keys,
1661da177e4SLinus Torvalds 		       sklist->nkeys * sizeof(struct key));
1671da177e4SLinus Torvalds 
1681da177e4SLinus Torvalds 		for (loop = klist->nkeys - 1; loop >= 0; loop--)
1691da177e4SLinus Torvalds 			atomic_inc(&klist->keys[loop]->usage);
1701da177e4SLinus Torvalds 
17176d8aeabSDavid Howells 		rcu_read_unlock();
17276d8aeabSDavid Howells 
17376d8aeabSDavid Howells 		rcu_assign_pointer(keyring->payload.subscriptions, klist);
1741da177e4SLinus Torvalds 		ret = 0;
1751da177e4SLinus Torvalds 	}
1761da177e4SLinus Torvalds 
1771da177e4SLinus Torvalds  error:
1781da177e4SLinus Torvalds 	return ret;
1791da177e4SLinus Torvalds 
1801da177e4SLinus Torvalds } /* end keyring_duplicate() */
1811da177e4SLinus Torvalds 
1821da177e4SLinus Torvalds /*****************************************************************************/
1831da177e4SLinus Torvalds /*
1841da177e4SLinus Torvalds  * match keyrings on their name
1851da177e4SLinus Torvalds  */
1861da177e4SLinus Torvalds static int keyring_match(const struct key *keyring, const void *description)
1871da177e4SLinus Torvalds {
1881da177e4SLinus Torvalds 	return keyring->description &&
1891da177e4SLinus Torvalds 		strcmp(keyring->description, description) == 0;
1901da177e4SLinus Torvalds 
1911da177e4SLinus Torvalds } /* end keyring_match() */
1921da177e4SLinus Torvalds 
1931da177e4SLinus Torvalds /*****************************************************************************/
1941da177e4SLinus Torvalds /*
1951da177e4SLinus Torvalds  * dispose of the data dangling from the corpse of a keyring
1961da177e4SLinus Torvalds  */
1971da177e4SLinus Torvalds static void keyring_destroy(struct key *keyring)
1981da177e4SLinus Torvalds {
1991da177e4SLinus Torvalds 	struct keyring_list *klist;
2001da177e4SLinus Torvalds 	int loop;
2011da177e4SLinus Torvalds 
2021da177e4SLinus Torvalds 	if (keyring->description) {
2031da177e4SLinus Torvalds 		write_lock(&keyring_name_lock);
2041da177e4SLinus Torvalds 		list_del(&keyring->type_data.link);
2051da177e4SLinus Torvalds 		write_unlock(&keyring_name_lock);
2061da177e4SLinus Torvalds 	}
2071da177e4SLinus Torvalds 
20876d8aeabSDavid Howells 	klist = rcu_dereference(keyring->payload.subscriptions);
2091da177e4SLinus Torvalds 	if (klist) {
2101da177e4SLinus Torvalds 		for (loop = klist->nkeys - 1; loop >= 0; loop--)
2111da177e4SLinus Torvalds 			key_put(klist->keys[loop]);
2121da177e4SLinus Torvalds 		kfree(klist);
2131da177e4SLinus Torvalds 	}
2141da177e4SLinus Torvalds 
2151da177e4SLinus Torvalds } /* end keyring_destroy() */
2161da177e4SLinus Torvalds 
2171da177e4SLinus Torvalds /*****************************************************************************/
2181da177e4SLinus Torvalds /*
2191da177e4SLinus Torvalds  * describe the keyring
2201da177e4SLinus Torvalds  */
2211da177e4SLinus Torvalds static void keyring_describe(const struct key *keyring, struct seq_file *m)
2221da177e4SLinus Torvalds {
2231da177e4SLinus Torvalds 	struct keyring_list *klist;
2241da177e4SLinus Torvalds 
2251da177e4SLinus Torvalds 	if (keyring->description) {
2261da177e4SLinus Torvalds 		seq_puts(m, keyring->description);
2271da177e4SLinus Torvalds 	}
2281da177e4SLinus Torvalds 	else {
2291da177e4SLinus Torvalds 		seq_puts(m, "[anon]");
2301da177e4SLinus Torvalds 	}
2311da177e4SLinus Torvalds 
23276d8aeabSDavid Howells 	rcu_read_lock();
23376d8aeabSDavid Howells 	klist = rcu_dereference(keyring->payload.subscriptions);
2341da177e4SLinus Torvalds 	if (klist)
2351da177e4SLinus Torvalds 		seq_printf(m, ": %u/%u", klist->nkeys, klist->maxkeys);
2361da177e4SLinus Torvalds 	else
2371da177e4SLinus Torvalds 		seq_puts(m, ": empty");
23876d8aeabSDavid Howells 	rcu_read_unlock();
2391da177e4SLinus Torvalds 
2401da177e4SLinus Torvalds } /* end keyring_describe() */
2411da177e4SLinus Torvalds 
2421da177e4SLinus Torvalds /*****************************************************************************/
2431da177e4SLinus Torvalds /*
2441da177e4SLinus Torvalds  * read a list of key IDs from the keyring's contents
24576d8aeabSDavid Howells  * - the keyring's semaphore is read-locked
2461da177e4SLinus Torvalds  */
2471da177e4SLinus Torvalds static long keyring_read(const struct key *keyring,
2481da177e4SLinus Torvalds 			 char __user *buffer, size_t buflen)
2491da177e4SLinus Torvalds {
2501da177e4SLinus Torvalds 	struct keyring_list *klist;
2511da177e4SLinus Torvalds 	struct key *key;
2521da177e4SLinus Torvalds 	size_t qty, tmp;
2531da177e4SLinus Torvalds 	int loop, ret;
2541da177e4SLinus Torvalds 
2551da177e4SLinus Torvalds 	ret = 0;
25676d8aeabSDavid Howells 	klist = rcu_dereference(keyring->payload.subscriptions);
2571da177e4SLinus Torvalds 
2581da177e4SLinus Torvalds 	if (klist) {
2591da177e4SLinus Torvalds 		/* calculate how much data we could return */
2601da177e4SLinus Torvalds 		qty = klist->nkeys * sizeof(key_serial_t);
2611da177e4SLinus Torvalds 
2621da177e4SLinus Torvalds 		if (buffer && buflen > 0) {
2631da177e4SLinus Torvalds 			if (buflen > qty)
2641da177e4SLinus Torvalds 				buflen = qty;
2651da177e4SLinus Torvalds 
2661da177e4SLinus Torvalds 			/* copy the IDs of the subscribed keys into the
2671da177e4SLinus Torvalds 			 * buffer */
2681da177e4SLinus Torvalds 			ret = -EFAULT;
2691da177e4SLinus Torvalds 
2701da177e4SLinus Torvalds 			for (loop = 0; loop < klist->nkeys; loop++) {
2711da177e4SLinus Torvalds 				key = klist->keys[loop];
2721da177e4SLinus Torvalds 
2731da177e4SLinus Torvalds 				tmp = sizeof(key_serial_t);
2741da177e4SLinus Torvalds 				if (tmp > buflen)
2751da177e4SLinus Torvalds 					tmp = buflen;
2761da177e4SLinus Torvalds 
2771da177e4SLinus Torvalds 				if (copy_to_user(buffer,
2781da177e4SLinus Torvalds 						 &key->serial,
2791da177e4SLinus Torvalds 						 tmp) != 0)
2801da177e4SLinus Torvalds 					goto error;
2811da177e4SLinus Torvalds 
2821da177e4SLinus Torvalds 				buflen -= tmp;
2831da177e4SLinus Torvalds 				if (buflen == 0)
2841da177e4SLinus Torvalds 					break;
2851da177e4SLinus Torvalds 				buffer += tmp;
2861da177e4SLinus Torvalds 			}
2871da177e4SLinus Torvalds 		}
2881da177e4SLinus Torvalds 
2891da177e4SLinus Torvalds 		ret = qty;
2901da177e4SLinus Torvalds 	}
2911da177e4SLinus Torvalds 
2921da177e4SLinus Torvalds  error:
2931da177e4SLinus Torvalds 	return ret;
2941da177e4SLinus Torvalds 
2951da177e4SLinus Torvalds } /* end keyring_read() */
2961da177e4SLinus Torvalds 
2971da177e4SLinus Torvalds /*****************************************************************************/
2981da177e4SLinus Torvalds /*
2991da177e4SLinus Torvalds  * allocate a keyring and link into the destination keyring
3001da177e4SLinus Torvalds  */
3011da177e4SLinus Torvalds struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
3021da177e4SLinus Torvalds 			  int not_in_quota, struct key *dest)
3031da177e4SLinus Torvalds {
3041da177e4SLinus Torvalds 	struct key *keyring;
3051da177e4SLinus Torvalds 	int ret;
3061da177e4SLinus Torvalds 
3071da177e4SLinus Torvalds 	keyring = key_alloc(&key_type_keyring, description,
3081da177e4SLinus Torvalds 			    uid, gid, KEY_USR_ALL, not_in_quota);
3091da177e4SLinus Torvalds 
3101da177e4SLinus Torvalds 	if (!IS_ERR(keyring)) {
311*3e30148cSDavid Howells 		ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL);
3121da177e4SLinus Torvalds 		if (ret < 0) {
3131da177e4SLinus Torvalds 			key_put(keyring);
3141da177e4SLinus Torvalds 			keyring = ERR_PTR(ret);
3151da177e4SLinus Torvalds 		}
3161da177e4SLinus Torvalds 	}
3171da177e4SLinus Torvalds 
3181da177e4SLinus Torvalds 	return keyring;
3191da177e4SLinus Torvalds 
3201da177e4SLinus Torvalds } /* end keyring_alloc() */
3211da177e4SLinus Torvalds 
3221da177e4SLinus Torvalds /*****************************************************************************/
3231da177e4SLinus Torvalds /*
3241da177e4SLinus Torvalds  * search the supplied keyring tree for a key that matches the criterion
3251da177e4SLinus Torvalds  * - perform a breadth-then-depth search up to the prescribed limit
3261da177e4SLinus Torvalds  * - we only find keys on which we have search permission
3271da177e4SLinus Torvalds  * - we use the supplied match function to see if the description (or other
3281da177e4SLinus Torvalds  *   feature of interest) matches
329*3e30148cSDavid Howells  * - we rely on RCU to prevent the keyring lists from disappearing on us
3301da177e4SLinus Torvalds  * - we return -EAGAIN if we didn't find any matching key
3311da177e4SLinus Torvalds  * - we return -ENOKEY if we only found negative matching keys
3321da177e4SLinus Torvalds  */
3331da177e4SLinus Torvalds struct key *keyring_search_aux(struct key *keyring,
334*3e30148cSDavid Howells 			       struct task_struct *context,
3351da177e4SLinus Torvalds 			       struct key_type *type,
3361da177e4SLinus Torvalds 			       const void *description,
3371da177e4SLinus Torvalds 			       key_match_func_t match)
3381da177e4SLinus Torvalds {
3391da177e4SLinus Torvalds 	struct {
34076d8aeabSDavid Howells 		struct keyring_list *keylist;
3411da177e4SLinus Torvalds 		int kix;
3421da177e4SLinus Torvalds 	} stack[KEYRING_SEARCH_MAX_DEPTH];
3431da177e4SLinus Torvalds 
3441da177e4SLinus Torvalds 	struct keyring_list *keylist;
3451da177e4SLinus Torvalds 	struct timespec now;
3461da177e4SLinus Torvalds 	struct key *key;
3471da177e4SLinus Torvalds 	long err;
34876d8aeabSDavid Howells 	int sp, kix;
3491da177e4SLinus Torvalds 
3501da177e4SLinus Torvalds 	key_check(keyring);
3511da177e4SLinus Torvalds 
35276d8aeabSDavid Howells 	rcu_read_lock();
35376d8aeabSDavid Howells 
3541da177e4SLinus Torvalds 	/* top keyring must have search permission to begin the search */
3551da177e4SLinus Torvalds 	key = ERR_PTR(-EACCES);
356*3e30148cSDavid Howells 	if (!key_task_permission(keyring, context, KEY_SEARCH))
3571da177e4SLinus Torvalds 		goto error;
3581da177e4SLinus Torvalds 
3591da177e4SLinus Torvalds 	key = ERR_PTR(-ENOTDIR);
3601da177e4SLinus Torvalds 	if (keyring->type != &key_type_keyring)
3611da177e4SLinus Torvalds 		goto error;
3621da177e4SLinus Torvalds 
3631da177e4SLinus Torvalds 	now = current_kernel_time();
3641da177e4SLinus Torvalds 	err = -EAGAIN;
3651da177e4SLinus Torvalds 	sp = 0;
3661da177e4SLinus Torvalds 
3671da177e4SLinus Torvalds 	/* start processing a new keyring */
3681da177e4SLinus Torvalds  descend:
36976d8aeabSDavid Howells 	if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
3701da177e4SLinus Torvalds 		goto not_this_keyring;
3711da177e4SLinus Torvalds 
37276d8aeabSDavid Howells 	keylist = rcu_dereference(keyring->payload.subscriptions);
3731da177e4SLinus Torvalds 	if (!keylist)
3741da177e4SLinus Torvalds 		goto not_this_keyring;
3751da177e4SLinus Torvalds 
3761da177e4SLinus Torvalds 	/* iterate through the keys in this keyring first */
3771da177e4SLinus Torvalds 	for (kix = 0; kix < keylist->nkeys; kix++) {
3781da177e4SLinus Torvalds 		key = keylist->keys[kix];
3791da177e4SLinus Torvalds 
3801da177e4SLinus Torvalds 		/* ignore keys not of this type */
3811da177e4SLinus Torvalds 		if (key->type != type)
3821da177e4SLinus Torvalds 			continue;
3831da177e4SLinus Torvalds 
3841da177e4SLinus Torvalds 		/* skip revoked keys and expired keys */
38576d8aeabSDavid Howells 		if (test_bit(KEY_FLAG_REVOKED, &key->flags))
3861da177e4SLinus Torvalds 			continue;
3871da177e4SLinus Torvalds 
3881da177e4SLinus Torvalds 		if (key->expiry && now.tv_sec >= key->expiry)
3891da177e4SLinus Torvalds 			continue;
3901da177e4SLinus Torvalds 
3911da177e4SLinus Torvalds 		/* keys that don't match */
3921da177e4SLinus Torvalds 		if (!match(key, description))
3931da177e4SLinus Torvalds 			continue;
3941da177e4SLinus Torvalds 
3951da177e4SLinus Torvalds 		/* key must have search permissions */
396*3e30148cSDavid Howells 		if (!key_task_permission(key, context, KEY_SEARCH))
3971da177e4SLinus Torvalds 			continue;
3981da177e4SLinus Torvalds 
3991da177e4SLinus Torvalds 		/* we set a different error code if we find a negative key */
40076d8aeabSDavid Howells 		if (test_bit(KEY_FLAG_NEGATIVE, &key->flags)) {
4011da177e4SLinus Torvalds 			err = -ENOKEY;
4021da177e4SLinus Torvalds 			continue;
4031da177e4SLinus Torvalds 		}
4041da177e4SLinus Torvalds 
4051da177e4SLinus Torvalds 		goto found;
4061da177e4SLinus Torvalds 	}
4071da177e4SLinus Torvalds 
4081da177e4SLinus Torvalds 	/* search through the keyrings nested in this one */
4091da177e4SLinus Torvalds 	kix = 0;
4101da177e4SLinus Torvalds  ascend:
41176d8aeabSDavid Howells 	for (; kix < keylist->nkeys; kix++) {
4121da177e4SLinus Torvalds 		key = keylist->keys[kix];
4131da177e4SLinus Torvalds 		if (key->type != &key_type_keyring)
41476d8aeabSDavid Howells 			continue;
4151da177e4SLinus Torvalds 
4161da177e4SLinus Torvalds 		/* recursively search nested keyrings
4171da177e4SLinus Torvalds 		 * - only search keyrings for which we have search permission
4181da177e4SLinus Torvalds 		 */
4191da177e4SLinus Torvalds 		if (sp >= KEYRING_SEARCH_MAX_DEPTH)
42076d8aeabSDavid Howells 			continue;
4211da177e4SLinus Torvalds 
422*3e30148cSDavid Howells 		if (!key_task_permission(key, context, KEY_SEARCH))
42376d8aeabSDavid Howells 			continue;
4241da177e4SLinus Torvalds 
4251da177e4SLinus Torvalds 		/* stack the current position */
42676d8aeabSDavid Howells 		stack[sp].keylist = keylist;
4271da177e4SLinus Torvalds 		stack[sp].kix = kix;
4281da177e4SLinus Torvalds 		sp++;
4291da177e4SLinus Torvalds 
4301da177e4SLinus Torvalds 		/* begin again with the new keyring */
4311da177e4SLinus Torvalds 		keyring = key;
4321da177e4SLinus Torvalds 		goto descend;
4331da177e4SLinus Torvalds 	}
4341da177e4SLinus Torvalds 
4351da177e4SLinus Torvalds 	/* the keyring we're looking at was disqualified or didn't contain a
4361da177e4SLinus Torvalds 	 * matching key */
4371da177e4SLinus Torvalds  not_this_keyring:
4381da177e4SLinus Torvalds 	if (sp > 0) {
4391da177e4SLinus Torvalds 		/* resume the processing of a keyring higher up in the tree */
4401da177e4SLinus Torvalds 		sp--;
44176d8aeabSDavid Howells 		keylist = stack[sp].keylist;
4421da177e4SLinus Torvalds 		kix = stack[sp].kix + 1;
4431da177e4SLinus Torvalds 		goto ascend;
4441da177e4SLinus Torvalds 	}
4451da177e4SLinus Torvalds 
4461da177e4SLinus Torvalds 	key = ERR_PTR(err);
4471da177e4SLinus Torvalds 	goto error;
4481da177e4SLinus Torvalds 
4491da177e4SLinus Torvalds 	/* we found a viable match */
4501da177e4SLinus Torvalds  found:
4511da177e4SLinus Torvalds 	atomic_inc(&key->usage);
4521da177e4SLinus Torvalds 	key_check(key);
4531da177e4SLinus Torvalds  error:
45476d8aeabSDavid Howells 	rcu_read_unlock();
4551da177e4SLinus Torvalds 	return key;
4561da177e4SLinus Torvalds 
4571da177e4SLinus Torvalds } /* end keyring_search_aux() */
4581da177e4SLinus Torvalds 
4591da177e4SLinus Torvalds /*****************************************************************************/
4601da177e4SLinus Torvalds /*
4611da177e4SLinus Torvalds  * search the supplied keyring tree for a key that matches the criterion
4621da177e4SLinus Torvalds  * - perform a breadth-then-depth search up to the prescribed limit
4631da177e4SLinus Torvalds  * - we only find keys on which we have search permission
4641da177e4SLinus Torvalds  * - we readlock the keyrings as we search down the tree
4651da177e4SLinus Torvalds  * - we return -EAGAIN if we didn't find any matching key
4661da177e4SLinus Torvalds  * - we return -ENOKEY if we only found negative matching keys
4671da177e4SLinus Torvalds  */
4681da177e4SLinus Torvalds struct key *keyring_search(struct key *keyring,
4691da177e4SLinus Torvalds 			   struct key_type *type,
4701da177e4SLinus Torvalds 			   const char *description)
4711da177e4SLinus Torvalds {
472*3e30148cSDavid Howells 	if (!type->match)
473*3e30148cSDavid Howells 		return ERR_PTR(-ENOKEY);
474*3e30148cSDavid Howells 
475*3e30148cSDavid Howells 	return keyring_search_aux(keyring, current,
476*3e30148cSDavid Howells 				  type, description, type->match);
4771da177e4SLinus Torvalds 
4781da177e4SLinus Torvalds } /* end keyring_search() */
4791da177e4SLinus Torvalds 
4801da177e4SLinus Torvalds EXPORT_SYMBOL(keyring_search);
4811da177e4SLinus Torvalds 
4821da177e4SLinus Torvalds /*****************************************************************************/
4831da177e4SLinus Torvalds /*
4841da177e4SLinus Torvalds  * search the given keyring only (no recursion)
4851da177e4SLinus Torvalds  * - keyring must be locked by caller
4861da177e4SLinus Torvalds  */
4871da177e4SLinus Torvalds struct key *__keyring_search_one(struct key *keyring,
4881da177e4SLinus Torvalds 				 const struct key_type *ktype,
4891da177e4SLinus Torvalds 				 const char *description,
4901da177e4SLinus Torvalds 				 key_perm_t perm)
4911da177e4SLinus Torvalds {
4921da177e4SLinus Torvalds 	struct keyring_list *klist;
4931da177e4SLinus Torvalds 	struct key *key;
4941da177e4SLinus Torvalds 	int loop;
4951da177e4SLinus Torvalds 
49676d8aeabSDavid Howells 	rcu_read_lock();
49776d8aeabSDavid Howells 
49876d8aeabSDavid Howells 	klist = rcu_dereference(keyring->payload.subscriptions);
4991da177e4SLinus Torvalds 	if (klist) {
5001da177e4SLinus Torvalds 		for (loop = 0; loop < klist->nkeys; loop++) {
5011da177e4SLinus Torvalds 			key = klist->keys[loop];
5021da177e4SLinus Torvalds 
5031da177e4SLinus Torvalds 			if (key->type == ktype &&
504*3e30148cSDavid Howells 			    (!key->type->match ||
505*3e30148cSDavid Howells 			     key->type->match(key, description)) &&
5061da177e4SLinus Torvalds 			    key_permission(key, perm) &&
50776d8aeabSDavid Howells 			    !test_bit(KEY_FLAG_REVOKED, &key->flags)
5081da177e4SLinus Torvalds 			    )
5091da177e4SLinus Torvalds 				goto found;
5101da177e4SLinus Torvalds 		}
5111da177e4SLinus Torvalds 	}
5121da177e4SLinus Torvalds 
5131da177e4SLinus Torvalds 	key = ERR_PTR(-ENOKEY);
5141da177e4SLinus Torvalds 	goto error;
5151da177e4SLinus Torvalds 
5161da177e4SLinus Torvalds  found:
5171da177e4SLinus Torvalds 	atomic_inc(&key->usage);
5181da177e4SLinus Torvalds  error:
51976d8aeabSDavid Howells 	rcu_read_unlock();
5201da177e4SLinus Torvalds 	return key;
5211da177e4SLinus Torvalds 
5221da177e4SLinus Torvalds } /* end __keyring_search_one() */
5231da177e4SLinus Torvalds 
5241da177e4SLinus Torvalds /*****************************************************************************/
5251da177e4SLinus Torvalds /*
526*3e30148cSDavid Howells  * search for an instantiation authorisation key matching a target key
527*3e30148cSDavid Howells  * - the RCU read lock must be held by the caller
528*3e30148cSDavid Howells  * - a target_id of zero specifies any valid token
529*3e30148cSDavid Howells  */
530*3e30148cSDavid Howells struct key *keyring_search_instkey(struct key *keyring,
531*3e30148cSDavid Howells 				   key_serial_t target_id)
532*3e30148cSDavid Howells {
533*3e30148cSDavid Howells 	struct request_key_auth *rka;
534*3e30148cSDavid Howells 	struct keyring_list *klist;
535*3e30148cSDavid Howells 	struct key *instkey;
536*3e30148cSDavid Howells 	int loop;
537*3e30148cSDavid Howells 
538*3e30148cSDavid Howells 	klist = rcu_dereference(keyring->payload.subscriptions);
539*3e30148cSDavid Howells 	if (klist) {
540*3e30148cSDavid Howells 		for (loop = 0; loop < klist->nkeys; loop++) {
541*3e30148cSDavid Howells 			instkey = klist->keys[loop];
542*3e30148cSDavid Howells 
543*3e30148cSDavid Howells 			if (instkey->type != &key_type_request_key_auth)
544*3e30148cSDavid Howells 				continue;
545*3e30148cSDavid Howells 
546*3e30148cSDavid Howells 			rka = instkey->payload.data;
547*3e30148cSDavid Howells 			if (target_id && rka->target_key->serial != target_id)
548*3e30148cSDavid Howells 				continue;
549*3e30148cSDavid Howells 
550*3e30148cSDavid Howells 			/* the auth key is revoked during instantiation */
551*3e30148cSDavid Howells 			if (!test_bit(KEY_FLAG_REVOKED, &instkey->flags))
552*3e30148cSDavid Howells 				goto found;
553*3e30148cSDavid Howells 
554*3e30148cSDavid Howells 			instkey = ERR_PTR(-EKEYREVOKED);
555*3e30148cSDavid Howells 			goto error;
556*3e30148cSDavid Howells 		}
557*3e30148cSDavid Howells 	}
558*3e30148cSDavid Howells 
559*3e30148cSDavid Howells 	instkey = ERR_PTR(-EACCES);
560*3e30148cSDavid Howells 	goto error;
561*3e30148cSDavid Howells 
562*3e30148cSDavid Howells found:
563*3e30148cSDavid Howells 	atomic_inc(&instkey->usage);
564*3e30148cSDavid Howells error:
565*3e30148cSDavid Howells 	return instkey;
566*3e30148cSDavid Howells 
567*3e30148cSDavid Howells } /* end keyring_search_instkey() */
568*3e30148cSDavid Howells 
569*3e30148cSDavid Howells /*****************************************************************************/
570*3e30148cSDavid Howells /*
5711da177e4SLinus Torvalds  * find a keyring with the specified name
5721da177e4SLinus Torvalds  * - all named keyrings are searched
5731da177e4SLinus Torvalds  * - only find keyrings with search permission for the process
5741da177e4SLinus Torvalds  * - only find keyrings with a serial number greater than the one specified
5751da177e4SLinus Torvalds  */
5761da177e4SLinus Torvalds struct key *find_keyring_by_name(const char *name, key_serial_t bound)
5771da177e4SLinus Torvalds {
5781da177e4SLinus Torvalds 	struct key *keyring;
5791da177e4SLinus Torvalds 	int bucket;
5801da177e4SLinus Torvalds 
5811da177e4SLinus Torvalds 	keyring = ERR_PTR(-EINVAL);
5821da177e4SLinus Torvalds 	if (!name)
5831da177e4SLinus Torvalds 		goto error;
5841da177e4SLinus Torvalds 
5851da177e4SLinus Torvalds 	bucket = keyring_hash(name);
5861da177e4SLinus Torvalds 
5871da177e4SLinus Torvalds 	read_lock(&keyring_name_lock);
5881da177e4SLinus Torvalds 
5891da177e4SLinus Torvalds 	if (keyring_name_hash[bucket].next) {
5901da177e4SLinus Torvalds 		/* search this hash bucket for a keyring with a matching name
5911da177e4SLinus Torvalds 		 * that's readable and that hasn't been revoked */
5921da177e4SLinus Torvalds 		list_for_each_entry(keyring,
5931da177e4SLinus Torvalds 				    &keyring_name_hash[bucket],
5941da177e4SLinus Torvalds 				    type_data.link
5951da177e4SLinus Torvalds 				    ) {
59676d8aeabSDavid Howells 			if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
5971da177e4SLinus Torvalds 				continue;
5981da177e4SLinus Torvalds 
5991da177e4SLinus Torvalds 			if (strcmp(keyring->description, name) != 0)
6001da177e4SLinus Torvalds 				continue;
6011da177e4SLinus Torvalds 
6021da177e4SLinus Torvalds 			if (!key_permission(keyring, KEY_SEARCH))
6031da177e4SLinus Torvalds 				continue;
6041da177e4SLinus Torvalds 
6051da177e4SLinus Torvalds 			/* found a potential candidate, but we still need to
6061da177e4SLinus Torvalds 			 * check the serial number */
6071da177e4SLinus Torvalds 			if (keyring->serial <= bound)
6081da177e4SLinus Torvalds 				continue;
6091da177e4SLinus Torvalds 
6101da177e4SLinus Torvalds 			/* we've got a match */
6111da177e4SLinus Torvalds 			atomic_inc(&keyring->usage);
6121da177e4SLinus Torvalds 			read_unlock(&keyring_name_lock);
6131da177e4SLinus Torvalds 			goto error;
6141da177e4SLinus Torvalds 		}
6151da177e4SLinus Torvalds 	}
6161da177e4SLinus Torvalds 
6171da177e4SLinus Torvalds 	read_unlock(&keyring_name_lock);
6181da177e4SLinus Torvalds 	keyring = ERR_PTR(-ENOKEY);
6191da177e4SLinus Torvalds 
6201da177e4SLinus Torvalds  error:
6211da177e4SLinus Torvalds 	return keyring;
6221da177e4SLinus Torvalds 
6231da177e4SLinus Torvalds } /* end find_keyring_by_name() */
6241da177e4SLinus Torvalds 
6251da177e4SLinus Torvalds /*****************************************************************************/
6261da177e4SLinus Torvalds /*
6271da177e4SLinus Torvalds  * see if a cycle will will be created by inserting acyclic tree B in acyclic
6281da177e4SLinus Torvalds  * tree A at the topmost level (ie: as a direct child of A)
6291da177e4SLinus Torvalds  * - since we are adding B to A at the top level, checking for cycles should
6301da177e4SLinus Torvalds  *   just be a matter of seeing if node A is somewhere in tree B
6311da177e4SLinus Torvalds  */
6321da177e4SLinus Torvalds static int keyring_detect_cycle(struct key *A, struct key *B)
6331da177e4SLinus Torvalds {
6341da177e4SLinus Torvalds 	struct {
63576d8aeabSDavid Howells 		struct keyring_list *keylist;
6361da177e4SLinus Torvalds 		int kix;
6371da177e4SLinus Torvalds 	} stack[KEYRING_SEARCH_MAX_DEPTH];
6381da177e4SLinus Torvalds 
6391da177e4SLinus Torvalds 	struct keyring_list *keylist;
6401da177e4SLinus Torvalds 	struct key *subtree, *key;
6411da177e4SLinus Torvalds 	int sp, kix, ret;
6421da177e4SLinus Torvalds 
64376d8aeabSDavid Howells 	rcu_read_lock();
64476d8aeabSDavid Howells 
6451da177e4SLinus Torvalds 	ret = -EDEADLK;
6461da177e4SLinus Torvalds 	if (A == B)
64776d8aeabSDavid Howells 		goto cycle_detected;
6481da177e4SLinus Torvalds 
6491da177e4SLinus Torvalds 	subtree = B;
6501da177e4SLinus Torvalds 	sp = 0;
6511da177e4SLinus Torvalds 
6521da177e4SLinus Torvalds 	/* start processing a new keyring */
6531da177e4SLinus Torvalds  descend:
65476d8aeabSDavid Howells 	if (test_bit(KEY_FLAG_REVOKED, &subtree->flags))
6551da177e4SLinus Torvalds 		goto not_this_keyring;
6561da177e4SLinus Torvalds 
65776d8aeabSDavid Howells 	keylist = rcu_dereference(subtree->payload.subscriptions);
6581da177e4SLinus Torvalds 	if (!keylist)
6591da177e4SLinus Torvalds 		goto not_this_keyring;
6601da177e4SLinus Torvalds 	kix = 0;
6611da177e4SLinus Torvalds 
6621da177e4SLinus Torvalds  ascend:
6631da177e4SLinus Torvalds 	/* iterate through the remaining keys in this keyring */
6641da177e4SLinus Torvalds 	for (; kix < keylist->nkeys; kix++) {
6651da177e4SLinus Torvalds 		key = keylist->keys[kix];
6661da177e4SLinus Torvalds 
6671da177e4SLinus Torvalds 		if (key == A)
6681da177e4SLinus Torvalds 			goto cycle_detected;
6691da177e4SLinus Torvalds 
6701da177e4SLinus Torvalds 		/* recursively check nested keyrings */
6711da177e4SLinus Torvalds 		if (key->type == &key_type_keyring) {
6721da177e4SLinus Torvalds 			if (sp >= KEYRING_SEARCH_MAX_DEPTH)
6731da177e4SLinus Torvalds 				goto too_deep;
6741da177e4SLinus Torvalds 
6751da177e4SLinus Torvalds 			/* stack the current position */
67676d8aeabSDavid Howells 			stack[sp].keylist = keylist;
6771da177e4SLinus Torvalds 			stack[sp].kix = kix;
6781da177e4SLinus Torvalds 			sp++;
6791da177e4SLinus Torvalds 
6801da177e4SLinus Torvalds 			/* begin again with the new keyring */
6811da177e4SLinus Torvalds 			subtree = key;
6821da177e4SLinus Torvalds 			goto descend;
6831da177e4SLinus Torvalds 		}
6841da177e4SLinus Torvalds 	}
6851da177e4SLinus Torvalds 
6861da177e4SLinus Torvalds 	/* the keyring we're looking at was disqualified or didn't contain a
6871da177e4SLinus Torvalds 	 * matching key */
6881da177e4SLinus Torvalds  not_this_keyring:
6891da177e4SLinus Torvalds 	if (sp > 0) {
6901da177e4SLinus Torvalds 		/* resume the checking of a keyring higher up in the tree */
6911da177e4SLinus Torvalds 		sp--;
69276d8aeabSDavid Howells 		keylist = stack[sp].keylist;
6931da177e4SLinus Torvalds 		kix = stack[sp].kix + 1;
6941da177e4SLinus Torvalds 		goto ascend;
6951da177e4SLinus Torvalds 	}
6961da177e4SLinus Torvalds 
6971da177e4SLinus Torvalds 	ret = 0; /* no cycles detected */
6981da177e4SLinus Torvalds 
6991da177e4SLinus Torvalds  error:
70076d8aeabSDavid Howells 	rcu_read_unlock();
7011da177e4SLinus Torvalds 	return ret;
7021da177e4SLinus Torvalds 
7031da177e4SLinus Torvalds  too_deep:
7041da177e4SLinus Torvalds 	ret = -ELOOP;
70576d8aeabSDavid Howells 	goto error;
70676d8aeabSDavid Howells 
7071da177e4SLinus Torvalds  cycle_detected:
7081da177e4SLinus Torvalds 	ret = -EDEADLK;
7091da177e4SLinus Torvalds 	goto error;
7101da177e4SLinus Torvalds 
7111da177e4SLinus Torvalds } /* end keyring_detect_cycle() */
7121da177e4SLinus Torvalds 
7131da177e4SLinus Torvalds /*****************************************************************************/
7141da177e4SLinus Torvalds /*
71576d8aeabSDavid Howells  * dispose of a keyring list after the RCU grace period
71676d8aeabSDavid Howells  */
71776d8aeabSDavid Howells static void keyring_link_rcu_disposal(struct rcu_head *rcu)
71876d8aeabSDavid Howells {
71976d8aeabSDavid Howells 	struct keyring_list *klist =
72076d8aeabSDavid Howells 		container_of(rcu, struct keyring_list, rcu);
72176d8aeabSDavid Howells 
72276d8aeabSDavid Howells 	kfree(klist);
72376d8aeabSDavid Howells 
72476d8aeabSDavid Howells } /* end keyring_link_rcu_disposal() */
72576d8aeabSDavid Howells 
72676d8aeabSDavid Howells /*****************************************************************************/
72776d8aeabSDavid Howells /*
7281da177e4SLinus Torvalds  * link a key into to a keyring
72976d8aeabSDavid Howells  * - must be called with the keyring's semaphore write-locked
7301da177e4SLinus Torvalds  */
7311da177e4SLinus Torvalds int __key_link(struct key *keyring, struct key *key)
7321da177e4SLinus Torvalds {
7331da177e4SLinus Torvalds 	struct keyring_list *klist, *nklist;
7341da177e4SLinus Torvalds 	unsigned max;
7351da177e4SLinus Torvalds 	size_t size;
7361da177e4SLinus Torvalds 	int ret;
7371da177e4SLinus Torvalds 
7381da177e4SLinus Torvalds 	ret = -EKEYREVOKED;
73976d8aeabSDavid Howells 	if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
7401da177e4SLinus Torvalds 		goto error;
7411da177e4SLinus Torvalds 
7421da177e4SLinus Torvalds 	ret = -ENOTDIR;
7431da177e4SLinus Torvalds 	if (keyring->type != &key_type_keyring)
7441da177e4SLinus Torvalds 		goto error;
7451da177e4SLinus Torvalds 
7461da177e4SLinus Torvalds 	/* serialise link/link calls to prevent parallel calls causing a
7471da177e4SLinus Torvalds 	 * cycle when applied to two keyring in opposite orders */
7481da177e4SLinus Torvalds 	down_write(&keyring_serialise_link_sem);
7491da177e4SLinus Torvalds 
7501da177e4SLinus Torvalds 	/* check that we aren't going to create a cycle adding one keyring to
7511da177e4SLinus Torvalds 	 * another */
7521da177e4SLinus Torvalds 	if (key->type == &key_type_keyring) {
7531da177e4SLinus Torvalds 		ret = keyring_detect_cycle(keyring, key);
7541da177e4SLinus Torvalds 		if (ret < 0)
7551da177e4SLinus Torvalds 			goto error2;
7561da177e4SLinus Torvalds 	}
7571da177e4SLinus Torvalds 
7581da177e4SLinus Torvalds 	/* check that we aren't going to overrun the user's quota */
7591da177e4SLinus Torvalds 	ret = key_payload_reserve(keyring,
7601da177e4SLinus Torvalds 				  keyring->datalen + KEYQUOTA_LINK_BYTES);
7611da177e4SLinus Torvalds 	if (ret < 0)
7621da177e4SLinus Torvalds 		goto error2;
7631da177e4SLinus Torvalds 
7641da177e4SLinus Torvalds 	klist = keyring->payload.subscriptions;
7651da177e4SLinus Torvalds 
7661da177e4SLinus Torvalds 	if (klist && klist->nkeys < klist->maxkeys) {
7671da177e4SLinus Torvalds 		/* there's sufficient slack space to add directly */
7681da177e4SLinus Torvalds 		atomic_inc(&key->usage);
7691da177e4SLinus Torvalds 
77076d8aeabSDavid Howells 		klist->keys[klist->nkeys] = key;
77176d8aeabSDavid Howells 		smp_wmb();
77276d8aeabSDavid Howells 		klist->nkeys++;
77376d8aeabSDavid Howells 		smp_wmb();
7741da177e4SLinus Torvalds 
7751da177e4SLinus Torvalds 		ret = 0;
7761da177e4SLinus Torvalds 	}
7771da177e4SLinus Torvalds 	else {
7781da177e4SLinus Torvalds 		/* grow the key list */
7791da177e4SLinus Torvalds 		max = 4;
7801da177e4SLinus Torvalds 		if (klist)
7811da177e4SLinus Torvalds 			max += klist->maxkeys;
7821da177e4SLinus Torvalds 
7831da177e4SLinus Torvalds 		ret = -ENFILE;
78476d8aeabSDavid Howells 		if (max > 65535)
78576d8aeabSDavid Howells 			goto error3;
7861da177e4SLinus Torvalds 		size = sizeof(*klist) + sizeof(*key) * max;
7871da177e4SLinus Torvalds 		if (size > PAGE_SIZE)
7881da177e4SLinus Torvalds 			goto error3;
7891da177e4SLinus Torvalds 
7901da177e4SLinus Torvalds 		ret = -ENOMEM;
7911da177e4SLinus Torvalds 		nklist = kmalloc(size, GFP_KERNEL);
7921da177e4SLinus Torvalds 		if (!nklist)
7931da177e4SLinus Torvalds 			goto error3;
7941da177e4SLinus Torvalds 		nklist->maxkeys = max;
7951da177e4SLinus Torvalds 		nklist->nkeys = 0;
7961da177e4SLinus Torvalds 
7971da177e4SLinus Torvalds 		if (klist) {
7981da177e4SLinus Torvalds 			nklist->nkeys = klist->nkeys;
7991da177e4SLinus Torvalds 			memcpy(nklist->keys,
8001da177e4SLinus Torvalds 			       klist->keys,
8011da177e4SLinus Torvalds 			       sizeof(struct key *) * klist->nkeys);
8021da177e4SLinus Torvalds 		}
8031da177e4SLinus Torvalds 
8041da177e4SLinus Torvalds 		/* add the key into the new space */
8051da177e4SLinus Torvalds 		atomic_inc(&key->usage);
8061da177e4SLinus Torvalds 		nklist->keys[nklist->nkeys++] = key;
80776d8aeabSDavid Howells 
80876d8aeabSDavid Howells 		rcu_assign_pointer(keyring->payload.subscriptions, nklist);
8091da177e4SLinus Torvalds 
8101da177e4SLinus Torvalds 		/* dispose of the old keyring list */
81176d8aeabSDavid Howells 		if (klist)
81276d8aeabSDavid Howells 			call_rcu(&klist->rcu, keyring_link_rcu_disposal);
8131da177e4SLinus Torvalds 
8141da177e4SLinus Torvalds 		ret = 0;
8151da177e4SLinus Torvalds 	}
8161da177e4SLinus Torvalds 
8171da177e4SLinus Torvalds  error2:
8181da177e4SLinus Torvalds 	up_write(&keyring_serialise_link_sem);
8191da177e4SLinus Torvalds  error:
8201da177e4SLinus Torvalds 	return ret;
8211da177e4SLinus Torvalds 
8221da177e4SLinus Torvalds  error3:
8231da177e4SLinus Torvalds 	/* undo the quota changes */
8241da177e4SLinus Torvalds 	key_payload_reserve(keyring,
8251da177e4SLinus Torvalds 			    keyring->datalen - KEYQUOTA_LINK_BYTES);
8261da177e4SLinus Torvalds 	goto error2;
8271da177e4SLinus Torvalds 
8281da177e4SLinus Torvalds } /* end __key_link() */
8291da177e4SLinus Torvalds 
8301da177e4SLinus Torvalds /*****************************************************************************/
8311da177e4SLinus Torvalds /*
8321da177e4SLinus Torvalds  * link a key to a keyring
8331da177e4SLinus Torvalds  */
8341da177e4SLinus Torvalds int key_link(struct key *keyring, struct key *key)
8351da177e4SLinus Torvalds {
8361da177e4SLinus Torvalds 	int ret;
8371da177e4SLinus Torvalds 
8381da177e4SLinus Torvalds 	key_check(keyring);
8391da177e4SLinus Torvalds 	key_check(key);
8401da177e4SLinus Torvalds 
8411da177e4SLinus Torvalds 	down_write(&keyring->sem);
8421da177e4SLinus Torvalds 	ret = __key_link(keyring, key);
8431da177e4SLinus Torvalds 	up_write(&keyring->sem);
8441da177e4SLinus Torvalds 
8451da177e4SLinus Torvalds 	return ret;
8461da177e4SLinus Torvalds 
8471da177e4SLinus Torvalds } /* end key_link() */
8481da177e4SLinus Torvalds 
8491da177e4SLinus Torvalds EXPORT_SYMBOL(key_link);
8501da177e4SLinus Torvalds 
8511da177e4SLinus Torvalds /*****************************************************************************/
8521da177e4SLinus Torvalds /*
85376d8aeabSDavid Howells  * dispose of a keyring list after the RCU grace period, freeing the unlinked
85476d8aeabSDavid Howells  * key
85576d8aeabSDavid Howells  */
85676d8aeabSDavid Howells static void keyring_unlink_rcu_disposal(struct rcu_head *rcu)
85776d8aeabSDavid Howells {
85876d8aeabSDavid Howells 	struct keyring_list *klist =
85976d8aeabSDavid Howells 		container_of(rcu, struct keyring_list, rcu);
86076d8aeabSDavid Howells 
86176d8aeabSDavid Howells 	key_put(klist->keys[klist->delkey]);
86276d8aeabSDavid Howells 	kfree(klist);
86376d8aeabSDavid Howells 
86476d8aeabSDavid Howells } /* end keyring_unlink_rcu_disposal() */
86576d8aeabSDavid Howells 
86676d8aeabSDavid Howells /*****************************************************************************/
86776d8aeabSDavid Howells /*
8681da177e4SLinus Torvalds  * unlink the first link to a key from a keyring
8691da177e4SLinus Torvalds  */
8701da177e4SLinus Torvalds int key_unlink(struct key *keyring, struct key *key)
8711da177e4SLinus Torvalds {
87276d8aeabSDavid Howells 	struct keyring_list *klist, *nklist;
8731da177e4SLinus Torvalds 	int loop, ret;
8741da177e4SLinus Torvalds 
8751da177e4SLinus Torvalds 	key_check(keyring);
8761da177e4SLinus Torvalds 	key_check(key);
8771da177e4SLinus Torvalds 
8781da177e4SLinus Torvalds 	ret = -ENOTDIR;
8791da177e4SLinus Torvalds 	if (keyring->type != &key_type_keyring)
8801da177e4SLinus Torvalds 		goto error;
8811da177e4SLinus Torvalds 
8821da177e4SLinus Torvalds 	down_write(&keyring->sem);
8831da177e4SLinus Torvalds 
8841da177e4SLinus Torvalds 	klist = keyring->payload.subscriptions;
8851da177e4SLinus Torvalds 	if (klist) {
8861da177e4SLinus Torvalds 		/* search the keyring for the key */
8871da177e4SLinus Torvalds 		for (loop = 0; loop < klist->nkeys; loop++)
8881da177e4SLinus Torvalds 			if (klist->keys[loop] == key)
8891da177e4SLinus Torvalds 				goto key_is_present;
8901da177e4SLinus Torvalds 	}
8911da177e4SLinus Torvalds 
8921da177e4SLinus Torvalds 	up_write(&keyring->sem);
8931da177e4SLinus Torvalds 	ret = -ENOENT;
8941da177e4SLinus Torvalds 	goto error;
8951da177e4SLinus Torvalds 
8961da177e4SLinus Torvalds key_is_present:
89776d8aeabSDavid Howells 	/* we need to copy the key list for RCU purposes */
89876d8aeabSDavid Howells 	nklist = kmalloc(sizeof(*klist) + sizeof(*key) * klist->maxkeys,
89976d8aeabSDavid Howells 			 GFP_KERNEL);
90076d8aeabSDavid Howells 	if (!nklist)
90176d8aeabSDavid Howells 		goto nomem;
90276d8aeabSDavid Howells 	nklist->maxkeys = klist->maxkeys;
90376d8aeabSDavid Howells 	nklist->nkeys = klist->nkeys - 1;
90476d8aeabSDavid Howells 
90576d8aeabSDavid Howells 	if (loop > 0)
90676d8aeabSDavid Howells 		memcpy(&nklist->keys[0],
90776d8aeabSDavid Howells 		       &klist->keys[0],
90876d8aeabSDavid Howells 		       loop * sizeof(klist->keys[0]));
90976d8aeabSDavid Howells 
91076d8aeabSDavid Howells 	if (loop < nklist->nkeys)
91176d8aeabSDavid Howells 		memcpy(&nklist->keys[loop],
91276d8aeabSDavid Howells 		       &klist->keys[loop + 1],
91376d8aeabSDavid Howells 		       (nklist->nkeys - loop) * sizeof(klist->keys[0]));
91476d8aeabSDavid Howells 
9151da177e4SLinus Torvalds 	/* adjust the user's quota */
9161da177e4SLinus Torvalds 	key_payload_reserve(keyring,
9171da177e4SLinus Torvalds 			    keyring->datalen - KEYQUOTA_LINK_BYTES);
9181da177e4SLinus Torvalds 
91976d8aeabSDavid Howells 	rcu_assign_pointer(keyring->payload.subscriptions, nklist);
9201da177e4SLinus Torvalds 
9211da177e4SLinus Torvalds 	up_write(&keyring->sem);
92276d8aeabSDavid Howells 
92376d8aeabSDavid Howells 	/* schedule for later cleanup */
92476d8aeabSDavid Howells 	klist->delkey = loop;
92576d8aeabSDavid Howells 	call_rcu(&klist->rcu, keyring_unlink_rcu_disposal);
92676d8aeabSDavid Howells 
9271da177e4SLinus Torvalds 	ret = 0;
9281da177e4SLinus Torvalds 
9291da177e4SLinus Torvalds error:
9301da177e4SLinus Torvalds 	return ret;
93176d8aeabSDavid Howells nomem:
93276d8aeabSDavid Howells 	ret = -ENOMEM;
93376d8aeabSDavid Howells 	up_write(&keyring->sem);
93476d8aeabSDavid Howells 	goto error;
9351da177e4SLinus Torvalds 
9361da177e4SLinus Torvalds } /* end key_unlink() */
9371da177e4SLinus Torvalds 
9381da177e4SLinus Torvalds EXPORT_SYMBOL(key_unlink);
9391da177e4SLinus Torvalds 
9401da177e4SLinus Torvalds /*****************************************************************************/
9411da177e4SLinus Torvalds /*
94276d8aeabSDavid Howells  * dispose of a keyring list after the RCU grace period, releasing the keys it
94376d8aeabSDavid Howells  * links to
94476d8aeabSDavid Howells  */
94576d8aeabSDavid Howells static void keyring_clear_rcu_disposal(struct rcu_head *rcu)
94676d8aeabSDavid Howells {
94776d8aeabSDavid Howells 	struct keyring_list *klist;
94876d8aeabSDavid Howells 	int loop;
94976d8aeabSDavid Howells 
95076d8aeabSDavid Howells 	klist = container_of(rcu, struct keyring_list, rcu);
95176d8aeabSDavid Howells 
95276d8aeabSDavid Howells 	for (loop = klist->nkeys - 1; loop >= 0; loop--)
95376d8aeabSDavid Howells 		key_put(klist->keys[loop]);
95476d8aeabSDavid Howells 
95576d8aeabSDavid Howells 	kfree(klist);
95676d8aeabSDavid Howells 
95776d8aeabSDavid Howells } /* end keyring_clear_rcu_disposal() */
95876d8aeabSDavid Howells 
95976d8aeabSDavid Howells /*****************************************************************************/
96076d8aeabSDavid Howells /*
9611da177e4SLinus Torvalds  * clear the specified process keyring
9621da177e4SLinus Torvalds  * - implements keyctl(KEYCTL_CLEAR)
9631da177e4SLinus Torvalds  */
9641da177e4SLinus Torvalds int keyring_clear(struct key *keyring)
9651da177e4SLinus Torvalds {
9661da177e4SLinus Torvalds 	struct keyring_list *klist;
96776d8aeabSDavid Howells 	int ret;
9681da177e4SLinus Torvalds 
9691da177e4SLinus Torvalds 	ret = -ENOTDIR;
9701da177e4SLinus Torvalds 	if (keyring->type == &key_type_keyring) {
9711da177e4SLinus Torvalds 		/* detach the pointer block with the locks held */
9721da177e4SLinus Torvalds 		down_write(&keyring->sem);
9731da177e4SLinus Torvalds 
9741da177e4SLinus Torvalds 		klist = keyring->payload.subscriptions;
9751da177e4SLinus Torvalds 		if (klist) {
9761da177e4SLinus Torvalds 			/* adjust the quota */
9771da177e4SLinus Torvalds 			key_payload_reserve(keyring,
9781da177e4SLinus Torvalds 					    sizeof(struct keyring_list));
9791da177e4SLinus Torvalds 
98076d8aeabSDavid Howells 			rcu_assign_pointer(keyring->payload.subscriptions,
98176d8aeabSDavid Howells 					   NULL);
9821da177e4SLinus Torvalds 		}
9831da177e4SLinus Torvalds 
9841da177e4SLinus Torvalds 		up_write(&keyring->sem);
9851da177e4SLinus Torvalds 
9861da177e4SLinus Torvalds 		/* free the keys after the locks have been dropped */
98776d8aeabSDavid Howells 		if (klist)
98876d8aeabSDavid Howells 			call_rcu(&klist->rcu, keyring_clear_rcu_disposal);
9891da177e4SLinus Torvalds 
9901da177e4SLinus Torvalds 		ret = 0;
9911da177e4SLinus Torvalds 	}
9921da177e4SLinus Torvalds 
9931da177e4SLinus Torvalds 	return ret;
9941da177e4SLinus Torvalds 
9951da177e4SLinus Torvalds } /* end keyring_clear() */
9961da177e4SLinus Torvalds 
9971da177e4SLinus Torvalds EXPORT_SYMBOL(keyring_clear);
998