keyring.c 23.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2
/* keyring.c: keyring handling
 *
3
 * Copyright (C) 2004-5 Red Hat, Inc. All Rights Reserved.
L
Linus Torvalds 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/seq_file.h>
#include <linux/err.h>
#include <asm/uaccess.h>
#include "internal.h"

/*
 * when plumbing the depths of the key tree, this sets a hard limit set on how
 * deep we're willing to go
 */
#define KEYRING_SEARCH_MAX_DEPTH 6

/*
 * we keep all named keyrings in a hash to speed looking them up
 */
#define KEYRING_NAME_HASH_SIZE	(1 << 5)

static struct list_head	keyring_name_hash[KEYRING_NAME_HASH_SIZE];
static DEFINE_RWLOCK(keyring_name_lock);

static inline unsigned keyring_hash(const char *desc)
{
	unsigned bucket = 0;

	for (; *desc; desc++)
		bucket += (unsigned char) *desc;

	return bucket & (KEYRING_NAME_HASH_SIZE - 1);
}

/*
 * the keyring type definition
 */
static int keyring_instantiate(struct key *keyring,
			       const void *data, size_t datalen);
static int keyring_duplicate(struct key *keyring, const struct key *source);
static int keyring_match(const struct key *keyring, const void *criterion);
static void keyring_destroy(struct key *keyring);
static void keyring_describe(const struct key *keyring, struct seq_file *m);
static long keyring_read(const struct key *keyring,
			 char __user *buffer, size_t buflen);

struct key_type key_type_keyring = {
	.name		= "keyring",
	.def_datalen	= sizeof(struct keyring_list),
	.instantiate	= keyring_instantiate,
	.duplicate	= keyring_duplicate,
	.match		= keyring_match,
	.destroy	= keyring_destroy,
	.describe	= keyring_describe,
	.read		= keyring_read,
};

/*
 * semaphore to serialise link/link calls to prevent two link calls in parallel
 * introducing a cycle
 */
DECLARE_RWSEM(keyring_serialise_link_sem);

/*****************************************************************************/
/*
 * publish the name of a keyring so that it can be found by name (if it has
 * one)
 */
void keyring_publish_name(struct key *keyring)
{
	int bucket;

	if (keyring->description) {
		bucket = keyring_hash(keyring->description);

		write_lock(&keyring_name_lock);

		if (!keyring_name_hash[bucket].next)
			INIT_LIST_HEAD(&keyring_name_hash[bucket]);

		list_add_tail(&keyring->type_data.link,
			      &keyring_name_hash[bucket]);

		write_unlock(&keyring_name_lock);
	}

} /* end keyring_publish_name() */

/*****************************************************************************/
/*
 * initialise a keyring
 * - we object if we were given any data
 */
static int keyring_instantiate(struct key *keyring,
			       const void *data, size_t datalen)
{
	int ret;

	ret = -EINVAL;
	if (datalen == 0) {
		/* make the keyring available by name if it has one */
		keyring_publish_name(keyring);
		ret = 0;
	}

	return ret;

} /* end keyring_instantiate() */

/*****************************************************************************/
/*
 * duplicate the list of subscribed keys from a source keyring into this one
 */
static int keyring_duplicate(struct key *keyring, const struct key *source)
{
	struct keyring_list *sklist, *klist;
	unsigned max;
	size_t size;
	int loop, ret;

	const unsigned limit =
132
		(PAGE_SIZE - sizeof(*klist)) / sizeof(struct key *);
L
Linus Torvalds 已提交
133 134 135

	ret = 0;

136 137 138 139 140
	/* find out how many keys are currently linked */
	rcu_read_lock();
	sklist = rcu_dereference(source->payload.subscriptions);
	max = 0;
	if (sklist)
L
Linus Torvalds 已提交
141
		max = sklist->nkeys;
142 143 144 145
	rcu_read_unlock();

	/* allocate a new payload and stuff load with key links */
	if (max > 0) {
L
Linus Torvalds 已提交
146 147 148 149 150 151 152
		BUG_ON(max > limit);

		max = (max + 3) & ~3;
		if (max > limit)
			max = limit;

		ret = -ENOMEM;
153
		size = sizeof(*klist) + sizeof(struct key *) * max;
L
Linus Torvalds 已提交
154 155 156 157
		klist = kmalloc(size, GFP_KERNEL);
		if (!klist)
			goto error;

158 159 160 161
		/* set links */
		rcu_read_lock();
		sklist = rcu_dereference(source->payload.subscriptions);

L
Linus Torvalds 已提交
162 163 164 165
		klist->maxkeys = max;
		klist->nkeys = sklist->nkeys;
		memcpy(klist->keys,
		       sklist->keys,
166
		       sklist->nkeys * sizeof(struct key *));
L
Linus Torvalds 已提交
167 168 169 170

		for (loop = klist->nkeys - 1; loop >= 0; loop--)
			atomic_inc(&klist->keys[loop]->usage);

171 172 173
		rcu_read_unlock();

		rcu_assign_pointer(keyring->payload.subscriptions, klist);
L
Linus Torvalds 已提交
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
		ret = 0;
	}

 error:
	return ret;

} /* end keyring_duplicate() */

/*****************************************************************************/
/*
 * match keyrings on their name
 */
static int keyring_match(const struct key *keyring, const void *description)
{
	return keyring->description &&
		strcmp(keyring->description, description) == 0;

} /* end keyring_match() */

/*****************************************************************************/
/*
 * dispose of the data dangling from the corpse of a keyring
 */
static void keyring_destroy(struct key *keyring)
{
	struct keyring_list *klist;
	int loop;

	if (keyring->description) {
		write_lock(&keyring_name_lock);
204 205 206 207 208

		if (keyring->type_data.link.next != NULL &&
		    !list_empty(&keyring->type_data.link))
			list_del(&keyring->type_data.link);

L
Linus Torvalds 已提交
209 210 211
		write_unlock(&keyring_name_lock);
	}

212
	klist = rcu_dereference(keyring->payload.subscriptions);
L
Linus Torvalds 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
	if (klist) {
		for (loop = klist->nkeys - 1; loop >= 0; loop--)
			key_put(klist->keys[loop]);
		kfree(klist);
	}

} /* end keyring_destroy() */

/*****************************************************************************/
/*
 * describe the keyring
 */
static void keyring_describe(const struct key *keyring, struct seq_file *m)
{
	struct keyring_list *klist;

	if (keyring->description) {
		seq_puts(m, keyring->description);
	}
	else {
		seq_puts(m, "[anon]");
	}

236 237
	rcu_read_lock();
	klist = rcu_dereference(keyring->payload.subscriptions);
L
Linus Torvalds 已提交
238 239 240 241
	if (klist)
		seq_printf(m, ": %u/%u", klist->nkeys, klist->maxkeys);
	else
		seq_puts(m, ": empty");
242
	rcu_read_unlock();
L
Linus Torvalds 已提交
243 244 245 246 247 248

} /* end keyring_describe() */

/*****************************************************************************/
/*
 * read a list of key IDs from the keyring's contents
249
 * - the keyring's semaphore is read-locked
L
Linus Torvalds 已提交
250 251 252 253 254 255 256 257 258 259
 */
static long keyring_read(const struct key *keyring,
			 char __user *buffer, size_t buflen)
{
	struct keyring_list *klist;
	struct key *key;
	size_t qty, tmp;
	int loop, ret;

	ret = 0;
260
	klist = rcu_dereference(keyring->payload.subscriptions);
L
Linus Torvalds 已提交
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314

	if (klist) {
		/* calculate how much data we could return */
		qty = klist->nkeys * sizeof(key_serial_t);

		if (buffer && buflen > 0) {
			if (buflen > qty)
				buflen = qty;

			/* copy the IDs of the subscribed keys into the
			 * buffer */
			ret = -EFAULT;

			for (loop = 0; loop < klist->nkeys; loop++) {
				key = klist->keys[loop];

				tmp = sizeof(key_serial_t);
				if (tmp > buflen)
					tmp = buflen;

				if (copy_to_user(buffer,
						 &key->serial,
						 tmp) != 0)
					goto error;

				buflen -= tmp;
				if (buflen == 0)
					break;
				buffer += tmp;
			}
		}

		ret = qty;
	}

 error:
	return ret;

} /* end keyring_read() */

/*****************************************************************************/
/*
 * allocate a keyring and link into the destination keyring
 */
struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
			  int not_in_quota, struct key *dest)
{
	struct key *keyring;
	int ret;

	keyring = key_alloc(&key_type_keyring, description,
			    uid, gid, KEY_USR_ALL, not_in_quota);

	if (!IS_ERR(keyring)) {
315
		ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL);
L
Linus Torvalds 已提交
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
		if (ret < 0) {
			key_put(keyring);
			keyring = ERR_PTR(ret);
		}
	}

	return keyring;

} /* end keyring_alloc() */

/*****************************************************************************/
/*
 * search the supplied keyring tree for a key that matches the criterion
 * - perform a breadth-then-depth search up to the prescribed limit
 * - we only find keys on which we have search permission
 * - we use the supplied match function to see if the description (or other
 *   feature of interest) matches
333
 * - we rely on RCU to prevent the keyring lists from disappearing on us
L
Linus Torvalds 已提交
334 335 336 337
 * - we return -EAGAIN if we didn't find any matching key
 * - we return -ENOKEY if we only found negative matching keys
 */
struct key *keyring_search_aux(struct key *keyring,
338
			       struct task_struct *context,
L
Linus Torvalds 已提交
339 340 341 342 343
			       struct key_type *type,
			       const void *description,
			       key_match_func_t match)
{
	struct {
344
		struct keyring_list *keylist;
L
Linus Torvalds 已提交
345 346 347 348 349 350 351
		int kix;
	} stack[KEYRING_SEARCH_MAX_DEPTH];

	struct keyring_list *keylist;
	struct timespec now;
	struct key *key;
	long err;
352
	int sp, kix;
L
Linus Torvalds 已提交
353 354 355

	key_check(keyring);

356 357
	rcu_read_lock();

L
Linus Torvalds 已提交
358 359
	/* top keyring must have search permission to begin the search */
	key = ERR_PTR(-EACCES);
360
	if (!key_task_permission(keyring, context, KEY_SEARCH))
L
Linus Torvalds 已提交
361 362 363 364 365 366 367 368 369 370 371 372
		goto error;

	key = ERR_PTR(-ENOTDIR);
	if (keyring->type != &key_type_keyring)
		goto error;

	now = current_kernel_time();
	err = -EAGAIN;
	sp = 0;

	/* start processing a new keyring */
 descend:
373
	if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
L
Linus Torvalds 已提交
374 375
		goto not_this_keyring;

376
	keylist = rcu_dereference(keyring->payload.subscriptions);
L
Linus Torvalds 已提交
377 378 379 380 381 382 383 384 385 386 387 388
	if (!keylist)
		goto not_this_keyring;

	/* iterate through the keys in this keyring first */
	for (kix = 0; kix < keylist->nkeys; kix++) {
		key = keylist->keys[kix];

		/* ignore keys not of this type */
		if (key->type != type)
			continue;

		/* skip revoked keys and expired keys */
389
		if (test_bit(KEY_FLAG_REVOKED, &key->flags))
L
Linus Torvalds 已提交
390 391 392 393 394 395 396 397 398 399
			continue;

		if (key->expiry && now.tv_sec >= key->expiry)
			continue;

		/* keys that don't match */
		if (!match(key, description))
			continue;

		/* key must have search permissions */
400
		if (!key_task_permission(key, context, KEY_SEARCH))
L
Linus Torvalds 已提交
401 402 403
			continue;

		/* we set a different error code if we find a negative key */
404
		if (test_bit(KEY_FLAG_NEGATIVE, &key->flags)) {
L
Linus Torvalds 已提交
405 406 407 408 409 410 411 412 413 414
			err = -ENOKEY;
			continue;
		}

		goto found;
	}

	/* search through the keyrings nested in this one */
	kix = 0;
 ascend:
415
	for (; kix < keylist->nkeys; kix++) {
L
Linus Torvalds 已提交
416 417
		key = keylist->keys[kix];
		if (key->type != &key_type_keyring)
418
			continue;
L
Linus Torvalds 已提交
419 420 421 422 423

		/* recursively search nested keyrings
		 * - only search keyrings for which we have search permission
		 */
		if (sp >= KEYRING_SEARCH_MAX_DEPTH)
424
			continue;
L
Linus Torvalds 已提交
425

426
		if (!key_task_permission(key, context, KEY_SEARCH))
427
			continue;
L
Linus Torvalds 已提交
428 429

		/* stack the current position */
430
		stack[sp].keylist = keylist;
L
Linus Torvalds 已提交
431 432 433 434 435 436 437 438 439 440 441 442 443 444
		stack[sp].kix = kix;
		sp++;

		/* begin again with the new keyring */
		keyring = key;
		goto descend;
	}

	/* the keyring we're looking at was disqualified or didn't contain a
	 * matching key */
 not_this_keyring:
	if (sp > 0) {
		/* resume the processing of a keyring higher up in the tree */
		sp--;
445
		keylist = stack[sp].keylist;
L
Linus Torvalds 已提交
446 447 448 449 450 451 452 453 454 455 456 457
		kix = stack[sp].kix + 1;
		goto ascend;
	}

	key = ERR_PTR(err);
	goto error;

	/* we found a viable match */
 found:
	atomic_inc(&key->usage);
	key_check(key);
 error:
458
	rcu_read_unlock();
L
Linus Torvalds 已提交
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
	return key;

} /* end keyring_search_aux() */

/*****************************************************************************/
/*
 * search the supplied keyring tree for a key that matches the criterion
 * - perform a breadth-then-depth search up to the prescribed limit
 * - we only find keys on which we have search permission
 * - we readlock the keyrings as we search down the tree
 * - we return -EAGAIN if we didn't find any matching key
 * - we return -ENOKEY if we only found negative matching keys
 */
struct key *keyring_search(struct key *keyring,
			   struct key_type *type,
			   const char *description)
{
476 477 478 479 480
	if (!type->match)
		return ERR_PTR(-ENOKEY);

	return keyring_search_aux(keyring, current,
				  type, description, type->match);
L
Linus Torvalds 已提交
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499

} /* end keyring_search() */

EXPORT_SYMBOL(keyring_search);

/*****************************************************************************/
/*
 * search the given keyring only (no recursion)
 * - keyring must be locked by caller
 */
struct key *__keyring_search_one(struct key *keyring,
				 const struct key_type *ktype,
				 const char *description,
				 key_perm_t perm)
{
	struct keyring_list *klist;
	struct key *key;
	int loop;

500 501 502
	rcu_read_lock();

	klist = rcu_dereference(keyring->payload.subscriptions);
L
Linus Torvalds 已提交
503 504 505 506 507
	if (klist) {
		for (loop = 0; loop < klist->nkeys; loop++) {
			key = klist->keys[loop];

			if (key->type == ktype &&
508 509
			    (!key->type->match ||
			     key->type->match(key, description)) &&
L
Linus Torvalds 已提交
510
			    key_permission(key, perm) &&
511
			    !test_bit(KEY_FLAG_REVOKED, &key->flags)
L
Linus Torvalds 已提交
512 513 514 515 516 517 518 519 520 521 522
			    )
				goto found;
		}
	}

	key = ERR_PTR(-ENOKEY);
	goto error;

 found:
	atomic_inc(&key->usage);
 error:
523
	rcu_read_unlock();
L
Linus Torvalds 已提交
524 525 526 527
	return key;

} /* end __keyring_search_one() */

528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
/*****************************************************************************/
/*
 * search for an instantiation authorisation key matching a target key
 * - the RCU read lock must be held by the caller
 * - a target_id of zero specifies any valid token
 */
struct key *keyring_search_instkey(struct key *keyring,
				   key_serial_t target_id)
{
	struct request_key_auth *rka;
	struct keyring_list *klist;
	struct key *instkey;
	int loop;

	klist = rcu_dereference(keyring->payload.subscriptions);
	if (klist) {
		for (loop = 0; loop < klist->nkeys; loop++) {
			instkey = klist->keys[loop];

			if (instkey->type != &key_type_request_key_auth)
				continue;

			rka = instkey->payload.data;
			if (target_id && rka->target_key->serial != target_id)
				continue;

			/* the auth key is revoked during instantiation */
			if (!test_bit(KEY_FLAG_REVOKED, &instkey->flags))
				goto found;

			instkey = ERR_PTR(-EKEYREVOKED);
			goto error;
		}
	}

	instkey = ERR_PTR(-EACCES);
	goto error;

found:
	atomic_inc(&instkey->usage);
error:
	return instkey;

} /* end keyring_search_instkey() */

L
Linus Torvalds 已提交
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
/*****************************************************************************/
/*
 * find a keyring with the specified name
 * - all named keyrings are searched
 * - only find keyrings with search permission for the process
 * - only find keyrings with a serial number greater than the one specified
 */
struct key *find_keyring_by_name(const char *name, key_serial_t bound)
{
	struct key *keyring;
	int bucket;

	keyring = ERR_PTR(-EINVAL);
	if (!name)
		goto error;

	bucket = keyring_hash(name);

	read_lock(&keyring_name_lock);

	if (keyring_name_hash[bucket].next) {
		/* search this hash bucket for a keyring with a matching name
		 * that's readable and that hasn't been revoked */
		list_for_each_entry(keyring,
				    &keyring_name_hash[bucket],
				    type_data.link
				    ) {
600
			if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
L
Linus Torvalds 已提交
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
				continue;

			if (strcmp(keyring->description, name) != 0)
				continue;

			if (!key_permission(keyring, KEY_SEARCH))
				continue;

			/* found a potential candidate, but we still need to
			 * check the serial number */
			if (keyring->serial <= bound)
				continue;

			/* we've got a match */
			atomic_inc(&keyring->usage);
			read_unlock(&keyring_name_lock);
			goto error;
		}
	}

	read_unlock(&keyring_name_lock);
	keyring = ERR_PTR(-ENOKEY);

 error:
	return keyring;

} /* end find_keyring_by_name() */

/*****************************************************************************/
/*
 * see if a cycle will will be created by inserting acyclic tree B in acyclic
 * tree A at the topmost level (ie: as a direct child of A)
 * - since we are adding B to A at the top level, checking for cycles should
 *   just be a matter of seeing if node A is somewhere in tree B
 */
static int keyring_detect_cycle(struct key *A, struct key *B)
{
	struct {
639
		struct keyring_list *keylist;
L
Linus Torvalds 已提交
640 641 642 643 644 645 646
		int kix;
	} stack[KEYRING_SEARCH_MAX_DEPTH];

	struct keyring_list *keylist;
	struct key *subtree, *key;
	int sp, kix, ret;

647 648
	rcu_read_lock();

L
Linus Torvalds 已提交
649 650
	ret = -EDEADLK;
	if (A == B)
651
		goto cycle_detected;
L
Linus Torvalds 已提交
652 653 654 655 656 657

	subtree = B;
	sp = 0;

	/* start processing a new keyring */
 descend:
658
	if (test_bit(KEY_FLAG_REVOKED, &subtree->flags))
L
Linus Torvalds 已提交
659 660
		goto not_this_keyring;

661
	keylist = rcu_dereference(subtree->payload.subscriptions);
L
Linus Torvalds 已提交
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
	if (!keylist)
		goto not_this_keyring;
	kix = 0;

 ascend:
	/* iterate through the remaining keys in this keyring */
	for (; kix < keylist->nkeys; kix++) {
		key = keylist->keys[kix];

		if (key == A)
			goto cycle_detected;

		/* recursively check nested keyrings */
		if (key->type == &key_type_keyring) {
			if (sp >= KEYRING_SEARCH_MAX_DEPTH)
				goto too_deep;

			/* stack the current position */
680
			stack[sp].keylist = keylist;
L
Linus Torvalds 已提交
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
			stack[sp].kix = kix;
			sp++;

			/* begin again with the new keyring */
			subtree = key;
			goto descend;
		}
	}

	/* the keyring we're looking at was disqualified or didn't contain a
	 * matching key */
 not_this_keyring:
	if (sp > 0) {
		/* resume the checking of a keyring higher up in the tree */
		sp--;
696
		keylist = stack[sp].keylist;
L
Linus Torvalds 已提交
697 698 699 700 701 702 703
		kix = stack[sp].kix + 1;
		goto ascend;
	}

	ret = 0; /* no cycles detected */

 error:
704
	rcu_read_unlock();
L
Linus Torvalds 已提交
705 706 707 708
	return ret;

 too_deep:
	ret = -ELOOP;
709 710
	goto error;

L
Linus Torvalds 已提交
711 712 713 714 715 716
 cycle_detected:
	ret = -EDEADLK;
	goto error;

} /* end keyring_detect_cycle() */

717 718 719 720 721 722 723 724 725 726 727 728 729
/*****************************************************************************/
/*
 * dispose of a keyring list after the RCU grace period
 */
static void keyring_link_rcu_disposal(struct rcu_head *rcu)
{
	struct keyring_list *klist =
		container_of(rcu, struct keyring_list, rcu);

	kfree(klist);

} /* end keyring_link_rcu_disposal() */

L
Linus Torvalds 已提交
730 731 732
/*****************************************************************************/
/*
 * link a key into to a keyring
733
 * - must be called with the keyring's semaphore write-locked
L
Linus Torvalds 已提交
734 735 736 737 738 739 740 741 742
 */
int __key_link(struct key *keyring, struct key *key)
{
	struct keyring_list *klist, *nklist;
	unsigned max;
	size_t size;
	int ret;

	ret = -EKEYREVOKED;
743
	if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
L
Linus Torvalds 已提交
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
		goto error;

	ret = -ENOTDIR;
	if (keyring->type != &key_type_keyring)
		goto error;

	/* serialise link/link calls to prevent parallel calls causing a
	 * cycle when applied to two keyring in opposite orders */
	down_write(&keyring_serialise_link_sem);

	/* check that we aren't going to create a cycle adding one keyring to
	 * another */
	if (key->type == &key_type_keyring) {
		ret = keyring_detect_cycle(keyring, key);
		if (ret < 0)
			goto error2;
	}

	/* check that we aren't going to overrun the user's quota */
	ret = key_payload_reserve(keyring,
				  keyring->datalen + KEYQUOTA_LINK_BYTES);
	if (ret < 0)
		goto error2;

	klist = keyring->payload.subscriptions;

	if (klist && klist->nkeys < klist->maxkeys) {
		/* there's sufficient slack space to add directly */
		atomic_inc(&key->usage);

774 775 776 777
		klist->keys[klist->nkeys] = key;
		smp_wmb();
		klist->nkeys++;
		smp_wmb();
L
Linus Torvalds 已提交
778 779 780 781 782 783 784 785 786 787

		ret = 0;
	}
	else {
		/* grow the key list */
		max = 4;
		if (klist)
			max += klist->maxkeys;

		ret = -ENFILE;
788 789
		if (max > 65535)
			goto error3;
790
		size = sizeof(*klist) + sizeof(struct key *) * max;
L
Linus Torvalds 已提交
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
		if (size > PAGE_SIZE)
			goto error3;

		ret = -ENOMEM;
		nklist = kmalloc(size, GFP_KERNEL);
		if (!nklist)
			goto error3;
		nklist->maxkeys = max;
		nklist->nkeys = 0;

		if (klist) {
			nklist->nkeys = klist->nkeys;
			memcpy(nklist->keys,
			       klist->keys,
			       sizeof(struct key *) * klist->nkeys);
		}

		/* add the key into the new space */
		atomic_inc(&key->usage);
		nklist->keys[nklist->nkeys++] = key;
811 812

		rcu_assign_pointer(keyring->payload.subscriptions, nklist);
L
Linus Torvalds 已提交
813 814

		/* dispose of the old keyring list */
815 816
		if (klist)
			call_rcu(&klist->rcu, keyring_link_rcu_disposal);
L
Linus Torvalds 已提交
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

		ret = 0;
	}

 error2:
	up_write(&keyring_serialise_link_sem);
 error:
	return ret;

 error3:
	/* undo the quota changes */
	key_payload_reserve(keyring,
			    keyring->datalen - KEYQUOTA_LINK_BYTES);
	goto error2;

} /* end __key_link() */

/*****************************************************************************/
/*
 * link a key to a keyring
 */
int key_link(struct key *keyring, struct key *key)
{
	int ret;

	key_check(keyring);
	key_check(key);

	down_write(&keyring->sem);
	ret = __key_link(keyring, key);
	up_write(&keyring->sem);

	return ret;

} /* end key_link() */

EXPORT_SYMBOL(key_link);

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
/*****************************************************************************/
/*
 * dispose of a keyring list after the RCU grace period, freeing the unlinked
 * key
 */
static void keyring_unlink_rcu_disposal(struct rcu_head *rcu)
{
	struct keyring_list *klist =
		container_of(rcu, struct keyring_list, rcu);

	key_put(klist->keys[klist->delkey]);
	kfree(klist);

} /* end keyring_unlink_rcu_disposal() */

L
Linus Torvalds 已提交
870 871 872 873 874 875
/*****************************************************************************/
/*
 * unlink the first link to a key from a keyring
 */
int key_unlink(struct key *keyring, struct key *key)
{
876
	struct keyring_list *klist, *nklist;
L
Linus Torvalds 已提交
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
	int loop, ret;

	key_check(keyring);
	key_check(key);

	ret = -ENOTDIR;
	if (keyring->type != &key_type_keyring)
		goto error;

	down_write(&keyring->sem);

	klist = keyring->payload.subscriptions;
	if (klist) {
		/* search the keyring for the key */
		for (loop = 0; loop < klist->nkeys; loop++)
			if (klist->keys[loop] == key)
				goto key_is_present;
	}

	up_write(&keyring->sem);
	ret = -ENOENT;
	goto error;

900 901
key_is_present:
	/* we need to copy the key list for RCU purposes */
902 903
	nklist = kmalloc(sizeof(*klist) +
			 sizeof(struct key *) * klist->maxkeys,
904 905 906 907 908 909 910 911 912
			 GFP_KERNEL);
	if (!nklist)
		goto nomem;
	nklist->maxkeys = klist->maxkeys;
	nklist->nkeys = klist->nkeys - 1;

	if (loop > 0)
		memcpy(&nklist->keys[0],
		       &klist->keys[0],
913
		       loop * sizeof(struct key *));
914 915 916 917

	if (loop < nklist->nkeys)
		memcpy(&nklist->keys[loop],
		       &klist->keys[loop + 1],
918
		       (nklist->nkeys - loop) * sizeof(struct key *));
919

L
Linus Torvalds 已提交
920 921 922 923
	/* adjust the user's quota */
	key_payload_reserve(keyring,
			    keyring->datalen - KEYQUOTA_LINK_BYTES);

924
	rcu_assign_pointer(keyring->payload.subscriptions, nklist);
L
Linus Torvalds 已提交
925

926
	up_write(&keyring->sem);
L
Linus Torvalds 已提交
927

928 929 930
	/* schedule for later cleanup */
	klist->delkey = loop;
	call_rcu(&klist->rcu, keyring_unlink_rcu_disposal);
L
Linus Torvalds 已提交
931 932 933

	ret = 0;

934
error:
L
Linus Torvalds 已提交
935
	return ret;
936 937 938 939
nomem:
	ret = -ENOMEM;
	up_write(&keyring->sem);
	goto error;
L
Linus Torvalds 已提交
940 941 942 943 944

} /* end key_unlink() */

EXPORT_SYMBOL(key_unlink);

945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
/*****************************************************************************/
/*
 * dispose of a keyring list after the RCU grace period, releasing the keys it
 * links to
 */
static void keyring_clear_rcu_disposal(struct rcu_head *rcu)
{
	struct keyring_list *klist;
	int loop;

	klist = container_of(rcu, struct keyring_list, rcu);

	for (loop = klist->nkeys - 1; loop >= 0; loop--)
		key_put(klist->keys[loop]);

	kfree(klist);

} /* end keyring_clear_rcu_disposal() */

L
Linus Torvalds 已提交
964 965 966 967 968 969 970 971
/*****************************************************************************/
/*
 * clear the specified process keyring
 * - implements keyctl(KEYCTL_CLEAR)
 */
int keyring_clear(struct key *keyring)
{
	struct keyring_list *klist;
972
	int ret;
L
Linus Torvalds 已提交
973 974 975 976 977 978 979 980 981 982 983 984

	ret = -ENOTDIR;
	if (keyring->type == &key_type_keyring) {
		/* detach the pointer block with the locks held */
		down_write(&keyring->sem);

		klist = keyring->payload.subscriptions;
		if (klist) {
			/* adjust the quota */
			key_payload_reserve(keyring,
					    sizeof(struct keyring_list));

985 986
			rcu_assign_pointer(keyring->payload.subscriptions,
					   NULL);
L
Linus Torvalds 已提交
987 988 989 990 991
		}

		up_write(&keyring->sem);

		/* free the keys after the locks have been dropped */
992 993
		if (klist)
			call_rcu(&klist->rcu, keyring_clear_rcu_disposal);
L
Linus Torvalds 已提交
994 995 996 997 998 999 1000 1001 1002

		ret = 0;
	}

	return ret;

} /* end keyring_clear() */

EXPORT_SYMBOL(keyring_clear);