security/keys/keyring.c

   1 /* Keyring handling
   2  *
   3  * Copyright (C) 2004-2005, 2008, 2013 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 <keys/user-type.h>
  21 #include <linux/assoc_array_priv.h>
  22 #include <linux/uaccess.h>
  23 #include "internal.h"
  24
  25 /*
  26  * When plumbing the depths of the key tree, this sets a hard limit
  27  * set on how deep we're willing to go.
  28  */
  29 #define KEYRING_SEARCH_MAX_DEPTH 6
  30
  31 /*
  32  * We keep all named keyrings in a hash to speed looking them up.
  33  */
  34 #define KEYRING_NAME_HASH_SIZE  (1 << 5)
  35
  36 /*
  37  * We mark pointers we pass to the associative array with bit 1 set if
  38  * they're keyrings and clear otherwise.
  39  */
  40 #define KEYRING_PTR_SUBTYPE     0x2UL
  41
  42 static inline bool keyring_ptr_is_keyring(const struct assoc_array_ptr *x)
  43 {
  44         return (unsigned long)x & KEYRING_PTR_SUBTYPE;
  45 }
  46 static inline struct key *keyring_ptr_to_key(const struct assoc_array_ptr *x)
  47 {
  48         void *object = assoc_array_ptr_to_leaf(x);
  49         return (struct key *)((unsigned long)object & ~KEYRING_PTR_SUBTYPE);
  50 }
  51 static inline void *keyring_key_to_ptr(struct key *key)
  52 {
  53         if (key->type == &key_type_keyring)
  54                 return (void *)((unsigned long)key | KEYRING_PTR_SUBTYPE);
  55         return key;
  56 }
  57
  58 static struct list_head keyring_name_hash[KEYRING_NAME_HASH_SIZE];
  59 static DEFINE_RWLOCK(keyring_name_lock);
  60
  61 static inline unsigned keyring_hash(const char *desc)
  62 {
  63         unsigned bucket = 0;
  64
  65         for (; *desc; desc++)
  66                 bucket += (unsigned char)*desc;
  67
  68         return bucket & (KEYRING_NAME_HASH_SIZE - 1);
  69 }
  70
  71 /*
  72  * The keyring key type definition.  Keyrings are simply keys of this type and
  73  * can be treated as ordinary keys in addition to having their own special
  74  * operations.
  75  */
  76 static int keyring_preparse(struct key_preparsed_payload *prep);
  77 static void keyring_free_preparse(struct key_preparsed_payload *prep);
  78 static int keyring_instantiate(struct key *keyring,
  79                                struct key_preparsed_payload *prep);
  80 static void keyring_revoke(struct key *keyring);
  81 static void keyring_destroy(struct key *keyring);
  82 static void keyring_describe(const struct key *keyring, struct seq_file *m);
  83 static long keyring_read(const struct key *keyring,
  84                          char __user *buffer, size_t buflen);
  85
  86 struct key_type key_type_keyring = {
  87         .name           = "keyring",
  88         .def_datalen    = 0,
  89         .preparse       = keyring_preparse,
  90         .free_preparse  = keyring_free_preparse,
  91         .instantiate    = keyring_instantiate,
  92         .revoke         = keyring_revoke,
  93         .destroy        = keyring_destroy,
  94         .describe       = keyring_describe,
  95         .read           = keyring_read,
  96 };
  97 EXPORT_SYMBOL(key_type_keyring);
  98
  99 /*
 100  * Semaphore to serialise link/link calls to prevent two link calls in parallel
 101  * introducing a cycle.
 102  */
 103 static DECLARE_RWSEM(keyring_serialise_link_sem);
 104
 105 /*
 106  * Publish the name of a keyring so that it can be found by name (if it has
 107  * one).
 108  */
 109 static void keyring_publish_name(struct key *keyring)
 110 {
 111         int bucket;
 112
 113         if (keyring->description) {
 114                 bucket = keyring_hash(keyring->description);
 115
 116                 write_lock(&keyring_name_lock);
 117
 118                 if (!keyring_name_hash[bucket].next)
 119                         INIT_LIST_HEAD(&keyring_name_hash[bucket]);
 120
 121                 list_add_tail(&keyring->name_link,
 122                               &keyring_name_hash[bucket]);
 123
 124                 write_unlock(&keyring_name_lock);
 125         }
 126 }
 127
 128 /*
 129  * Preparse a keyring payload
 130  */
 131 static int keyring_preparse(struct key_preparsed_payload *prep)
 132 {
 133         return prep->datalen != 0 ? -EINVAL : 0;
 134 }
 135
 136 /*
 137  * Free a preparse of a user defined key payload
 138  */
 139 static void keyring_free_preparse(struct key_preparsed_payload *prep)
 140 {
 141 }
 142
 143 /*
 144  * Initialise a keyring.
 145  *
 146  * Returns 0 on success, -EINVAL if given any data.
 147  */
 148 static int keyring_instantiate(struct key *keyring,
 149                                struct key_preparsed_payload *prep)
 150 {
 151         assoc_array_init(&keyring->keys);
 152         /* make the keyring available by name if it has one */
 153         keyring_publish_name(keyring);
 154         return 0;
 155 }
 156
 157 /*
 158  * Multiply 64-bits by 32-bits to 96-bits and fold back to 64-bit.  Ideally we'd
 159  * fold the carry back too, but that requires inline asm.
 160  */
 161 static u64 mult_64x32_and_fold(u64 x, u32 y)
 162 {
 163         u64 hi = (u64)(u32)(x >> 32) * y;
 164         u64 lo = (u64)(u32)(x) * y;
 165         return lo + ((u64)(u32)hi << 32) + (u32)(hi >> 32);
 166 }
 167
 168 /*
 169  * Hash a key type and description.
 170  */
 171 static unsigned long hash_key_type_and_desc(const struct keyring_index_key *index_key)
 172 {
 173         const unsigned level_shift = ASSOC_ARRAY_LEVEL_STEP;
 174         const unsigned long fan_mask = ASSOC_ARRAY_FAN_MASK;
 175         const char *description = index_key->description;
 176         unsigned long hash, type;
 177         u32 piece;
 178         u64 acc;
 179         int n, desc_len = index_key->desc_len;
 180
 181         type = (unsigned long)index_key->type;
 182
 183         acc = mult_64x32_and_fold(type, desc_len + 13);
 184         acc = mult_64x32_and_fold(acc, 9207);
 185         for (;;) {
 186                 n = desc_len;
 187                 if (n <= 0)
 188                         break;
 189                 if (n > 4)
 190                         n = 4;
 191                 piece = 0;
 192                 memcpy(&piece, description, n);
 193                 description += n;
 194                 desc_len -= n;
 195                 acc = mult_64x32_and_fold(acc, piece);
 196                 acc = mult_64x32_and_fold(acc, 9207);
 197         }
 198
 199         /* Fold the hash down to 32 bits if need be. */
 200         hash = acc;
 201         if (ASSOC_ARRAY_KEY_CHUNK_SIZE == 32)
 202                 hash ^= acc >> 32;
 203
 204         /* Squidge all the keyrings into a separate part of the tree to
 205          * ordinary keys by making sure the lowest level segment in the hash is
 206          * zero for keyrings and non-zero otherwise.
 207          */
 208         if (index_key->type != &key_type_keyring && (hash & fan_mask) == 0)
 209                 return hash | (hash >> (ASSOC_ARRAY_KEY_CHUNK_SIZE - level_shift)) | 1;
 210         if (index_key->type == &key_type_keyring && (hash & fan_mask) != 0)
 211                 return (hash + (hash << level_shift)) & ~fan_mask;
 212         return hash;
 213 }
 214
 215 /*
 216  * Build the next index key chunk.
 217  *
 218  * On 32-bit systems the index key is laid out as:
 219  *
 220  *      0       4       5       9...
 221  *      hash    desclen typeptr desc[]
 222  *
 223  * On 64-bit systems:
 224  *
 225  *      0       8       9       17...
 226  *      hash    desclen typeptr desc[]
 227  *
 228  * We return it one word-sized chunk at a time.
 229  */
 230 static unsigned long keyring_get_key_chunk(const void *data, int level)
 231 {
 232         const struct keyring_index_key *index_key = data;
 233         unsigned long chunk = 0;
 234         long offset = 0;
 235         int desc_len = index_key->desc_len, n = sizeof(chunk);
 236
 237         level /= ASSOC_ARRAY_KEY_CHUNK_SIZE;
 238         switch (level) {
 239         case 0:
 240                 return hash_key_type_and_desc(index_key);
 241         case 1:
 242                 return ((unsigned long)index_key->type << 8) | desc_len;
 243         case 2:
 244                 if (desc_len == 0)
 245                         return (u8)((unsigned long)index_key->type >>
 246                                     (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8));
 247                 n--;
 248                 offset = 1;
 249         default:
 250                 offset += sizeof(chunk) - 1;
 251                 offset += (level - 3) * sizeof(chunk);
 252                 if (offset >= desc_len)
 253                         return 0;
 254                 desc_len -= offset;
 255                 if (desc_len > n)
 256                         desc_len = n;
 257                 offset += desc_len;
 258                 do {
 259                         chunk <<= 8;
 260                         chunk |= ((u8*)index_key->description)[--offset];
 261                 } while (--desc_len > 0);
 262
 263                 if (level == 2) {
 264                         chunk <<= 8;
 265                         chunk |= (u8)((unsigned long)index_key->type >>
 266                                       (ASSOC_ARRAY_KEY_CHUNK_SIZE - 8));
 267                 }
 268                 return chunk;
 269         }
 270 }
 271
 272 static unsigned long keyring_get_object_key_chunk(const void *object, int level)
 273 {
 274         const struct key *key = keyring_ptr_to_key(object);
 275         return keyring_get_key_chunk(&key->index_key, level);
 276 }
 277
 278 static bool keyring_compare_object(const void *object, const void *data)
 279 {
 280         const struct keyring_index_key *index_key = data;
 281         const struct key *key = keyring_ptr_to_key(object);
 282
 283         return key->index_key.type == index_key->type &&
 284                 key->index_key.desc_len == index_key->desc_len &&
 285                 memcmp(key->index_key.description, index_key->description,
 286                        index_key->desc_len) == 0;
 287 }
 288
 289 /*
 290  * Compare the index keys of a pair of objects and determine the bit position
 291  * at which they differ - if they differ.
 292  */
 293 static int keyring_diff_objects(const void *object, const void *data)
 294 {
 295         const struct key *key_a = keyring_ptr_to_key(object);
 296         const struct keyring_index_key *a = &key_a->index_key;
 297         const struct keyring_index_key *b = data;
 298         unsigned long seg_a, seg_b;
 299         int level, i;
 300
 301         level = 0;
 302         seg_a = hash_key_type_and_desc(a);
 303         seg_b = hash_key_type_and_desc(b);
 304         if ((seg_a ^ seg_b) != 0)
 305                 goto differ;
 306
 307         /* The number of bits contributed by the hash is controlled by a
 308          * constant in the assoc_array headers.  Everything else thereafter we
 309          * can deal with as being machine word-size dependent.
 310          */
 311         level += ASSOC_ARRAY_KEY_CHUNK_SIZE / 8;
 312         seg_a = a->desc_len;
 313         seg_b = b->desc_len;
 314         if ((seg_a ^ seg_b) != 0)
 315                 goto differ;
 316
 317         /* The next bit may not work on big endian */
 318         level++;
 319         seg_a = (unsigned long)a->type;
 320         seg_b = (unsigned long)b->type;
 321         if ((seg_a ^ seg_b) != 0)
 322                 goto differ;
 323
 324         level += sizeof(unsigned long);
 325         if (a->desc_len == 0)
 326                 goto same;
 327
 328         i = 0;
 329         if (((unsigned long)a->description | (unsigned long)b->description) &
 330             (sizeof(unsigned long) - 1)) {
 331                 do {
 332                         seg_a = *(unsigned long *)(a->description + i);
 333                         seg_b = *(unsigned long *)(b->description + i);
 334                         if ((seg_a ^ seg_b) != 0)
 335                                 goto differ_plus_i;
 336                         i += sizeof(unsigned long);
 337                 } while (i < (a->desc_len & (sizeof(unsigned long) - 1)));
 338         }
 339
 340         for (; i < a->desc_len; i++) {
 341                 seg_a = *(unsigned char *)(a->description + i);
 342                 seg_b = *(unsigned char *)(b->description + i);
 343                 if ((seg_a ^ seg_b) != 0)
 344                         goto differ_plus_i;
 345         }
 346
 347 same:
 348         return -1;
 349
 350 differ_plus_i:
 351         level += i;
 352 differ:
 353         i = level * 8 + __ffs(seg_a ^ seg_b);
 354         return i;
 355 }
 356
 357 /*
 358  * Free an object after stripping the keyring flag off of the pointer.
 359  */
 360 static void keyring_free_object(void *object)
 361 {
 362         key_put(keyring_ptr_to_key(object));
 363 }
 364
 365 /*
 366  * Operations for keyring management by the index-tree routines.
 367  */
 368 static const struct assoc_array_ops keyring_assoc_array_ops = {
 369         .get_key_chunk          = keyring_get_key_chunk,
 370         .get_object_key_chunk   = keyring_get_object_key_chunk,
 371         .compare_object         = keyring_compare_object,
 372         .diff_objects           = keyring_diff_objects,
 373         .free_object            = keyring_free_object,
 374 };
 375
 376 /*
 377  * Clean up a keyring when it is destroyed.  Unpublish its name if it had one
 378  * and dispose of its data.
 379  *
 380  * The garbage collector detects the final key_put(), removes the keyring from
 381  * the serial number tree and then does RCU synchronisation before coming here,
 382  * so we shouldn't need to worry about code poking around here with the RCU
 383  * readlock held by this time.
 384  */
 385 static void keyring_destroy(struct key *keyring)
 386 {
 387         if (keyring->description) {
 388                 write_lock(&keyring_name_lock);
 389
 390                 if (keyring->name_link.next != NULL &&
 391                     !list_empty(&keyring->name_link))
 392                         list_del(&keyring->name_link);
 393
 394                 write_unlock(&keyring_name_lock);
 395         }
 396
 397         assoc_array_destroy(&keyring->keys, &keyring_assoc_array_ops);
 398 }
 399
 400 /*
 401  * Describe a keyring for /proc.
 402  */
 403 static void keyring_describe(const struct key *keyring, struct seq_file *m)
 404 {
 405         if (keyring->description)
 406                 seq_puts(m, keyring->description);
 407         else
 408                 seq_puts(m, "[anon]");
 409
 410         if (key_is_positive(keyring)) {
 411                 if (keyring->keys.nr_leaves_on_tree != 0)
 412                         seq_printf(m, ": %lu", keyring->keys.nr_leaves_on_tree);
 413                 else
 414                         seq_puts(m, ": empty");
 415         }
 416 }
 417
 418 struct keyring_read_iterator_context {
 419         size_t                  buflen;
 420         size_t                  count;
 421         key_serial_t __user     *buffer;
 422 };
 423
 424 static int keyring_read_iterator(const void *object, void *data)
 425 {
 426         struct keyring_read_iterator_context *ctx = data;
 427         const struct key *key = keyring_ptr_to_key(object);
 428         int ret;
 429
 430         kenter("{%s,%d},,{%zu/%zu}",
 431                key->type->name, key->serial, ctx->count, ctx->buflen);
 432
 433         if (ctx->count >= ctx->buflen)
 434                 return 1;
 435
 436         ret = put_user(key->serial, ctx->buffer);
 437         if (ret < 0)
 438                 return ret;
 439         ctx->buffer++;
 440         ctx->count += sizeof(key->serial);
 441         return 0;
 442 }
 443
 444 /*
 445  * Read a list of key IDs from the keyring's contents in binary form
 446  *
 447  * The keyring's semaphore is read-locked by the caller.  This prevents someone
 448  * from modifying it under us - which could cause us to read key IDs multiple
 449  * times.
 450  */
 451 static long keyring_read(const struct key *keyring,
 452                          char __user *buffer, size_t buflen)
 453 {
 454         struct keyring_read_iterator_context ctx;
 455         unsigned long nr_keys;
 456         int ret;
 457
 458         kenter("{%d},,%zu", key_serial(keyring), buflen);
 459
 460         if (buflen & (sizeof(key_serial_t) - 1))
 461                 return -EINVAL;
 462
 463         nr_keys = keyring->keys.nr_leaves_on_tree;
 464         if (nr_keys == 0)
 465                 return 0;
 466
 467         /* Calculate how much data we could return */
 468         if (!buffer || !buflen)
 469                 return nr_keys * sizeof(key_serial_t);
 470
 471         /* Copy the IDs of the subscribed keys into the buffer */
 472         ctx.buffer = (key_serial_t __user *)buffer;
 473         ctx.buflen = buflen;
 474         ctx.count = 0;
 475         ret = assoc_array_iterate(&keyring->keys, keyring_read_iterator, &ctx);
 476         if (ret < 0) {
 477                 kleave(" = %d [iterate]", ret);
 478                 return ret;
 479         }
 480
 481         kleave(" = %zu [ok]", ctx.count);
 482         return ctx.count;
 483 }
 484
 485 /*
 486  * Allocate a keyring and link into the destination keyring.
 487  */
 488 struct key *keyring_alloc(const char *description, kuid_t uid, kgid_t gid,
 489                           const struct cred *cred, key_perm_t perm,
 490                           unsigned long flags,
 491                           int (*restrict_link)(struct key *,
 492                                                const struct key_type *,
 493                                                const union key_payload *),
 494                           struct key *dest)
 495 {
 496         struct key *keyring;
 497         int ret;
 498
 499         keyring = key_alloc(&key_type_keyring, description,
 500                             uid, gid, cred, perm, flags, restrict_link);
 501         if (!IS_ERR(keyring)) {
 502                 ret = key_instantiate_and_link(keyring, NULL, 0, dest, NULL);
 503                 if (ret < 0) {
 504                         key_put(keyring);
 505                         keyring = ERR_PTR(ret);
 506                 }
 507         }
 508
 509         return keyring;
 510 }
 511 EXPORT_SYMBOL(keyring_alloc);
 512
 513 /**
 514  * restrict_link_reject - Give -EPERM to restrict link
 515  * @keyring: The keyring being added to.
 516  * @type: The type of key being added.
 517  * @payload: The payload of the key intended to be added.
 518  *
 519  * Reject the addition of any links to a keyring.  It can be overridden by
 520  * passing KEY_ALLOC_BYPASS_RESTRICTION to key_instantiate_and_link() when
 521  * adding a key to a keyring.
 522  *
 523  * This is meant to be passed as the restrict_link parameter to
 524  * keyring_alloc().
 525  */
 526 int restrict_link_reject(struct key *keyring,
 527                          const struct key_type *type,
 528                          const union key_payload *payload)
 529 {
 530         return -EPERM;
 531 }
 532
 533 /*
 534  * By default, we keys found by getting an exact match on their descriptions.
 535  */
 536 bool key_default_cmp(const struct key *key,
 537                      const struct key_match_data *match_data)
 538 {
 539         return strcmp(key->description, match_data->raw_data) == 0;
 540 }
 541
 542 /*
 543  * Iteration function to consider each key found.
 544  */
 545 static int keyring_search_iterator(const void *object, void *iterator_data)
 546 {
 547         struct keyring_search_context *ctx = iterator_data;
 548         const struct key *key = keyring_ptr_to_key(object);
 549         unsigned long kflags = READ_ONCE(key->flags);
 550         short state = READ_ONCE(key->state);
 551
 552         kenter("{%d}", key->serial);
 553
 554         /* ignore keys not of this type */
 555         if (key->type != ctx->index_key.type) {
 556                 kleave(" = 0 [!type]");
 557                 return 0;
 558         }
 559
 560         /* skip invalidated, revoked and expired keys */
 561         if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) {
 562                 if (kflags & ((1 << KEY_FLAG_INVALIDATED) |
 563                               (1 << KEY_FLAG_REVOKED))) {
 564                         ctx->result = ERR_PTR(-EKEYREVOKED);
 565                         kleave(" = %d [invrev]", ctx->skipped_ret);
 566                         goto skipped;
 567                 }
 568
 569                 if (key->expiry && ctx->now.tv_sec >= key->expiry) {
 570                         if (!(ctx->flags & KEYRING_SEARCH_SKIP_EXPIRED))
 571                                 ctx->result = ERR_PTR(-EKEYEXPIRED);
 572                         kleave(" = %d [expire]", ctx->skipped_ret);
 573                         goto skipped;
 574                 }
 575         }
 576
 577         /* keys that don't match */
 578         if (!ctx->match_data.cmp(key, &ctx->match_data)) {
 579                 kleave(" = 0 [!match]");
 580                 return 0;
 581         }
 582
 583         /* key must have search permissions */
 584         if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) &&
 585             key_task_permission(make_key_ref(key, ctx->possessed),
 586                                 ctx->cred, KEY_NEED_SEARCH) < 0) {
 587                 ctx->result = ERR_PTR(-EACCES);
 588                 kleave(" = %d [!perm]", ctx->skipped_ret);
 589                 goto skipped;
 590         }
 591
 592         if (ctx->flags & KEYRING_SEARCH_DO_STATE_CHECK) {
 593                 /* we set a different error code if we pass a negative key */
 594                 if (state < 0) {
 595                         ctx->result = ERR_PTR(state);
 596                         kleave(" = %d [neg]", ctx->skipped_ret);
 597                         goto skipped;
 598                 }
 599         }
 600
 601         /* Found */
 602         ctx->result = make_key_ref(key, ctx->possessed);
 603         kleave(" = 1 [found]");
 604         return 1;
 605
 606 skipped:
 607         return ctx->skipped_ret;
 608 }
 609
 610 /*
 611  * Search inside a keyring for a key.  We can search by walking to it
 612  * directly based on its index-key or we can iterate over the entire
 613  * tree looking for it, based on the match function.
 614  */
 615 static int search_keyring(struct key *keyring, struct keyring_search_context *ctx)
 616 {
 617         if (ctx->match_data.lookup_type == KEYRING_SEARCH_LOOKUP_DIRECT) {
 618                 const void *object;
 619
 620                 object = assoc_array_find(&keyring->keys,
 621                                           &keyring_assoc_array_ops,
 622                                           &ctx->index_key);
 623                 return object ? ctx->iterator(object, ctx) : 0;
 624         }
 625         return assoc_array_iterate(&keyring->keys, ctx->iterator, ctx);
 626 }
 627
 628 /*
 629  * Search a tree of keyrings that point to other keyrings up to the maximum
 630  * depth.
 631  */
 632 static bool search_nested_keyrings(struct key *keyring,
 633                                    struct keyring_search_context *ctx)
 634 {
 635         struct {
 636                 struct key *keyring;
 637                 struct assoc_array_node *node;
 638                 int slot;
 639         } stack[KEYRING_SEARCH_MAX_DEPTH];
 640
 641         struct assoc_array_shortcut *shortcut;
 642         struct assoc_array_node *node;
 643         struct assoc_array_ptr *ptr;
 644         struct key *key;
 645         int sp = 0, slot;
 646
 647         kenter("{%d},{%s,%s}",
 648                keyring->serial,
 649                ctx->index_key.type->name,
 650                ctx->index_key.description);
 651
 652 #define STATE_CHECKS (KEYRING_SEARCH_NO_STATE_CHECK | KEYRING_SEARCH_DO_STATE_CHECK)
 653         BUG_ON((ctx->flags & STATE_CHECKS) == 0 ||
 654                (ctx->flags & STATE_CHECKS) == STATE_CHECKS);
 655
 656         if (ctx->index_key.description)
 657                 ctx->index_key.desc_len = strlen(ctx->index_key.description);
 658
 659         /* Check to see if this top-level keyring is what we are looking for
 660          * and whether it is valid or not.
 661          */
 662         if (ctx->match_data.lookup_type == KEYRING_SEARCH_LOOKUP_ITERATE ||
 663             keyring_compare_object(keyring, &ctx->index_key)) {
 664                 ctx->skipped_ret = 2;
 665                 switch (ctx->iterator(keyring_key_to_ptr(keyring), ctx)) {
 666                 case 1:
 667                         goto found;
 668                 case 2:
 669                         return false;
 670                 default:
 671                         break;
 672                 }
 673         }
 674
 675         ctx->skipped_ret = 0;
 676
 677         /* Start processing a new keyring */
 678 descend_to_keyring:
 679         kdebug("descend to %d", keyring->serial);
 680         if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) |
 681                               (1 << KEY_FLAG_REVOKED)))
 682                 goto not_this_keyring;
 683
 684         /* Search through the keys in this keyring before its searching its
 685          * subtrees.
 686          */
 687         if (search_keyring(keyring, ctx))
 688                 goto found;
 689
 690         /* Then manually iterate through the keyrings nested in this one.
 691          *
 692          * Start from the root node of the index tree.  Because of the way the
 693          * hash function has been set up, keyrings cluster on the leftmost
 694          * branch of the root node (root slot 0) or in the root node itself.
 695          * Non-keyrings avoid the leftmost branch of the root entirely (root
 696          * slots 1-15).
 697          */
 698         ptr = ACCESS_ONCE(keyring->keys.root);
 699         if (!ptr)
 700                 goto not_this_keyring;
 701
 702         if (assoc_array_ptr_is_shortcut(ptr)) {
 703                 /* If the root is a shortcut, either the keyring only contains
 704                  * keyring pointers (everything clusters behind root slot 0) or
 705                  * doesn't contain any keyring pointers.
 706                  */
 707                 shortcut = assoc_array_ptr_to_shortcut(ptr);
 708                 smp_read_barrier_depends();
 709                 if ((shortcut->index_key[0] & ASSOC_ARRAY_FAN_MASK) != 0)
 710                         goto not_this_keyring;
 711
 712                 ptr = ACCESS_ONCE(shortcut->next_node);
 713                 node = assoc_array_ptr_to_node(ptr);
 714                 goto begin_node;
 715         }
 716
 717         node = assoc_array_ptr_to_node(ptr);
 718         smp_read_barrier_depends();
 719
 720         ptr = node->slots[0];
 721         if (!assoc_array_ptr_is_meta(ptr))
 722                 goto begin_node;
 723
 724 descend_to_node:
 725         /* Descend to a more distal node in this keyring's content tree and go
 726          * through that.
 727          */
 728         kdebug("descend");
 729         if (assoc_array_ptr_is_shortcut(ptr)) {
 730                 shortcut = assoc_array_ptr_to_shortcut(ptr);
 731                 smp_read_barrier_depends();
 732                 ptr = ACCESS_ONCE(shortcut->next_node);
 733                 BUG_ON(!assoc_array_ptr_is_node(ptr));
 734         }
 735         node = assoc_array_ptr_to_node(ptr);
 736
 737 begin_node:
 738         kdebug("begin_node");
 739         smp_read_barrier_depends();
 740         slot = 0;
 741 ascend_to_node:
 742         /* Go through the slots in a node */
 743         for (; slot < ASSOC_ARRAY_FAN_OUT; slot++) {
 744                 ptr = ACCESS_ONCE(node->slots[slot]);
 745
 746                 if (assoc_array_ptr_is_meta(ptr) && node->back_pointer)
 747                         goto descend_to_node;
 748
 749                 if (!keyring_ptr_is_keyring(ptr))
 750                         continue;
 751
 752                 key = keyring_ptr_to_key(ptr);
 753
 754                 if (sp >= KEYRING_SEARCH_MAX_DEPTH) {
 755                         if (ctx->flags & KEYRING_SEARCH_DETECT_TOO_DEEP) {
 756                                 ctx->result = ERR_PTR(-ELOOP);
 757                                 return false;
 758                         }
 759                         goto not_this_keyring;
 760                 }
 761
 762                 /* Search a nested keyring */
 763                 if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM) &&
 764                     key_task_permission(make_key_ref(key, ctx->possessed),
 765                                         ctx->cred, KEY_NEED_SEARCH) < 0)
 766                         continue;
 767
 768                 /* stack the current position */
 769                 stack[sp].keyring = keyring;
 770                 stack[sp].node = node;
 771                 stack[sp].slot = slot;
 772                 sp++;
 773
 774                 /* begin again with the new keyring */
 775                 keyring = key;
 776                 goto descend_to_keyring;
 777         }
 778
 779         /* We've dealt with all the slots in the current node, so now we need
 780          * to ascend to the parent and continue processing there.
 781          */
 782         ptr = ACCESS_ONCE(node->back_pointer);
 783         slot = node->parent_slot;
 784
 785         if (ptr && assoc_array_ptr_is_shortcut(ptr)) {
 786                 shortcut = assoc_array_ptr_to_shortcut(ptr);
 787                 smp_read_barrier_depends();
 788                 ptr = ACCESS_ONCE(shortcut->back_pointer);
 789                 slot = shortcut->parent_slot;
 790         }
 791         if (!ptr)
 792                 goto not_this_keyring;
 793         node = assoc_array_ptr_to_node(ptr);
 794         smp_read_barrier_depends();
 795         slot++;
 796
 797         /* If we've ascended to the root (zero backpointer), we must have just
 798          * finished processing the leftmost branch rather than the root slots -
 799          * so there can't be any more keyrings for us to find.
 800          */
 801         if (node->back_pointer) {
 802                 kdebug("ascend %d", slot);
 803                 goto ascend_to_node;
 804         }
 805
 806         /* The keyring we're looking at was disqualified or didn't contain a
 807          * matching key.
 808          */
 809 not_this_keyring:
 810         kdebug("not_this_keyring %d", sp);
 811         if (sp <= 0) {
 812                 kleave(" = false");
 813                 return false;
 814         }
 815
 816         /* Resume the processing of a keyring higher up in the tree */
 817         sp--;
 818         keyring = stack[sp].keyring;
 819         node = stack[sp].node;
 820         slot = stack[sp].slot + 1;
 821         kdebug("ascend to %d [%d]", keyring->serial, slot);
 822         goto ascend_to_node;
 823
 824         /* We found a viable match */
 825 found:
 826         key = key_ref_to_ptr(ctx->result);
 827         key_check(key);
 828         if (!(ctx->flags & KEYRING_SEARCH_NO_UPDATE_TIME)) {
 829                 key->last_used_at = ctx->now.tv_sec;
 830                 keyring->last_used_at = ctx->now.tv_sec;
 831                 while (sp > 0)
 832                         stack[--sp].keyring->last_used_at = ctx->now.tv_sec;
 833         }
 834         kleave(" = true");
 835         return true;
 836 }
 837
 838 /**
 839  * keyring_search_aux - Search a keyring tree for a key matching some criteria
 840  * @keyring_ref: A pointer to the keyring with possession indicator.
 841  * @ctx: The keyring search context.
 842  *
 843  * Search the supplied keyring tree for a key that matches the criteria given.
 844  * The root keyring and any linked keyrings must grant Search permission to the
 845  * caller to be searchable and keys can only be found if they too grant Search
 846  * to the caller. The possession flag on the root keyring pointer controls use
 847  * of the possessor bits in permissions checking of the entire tree.  In
 848  * addition, the LSM gets to forbid keyring searches and key matches.
 849  *
 850  * The search is performed as a breadth-then-depth search up to the prescribed
 851  * limit (KEYRING_SEARCH_MAX_DEPTH).
 852  *
 853  * Keys are matched to the type provided and are then filtered by the match
 854  * function, which is given the description to use in any way it sees fit.  The
 855  * match function may use any attributes of a key that it wishes to to
 856  * determine the match.  Normally the match function from the key type would be
 857  * used.
 858  *
 859  * RCU can be used to prevent the keyring key lists from disappearing without
 860  * the need to take lots of locks.
 861  *
 862  * Returns a pointer to the found key and increments the key usage count if
 863  * successful; -EAGAIN if no matching keys were found, or if expired or revoked
 864  * keys were found; -ENOKEY if only negative keys were found; -ENOTDIR if the
 865  * specified keyring wasn't a keyring.
 866  *
 867  * In the case of a successful return, the possession attribute from
 868  * @keyring_ref is propagated to the returned key reference.
 869  */
 870 key_ref_t keyring_search_aux(key_ref_t keyring_ref,
 871                              struct keyring_search_context *ctx)
 872 {
 873         struct key *keyring;
 874         long err;
 875
 876         ctx->iterator = keyring_search_iterator;
 877         ctx->possessed = is_key_possessed(keyring_ref);
 878         ctx->result = ERR_PTR(-EAGAIN);
 879
 880         keyring = key_ref_to_ptr(keyring_ref);
 881         key_check(keyring);
 882
 883         if (keyring->type != &key_type_keyring)
 884                 return ERR_PTR(-ENOTDIR);
 885
 886         if (!(ctx->flags & KEYRING_SEARCH_NO_CHECK_PERM)) {
 887                 err = key_task_permission(keyring_ref, ctx->cred, KEY_NEED_SEARCH);
 888                 if (err < 0)
 889                         return ERR_PTR(err);
 890         }
 891
 892         rcu_read_lock();
 893         ctx->now = current_kernel_time();
 894         if (search_nested_keyrings(keyring, ctx))
 895                 __key_get(key_ref_to_ptr(ctx->result));
 896         rcu_read_unlock();
 897         return ctx->result;
 898 }
 899
 900 /**
 901  * keyring_search - Search the supplied keyring tree for a matching key
 902  * @keyring: The root of the keyring tree to be searched.
 903  * @type: The type of keyring we want to find.
 904  * @description: The name of the keyring we want to find.
 905  *
 906  * As keyring_search_aux() above, but using the current task's credentials and
 907  * type's default matching function and preferred search method.
 908  */
 909 key_ref_t keyring_search(key_ref_t keyring,
 910                          struct key_type *type,
 911                          const char *description)
 912 {
 913         struct keyring_search_context ctx = {
 914                 .index_key.type         = type,
 915                 .index_key.description  = description,
 916                 .cred                   = current_cred(),
 917                 .match_data.cmp         = key_default_cmp,
 918                 .match_data.raw_data    = description,
 919                 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
 920                 .flags                  = KEYRING_SEARCH_DO_STATE_CHECK,
 921         };
 922         key_ref_t key;
 923         int ret;
 924
 925         if (type->match_preparse) {
 926                 ret = type->match_preparse(&ctx.match_data);
 927                 if (ret < 0)
 928                         return ERR_PTR(ret);
 929         }
 930
 931         key = keyring_search_aux(keyring, &ctx);
 932
 933         if (type->match_free)
 934                 type->match_free(&ctx.match_data);
 935         return key;
 936 }
 937 EXPORT_SYMBOL(keyring_search);
 938
 939 /*
 940  * Search the given keyring for a key that might be updated.
 941  *
 942  * The caller must guarantee that the keyring is a keyring and that the
 943  * permission is granted to modify the keyring as no check is made here.  The
 944  * caller must also hold a lock on the keyring semaphore.
 945  *
 946  * Returns a pointer to the found key with usage count incremented if
 947  * successful and returns NULL if not found.  Revoked and invalidated keys are
 948  * skipped over.
 949  *
 950  * If successful, the possession indicator is propagated from the keyring ref
 951  * to the returned key reference.
 952  */
 953 key_ref_t find_key_to_update(key_ref_t keyring_ref,
 954                              const struct keyring_index_key *index_key)
 955 {
 956         struct key *keyring, *key;
 957         const void *object;
 958
 959         keyring = key_ref_to_ptr(keyring_ref);
 960
 961         kenter("{%d},{%s,%s}",
 962                keyring->serial, index_key->type->name, index_key->description);
 963
 964         object = assoc_array_find(&keyring->keys, &keyring_assoc_array_ops,
 965                                   index_key);
 966
 967         if (object)
 968                 goto found;
 969
 970         kleave(" = NULL");
 971         return NULL;
 972
 973 found:
 974         key = keyring_ptr_to_key(object);
 975         if (key->flags & ((1 << KEY_FLAG_INVALIDATED) |
 976                           (1 << KEY_FLAG_REVOKED))) {
 977                 kleave(" = NULL [x]");
 978                 return NULL;
 979         }
 980         __key_get(key);
 981         kleave(" = {%d}", key->serial);
 982         return make_key_ref(key, is_key_possessed(keyring_ref));
 983 }
 984
 985 /*
 986  * Find a keyring with the specified name.
 987  *
 988  * Only keyrings that have nonzero refcount, are not revoked, and are owned by a
 989  * user in the current user namespace are considered.  If @uid_keyring is %true,
 990  * the keyring additionally must have been allocated as a user or user session
 991  * keyring; otherwise, it must grant Search permission directly to the caller.
 992  *
 993  * Returns a pointer to the keyring with the keyring's refcount having being
 994  * incremented on success.  -ENOKEY is returned if a key could not be found.
 995  */
 996 struct key *find_keyring_by_name(const char *name, bool uid_keyring)
 997 {
 998         struct key *keyring;
 999         int bucket;
1000
1001         if (!name)
1002                 return ERR_PTR(-EINVAL);
1003
1004         bucket = keyring_hash(name);
1005
1006         read_lock(&keyring_name_lock);
1007
1008         if (keyring_name_hash[bucket].next) {
1009                 /* search this hash bucket for a keyring with a matching name
1010                  * that's readable and that hasn't been revoked */
1011                 list_for_each_entry(keyring,
1012                                     &keyring_name_hash[bucket],
1013                                     name_link
1014                                     ) {
1015                         if (!kuid_has_mapping(current_user_ns(), keyring->user->uid))
1016                                 continue;
1017
1018                         if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
1019                                 continue;
1020
1021                         if (strcmp(keyring->description, name) != 0)
1022                                 continue;
1023
1024                         if (uid_keyring) {
1025                                 if (!test_bit(KEY_FLAG_UID_KEYRING,
1026                                               &keyring->flags))
1027                                         continue;
1028                         } else {
1029                                 if (key_permission(make_key_ref(keyring, 0),
1030                                                    KEY_NEED_SEARCH) < 0)
1031                                         continue;
1032                         }
1033
1034                         /* we've got a match but we might end up racing with
1035                          * key_cleanup() if the keyring is currently 'dead'
1036                          * (ie. it has a zero usage count) */
1037                         if (!atomic_inc_not_zero(&keyring->usage))
1038                                 continue;
1039                         keyring->last_used_at = current_kernel_time().tv_sec;
1040                         goto out;
1041                 }
1042         }
1043
1044         keyring = ERR_PTR(-ENOKEY);
1045 out:
1046         read_unlock(&keyring_name_lock);
1047         return keyring;
1048 }
1049
1050 static int keyring_detect_cycle_iterator(const void *object,
1051                                          void *iterator_data)
1052 {
1053         struct keyring_search_context *ctx = iterator_data;
1054         const struct key *key = keyring_ptr_to_key(object);
1055
1056         kenter("{%d}", key->serial);
1057
1058         /* We might get a keyring with matching index-key that is nonetheless a
1059          * different keyring. */
1060         if (key != ctx->match_data.raw_data)
1061                 return 0;
1062
1063         ctx->result = ERR_PTR(-EDEADLK);
1064         return 1;
1065 }
1066
1067 /*
1068  * See if a cycle will will be created by inserting acyclic tree B in acyclic
1069  * tree A at the topmost level (ie: as a direct child of A).
1070  *
1071  * Since we are adding B to A at the top level, checking for cycles should just
1072  * be a matter of seeing if node A is somewhere in tree B.
1073  */
1074 static int keyring_detect_cycle(struct key *A, struct key *B)
1075 {
1076         struct keyring_search_context ctx = {
1077                 .index_key              = A->index_key,
1078                 .match_data.raw_data    = A,
1079                 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
1080                 .iterator               = keyring_detect_cycle_iterator,
1081                 .flags                  = (KEYRING_SEARCH_NO_STATE_CHECK |
1082                                            KEYRING_SEARCH_NO_UPDATE_TIME |
1083                                            KEYRING_SEARCH_NO_CHECK_PERM |
1084                                            KEYRING_SEARCH_DETECT_TOO_DEEP),
1085         };
1086
1087         rcu_read_lock();
1088         search_nested_keyrings(B, &ctx);
1089         rcu_read_unlock();
1090         return PTR_ERR(ctx.result) == -EAGAIN ? 0 : PTR_ERR(ctx.result);
1091 }
1092
1093 /*
1094  * Preallocate memory so that a key can be linked into to a keyring.
1095  */
1096 int __key_link_begin(struct key *keyring,
1097                      const struct keyring_index_key *index_key,
1098                      struct assoc_array_edit **_edit)
1099         __acquires(&keyring->sem)
1100         __acquires(&keyring_serialise_link_sem)
1101 {
1102         struct assoc_array_edit *edit;
1103         int ret;
1104
1105         kenter("%d,%s,%s,",
1106                keyring->serial, index_key->type->name, index_key->description);
1107
1108         BUG_ON(index_key->desc_len == 0);
1109
1110         if (keyring->type != &key_type_keyring)
1111                 return -ENOTDIR;
1112
1113         down_write(&keyring->sem);
1114
1115         ret = -EKEYREVOKED;
1116         if (test_bit(KEY_FLAG_REVOKED, &keyring->flags))
1117                 goto error_krsem;
1118
1119         /* serialise link/link calls to prevent parallel calls causing a cycle
1120          * when linking two keyring in opposite orders */
1121         if (index_key->type == &key_type_keyring)
1122                 down_write(&keyring_serialise_link_sem);
1123
1124         /* Create an edit script that will insert/replace the key in the
1125          * keyring tree.
1126          */
1127         edit = assoc_array_insert(&keyring->keys,
1128                                   &keyring_assoc_array_ops,
1129                                   index_key,
1130                                   NULL);
1131         if (IS_ERR(edit)) {
1132                 ret = PTR_ERR(edit);
1133                 goto error_sem;
1134         }
1135
1136         /* If we're not replacing a link in-place then we're going to need some
1137          * extra quota.
1138          */
1139         if (!edit->dead_leaf) {
1140                 ret = key_payload_reserve(keyring,
1141                                           keyring->datalen + KEYQUOTA_LINK_BYTES);
1142                 if (ret < 0)
1143                         goto error_cancel;
1144         }
1145
1146         *_edit = edit;
1147         kleave(" = 0");
1148         return 0;
1149
1150 error_cancel:
1151         assoc_array_cancel_edit(edit);
1152 error_sem:
1153         if (index_key->type == &key_type_keyring)
1154                 up_write(&keyring_serialise_link_sem);
1155 error_krsem:
1156         up_write(&keyring->sem);
1157         kleave(" = %d", ret);
1158         return ret;
1159 }
1160
1161 /*
1162  * Check already instantiated keys aren't going to be a problem.
1163  *
1164  * The caller must have called __key_link_begin(). Don't need to call this for
1165  * keys that were created since __key_link_begin() was called.
1166  */
1167 int __key_link_check_live_key(struct key *keyring, struct key *key)
1168 {
1169         if (key->type == &key_type_keyring)
1170                 /* check that we aren't going to create a cycle by linking one
1171                  * keyring to another */
1172                 return keyring_detect_cycle(keyring, key);
1173         return 0;
1174 }
1175
1176 /*
1177  * Link a key into to a keyring.
1178  *
1179  * Must be called with __key_link_begin() having being called.  Discards any
1180  * already extant link to matching key if there is one, so that each keyring
1181  * holds at most one link to any given key of a particular type+description
1182  * combination.
1183  */
1184 void __key_link(struct key *key, struct assoc_array_edit **_edit)
1185 {
1186         __key_get(key);
1187         assoc_array_insert_set_object(*_edit, keyring_key_to_ptr(key));
1188         assoc_array_apply_edit(*_edit);
1189         *_edit = NULL;
1190 }
1191
1192 /*
1193  * Finish linking a key into to a keyring.
1194  *
1195  * Must be called with __key_link_begin() having being called.
1196  */
1197 void __key_link_end(struct key *keyring,
1198                     const struct keyring_index_key *index_key,
1199                     struct assoc_array_edit *edit)
1200         __releases(&keyring->sem)
1201         __releases(&keyring_serialise_link_sem)
1202 {
1203         BUG_ON(index_key->type == NULL);
1204         kenter("%d,%s,", keyring->serial, index_key->type->name);
1205
1206         if (index_key->type == &key_type_keyring)
1207                 up_write(&keyring_serialise_link_sem);
1208
1209         if (edit) {
1210                 if (!edit->dead_leaf) {
1211                         key_payload_reserve(keyring,
1212                                 keyring->datalen - KEYQUOTA_LINK_BYTES);
1213                 }
1214                 assoc_array_cancel_edit(edit);
1215         }
1216         up_write(&keyring->sem);
1217 }
1218
1219 /*
1220  * Check addition of keys to restricted keyrings.
1221  */
1222 static int __key_link_check_restriction(struct key *keyring, struct key *key)
1223 {
1224         if (!keyring->restrict_link)
1225                 return 0;
1226         return keyring->restrict_link(keyring, key->type, &key->payload);
1227 }
1228
1229 /**
1230  * key_link - Link a key to a keyring
1231  * @keyring: The keyring to make the link in.
1232  * @key: The key to link to.
1233  *
1234  * Make a link in a keyring to a key, such that the keyring holds a reference
1235  * on that key and the key can potentially be found by searching that keyring.
1236  *
1237  * This function will write-lock the keyring's semaphore and will consume some
1238  * of the user's key data quota to hold the link.
1239  *
1240  * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring,
1241  * -EKEYREVOKED if the keyring has been revoked, -ENFILE if the keyring is
1242  * full, -EDQUOT if there is insufficient key data quota remaining to add
1243  * another link or -ENOMEM if there's insufficient memory.
1244  *
1245  * It is assumed that the caller has checked that it is permitted for a link to
1246  * be made (the keyring should have Write permission and the key Link
1247  * permission).
1248  */
1249 int key_link(struct key *keyring, struct key *key)
1250 {
1251         struct assoc_array_edit *edit;
1252         int ret;
1253
1254         kenter("{%d,%d}", keyring->serial, atomic_read(&keyring->usage));
1255
1256         key_check(keyring);
1257         key_check(key);
1258
1259         ret = __key_link_begin(keyring, &key->index_key, &edit);
1260         if (ret == 0) {
1261                 kdebug("begun {%d,%d}", keyring->serial, atomic_read(&keyring->usage));
1262                 ret = __key_link_check_restriction(keyring, key);
1263                 if (ret == 0)
1264                         ret = __key_link_check_live_key(keyring, key);
1265                 if (ret == 0)
1266                         __key_link(key, &edit);
1267                 __key_link_end(keyring, &key->index_key, edit);
1268         }
1269
1270         kleave(" = %d {%d,%d}", ret, keyring->serial, atomic_read(&keyring->usage));
1271         return ret;
1272 }
1273 EXPORT_SYMBOL(key_link);
1274
1275 /**
1276  * key_unlink - Unlink the first link to a key from a keyring.
1277  * @keyring: The keyring to remove the link from.
1278  * @key: The key the link is to.
1279  *
1280  * Remove a link from a keyring to a key.
1281  *
1282  * This function will write-lock the keyring's semaphore.
1283  *
1284  * Returns 0 if successful, -ENOTDIR if the keyring isn't a keyring, -ENOENT if
1285  * the key isn't linked to by the keyring or -ENOMEM if there's insufficient
1286  * memory.
1287  *
1288  * It is assumed that the caller has checked that it is permitted for a link to
1289  * be removed (the keyring should have Write permission; no permissions are
1290  * required on the key).
1291  */
1292 int key_unlink(struct key *keyring, struct key *key)
1293 {
1294         struct assoc_array_edit *edit;
1295         int ret;
1296
1297         key_check(keyring);
1298         key_check(key);
1299
1300         if (keyring->type != &key_type_keyring)
1301                 return -ENOTDIR;
1302
1303         down_write(&keyring->sem);
1304
1305         edit = assoc_array_delete(&keyring->keys, &keyring_assoc_array_ops,
1306                                   &key->index_key);
1307         if (IS_ERR(edit)) {
1308                 ret = PTR_ERR(edit);
1309                 goto error;
1310         }
1311         ret = -ENOENT;
1312         if (edit == NULL)
1313                 goto error;
1314
1315         assoc_array_apply_edit(edit);
1316         key_payload_reserve(keyring, keyring->datalen - KEYQUOTA_LINK_BYTES);
1317         ret = 0;
1318
1319 error:
1320         up_write(&keyring->sem);
1321         return ret;
1322 }
1323 EXPORT_SYMBOL(key_unlink);
1324
1325 /**
1326  * keyring_clear - Clear a keyring
1327  * @keyring: The keyring to clear.
1328  *
1329  * Clear the contents of the specified keyring.
1330  *
1331  * Returns 0 if successful or -ENOTDIR if the keyring isn't a keyring.
1332  */
1333 int keyring_clear(struct key *keyring)
1334 {
1335         struct assoc_array_edit *edit;
1336         int ret;
1337
1338         if (keyring->type != &key_type_keyring)
1339                 return -ENOTDIR;
1340
1341         down_write(&keyring->sem);
1342
1343         edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops);
1344         if (IS_ERR(edit)) {
1345                 ret = PTR_ERR(edit);
1346         } else {
1347                 if (edit)
1348                         assoc_array_apply_edit(edit);
1349                 key_payload_reserve(keyring, 0);
1350                 ret = 0;
1351         }
1352
1353         up_write(&keyring->sem);
1354         return ret;
1355 }
1356 EXPORT_SYMBOL(keyring_clear);
1357
1358 /*
1359  * Dispose of the links from a revoked keyring.
1360  *
1361  * This is called with the key sem write-locked.
1362  */
1363 static void keyring_revoke(struct key *keyring)
1364 {
1365         struct assoc_array_edit *edit;
1366
1367         edit = assoc_array_clear(&keyring->keys, &keyring_assoc_array_ops);
1368         if (!IS_ERR(edit)) {
1369                 if (edit)
1370                         assoc_array_apply_edit(edit);
1371                 key_payload_reserve(keyring, 0);
1372         }
1373 }
1374
1375 static bool keyring_gc_select_iterator(void *object, void *iterator_data)
1376 {
1377         struct key *key = keyring_ptr_to_key(object);
1378         time_t *limit = iterator_data;
1379
1380         if (key_is_dead(key, *limit))
1381                 return false;
1382         key_get(key);
1383         return true;
1384 }
1385
1386 static int keyring_gc_check_iterator(const void *object, void *iterator_data)
1387 {
1388         const struct key *key = keyring_ptr_to_key(object);
1389         time_t *limit = iterator_data;
1390
1391         key_check(key);
1392         return key_is_dead(key, *limit);
1393 }
1394
1395 /*
1396  * Garbage collect pointers from a keyring.
1397  *
1398  * Not called with any locks held.  The keyring's key struct will not be
1399  * deallocated under us as only our caller may deallocate it.
1400  */
1401 void keyring_gc(struct key *keyring, time_t limit)
1402 {
1403         int result;
1404
1405         kenter("%x{%s}", keyring->serial, keyring->description ?: "");
1406
1407         if (keyring->flags & ((1 << KEY_FLAG_INVALIDATED) |
1408                               (1 << KEY_FLAG_REVOKED)))
1409                 goto dont_gc;
1410
1411         /* scan the keyring looking for dead keys */
1412         rcu_read_lock();
1413         result = assoc_array_iterate(&keyring->keys,
1414                                      keyring_gc_check_iterator, &limit);
1415         rcu_read_unlock();
1416         if (result == true)
1417                 goto do_gc;
1418
1419 dont_gc:
1420         kleave(" [no gc]");
1421         return;
1422
1423 do_gc:
1424         down_write(&keyring->sem);
1425         assoc_array_gc(&keyring->keys, &keyring_assoc_array_ops,
1426                        keyring_gc_select_iterator, &limit);
1427         up_write(&keyring->sem);
1428         kleave(" [gc]");
1429 }