security/keys/key.c

   1 /* Basic authentication token and access key management
   2  *
   3  * Copyright (C) 2004-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/poison.h>
  15 #include <linux/sched.h>
  16 #include <linux/slab.h>
  17 #include <linux/security.h>
  18 #include <linux/workqueue.h>
  19 #include <linux/random.h>
  20 #include <linux/err.h>
  21 #include "internal.h"
  22
  23 struct kmem_cache *key_jar;
  24 struct rb_root          key_serial_tree; /* tree of keys indexed by serial */
  25 DEFINE_SPINLOCK(key_serial_lock);
  26
  27 struct rb_root  key_user_tree; /* tree of quota records indexed by UID */
  28 DEFINE_SPINLOCK(key_user_lock);
  29
  30 unsigned int key_quota_root_maxkeys = 1000000;  /* root's key count quota */
  31 unsigned int key_quota_root_maxbytes = 25000000; /* root's key space quota */
  32 unsigned int key_quota_maxkeys = 200;           /* general key count quota */
  33 unsigned int key_quota_maxbytes = 20000;        /* general key space quota */
  34
  35 static LIST_HEAD(key_types_list);
  36 static DECLARE_RWSEM(key_types_sem);
  37
  38 /* We serialise key instantiation and link */
  39 DEFINE_MUTEX(key_construction_mutex);
  40
  41 #ifdef KEY_DEBUGGING
  42 void __key_check(const struct key *key)
  43 {
  44         printk("__key_check: key %p {%08x} should be {%08x}\n",
  45                key, key->magic, KEY_DEBUG_MAGIC);
  46         BUG();
  47 }
  48 #endif
  49
  50 /*
  51  * Get the key quota record for a user, allocating a new record if one doesn't
  52  * already exist.
  53  */
  54 struct key_user *key_user_lookup(kuid_t uid)
  55 {
  56         struct key_user *candidate = NULL, *user;
  57         struct rb_node *parent, **p;
  58
  59 try_again:
  60         parent = NULL;
  61         p = &key_user_tree.rb_node;
  62         spin_lock(&key_user_lock);
  63
  64         /* search the tree for a user record with a matching UID */
  65         while (*p) {
  66                 parent = *p;
  67                 user = rb_entry(parent, struct key_user, node);
  68
  69                 if (uid_lt(uid, user->uid))
  70                         p = &(*p)->rb_left;
  71                 else if (uid_gt(uid, user->uid))
  72                         p = &(*p)->rb_right;
  73                 else
  74                         goto found;
  75         }
  76
  77         /* if we get here, we failed to find a match in the tree */
  78         if (!candidate) {
  79                 /* allocate a candidate user record if we don't already have
  80                  * one */
  81                 spin_unlock(&key_user_lock);
  82
  83                 user = NULL;
  84                 candidate = kmalloc(sizeof(struct key_user), GFP_KERNEL);
  85                 if (unlikely(!candidate))
  86                         goto out;
  87
  88                 /* the allocation may have scheduled, so we need to repeat the
  89                  * search lest someone else added the record whilst we were
  90                  * asleep */
  91                 goto try_again;
  92         }
  93
  94         /* if we get here, then the user record still hadn't appeared on the
  95          * second pass - so we use the candidate record */
  96         refcount_set(&candidate->usage, 1);
  97         atomic_set(&candidate->nkeys, 0);
  98         atomic_set(&candidate->nikeys, 0);
  99         candidate->uid = uid;
 100         candidate->qnkeys = 0;
 101         candidate->qnbytes = 0;
 102         spin_lock_init(&candidate->lock);
 103         mutex_init(&candidate->cons_lock);
 104
 105         rb_link_node(&candidate->node, parent, p);
 106         rb_insert_color(&candidate->node, &key_user_tree);
 107         spin_unlock(&key_user_lock);
 108         user = candidate;
 109         goto out;
 110
 111         /* okay - we found a user record for this UID */
 112 found:
 113         refcount_inc(&user->usage);
 114         spin_unlock(&key_user_lock);
 115         kfree(candidate);
 116 out:
 117         return user;
 118 }
 119
 120 /*
 121  * Dispose of a user structure
 122  */
 123 void key_user_put(struct key_user *user)
 124 {
 125         if (refcount_dec_and_lock(&user->usage, &key_user_lock)) {
 126                 rb_erase(&user->node, &key_user_tree);
 127                 spin_unlock(&key_user_lock);
 128
 129                 kfree(user);
 130         }
 131 }
 132
 133 /*
 134  * Allocate a serial number for a key.  These are assigned randomly to avoid
 135  * security issues through covert channel problems.
 136  */
 137 static inline void key_alloc_serial(struct key *key)
 138 {
 139         struct rb_node *parent, **p;
 140         struct key *xkey;
 141
 142         /* propose a random serial number and look for a hole for it in the
 143          * serial number tree */
 144         do {
 145                 get_random_bytes(&key->serial, sizeof(key->serial));
 146
 147                 key->serial >>= 1; /* negative numbers are not permitted */
 148         } while (key->serial < 3);
 149
 150         spin_lock(&key_serial_lock);
 151
 152 attempt_insertion:
 153         parent = NULL;
 154         p = &key_serial_tree.rb_node;
 155
 156         while (*p) {
 157                 parent = *p;
 158                 xkey = rb_entry(parent, struct key, serial_node);
 159
 160                 if (key->serial < xkey->serial)
 161                         p = &(*p)->rb_left;
 162                 else if (key->serial > xkey->serial)
 163                         p = &(*p)->rb_right;
 164                 else
 165                         goto serial_exists;
 166         }
 167
 168         /* we've found a suitable hole - arrange for this key to occupy it */
 169         rb_link_node(&key->serial_node, parent, p);
 170         rb_insert_color(&key->serial_node, &key_serial_tree);
 171
 172         spin_unlock(&key_serial_lock);
 173         return;
 174
 175         /* we found a key with the proposed serial number - walk the tree from
 176          * that point looking for the next unused serial number */
 177 serial_exists:
 178         for (;;) {
 179                 key->serial++;
 180                 if (key->serial < 3) {
 181                         key->serial = 3;
 182                         goto attempt_insertion;
 183                 }
 184
 185                 parent = rb_next(parent);
 186                 if (!parent)
 187                         goto attempt_insertion;
 188
 189                 xkey = rb_entry(parent, struct key, serial_node);
 190                 if (key->serial < xkey->serial)
 191                         goto attempt_insertion;
 192         }
 193 }
 194
 195 /**
 196  * key_alloc - Allocate a key of the specified type.
 197  * @type: The type of key to allocate.
 198  * @desc: The key description to allow the key to be searched out.
 199  * @uid: The owner of the new key.
 200  * @gid: The group ID for the new key's group permissions.
 201  * @cred: The credentials specifying UID namespace.
 202  * @perm: The permissions mask of the new key.
 203  * @flags: Flags specifying quota properties.
 204  * @restrict_link: Optional link restriction for new keyrings.
 205  *
 206  * Allocate a key of the specified type with the attributes given.  The key is
 207  * returned in an uninstantiated state and the caller needs to instantiate the
 208  * key before returning.
 209  *
 210  * The restrict_link structure (if not NULL) will be freed when the
 211  * keyring is destroyed, so it must be dynamically allocated.
 212  *
 213  * The user's key count quota is updated to reflect the creation of the key and
 214  * the user's key data quota has the default for the key type reserved.  The
 215  * instantiation function should amend this as necessary.  If insufficient
 216  * quota is available, -EDQUOT will be returned.
 217  *
 218  * The LSM security modules can prevent a key being created, in which case
 219  * -EACCES will be returned.
 220  *
 221  * Returns a pointer to the new key if successful and an error code otherwise.
 222  *
 223  * Note that the caller needs to ensure the key type isn't uninstantiated.
 224  * Internally this can be done by locking key_types_sem.  Externally, this can
 225  * be done by either never unregistering the key type, or making sure
 226  * key_alloc() calls don't race with module unloading.
 227  */
 228 struct key *key_alloc(struct key_type *type, const char *desc,
 229                       kuid_t uid, kgid_t gid, const struct cred *cred,
 230                       key_perm_t perm, unsigned long flags,
 231                       struct key_restriction *restrict_link)
 232 {
 233         struct key_user *user = NULL;
 234         struct key *key;
 235         size_t desclen, quotalen;
 236         int ret;
 237
 238         key = ERR_PTR(-EINVAL);
 239         if (!desc || !*desc)
 240                 goto error;
 241
 242         if (type->vet_description) {
 243                 ret = type->vet_description(desc);
 244                 if (ret < 0) {
 245                         key = ERR_PTR(ret);
 246                         goto error;
 247                 }
 248         }
 249
 250         desclen = strlen(desc);
 251         quotalen = desclen + 1 + type->def_datalen;
 252
 253         /* get hold of the key tracking for this user */
 254         user = key_user_lookup(uid);
 255         if (!user)
 256                 goto no_memory_1;
 257
 258         /* check that the user's quota permits allocation of another key and
 259          * its description */
 260         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 261                 unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
 262                         key_quota_root_maxkeys : key_quota_maxkeys;
 263                 unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
 264                         key_quota_root_maxbytes : key_quota_maxbytes;
 265
 266                 spin_lock(&user->lock);
 267                 if (!(flags & KEY_ALLOC_QUOTA_OVERRUN)) {
 268                         if (user->qnkeys + 1 > maxkeys ||
 269                             user->qnbytes + quotalen > maxbytes ||
 270                             user->qnbytes + quotalen < user->qnbytes)
 271                                 goto no_quota;
 272                 }
 273
 274                 user->qnkeys++;
 275                 user->qnbytes += quotalen;
 276                 spin_unlock(&user->lock);
 277         }
 278
 279         /* allocate and initialise the key and its description */
 280         key = kmem_cache_zalloc(key_jar, GFP_KERNEL);
 281         if (!key)
 282                 goto no_memory_2;
 283
 284         key->index_key.desc_len = desclen;
 285         key->index_key.description = kmemdup(desc, desclen + 1, GFP_KERNEL);
 286         if (!key->index_key.description)
 287                 goto no_memory_3;
 288
 289         refcount_set(&key->usage, 1);
 290         init_rwsem(&key->sem);
 291         lockdep_set_class(&key->sem, &type->lock_class);
 292         key->index_key.type = type;
 293         key->user = user;
 294         key->quotalen = quotalen;
 295         key->datalen = type->def_datalen;
 296         key->uid = uid;
 297         key->gid = gid;
 298         key->perm = perm;
 299         key->restrict_link = restrict_link;
 300         key->last_used_at = ktime_get_real_seconds();
 301
 302         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA))
 303                 key->flags |= 1 << KEY_FLAG_IN_QUOTA;
 304         if (flags & KEY_ALLOC_BUILT_IN)
 305                 key->flags |= 1 << KEY_FLAG_BUILTIN;
 306         if (flags & KEY_ALLOC_UID_KEYRING)
 307                 key->flags |= 1 << KEY_FLAG_UID_KEYRING;
 308         if (flags & KEY_ALLOC_SET_KEEP)
 309                 key->flags |= 1 << KEY_FLAG_KEEP;
 310
 311 #ifdef KEY_DEBUGGING
 312         key->magic = KEY_DEBUG_MAGIC;
 313 #endif
 314
 315         /* let the security module know about the key */
 316         ret = security_key_alloc(key, cred, flags);
 317         if (ret < 0)
 318                 goto security_error;
 319
 320         /* publish the key by giving it a serial number */
 321         atomic_inc(&user->nkeys);
 322         key_alloc_serial(key);
 323
 324 error:
 325         return key;
 326
 327 security_error:
 328         kfree(key->description);
 329         kmem_cache_free(key_jar, key);
 330         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 331                 spin_lock(&user->lock);
 332                 user->qnkeys--;
 333                 user->qnbytes -= quotalen;
 334                 spin_unlock(&user->lock);
 335         }
 336         key_user_put(user);
 337         key = ERR_PTR(ret);
 338         goto error;
 339
 340 no_memory_3:
 341         kmem_cache_free(key_jar, key);
 342 no_memory_2:
 343         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 344                 spin_lock(&user->lock);
 345                 user->qnkeys--;
 346                 user->qnbytes -= quotalen;
 347                 spin_unlock(&user->lock);
 348         }
 349         key_user_put(user);
 350 no_memory_1:
 351         key = ERR_PTR(-ENOMEM);
 352         goto error;
 353
 354 no_quota:
 355         spin_unlock(&user->lock);
 356         key_user_put(user);
 357         key = ERR_PTR(-EDQUOT);
 358         goto error;
 359 }
 360 EXPORT_SYMBOL(key_alloc);
 361
 362 /**
 363  * key_payload_reserve - Adjust data quota reservation for the key's payload
 364  * @key: The key to make the reservation for.
 365  * @datalen: The amount of data payload the caller now wants.
 366  *
 367  * Adjust the amount of the owning user's key data quota that a key reserves.
 368  * If the amount is increased, then -EDQUOT may be returned if there isn't
 369  * enough free quota available.
 370  *
 371  * If successful, 0 is returned.
 372  */
 373 int key_payload_reserve(struct key *key, size_t datalen)
 374 {
 375         int delta = (int)datalen - key->datalen;
 376         int ret = 0;
 377
 378         key_check(key);
 379
 380         /* contemplate the quota adjustment */
 381         if (delta != 0 && test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
 382                 unsigned maxbytes = uid_eq(key->user->uid, GLOBAL_ROOT_UID) ?
 383                         key_quota_root_maxbytes : key_quota_maxbytes;
 384
 385                 spin_lock(&key->user->lock);
 386
 387                 if (delta > 0 &&
 388                     (key->user->qnbytes + delta > maxbytes ||
 389                      key->user->qnbytes + delta < key->user->qnbytes)) {
 390                         ret = -EDQUOT;
 391                 }
 392                 else {
 393                         key->user->qnbytes += delta;
 394                         key->quotalen += delta;
 395                 }
 396                 spin_unlock(&key->user->lock);
 397         }
 398
 399         /* change the recorded data length if that didn't generate an error */
 400         if (ret == 0)
 401                 key->datalen = datalen;
 402
 403         return ret;
 404 }
 405 EXPORT_SYMBOL(key_payload_reserve);
 406
 407 /*
 408  * Change the key state to being instantiated.
 409  */
 410 static void mark_key_instantiated(struct key *key, int reject_error)
 411 {
 412         /* Commit the payload before setting the state; barrier versus
 413          * key_read_state().
 414          */
 415         smp_store_release(&key->state,
 416                           (reject_error < 0) ? reject_error : KEY_IS_POSITIVE);
 417 }
 418
 419 /*
 420  * Instantiate a key and link it into the target keyring atomically.  Must be
 421  * called with the target keyring's semaphore writelocked.  The target key's
 422  * semaphore need not be locked as instantiation is serialised by
 423  * key_construction_mutex.
 424  */
 425 static int __key_instantiate_and_link(struct key *key,
 426                                       struct key_preparsed_payload *prep,
 427                                       struct key *keyring,
 428                                       struct key *authkey,
 429                                       struct assoc_array_edit **_edit)
 430 {
 431         int ret, awaken;
 432
 433         key_check(key);
 434         key_check(keyring);
 435
 436         awaken = 0;
 437         ret = -EBUSY;
 438
 439         mutex_lock(&key_construction_mutex);
 440
 441         /* can't instantiate twice */
 442         if (key->state == KEY_IS_UNINSTANTIATED) {
 443                 /* instantiate the key */
 444                 ret = key->type->instantiate(key, prep);
 445
 446                 if (ret == 0) {
 447                         /* mark the key as being instantiated */
 448                         atomic_inc(&key->user->nikeys);
 449                         mark_key_instantiated(key, 0);
 450
 451                         if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))
 452                                 awaken = 1;
 453
 454                         /* and link it into the destination keyring */
 455                         if (keyring) {
 456                                 if (test_bit(KEY_FLAG_KEEP, &keyring->flags))
 457                                         set_bit(KEY_FLAG_KEEP, &key->flags);
 458
 459                                 __key_link(key, _edit);
 460                         }
 461
 462                         /* disable the authorisation key */
 463                         if (authkey)
 464                                 key_revoke(authkey);
 465
 466                         if (prep->expiry != TIME_T_MAX) {
 467                                 key->expiry = prep->expiry;
 468                                 key_schedule_gc(prep->expiry + key_gc_delay);
 469                         }
 470                 }
 471         }
 472
 473         mutex_unlock(&key_construction_mutex);
 474
 475         /* wake up anyone waiting for a key to be constructed */
 476         if (awaken)
 477                 wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);
 478
 479         return ret;
 480 }
 481
 482 /**
 483  * key_instantiate_and_link - Instantiate a key and link it into the keyring.
 484  * @key: The key to instantiate.
 485  * @data: The data to use to instantiate the keyring.
 486  * @datalen: The length of @data.
 487  * @keyring: Keyring to create a link in on success (or NULL).
 488  * @authkey: The authorisation token permitting instantiation.
 489  *
 490  * Instantiate a key that's in the uninstantiated state using the provided data
 491  * and, if successful, link it in to the destination keyring if one is
 492  * supplied.
 493  *
 494  * If successful, 0 is returned, the authorisation token is revoked and anyone
 495  * waiting for the key is woken up.  If the key was already instantiated,
 496  * -EBUSY will be returned.
 497  */
 498 int key_instantiate_and_link(struct key *key,
 499                              const void *data,
 500                              size_t datalen,
 501                              struct key *keyring,
 502                              struct key *authkey)
 503 {
 504         struct key_preparsed_payload prep;
 505         struct assoc_array_edit *edit;
 506         int ret;
 507
 508         memset(&prep, 0, sizeof(prep));
 509         prep.data = data;
 510         prep.datalen = datalen;
 511         prep.quotalen = key->type->def_datalen;
 512         prep.expiry = TIME_T_MAX;
 513         if (key->type->preparse) {
 514                 ret = key->type->preparse(&prep);
 515                 if (ret < 0)
 516                         goto error;
 517         }
 518
 519         if (keyring) {
 520                 ret = __key_link_begin(keyring, &key->index_key, &edit);
 521                 if (ret < 0)
 522                         goto error;
 523
 524                 if (keyring->restrict_link && keyring->restrict_link->check) {
 525                         struct key_restriction *keyres = keyring->restrict_link;
 526
 527                         ret = keyres->check(keyring, key->type, &prep.payload,
 528                                             keyres->key);
 529                         if (ret < 0)
 530                                 goto error_link_end;
 531                 }
 532         }
 533
 534         ret = __key_instantiate_and_link(key, &prep, keyring, authkey, &edit);
 535
 536 error_link_end:
 537         if (keyring)
 538                 __key_link_end(keyring, &key->index_key, edit);
 539
 540 error:
 541         if (key->type->preparse)
 542                 key->type->free_preparse(&prep);
 543         return ret;
 544 }
 545
 546 EXPORT_SYMBOL(key_instantiate_and_link);
 547
 548 /**
 549  * key_reject_and_link - Negatively instantiate a key and link it into the keyring.
 550  * @key: The key to instantiate.
 551  * @timeout: The timeout on the negative key.
 552  * @error: The error to return when the key is hit.
 553  * @keyring: Keyring to create a link in on success (or NULL).
 554  * @authkey: The authorisation token permitting instantiation.
 555  *
 556  * Negatively instantiate a key that's in the uninstantiated state and, if
 557  * successful, set its timeout and stored error and link it in to the
 558  * destination keyring if one is supplied.  The key and any links to the key
 559  * will be automatically garbage collected after the timeout expires.
 560  *
 561  * Negative keys are used to rate limit repeated request_key() calls by causing
 562  * them to return the stored error code (typically ENOKEY) until the negative
 563  * key expires.
 564  *
 565  * If successful, 0 is returned, the authorisation token is revoked and anyone
 566  * waiting for the key is woken up.  If the key was already instantiated,
 567  * -EBUSY will be returned.
 568  */
 569 int key_reject_and_link(struct key *key,
 570                         unsigned timeout,
 571                         unsigned error,
 572                         struct key *keyring,
 573                         struct key *authkey)
 574 {
 575         struct assoc_array_edit *edit;
 576         struct timespec now;
 577         int ret, awaken, link_ret = 0;
 578
 579         key_check(key);
 580         key_check(keyring);
 581
 582         awaken = 0;
 583         ret = -EBUSY;
 584
 585         if (keyring) {
 586                 if (keyring->restrict_link)
 587                         return -EPERM;
 588
 589                 link_ret = __key_link_begin(keyring, &key->index_key, &edit);
 590         }
 591
 592         mutex_lock(&key_construction_mutex);
 593
 594         /* can't instantiate twice */
 595         if (key->state == KEY_IS_UNINSTANTIATED) {
 596                 /* mark the key as being negatively instantiated */
 597                 atomic_inc(&key->user->nikeys);
 598                 mark_key_instantiated(key, -error);
 599                 now = current_kernel_time();
 600                 key->expiry = now.tv_sec + timeout;
 601                 key_schedule_gc(key->expiry + key_gc_delay);
 602
 603                 if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))
 604                         awaken = 1;
 605
 606                 ret = 0;
 607
 608                 /* and link it into the destination keyring */
 609                 if (keyring && link_ret == 0)
 610                         __key_link(key, &edit);
 611
 612                 /* disable the authorisation key */
 613                 if (authkey)
 614                         key_revoke(authkey);
 615         }
 616
 617         mutex_unlock(&key_construction_mutex);
 618
 619         if (keyring && link_ret == 0)
 620                 __key_link_end(keyring, &key->index_key, edit);
 621
 622         /* wake up anyone waiting for a key to be constructed */
 623         if (awaken)
 624                 wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);
 625
 626         return ret == 0 ? link_ret : ret;
 627 }
 628 EXPORT_SYMBOL(key_reject_and_link);
 629
 630 /**
 631  * key_put - Discard a reference to a key.
 632  * @key: The key to discard a reference from.
 633  *
 634  * Discard a reference to a key, and when all the references are gone, we
 635  * schedule the cleanup task to come and pull it out of the tree in process
 636  * context at some later time.
 637  */
 638 void key_put(struct key *key)
 639 {
 640         if (key) {
 641                 key_check(key);
 642
 643                 if (refcount_dec_and_test(&key->usage))
 644                         schedule_work(&key_gc_work);
 645         }
 646 }
 647 EXPORT_SYMBOL(key_put);
 648
 649 /*
 650  * Find a key by its serial number.
 651  */
 652 struct key *key_lookup(key_serial_t id)
 653 {
 654         struct rb_node *n;
 655         struct key *key;
 656
 657         spin_lock(&key_serial_lock);
 658
 659         /* search the tree for the specified key */
 660         n = key_serial_tree.rb_node;
 661         while (n) {
 662                 key = rb_entry(n, struct key, serial_node);
 663
 664                 if (id < key->serial)
 665                         n = n->rb_left;
 666                 else if (id > key->serial)
 667                         n = n->rb_right;
 668                 else
 669                         goto found;
 670         }
 671
 672 not_found:
 673         key = ERR_PTR(-ENOKEY);
 674         goto error;
 675
 676 found:
 677         /* A key is allowed to be looked up only if someone still owns a
 678          * reference to it - otherwise it's awaiting the gc.
 679          */
 680         if (!refcount_inc_not_zero(&key->usage))
 681                 goto not_found;
 682
 683 error:
 684         spin_unlock(&key_serial_lock);
 685         return key;
 686 }
 687
 688 /*
 689  * Find and lock the specified key type against removal.
 690  *
 691  * We return with the sem read-locked if successful.  If the type wasn't
 692  * available -ENOKEY is returned instead.
 693  */
 694 struct key_type *key_type_lookup(const char *type)
 695 {
 696         struct key_type *ktype;
 697
 698         down_read(&key_types_sem);
 699
 700         /* look up the key type to see if it's one of the registered kernel
 701          * types */
 702         list_for_each_entry(ktype, &key_types_list, link) {
 703                 if (strcmp(ktype->name, type) == 0)
 704                         goto found_kernel_type;
 705         }
 706
 707         up_read(&key_types_sem);
 708         ktype = ERR_PTR(-ENOKEY);
 709
 710 found_kernel_type:
 711         return ktype;
 712 }
 713
 714 void key_set_timeout(struct key *key, unsigned timeout)
 715 {
 716         struct timespec now;
 717         time_t expiry = 0;
 718
 719         /* make the changes with the locks held to prevent races */
 720         down_write(&key->sem);
 721
 722         if (timeout > 0) {
 723                 now = current_kernel_time();
 724                 expiry = now.tv_sec + timeout;
 725         }
 726
 727         key->expiry = expiry;
 728         key_schedule_gc(key->expiry + key_gc_delay);
 729
 730         up_write(&key->sem);
 731 }
 732 EXPORT_SYMBOL_GPL(key_set_timeout);
 733
 734 /*
 735  * Unlock a key type locked by key_type_lookup().
 736  */
 737 void key_type_put(struct key_type *ktype)
 738 {
 739         up_read(&key_types_sem);
 740 }
 741
 742 /*
 743  * Attempt to update an existing key.
 744  *
 745  * The key is given to us with an incremented refcount that we need to discard
 746  * if we get an error.
 747  */
 748 static inline key_ref_t __key_update(key_ref_t key_ref,
 749                                      struct key_preparsed_payload *prep)
 750 {
 751         struct key *key = key_ref_to_ptr(key_ref);
 752         int ret;
 753
 754         /* need write permission on the key to update it */
 755         ret = key_permission(key_ref, KEY_NEED_WRITE);
 756         if (ret < 0)
 757                 goto error;
 758
 759         ret = -EEXIST;
 760         if (!key->type->update)
 761                 goto error;
 762
 763         down_write(&key->sem);
 764
 765         ret = key->type->update(key, prep);
 766         if (ret == 0)
 767                 /* Updating a negative key positively instantiates it */
 768                 mark_key_instantiated(key, 0);
 769
 770         up_write(&key->sem);
 771
 772         if (ret < 0)
 773                 goto error;
 774 out:
 775         return key_ref;
 776
 777 error:
 778         key_put(key);
 779         key_ref = ERR_PTR(ret);
 780         goto out;
 781 }
 782
 783 /**
 784  * key_create_or_update - Update or create and instantiate a key.
 785  * @keyring_ref: A pointer to the destination keyring with possession flag.
 786  * @type: The type of key.
 787  * @description: The searchable description for the key.
 788  * @payload: The data to use to instantiate or update the key.
 789  * @plen: The length of @payload.
 790  * @perm: The permissions mask for a new key.
 791  * @flags: The quota flags for a new key.
 792  *
 793  * Search the destination keyring for a key of the same description and if one
 794  * is found, update it, otherwise create and instantiate a new one and create a
 795  * link to it from that keyring.
 796  *
 797  * If perm is KEY_PERM_UNDEF then an appropriate key permissions mask will be
 798  * concocted.
 799  *
 800  * Returns a pointer to the new key if successful, -ENODEV if the key type
 801  * wasn't available, -ENOTDIR if the keyring wasn't a keyring, -EACCES if the
 802  * caller isn't permitted to modify the keyring or the LSM did not permit
 803  * creation of the key.
 804  *
 805  * On success, the possession flag from the keyring ref will be tacked on to
 806  * the key ref before it is returned.
 807  */
 808 key_ref_t key_create_or_update(key_ref_t keyring_ref,
 809                                const char *type,
 810                                const char *description,
 811                                const void *payload,
 812                                size_t plen,
 813                                key_perm_t perm,
 814                                unsigned long flags)
 815 {
 816         struct keyring_index_key index_key = {
 817                 .description    = description,
 818         };
 819         struct key_preparsed_payload prep;
 820         struct assoc_array_edit *edit;
 821         const struct cred *cred = current_cred();
 822         struct key *keyring, *key = NULL;
 823         key_ref_t key_ref;
 824         int ret;
 825         struct key_restriction *restrict_link = NULL;
 826
 827         /* look up the key type to see if it's one of the registered kernel
 828          * types */
 829         index_key.type = key_type_lookup(type);
 830         if (IS_ERR(index_key.type)) {
 831                 key_ref = ERR_PTR(-ENODEV);
 832                 goto error;
 833         }
 834
 835         key_ref = ERR_PTR(-EINVAL);
 836         if (!index_key.type->instantiate ||
 837             (!index_key.description && !index_key.type->preparse))
 838                 goto error_put_type;
 839
 840         keyring = key_ref_to_ptr(keyring_ref);
 841
 842         key_check(keyring);
 843
 844         key_ref = ERR_PTR(-EPERM);
 845         if (!(flags & KEY_ALLOC_BYPASS_RESTRICTION))
 846                 restrict_link = keyring->restrict_link;
 847
 848         key_ref = ERR_PTR(-ENOTDIR);
 849         if (keyring->type != &key_type_keyring)
 850                 goto error_put_type;
 851
 852         memset(&prep, 0, sizeof(prep));
 853         prep.data = payload;
 854         prep.datalen = plen;
 855         prep.quotalen = index_key.type->def_datalen;
 856         prep.expiry = TIME_T_MAX;
 857         if (index_key.type->preparse) {
 858                 ret = index_key.type->preparse(&prep);
 859                 if (ret < 0) {
 860                         key_ref = ERR_PTR(ret);
 861                         goto error_free_prep;
 862                 }
 863                 if (!index_key.description)
 864                         index_key.description = prep.description;
 865                 key_ref = ERR_PTR(-EINVAL);
 866                 if (!index_key.description)
 867                         goto error_free_prep;
 868         }
 869         index_key.desc_len = strlen(index_key.description);
 870
 871         ret = __key_link_begin(keyring, &index_key, &edit);
 872         if (ret < 0) {
 873                 key_ref = ERR_PTR(ret);
 874                 goto error_free_prep;
 875         }
 876
 877         if (restrict_link && restrict_link->check) {
 878                 ret = restrict_link->check(keyring, index_key.type,
 879                                            &prep.payload, restrict_link->key);
 880                 if (ret < 0) {
 881                         key_ref = ERR_PTR(ret);
 882                         goto error_link_end;
 883                 }
 884         }
 885
 886         /* if we're going to allocate a new key, we're going to have
 887          * to modify the keyring */
 888         ret = key_permission(keyring_ref, KEY_NEED_WRITE);
 889         if (ret < 0) {
 890                 key_ref = ERR_PTR(ret);
 891                 goto error_link_end;
 892         }
 893
 894         /* if it's possible to update this type of key, search for an existing
 895          * key of the same type and description in the destination keyring and
 896          * update that instead if possible
 897          */
 898         if (index_key.type->update) {
 899                 key_ref = find_key_to_update(keyring_ref, &index_key);
 900                 if (key_ref)
 901                         goto found_matching_key;
 902         }
 903
 904         /* if the client doesn't provide, decide on the permissions we want */
 905         if (perm == KEY_PERM_UNDEF) {
 906                 perm = KEY_POS_VIEW | KEY_POS_SEARCH | KEY_POS_LINK | KEY_POS_SETATTR;
 907                 perm |= KEY_USR_VIEW;
 908
 909                 if (index_key.type->read)
 910                         perm |= KEY_POS_READ;
 911
 912                 if (index_key.type == &key_type_keyring ||
 913                     index_key.type->update)
 914                         perm |= KEY_POS_WRITE;
 915         }
 916
 917         /* allocate a new key */
 918         key = key_alloc(index_key.type, index_key.description,
 919                         cred->fsuid, cred->fsgid, cred, perm, flags, NULL);
 920         if (IS_ERR(key)) {
 921                 key_ref = ERR_CAST(key);
 922                 goto error_link_end;
 923         }
 924
 925         /* instantiate it and link it into the target keyring */
 926         ret = __key_instantiate_and_link(key, &prep, keyring, NULL, &edit);
 927         if (ret < 0) {
 928                 key_put(key);
 929                 key_ref = ERR_PTR(ret);
 930                 goto error_link_end;
 931         }
 932
 933         key_ref = make_key_ref(key, is_key_possessed(keyring_ref));
 934
 935 error_link_end:
 936         __key_link_end(keyring, &index_key, edit);
 937 error_free_prep:
 938         if (index_key.type->preparse)
 939                 index_key.type->free_preparse(&prep);
 940 error_put_type:
 941         key_type_put(index_key.type);
 942 error:
 943         return key_ref;
 944
 945  found_matching_key:
 946         /* we found a matching key, so we're going to try to update it
 947          * - we can drop the locks first as we have the key pinned
 948          */
 949         __key_link_end(keyring, &index_key, edit);
 950
 951         key = key_ref_to_ptr(key_ref);
 952         if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags)) {
 953                 ret = wait_for_key_construction(key, true);
 954                 if (ret < 0) {
 955                         key_ref_put(key_ref);
 956                         key_ref = ERR_PTR(ret);
 957                         goto error_free_prep;
 958                 }
 959         }
 960
 961         key_ref = __key_update(key_ref, &prep);
 962         goto error_free_prep;
 963 }
 964 EXPORT_SYMBOL(key_create_or_update);
 965
 966 /**
 967  * key_update - Update a key's contents.
 968  * @key_ref: The pointer (plus possession flag) to the key.
 969  * @payload: The data to be used to update the key.
 970  * @plen: The length of @payload.
 971  *
 972  * Attempt to update the contents of a key with the given payload data.  The
 973  * caller must be granted Write permission on the key.  Negative keys can be
 974  * instantiated by this method.
 975  *
 976  * Returns 0 on success, -EACCES if not permitted and -EOPNOTSUPP if the key
 977  * type does not support updating.  The key type may return other errors.
 978  */
 979 int key_update(key_ref_t key_ref, const void *payload, size_t plen)
 980 {
 981         struct key_preparsed_payload prep;
 982         struct key *key = key_ref_to_ptr(key_ref);
 983         int ret;
 984
 985         key_check(key);
 986
 987         /* the key must be writable */
 988         ret = key_permission(key_ref, KEY_NEED_WRITE);
 989         if (ret < 0)
 990                 return ret;
 991
 992         /* attempt to update it if supported */
 993         if (!key->type->update)
 994                 return -EOPNOTSUPP;
 995
 996         memset(&prep, 0, sizeof(prep));
 997         prep.data = payload;
 998         prep.datalen = plen;
 999         prep.quotalen = key->type->def_datalen;
1000         prep.expiry = TIME_T_MAX;
1001         if (key->type->preparse) {
1002                 ret = key->type->preparse(&prep);
1003                 if (ret < 0)
1004                         goto error;
1005         }
1006
1007         down_write(&key->sem);
1008
1009         ret = key->type->update(key, &prep);
1010         if (ret == 0)
1011                 /* Updating a negative key positively instantiates it */
1012                 mark_key_instantiated(key, 0);
1013
1014         up_write(&key->sem);
1015
1016 error:
1017         if (key->type->preparse)
1018                 key->type->free_preparse(&prep);
1019         return ret;
1020 }
1021 EXPORT_SYMBOL(key_update);
1022
1023 /**
1024  * key_revoke - Revoke a key.
1025  * @key: The key to be revoked.
1026  *
1027  * Mark a key as being revoked and ask the type to free up its resources.  The
1028  * revocation timeout is set and the key and all its links will be
1029  * automatically garbage collected after key_gc_delay amount of time if they
1030  * are not manually dealt with first.
1031  */
1032 void key_revoke(struct key *key)
1033 {
1034         struct timespec now;
1035         time_t time;
1036
1037         key_check(key);
1038
1039         /* make sure no one's trying to change or use the key when we mark it
1040          * - we tell lockdep that we might nest because we might be revoking an
1041          *   authorisation key whilst holding the sem on a key we've just
1042          *   instantiated
1043          */
1044         down_write_nested(&key->sem, 1);
1045         if (!test_and_set_bit(KEY_FLAG_REVOKED, &key->flags) &&
1046             key->type->revoke)
1047                 key->type->revoke(key);
1048
1049         /* set the death time to no more than the expiry time */
1050         now = current_kernel_time();
1051         time = now.tv_sec;
1052         if (key->revoked_at == 0 || key->revoked_at > time) {
1053                 key->revoked_at = time;
1054                 key_schedule_gc(key->revoked_at + key_gc_delay);
1055         }
1056
1057         up_write(&key->sem);
1058 }
1059 EXPORT_SYMBOL(key_revoke);
1060
1061 /**
1062  * key_invalidate - Invalidate a key.
1063  * @key: The key to be invalidated.
1064  *
1065  * Mark a key as being invalidated and have it cleaned up immediately.  The key
1066  * is ignored by all searches and other operations from this point.
1067  */
1068 void key_invalidate(struct key *key)
1069 {
1070         kenter("%d", key_serial(key));
1071
1072         key_check(key);
1073
1074         if (!test_bit(KEY_FLAG_INVALIDATED, &key->flags)) {
1075                 down_write_nested(&key->sem, 1);
1076                 if (!test_and_set_bit(KEY_FLAG_INVALIDATED, &key->flags))
1077                         key_schedule_gc_links();
1078                 up_write(&key->sem);
1079         }
1080 }
1081 EXPORT_SYMBOL(key_invalidate);
1082
1083 /**
1084  * generic_key_instantiate - Simple instantiation of a key from preparsed data
1085  * @key: The key to be instantiated
1086  * @prep: The preparsed data to load.
1087  *
1088  * Instantiate a key from preparsed data.  We assume we can just copy the data
1089  * in directly and clear the old pointers.
1090  *
1091  * This can be pointed to directly by the key type instantiate op pointer.
1092  */
1093 int generic_key_instantiate(struct key *key, struct key_preparsed_payload *prep)
1094 {
1095         int ret;
1096
1097         pr_devel("==>%s()\n", __func__);
1098
1099         ret = key_payload_reserve(key, prep->quotalen);
1100         if (ret == 0) {
1101                 rcu_assign_keypointer(key, prep->payload.data[0]);
1102                 key->payload.data[1] = prep->payload.data[1];
1103                 key->payload.data[2] = prep->payload.data[2];
1104                 key->payload.data[3] = prep->payload.data[3];
1105                 prep->payload.data[0] = NULL;
1106                 prep->payload.data[1] = NULL;
1107                 prep->payload.data[2] = NULL;
1108                 prep->payload.data[3] = NULL;
1109         }
1110         pr_devel("<==%s() = %d\n", __func__, ret);
1111         return ret;
1112 }
1113 EXPORT_SYMBOL(generic_key_instantiate);
1114
1115 /**
1116  * register_key_type - Register a type of key.
1117  * @ktype: The new key type.
1118  *
1119  * Register a new key type.
1120  *
1121  * Returns 0 on success or -EEXIST if a type of this name already exists.
1122  */
1123 int register_key_type(struct key_type *ktype)
1124 {
1125         struct key_type *p;
1126         int ret;
1127
1128         memset(&ktype->lock_class, 0, sizeof(ktype->lock_class));
1129
1130         ret = -EEXIST;
1131         down_write(&key_types_sem);
1132
1133         /* disallow key types with the same name */
1134         list_for_each_entry(p, &key_types_list, link) {
1135                 if (strcmp(p->name, ktype->name) == 0)
1136                         goto out;
1137         }
1138
1139         /* store the type */
1140         list_add(&ktype->link, &key_types_list);
1141
1142         pr_notice("Key type %s registered\n", ktype->name);
1143         ret = 0;
1144
1145 out:
1146         up_write(&key_types_sem);
1147         return ret;
1148 }
1149 EXPORT_SYMBOL(register_key_type);
1150
1151 /**
1152  * unregister_key_type - Unregister a type of key.
1153  * @ktype: The key type.
1154  *
1155  * Unregister a key type and mark all the extant keys of this type as dead.
1156  * Those keys of this type are then destroyed to get rid of their payloads and
1157  * they and their links will be garbage collected as soon as possible.
1158  */
1159 void unregister_key_type(struct key_type *ktype)
1160 {
1161         down_write(&key_types_sem);
1162         list_del_init(&ktype->link);
1163         downgrade_write(&key_types_sem);
1164         key_gc_keytype(ktype);
1165         pr_notice("Key type %s unregistered\n", ktype->name);
1166         up_read(&key_types_sem);
1167 }
1168 EXPORT_SYMBOL(unregister_key_type);
1169
1170 /*
1171  * Initialise the key management state.
1172  */
1173 void __init key_init(void)
1174 {
1175         /* allocate a slab in which we can store keys */
1176         key_jar = kmem_cache_create("key_jar", sizeof(struct key),
1177                         0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
1178
1179         /* add the special key types */
1180         list_add_tail(&key_type_keyring.link, &key_types_list);
1181         list_add_tail(&key_type_dead.link, &key_types_list);
1182         list_add_tail(&key_type_user.link, &key_types_list);
1183         list_add_tail(&key_type_logon.link, &key_types_list);
1184
1185         /* record the root user tracking */
1186         rb_link_node(&root_key_user.node,
1187                      NULL,
1188                      &key_user_tree.rb_node);
1189
1190         rb_insert_color(&root_key_user.node,
1191                         &key_user_tree);
1192 }