security/keys/keyring.c

   1 /* Keyring handling
   2  *
   3  * Copyright (C) 2004-2005, 2008 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/init.h>
  14 #include <linux/sched.h>
  15 #include <linux/slab.h>
  16 #include <linux/security.h>
  17 #include <linux/seq_file.h>
  18 #include <linux/err.h>
  19 #include <keys/keyring-type.h>
  20 #include <linux/uaccess.h>
  21 #include "internal.h"
  22
  23 #define rcu_dereference_locked_keyring(keyring)                         \
  24         (rcu_dereference_protected(                                     \
  25                 (keyring)->payload.subscriptions,                       \
  26                 rwsem_is_locked((struct rw_semaphore *)&(keyring)->sem)))
  27
  28 #define rcu_deref_link_locked(klist, index, keyring)                    \
  29         (rcu_dereference_protected(                                     \
  30                 (klist)->keys[index],                                   \
  31                 rwsem_is_locked((struct rw_semaphore *)&(keyring)->sem)))
  32
  33 #define MAX_KEYRING_LINKS                                               \
  34         min_t(size_t, USHRT_MAX - 1,                                    \
  35               ((PAGE_SIZE - sizeof(struct keyring_list)) / sizeof(struct key *)))
  36
  37 #define KEY_LINK_FIXQUOTA 1UL
  38
  39 /*
  40  * When plumbing the depths of the key tree, this sets a hard limit
  41  * set on how deep we're willing to go.
  42  */
  43 #define KEYRING_SEARCH_MAX_DEPTH 6
  44
  45 /*
  46  * We keep all named keyrings in a hash to speed looking them up.
  47  */
  48 #define KEYRING_NAME_HASH_SIZE  (1 << 5)
  49
  50 static struct list_head keyring_name_hash[KEYRING_NAME_HASH_SIZE];
  51 static DEFINE_RWLOCK(keyring_name_lock);
  52
  53 static inline unsigned keyring_hash(const char *desc)
  54 {
  55         unsigned bucket = 0;
  56
  57         for (; *desc; desc++)
  58                 bucket += (unsigned char)*desc;
  59
  60         return bucket & (KEYRING_NAME_HASH_SIZE - 1);
  61 }
  62
  63 /*
  64  * The keyring key type definition.  Keyrings are simply keys of this type and
  65  * can be treated as ordinary keys in addition to having their own special
  66  * operations.
  67  */
  68 static int keyring_instantiate(struct key *keyring,
  69                                const void *data, size_t datalen);
  70 static int keyring_match(const struct key *keyring, const void *criterion);
  71 static void keyring_revoke(struct key *keyring);
  72 static void keyring_destroy(struct key *keyring);
  73 static void keyring_describe(const struct key *keyring, struct seq_file *m);
  74 static long keyring_read(const struct key *keyring,
  75                          char __user *buffer, size_t buflen);
  76
  77 struct key_type key_type_keyring = {
  78         .name           = "keyring",
  79         .def_datalen    = sizeof(struct keyring_list),
  80         .instantiate    = keyring_instantiate,
  81         .match          = keyring_match,
  82         .revoke         = keyring_revoke,
  83         .destroy        = keyring_destroy,
  84         .describe       = keyring_describe,
  85         .read           = keyring_read,
  86 };
  87 EXPORT_SYMBOL(key_type_keyring);
  88
  89 /*
  90  * Semaphore to serialise link/link calls to prevent two link calls in parallel
  91  * introducing a cycle.
  92  */
  93 static DECLARE_RWSEM(keyring_serialise_link_sem);
  94
  95 /*
  96  * Publish the name of a keyring so that it can be found by name (if it has
  97  * one).
  98  */
  99 static void keyring_publish_name(struct key *keyring)
 100 {
 101         int bucket;
 102
 103         if (keyring->description) {
 104                 bucket = keyring_hash(keyring->description);
 105
 106                 write_lock(&keyring_name_lock);
 107
 108                 if (!keyring_name_hash[bucket].next)
 109                         INIT_LIST_HEAD(&keyring_name_hash[bucket]);
 110
 111                 list_add_tail(&keyring->type_data.link,
 112                               &keyring_name_hash[bucket]);
 113
 114                 write_unlock(&keyring_name_lock);
 115         }
 116 }
 117
 118 /*
 119  * Initialise a keyring.
 120  *
 121  * Returns 0 on success, -EINVAL if given any data.
 122  */
 123 static int keyring_instantiate(struct key *keyring,
 124                                const void *data, size_t datalen)
 125 {
 126         int ret;
 127
 128         ret = -EINVAL;
 129         if (datalen == 0) {
 130                 /* make the keyring available by name if it has one */
 131                 keyring_publish_name(keyring);
 132                 ret = 0;
 133         }
 134
 135         return ret;
 136 }
 137
 138 /*
 139  * Match keyrings on their name
 140  */
 141 static int keyring_match(const struct key *keyring, const void *description)
 142 {
 143         return keyring->description &&
 144                 strcmp(keyring->description, description) == 0;
 145 }
 146
 147 /*
 148  * Clean up a keyring when it is destroyed.  Unpublish its name if it had one
 149  * and dispose of its data.
 150  *
 151  * The garbage collector detects the final key_put(), removes the keyring from
 152  * the serial number tree and then does RCU synchronisation before coming here,
 153  * so we shouldn't need to worry about code poking around here with the RCU
 154  * readlock held by this time.
 155  */
 156 static void keyring_destroy(struct key *keyring)
 157 {
 158         struct keyring_list *klist;
 159         int loop;
 160
 161         if (keyring->description) {
 162                 write_lock(&keyring_name_lock);
 163
 164                 if (keyring->type_data.link.next != NULL &&
 165                     !list_empty(&keyring->type_data.link))
 166                         list_del(&keyring->type_data.link);
 167
 168                 write_unlock(&keyring_name_lock);
 169         }
 170
 171         klist = rcu_access_pointer(keyring->payload.subscriptions);
 172         if (klist) {
 173                 for (loop = klist->nkeys - 1; loop >= 0; loop--)
 174                         key_put(rcu_access_pointer(klist->keys[loop]));
 175                 kfree(klist);
 176         }
 177 }
 178
 179 /*
 180  * Describe a keyring for /proc.
 181  */
 182 static void keyring_describe(const struct key *keyring, struct seq_file *m)
 183 {
 184         struct keyring_list *klist;
 185
 186         if (keyring->description)
 187                 seq_puts(m, keyring->description);
 188         else
 189                 seq_puts(m, "[anon]");
 190
 191         if (key_is_instantiated(keyring)) {
 192                 rcu_read_lock();
 193                 klist = rcu_dereference(keyring->payload.subscriptions);
 194                 if (klist)
 195                         seq_printf(m, ": %u/%u", klist->nkeys, klist->maxkeys);
 196                 else
 197                         seq_puts(m, ": empty");
 198                 rcu_read_unlock();
 199         }
 200 }
 201
 202 /*
 203  * Read a list of key IDs from the keyring's contents in binary form
 204  *
 205  * The keyring's semaphore is read-locked by the caller.
 206  */
 207 static long keyring_read(const struct key *keyring,
 208                          char __user *buffer, size_t buflen)
 209 {
 210         struct keyring_list *klist;
 211         struct key *key;
 212         size_t qty, tmp;
 213         int loop, ret;
 214
 215         ret = 0;
 216         klist = rcu_dereference_locked_keyring(keyring);
 217         if (klist) {
 218                 /* calculate how much data we could return */
 219                 qty = klist->nkeys * sizeof(key_serial_t);
 220
 221                 if (buffer && buflen > 0) {
 222                         if (buflen > qty)
 223                                 buflen = qty;
 224
 225                         /* copy the IDs of the subscribed keys into the
 226                          * buffer */
 227                         ret = -EFAULT;
 228
 229                         for (loop = 0; loop < klist->nkeys; loop++) {
 230                                 key = rcu_deref_link_locked(klist, loop,
 231                                                             keyring);
 232
 233                                 tmp = sizeof(key_serial_t);
 234                                 if (tmp > buflen)
 235                                         tmp = buflen;
 236
 237                                 if (copy_to_user(buffer,
 238                                                  &key->serial,
 239                                                  tmp) != 0)
 240                                         goto error;
 241
 242                                 buflen -= tmp;
 243                                 if (buflen == 0)
 244                                         break;
 245                                 buffer += tmp;
 246                         }
 247                 }
 248
 249                 ret = qty;
 250         }
 251
 252 error:
 253         return ret;
 254 }
 255
 256 /*
 257  * Allocate a keyring and link into the destination keyring.
 258  */
 259 struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
 260                           const struct cred *cred, unsigned long flags,
 261                           struct key *dest)
 262 {
 263         struct key *keyring;
 264         int ret;
 265
 266         keyring = key_alloc(&key_type_keyring, description,
 267                             uid, gid, cred,
 268                             (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL,
 269                             flags);
 270
 271         if (!IS_ERR(keyring)) {
 272                 ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL);
 273                 if (ret < 0) {
 274                         key_put(keyring);
 275                         keyring = ERR_PTR(ret);
 276                 }
 277         }
 278
 279         return keyring;
 280 }
 281
 282 /**
 283  * keyring_search_aux - Search a keyring tree for a key matching some criteria
 284  * @keyring_ref: A pointer to the keyring with possession indicator.
 285  * @cred: The credentials to use for permissions checks.
 286  * @type: The type of key to search for.
 287  * @description: Parameter for @match.
 288  * @match: Function to rule on whether or not a key is the one required.
 289  * @no_state_check: Don't check if a matching key is bad
 290  *
 291  * Search the supplied keyring tree for a key that matches the criteria given.
 292  * The root keyring and any linked keyrings must grant Search permission to the
 293  * caller to be searchable and keys can only be found if they too grant Search
 294  * to the caller. The possession flag on the root keyring pointer controls use
 295  * of the possessor bits in permissions checking of the entire tree.  In
 296  * addition, the LSM gets to forbid keyring searches and key matches.
 297  *
 298  * The search is performed as a breadth-then-depth search up to the prescribed
 299  * limit (KEYRING_SEARCH_MAX_DEPTH).
 300  *
 301  * Keys are matched to the type provided and are then filtered by the match
 302  * function, which is given the description to use in any way it sees fit.  The
 303  * match function may use any attributes of a key that it wishes to to
 304  * determine the match.  Normally the match function from the key type would be
 305  * used.
 306  *
 307  * RCU is used to prevent the keyring key lists from disappearing without the
 308  * need to take lots of locks.
 309  *
 310  * Returns a pointer to the found key and increments the key usage count if
 311  * successful; -EAGAIN if no matching keys were found, or if expired or revoked
 312  * keys were found; -ENOKEY if only negative keys were found; -ENOTDIR if the
 313  * specified keyring wasn't a keyring.
 314  *
 315  * In the case of a successful return, the possession attribute from
 316  * @keyring_ref is propagated to the returned key reference.
 317  */
 318 key_ref_t keyring_search_aux(key_ref_t keyring_ref,
 319                              const struct cred *cred,
 320                              struct key_type *type,
 321                              const void *description,
 322                              key_match_func_t match,
 323                              bool no_state_check)
 324 {
 325         struct {
 326                 /* Need a separate keylist pointer for RCU purposes */
 327                 struct key *keyring;
 328                 struct keyring_list *keylist;
 329                 int kix;
 330         } stack[KEYRING_SEARCH_MAX_DEPTH];
 331
 332         struct keyring_list *keylist;
 333         struct timespec now;
 334         unsigned long possessed, kflags;
 335         struct key *keyring, *key;
 336         key_ref_t key_ref;
 337         long err;
 338         int sp, nkeys, kix;
 339
 340         keyring = key_ref_to_ptr(keyring_ref);
 341         possessed = is_key_possessed(keyring_ref);
 342         key_check(keyring);
 343
 344         /* top keyring must have search permission to begin the search */
 345         err = key_task_permission(keyring_ref, cred, KEY_SEARCH);
 346         if (err < 0) {
 347                 key_ref = ERR_PTR(err);
 348                 goto error;
 349         }
 350
 351         key_ref = ERR_PTR(-ENOTDIR);
 352         if (keyring->type != &key_type_keyring)
 353                 goto error;
 354
 355         rcu_read_lock();
 356
 357         now = current_kernel_time();
 358         err = -EAGAIN;
 359         sp = 0;
 360
 361         /* firstly we should check to see if this top-level keyring is what we
 362          * are looking for */
 363         key_ref = ERR_PTR(-EAGAIN);
 364         kflags = keyring->flags;
 365         if (keyring->type == type && match(keyring, description)) {
 366                 key = keyring;
 367                 if (no_state_check)
 368                         goto found;
 369
 370                 /* check it isn't negative and hasn't expired or been
 371                  * revoked */
 372                 if (kflags & (1 << KEY_FLAG_REVOKED))
 373                         goto error_2;
 374                 if (key->expiry && now.tv_sec >= key->expiry)
 375                         goto error_2;
 376                 key_ref = ERR_PTR(key->type_data.reject_error);
 377                 if (kflags & (1 << KEY_FLAG_NEGATIVE))
 378                         goto error_2;
 379                 goto found;
 380         }
 381
 382         /* otherwise, the top keyring must not be revoked, expired, or
 383          * negatively instantiated if we are to search it */
 384         key_ref = ERR_PTR(-EAGAIN);
 385         if (kflags & ((1 << KEY_FLAG_REVOKED) | (1 << KEY_FLAG_NEGATIVE)) ||
 386             (keyring->expiry && now.tv_sec >= keyring->expiry))
 387                 goto error_2;
 388
 389         /* start processing a new keyring */
 390 descend:
 391         if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
 392                 goto not_this_keyring;
 393
 394         keylist = rcu_dereference(keyring->payload.subscriptions);
 395         if (!keylist)
 396                 goto not_this_keyring;
 397
 398         /* iterate through the keys in this keyring first */
 399         nkeys = keylist->nkeys;
 400         smp_rmb();
 401         for (kix = 0; kix < nkeys; kix++) {
 402                 key = rcu_dereference(keylist->keys[kix]);
 403                 kflags = key->flags;
 404
 405                 /* ignore keys not of this type */
 406                 if (key->type != type)
 407                         continue;
 408
 409                 /* skip revoked keys and expired keys */
 410                 if (!no_state_check) {
 411                         if (kflags & (1 << KEY_FLAG_REVOKED))
 412                                 continue;
 413
 414                         if (key->expiry && now.tv_sec >= key->expiry)
 415                                 continue;
 416                 }
 417
 418                 /* keys that don't match */
 419                 if (!match(key, description))
 420                         continue;
 421
 422                 /* key must have search permissions */
 423                 if (key_task_permission(make_key_ref(key, possessed),
 424                                         cred, KEY_SEARCH) < 0)
 425                         continue;
 426
 427                 if (no_state_check)
 428                         goto found;
 429
 430                 /* we set a different error code if we pass a negative key */
 431                 if (kflags & (1 << KEY_FLAG_NEGATIVE)) {
 432                         err = key->type_data.reject_error;
 433                         continue;
 434                 }
 435
 436                 goto found;
 437         }
 438
 439         /* search through the keyrings nested in this one */
 440         kix = 0;
 441 ascend:
 442         nkeys = keylist->nkeys;
 443         smp_rmb();
 444         for (; kix < nkeys; kix++) {
 445                 key = rcu_dereference(keylist->keys[kix]);
 446                 if (key->type != &key_type_keyring)
 447                         continue;
 448
 449                 /* recursively search nested keyrings
 450                  * - only search keyrings for which we have search permission
 451                  */
 452                 if (sp >= KEYRING_SEARCH_MAX_DEPTH)
 453                         continue;
 454
 455                 if (key_task_permission(make_key_ref(key, possessed),
 456                                         cred, KEY_SEARCH) < 0)
 457                         continue;
 458
 459                 /* stack the current position */
 460                 stack[sp].keyring = keyring;
 461                 stack[sp].keylist = keylist;
 462                 stack[sp].kix = kix;
 463                 sp++;
 464
 465                 /* begin again with the new keyring */
 466                 keyring = key;
 467                 goto descend;
 468         }
 469
 470         /* the keyring we're looking at was disqualified or didn't contain a
 471          * matching key */
 472 not_this_keyring:
 473         if (sp > 0) {
 474                 /* resume the processing of a keyring higher up in the tree */
 475                 sp--;
 476                 keyring = stack[sp].keyring;
 477                 keylist = stack[sp].keylist;
 478                 kix = stack[sp].kix + 1;
 479                 goto ascend;
 480         }
 481
 482         key_ref = ERR_PTR(err);
 483         goto error_2;
 484
 485         /* we found a viable match */
 486 found:
 487         atomic_inc(&key->usage);
 488         key->last_used_at = now.tv_sec;
 489         keyring->last_used_at = now.tv_sec;
 490         while (sp > 0)
 491                 stack[--sp].keyring->last_used_at = now.tv_sec;
 492         key_check(key);
 493         key_ref = make_key_ref(key, possessed);
 494 error_2:
 495         rcu_read_unlock();
 496 error:
 497         return key_ref;
 498 }
 499
 500 /**
 501  * keyring_search - Search the supplied keyring tree for a matching key
 502  * @keyring: The root of the keyring tree to be searched.
 503  * @type: The type of keyring we want to find.
 504  * @description: The name of the keyring we want to find.
 505  *
 506  * As keyring_search_aux() above, but using the current task's credentials and
 507  * type's default matching function.
 508  */
 509 key_ref_t keyring_search(key_ref_t keyring,
 510                          struct key_type *type,
 511                          const char *description)
 512 {
 513         if (!type->match)
 514                 return ERR_PTR(-ENOKEY);
 515
 516         return keyring_search_aux(keyring, current->cred,
 517                                   type, description, type->match, false);
 518 }
 519 EXPORT_SYMBOL(keyring_search);
 520
 521 /*
 522  * Search the given keyring only (no recursion).
 523  *
 524  * The caller must guarantee that the keyring is a keyring and that the
 525  * permission is granted to search the keyring as no check is made here.
 526  *
 527  * RCU is used to make it unnecessary to lock the keyring key list here.
 528  *
 529  * Returns a pointer to the found key with usage count incremented if
 530  * successful and returns -ENOKEY if not found.  Revoked keys and keys not
 531  * providing the requested permission are skipped over.
 532  *
 533  * If successful, the possession indicator is propagated from the keyring ref
 534  * to the returned key reference.
 535  */
 536 key_ref_t __keyring_search_one(key_ref_t keyring_ref,
 537                                const struct key_type *ktype,
 538                                const char *description,
 539                                key_perm_t perm)
 540 {
 541         struct keyring_list *klist;
 542         unsigned long possessed;
 543         struct key *keyring, *key;
 544         int nkeys, loop;
 545
 546         keyring = key_ref_to_ptr(keyring_ref);
 547         possessed = is_key_possessed(keyring_ref);
 548
 549         rcu_read_lock();
 550
 551         klist = rcu_dereference(keyring->payload.subscriptions);
 552         if (klist) {
 553                 nkeys = klist->nkeys;
 554                 smp_rmb();
 555                 for (loop = 0; loop < nkeys ; loop++) {
 556                         key = rcu_dereference(klist->keys[loop]);
 557                         if (key->type == ktype &&
 558                             (!key->type->match ||
 559                              key->type->match(key, description)) &&
 560                             key_permission(make_key_ref(key, possessed),
 561                                            perm) == 0 &&
 562                             !test_bit(KEY_FLAG_REVOKED, &key->flags)
 563                             )
 564                                 goto found;
 565                 }
 566         }
 567
 568         rcu_read_unlock();
 569         return ERR_PTR(-ENOKEY);
 570
 571 found:
 572         atomic_inc(&key->usage);
 573         keyring->last_used_at = key->last_used_at =
 574                 current_kernel_time().tv_sec;
 575         rcu_read_unlock();
 576         return make_key_ref(key, possessed);
 577 }
 578
 579 /*
 580  * Find a keyring with the specified name.
 581  *
 582  * All named keyrings in the current user namespace are searched, provided they
 583  * grant Search permission directly to the caller (unless this check is
 584  * skipped).  Keyrings whose usage points have reached zero or who have been
 585  * revoked are skipped.
 586  *
 587  * Returns a pointer to the keyring with the keyring's refcount having being
 588  * incremented on success.  -ENOKEY is returned if a key could not be found.
 589  */
 590 struct key *find_keyring_by_name(const char *name, bool skip_perm_check)
 591 {
 592         struct key *keyring;
 593         int bucket;
 594
 595         if (!name)
 596                 return ERR_PTR(-EINVAL);
 597
 598         bucket = keyring_hash(name);
 599
 600         read_lock(&keyring_name_lock);
 601
 602         if (keyring_name_hash[bucket].next) {
 603                 /* search this hash bucket for a keyring with a matching name
 604                  * that's readable and that hasn't been revoked */
 605                 list_for_each_entry(keyring,
 606                                     &keyring_name_hash[bucket],
 607                                     type_data.link
 608                                     ) {
 609                         if (keyring->user->user_ns != current_user_ns())
 610                                 continue;
 611
 612                         if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
 613                                 continue;
 614
 615                         if (strcmp(keyring->description, name) != 0)
 616                                 continue;
 617
 618                         if (!skip_perm_check &&
 619                             key_permission(make_key_ref(keyring, 0),
 620                                            KEY_SEARCH) < 0)
 621                                 continue;
 622
 623                         /* we've got a match but we might end up racing with
 624                          * key_cleanup() if the keyring is currently 'dead'
 625                          * (ie. it has a zero usage count) */
 626                         if (!atomic_inc_not_zero(&keyring->usage))
 627                                 continue;
 628                         keyring->last_used_at = current_kernel_time().tv_sec;
 629                         goto out;
 630                 }
 631         }
 632
 633         keyring = ERR_PTR(-ENOKEY);
 634 out:
 635         read_unlock(&keyring_name_lock);
 636         return keyring;
 637 }
 638
 639 /*
 640  * See if a cycle will will be created by inserting acyclic tree B in acyclic
 641  * tree A at the topmost level (ie: as a direct child of A).
 642  *
 643  * Since we are adding B to A at the top level, checking for cycles should just
 644  * be a matter of seeing if node A is somewhere in tree B.
 645  */
 646 static int keyring_detect_cycle(struct key *A, struct key *B)
 647 {
 648         struct {
 649                 struct keyring_list *keylist;
 650                 int kix;
 651         } stack[KEYRING_SEARCH_MAX_DEPTH];
 652
 653         struct keyring_list *keylist;
 654         struct key *subtree, *key;
 655         int sp, nkeys, kix, ret;
 656
 657         rcu_read_lock();
 658
 659         ret = -EDEADLK;
 660         if (A == B)
 661                 goto cycle_detected;
 662
 663         subtree = B;
 664         sp = 0;
 665
 666         /* start processing a new keyring */
 667 descend:
 668         if (test_bit(KEY_FLAG_REVOKED, &subtree->flags))
 669                 goto not_this_keyring;
 670
 671         keylist = rcu_dereference(subtree->payload.subscriptions);
 672         if (!keylist)
 673                 goto not_this_keyring;
 674         kix = 0;
 675
 676 ascend:
 677         /* iterate through the remaining keys in this keyring */
 678         nkeys = keylist->nkeys;
 679         smp_rmb();
 680         for (; kix < nkeys; kix++) {
 681                 key = rcu_dereference(keylist->keys[kix]);
 682
 683                 if (key == A)
 684                         goto cycle_detected;
 685
 686                 /* recursively check nested keyrings */
 687                 if (key->type == &key_type_keyring) {
 688                         if (sp >= KEYRING_SEARCH_MAX_DEPTH)
 689                                 goto too_deep;
 690
 691                         /* stack the current position */
 692                         stack[sp].keylist = keylist;
 693                         stack[sp].kix = kix;
 694                         sp++;
 695
 696                         /* begin again with the new keyring */
 697                         subtree = key;
 698                         goto descend;
 699                 }
 700         }
 701
 702         /* the keyring we're looking at was disqualified or didn't contain a
 703          * matching key */
 704 not_this_keyring:
 705         if (sp > 0) {
 706                 /* resume the checking of a keyring higher up in the tree */
 707                 sp--;
 708                 keylist = stack[sp].keylist;
 709                 kix = stack[sp].kix + 1;
 710                 goto ascend;
 711         }
 712
 713         ret = 0; /* no cycles detected */
 714
 715 error:
 716         rcu_read_unlock();
 717         return ret;
 718
 719 too_deep:
 720         ret = -ELOOP;
 721         goto error;
 722
 723 cycle_detected:
 724         ret = -EDEADLK;
 725         goto error;
 726 }
 727
 728 /*
 729  * Dispose of a keyring list after the RCU grace period, freeing the unlinked
 730  * key
 731  */
 732 static void keyring_unlink_rcu_disposal(struct rcu_head *rcu)
 733 {
 734         struct keyring_list *klist =
 735                 container_of(rcu, struct keyring_list, rcu);
 736
 737         if (klist->delkey != USHRT_MAX)
 738                 key_put(rcu_access_pointer(klist->keys[klist->delkey]));
 739         kfree(klist);
 740 }
 741
 742 /*
 743  * Preallocate memory so that a key can be linked into to a keyring.
 744  */
 745 int __key_link_begin(struct key *keyring, const struct key_type *type,
 746                      const char *description, unsigned long *_prealloc)
 747         __acquires(&keyring->sem)
 748 {
 749         struct keyring_list *klist, *nklist;
 750         unsigned long prealloc;
 751         unsigned max;
 752         time_t lowest_lru;
 753         size_t size;
 754         int loop, lru, ret;
 755
 756         kenter("%d,%s,%s,", key_serial(keyring), type->name, description);
 757
 758         if (keyring->type != &key_type_keyring)
 759                 return -ENOTDIR;
 760
 761         down_write(&keyring->sem);
 762
 763         ret = -EKEYREVOKED;
 764         if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
 765                 goto error_krsem;
 766
 767         /* serialise link/link calls to prevent parallel calls causing a cycle
 768          * when linking two keyring in opposite orders */
 769         if (type == &key_type_keyring)
 770                 down_write(&keyring_serialise_link_sem);
 771
 772         klist = rcu_dereference_locked_keyring(keyring);
 773
 774         /* see if there's a matching key we can displace */
 775         lru = -1;
 776         if (klist && klist->nkeys > 0) {
 777                 lowest_lru = TIME_T_MAX;
 778                 for (loop = klist->nkeys - 1; loop >= 0; loop--) {
 779                         struct key *key = rcu_deref_link_locked(klist, loop,
 780                                                                 keyring);
 781                         if (key->type == type &&
 782                             strcmp(key->description, description) == 0) {
 783                                 /* Found a match - we'll replace the link with
 784                                  * one to the new key.  We record the slot
 785                                  * position.
 786                                  */
 787                                 klist->delkey = loop;
 788                                 prealloc = 0;
 789                                 goto done;
 790                         }
 791                         if (key->last_used_at < lowest_lru) {
 792                                 lowest_lru = key->last_used_at;
 793                                 lru = loop;
 794                         }
 795                 }
 796         }
 797
 798         /* If the keyring is full then do an LRU discard */
 799         if (klist &&
 800             klist->nkeys == klist->maxkeys &&
 801             klist->maxkeys >= MAX_KEYRING_LINKS) {
 802                 kdebug("LRU discard %d\n", lru);
 803                 klist->delkey = lru;
 804                 prealloc = 0;
 805                 goto done;
 806         }
 807
 808         /* check that we aren't going to overrun the user's quota */
 809         ret = key_payload_reserve(keyring,
 810                                   keyring->datalen + KEYQUOTA_LINK_BYTES);
 811         if (ret < 0)
 812                 goto error_sem;
 813
 814         if (klist && klist->nkeys < klist->maxkeys) {
 815                 /* there's sufficient slack space to append directly */
 816                 klist->delkey = klist->nkeys;
 817                 prealloc = KEY_LINK_FIXQUOTA;
 818         } else {
 819                 /* grow the key list */
 820                 max = 4;
 821                 if (klist) {
 822                         max += klist->maxkeys;
 823                         if (max > MAX_KEYRING_LINKS)
 824                                 max = MAX_KEYRING_LINKS;
 825                         BUG_ON(max <= klist->maxkeys);
 826                 }
 827
 828                 size = sizeof(*klist) + sizeof(struct key *) * max;
 829
 830                 ret = -ENOMEM;
 831                 nklist = kmalloc(size, GFP_KERNEL);
 832                 if (!nklist)
 833                         goto error_quota;
 834
 835                 nklist->maxkeys = max;
 836                 if (klist) {
 837                         memcpy(nklist->keys, klist->keys,
 838                                sizeof(struct key *) * klist->nkeys);
 839                         nklist->delkey = klist->nkeys;
 840                         nklist->nkeys = klist->nkeys + 1;
 841                         klist->delkey = USHRT_MAX;
 842                 } else {
 843                         nklist->nkeys = 1;
 844                         nklist->delkey = 0;
 845                 }
 846
 847                 /* add the key into the new space */
 848                 RCU_INIT_POINTER(nklist->keys[nklist->delkey], NULL);
 849                 prealloc = (unsigned long)nklist | KEY_LINK_FIXQUOTA;
 850         }
 851
 852 done:
 853         *_prealloc = prealloc;
 854         kleave(" = 0");
 855         return 0;
 856
 857 error_quota:
 858         /* undo the quota changes */
 859         key_payload_reserve(keyring,
 860                             keyring->datalen - KEYQUOTA_LINK_BYTES);
 861 error_sem:
 862         if (type == &key_type_keyring)
 863                 up_write(&keyring_serialise_link_sem);
 864 error_krsem:
 865         up_write(&keyring->sem);
 866         kleave(" = %d", ret);
 867         return ret;
 868 }
 869
 870 /*
 871  * Check already instantiated keys aren't going to be a problem.
 872  *
 873  * The caller must have called __key_link_begin(). Don't need to call this for
 874  * keys that were created since __key_link_begin() was called.
 875  */
 876 int __key_link_check_live_key(struct key *keyring, struct key *key)
 877 {
 878         if (key->type == &key_type_keyring)
 879                 /* check that we aren't going to create a cycle by linking one
 880                  * keyring to another */
 881                 return keyring_detect_cycle(keyring, key);
 882         return 0;
 883 }
 884
 885 /*
 886  * Link a key into to a keyring.
 887  *
 888  * Must be called with __key_link_begin() having being called.  Discards any
 889  * already extant link to matching key if there is one, so that each keyring
 890  * holds at most one link to any given key of a particular type+description
 891  * combination.
 892  */
 893 void __key_link(struct key *keyring, struct key *key,
 894                 unsigned long *_prealloc)
 895 {
 896         struct keyring_list *klist, *nklist;
 897         struct key *discard;
 898
 899         nklist = (struct keyring_list *)(*_prealloc & ~KEY_LINK_FIXQUOTA);
 900         *_prealloc = 0;
 901
 902         kenter("%d,%d,%p", keyring->serial, key->serial, nklist);
 903
 904         klist = rcu_dereference_locked_keyring(keyring);
 905
 906         atomic_inc(&key->usage);
 907         keyring->last_used_at = key->last_used_at =
 908                 current_kernel_time().tv_sec;
 909
 910         /* there's a matching key we can displace or an empty slot in a newly
 911          * allocated list we can fill */
 912         if (nklist) {
 913                 kdebug("reissue %hu/%hu/%hu",
 914                        nklist->delkey, nklist->nkeys, nklist->maxkeys);
 915
 916                 RCU_INIT_POINTER(nklist->keys[nklist->delkey], key);
 917
 918                 rcu_assign_pointer(keyring->payload.subscriptions, nklist);
 919
 920                 /* dispose of the old keyring list and, if there was one, the
 921                  * displaced key */
 922                 if (klist) {
 923                         kdebug("dispose %hu/%hu/%hu",
 924                                klist->delkey, klist->nkeys, klist->maxkeys);
 925                         call_rcu(&klist->rcu, keyring_unlink_rcu_disposal);
 926                 }
 927         } else if (klist->delkey < klist->nkeys) {
 928                 kdebug("replace %hu/%hu/%hu",
 929                        klist->delkey, klist->nkeys, klist->maxkeys);
 930
 931                 discard = rcu_dereference_protected(
 932                         klist->keys[klist->delkey],
 933                         rwsem_is_locked(&keyring->sem));
 934                 rcu_assign_pointer(klist->keys[klist->delkey], key);
 935                 /* The garbage collector will take care of RCU
 936                  * synchronisation */
 937                 key_put(discard);
 938         } else {
 939                 /* there's sufficient slack space to append directly */
 940                 kdebug("append %hu/%hu/%hu",
 941                        klist->delkey, klist->nkeys, klist->maxkeys);
 942
 943                 RCU_INIT_POINTER(klist->keys[klist->delkey], key);
 944                 smp_wmb();
 945                 klist->nkeys++;
 946         }
 947 }
 948
 949 /*
 950  * Finish linking a key into to a keyring.
 951  *
 952  * Must be called with __key_link_begin() having being called.
 953  */
 954 void __key_link_end(struct key *keyring, struct key_type *type,
 955                     unsigned long prealloc)
 956         __releases(&keyring->sem)
 957 {
 958         BUG_ON(type == NULL);
 959         BUG_ON(type->name == NULL);
 960         kenter("%d,%s,%lx", keyring->serial, type->name, prealloc);
 961
 962         if (type == &key_type_keyring)
 963                 up_write(&keyring_serialise_link_sem);
 964
 965         if (prealloc) {
 966                 if (prealloc & KEY_LINK_FIXQUOTA)
 967                         key_payload_reserve(keyring,
 968                                             keyring->datalen -
 969                                             KEYQUOTA_LINK_BYTES);
 970                 kfree((struct keyring_list *)(prealloc & ~KEY_LINK_FIXQUOTA));
 971         }
 972         up_write(&keyring->sem);
 973 }
 974
 975 /**
 976  * key_link - Link a key to a keyring
 977  * @keyring: The keyring to make the link in.
 978  * @key: The key to link to.
 979  *
 980  * Make a link in a keyring to a key, such that the keyring holds a reference
 981  * on that key and the key can potentially be found by searching that keyring.
 982  *
 983  * This function will write-lock the keyring's semaphore and will consume some
 984  * of the user's key data quota to hold the link.
 985  *
 986  * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring,
 987  * -EKEYREVOKED if the keyring has been revoked, -ENFILE if the keyring is
 988  * full, -EDQUOT if there is insufficient key data quota remaining to add
 989  * another link or -ENOMEM if there's insufficient memory.
 990  *
 991  * It is assumed that the caller has checked that it is permitted for a link to
 992  * be made (the keyring should have Write permission and the key Link
 993  * permission).
 994  */
 995 int key_link(struct key *keyring, struct key *key)
 996 {
 997         unsigned long prealloc;
 998         int ret;
 999
1000         key_check(keyring);
1001         key_check(key);
1002
1003         ret = __key_link_begin(keyring, key->type, key->description, &prealloc);
1004         if (ret == 0) {
1005                 ret = __key_link_check_live_key(keyring, key);
1006                 if (ret == 0)
1007                         __key_link(keyring, key, &prealloc);
1008                 __key_link_end(keyring, key->type, prealloc);
1009         }
1010
1011         return ret;
1012 }
1013 EXPORT_SYMBOL(key_link);
1014
1015 /**
1016  * key_unlink - Unlink the first link to a key from a keyring.
1017  * @keyring: The keyring to remove the link from.
1018  * @key: The key the link is to.
1019  *
1020  * Remove a link from a keyring to a key.
1021  *
1022  * This function will write-lock the keyring's semaphore.
1023  *
1024  * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring, -ENOENT if
1025  * the key isn't linked to by the keyring or -ENOMEM if there's insufficient
1026  * memory.
1027  *
1028  * It is assumed that the caller has checked that it is permitted for a link to
1029  * be removed (the keyring should have Write permission; no permissions are
1030  * required on the key).
1031  */
1032 int key_unlink(struct key *keyring, struct key *key)
1033 {
1034         struct keyring_list *klist, *nklist;
1035         int loop, ret;
1036
1037         key_check(keyring);
1038         key_check(key);
1039
1040         ret = -ENOTDIR;
1041         if (keyring->type != &key_type_keyring)
1042                 goto error;
1043
1044         down_write(&keyring->sem);
1045
1046         klist = rcu_dereference_locked_keyring(keyring);
1047         if (klist) {
1048                 /* search the keyring for the key */
1049                 for (loop = 0; loop < klist->nkeys; loop++)
1050                         if (rcu_access_pointer(klist->keys[loop]) == key)
1051                                 goto key_is_present;
1052         }
1053
1054         up_write(&keyring->sem);
1055         ret = -ENOENT;
1056         goto error;
1057
1058 key_is_present:
1059         /* we need to copy the key list for RCU purposes */
1060         nklist = kmalloc(sizeof(*klist) +
1061                          sizeof(struct key *) * klist->maxkeys,
1062                          GFP_KERNEL);
1063         if (!nklist)
1064                 goto nomem;
1065         nklist->maxkeys = klist->maxkeys;
1066         nklist->nkeys = klist->nkeys - 1;
1067
1068         if (loop > 0)
1069                 memcpy(&nklist->keys[0],
1070                        &klist->keys[0],
1071                        loop * sizeof(struct key *));
1072
1073         if (loop < nklist->nkeys)
1074                 memcpy(&nklist->keys[loop],
1075                        &klist->keys[loop + 1],
1076                        (nklist->nkeys - loop) * sizeof(struct key *));
1077
1078         /* adjust the user's quota */
1079         key_payload_reserve(keyring,
1080                             keyring->datalen - KEYQUOTA_LINK_BYTES);
1081
1082         rcu_assign_pointer(keyring->payload.subscriptions, nklist);
1083
1084         up_write(&keyring->sem);
1085
1086         /* schedule for later cleanup */
1087         klist->delkey = loop;
1088         call_rcu(&klist->rcu, keyring_unlink_rcu_disposal);
1089
1090         ret = 0;
1091
1092 error:
1093         return ret;
1094 nomem:
1095         ret = -ENOMEM;
1096         up_write(&keyring->sem);
1097         goto error;
1098 }
1099 EXPORT_SYMBOL(key_unlink);
1100
1101 /*
1102  * Dispose of a keyring list after the RCU grace period, releasing the keys it
1103  * links to.
1104  */
1105 static void keyring_clear_rcu_disposal(struct rcu_head *rcu)
1106 {
1107         struct keyring_list *klist;
1108         int loop;
1109
1110         klist = container_of(rcu, struct keyring_list, rcu);
1111
1112         for (loop = klist->nkeys - 1; loop >= 0; loop--)
1113                 key_put(rcu_access_pointer(klist->keys[loop]));
1114
1115         kfree(klist);
1116 }
1117
1118 /**
1119  * keyring_clear - Clear a keyring
1120  * @keyring: The keyring to clear.
1121  *
1122  * Clear the contents of the specified keyring.
1123  *
1124  * Returns 0 if successful or -ENOTDIR if the keyring isn't a keyring.
1125  */
1126 int keyring_clear(struct key *keyring)
1127 {
1128         struct keyring_list *klist;
1129         int ret;
1130
1131         ret = -ENOTDIR;
1132         if (keyring->type == &key_type_keyring) {
1133                 /* detach the pointer block with the locks held */
1134                 down_write(&keyring->sem);
1135
1136                 klist = rcu_dereference_locked_keyring(keyring);
1137                 if (klist) {
1138                         /* adjust the quota */
1139                         key_payload_reserve(keyring,
1140                                             sizeof(struct keyring_list));
1141
1142                         rcu_assign_pointer(keyring->payload.subscriptions,
1143                                            NULL);
1144                 }
1145
1146                 up_write(&keyring->sem);
1147
1148                 /* free the keys after the locks have been dropped */
1149                 if (klist)
1150                         call_rcu(&klist->rcu, keyring_clear_rcu_disposal);
1151
1152                 ret = 0;
1153         }
1154
1155         return ret;
1156 }
1157 EXPORT_SYMBOL(keyring_clear);
1158
1159 /*
1160  * Dispose of the links from a revoked keyring.
1161  *
1162  * This is called with the key sem write-locked.
1163  */
1164 static void keyring_revoke(struct key *keyring)
1165 {
1166         struct keyring_list *klist;
1167
1168         klist = rcu_dereference_locked_keyring(keyring);
1169
1170         /* adjust the quota */
1171         key_payload_reserve(keyring, 0);
1172
1173         if (klist) {
1174                 rcu_assign_pointer(keyring->payload.subscriptions, NULL);
1175                 call_rcu(&klist->rcu, keyring_clear_rcu_disposal);
1176         }
1177 }
1178
1179 /*
1180  * Determine whether a key is dead.
1181  */
1182 static bool key_is_dead(struct key *key, time_t limit)
1183 {
1184         return test_bit(KEY_FLAG_DEAD, &key->flags) ||
1185                 (key->expiry > 0 && key->expiry <= limit);
1186 }
1187
1188 /*
1189  * Collect garbage from the contents of a keyring, replacing the old list with
1190  * a new one with the pointers all shuffled down.
1191  *
1192  * Dead keys are classed as oned that are flagged as being dead or are revoked,
1193  * expired or negative keys that were revoked or expired before the specified
1194  * limit.
1195  */
1196 void keyring_gc(struct key *keyring, time_t limit)
1197 {
1198         struct keyring_list *klist, *new;
1199         struct key *key;
1200         int loop, keep, max;
1201
1202         kenter("{%x,%s}", key_serial(keyring), keyring->description);
1203
1204         down_write(&keyring->sem);
1205
1206         klist = rcu_dereference_locked_keyring(keyring);
1207         if (!klist)
1208                 goto no_klist;
1209
1210         /* work out how many subscriptions we're keeping */
1211         keep = 0;
1212         for (loop = klist->nkeys - 1; loop >= 0; loop--)
1213                 if (!key_is_dead(rcu_deref_link_locked(klist, loop, keyring),
1214                                  limit))
1215                         keep++;
1216
1217         if (keep == klist->nkeys)
1218                 goto just_return;
1219
1220         /* allocate a new keyring payload */
1221         max = roundup(keep, 4);
1222         new = kmalloc(sizeof(struct keyring_list) + max * sizeof(struct key *),
1223                       GFP_KERNEL);
1224         if (!new)
1225                 goto nomem;
1226         new->maxkeys = max;
1227         new->nkeys = 0;
1228         new->delkey = 0;
1229
1230         /* install the live keys
1231          * - must take care as expired keys may be updated back to life
1232          */
1233         keep = 0;
1234         for (loop = klist->nkeys - 1; loop >= 0; loop--) {
1235                 key = rcu_deref_link_locked(klist, loop, keyring);
1236                 if (!key_is_dead(key, limit)) {
1237                         if (keep >= max)
1238                                 goto discard_new;
1239                         RCU_INIT_POINTER(new->keys[keep++], key_get(key));
1240                 }
1241         }
1242         new->nkeys = keep;
1243
1244         /* adjust the quota */
1245         key_payload_reserve(keyring,
1246                             sizeof(struct keyring_list) +
1247                             KEYQUOTA_LINK_BYTES * keep);
1248
1249         if (keep == 0) {
1250                 rcu_assign_pointer(keyring->payload.subscriptions, NULL);
1251                 kfree(new);
1252         } else {
1253                 rcu_assign_pointer(keyring->payload.subscriptions, new);
1254         }
1255
1256         up_write(&keyring->sem);
1257
1258         call_rcu(&klist->rcu, keyring_clear_rcu_disposal);
1259         kleave(" [yes]");
1260         return;
1261
1262 discard_new:
1263         new->nkeys = keep;
1264         keyring_clear_rcu_disposal(&new->rcu);
1265         up_write(&keyring->sem);
1266         kleave(" [discard]");
1267         return;
1268
1269 just_return:
1270         up_write(&keyring->sem);
1271         kleave(" [no dead]");
1272         return;
1273
1274 no_klist:
1275         up_write(&keyring->sem);
1276         kleave(" [no_klist]");
1277         return;
1278
1279 nomem:
1280         up_write(&keyring->sem);
1281         kleave(" [oom]");
1282 }