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 = 200;      /* root's key count quota */
  31 unsigned int key_quota_root_maxbytes = 20000;   /* 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 = NULL;
  58         struct rb_node **p;
  59
  60 try_again:
  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         atomic_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         atomic_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 (atomic_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  *
 205  * Allocate a key of the specified type with the attributes given.  The key is
 206  * returned in an uninstantiated state and the caller needs to instantiate the
 207  * key before returning.
 208  *
 209  * The user's key count quota is updated to reflect the creation of the key and
 210  * the user's key data quota has the default for the key type reserved.  The
 211  * instantiation function should amend this as necessary.  If insufficient
 212  * quota is available, -EDQUOT will be returned.
 213  *
 214  * The LSM security modules can prevent a key being created, in which case
 215  * -EACCES will be returned.
 216  *
 217  * Returns a pointer to the new key if successful and an error code otherwise.
 218  *
 219  * Note that the caller needs to ensure the key type isn't uninstantiated.
 220  * Internally this can be done by locking key_types_sem.  Externally, this can
 221  * be done by either never unregistering the key type, or making sure
 222  * key_alloc() calls don't race with module unloading.
 223  */
 224 struct key *key_alloc(struct key_type *type, const char *desc,
 225                       kuid_t uid, kgid_t gid, const struct cred *cred,
 226                       key_perm_t perm, unsigned long flags)
 227 {
 228         struct key_user *user = NULL;
 229         struct key *key;
 230         size_t desclen, quotalen;
 231         int ret;
 232
 233         key = ERR_PTR(-EINVAL);
 234         if (!desc || !*desc)
 235                 goto error;
 236
 237         if (type->vet_description) {
 238                 ret = type->vet_description(desc);
 239                 if (ret < 0) {
 240                         key = ERR_PTR(ret);
 241                         goto error;
 242                 }
 243         }
 244
 245         desclen = strlen(desc);
 246         quotalen = desclen + 1 + type->def_datalen;
 247
 248         /* get hold of the key tracking for this user */
 249         user = key_user_lookup(uid);
 250         if (!user)
 251                 goto no_memory_1;
 252
 253         /* check that the user's quota permits allocation of another key and
 254          * its description */
 255         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 256                 unsigned maxkeys = uid_eq(uid, GLOBAL_ROOT_UID) ?
 257                         key_quota_root_maxkeys : key_quota_maxkeys;
 258                 unsigned maxbytes = uid_eq(uid, GLOBAL_ROOT_UID) ?
 259                         key_quota_root_maxbytes : key_quota_maxbytes;
 260
 261                 spin_lock(&user->lock);
 262                 if (!(flags & KEY_ALLOC_QUOTA_OVERRUN)) {
 263                         if (user->qnkeys + 1 >= maxkeys ||
 264                             user->qnbytes + quotalen >= maxbytes ||
 265                             user->qnbytes + quotalen < user->qnbytes)
 266                                 goto no_quota;
 267                 }
 268
 269                 user->qnkeys++;
 270                 user->qnbytes += quotalen;
 271                 spin_unlock(&user->lock);
 272         }
 273
 274         /* allocate and initialise the key and its description */
 275         key = kmem_cache_alloc(key_jar, GFP_KERNEL);
 276         if (!key)
 277                 goto no_memory_2;
 278
 279         if (desc) {
 280                 key->index_key.desc_len = desclen;
 281                 key->index_key.description = kmemdup(desc, desclen + 1, GFP_KERNEL);
 282                 if (!key->description)
 283                         goto no_memory_3;
 284         }
 285
 286         atomic_set(&key->usage, 1);
 287         init_rwsem(&key->sem);
 288         lockdep_set_class(&key->sem, &type->lock_class);
 289         key->index_key.type = type;
 290         key->user = user;
 291         key->quotalen = quotalen;
 292         key->datalen = type->def_datalen;
 293         key->uid = uid;
 294         key->gid = gid;
 295         key->perm = perm;
 296         key->flags = 0;
 297         key->expiry = 0;
 298         key->payload.data = NULL;
 299         key->security = NULL;
 300
 301         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA))
 302                 key->flags |= 1 << KEY_FLAG_IN_QUOTA;
 303         if (flags & KEY_ALLOC_TRUSTED)
 304                 key->flags |= 1 << KEY_FLAG_TRUSTED;
 305
 306         memset(&key->type_data, 0, sizeof(key->type_data));
 307
 308 #ifdef KEY_DEBUGGING
 309         key->magic = KEY_DEBUG_MAGIC;
 310 #endif
 311
 312         /* let the security module know about the key */
 313         ret = security_key_alloc(key, cred, flags);
 314         if (ret < 0)
 315                 goto security_error;
 316
 317         /* publish the key by giving it a serial number */
 318         atomic_inc(&user->nkeys);
 319         key_alloc_serial(key);
 320
 321 error:
 322         return key;
 323
 324 security_error:
 325         kfree(key->description);
 326         kmem_cache_free(key_jar, key);
 327         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 328                 spin_lock(&user->lock);
 329                 user->qnkeys--;
 330                 user->qnbytes -= quotalen;
 331                 spin_unlock(&user->lock);
 332         }
 333         key_user_put(user);
 334         key = ERR_PTR(ret);
 335         goto error;
 336
 337 no_memory_3:
 338         kmem_cache_free(key_jar, key);
 339 no_memory_2:
 340         if (!(flags & KEY_ALLOC_NOT_IN_QUOTA)) {
 341                 spin_lock(&user->lock);
 342                 user->qnkeys--;
 343                 user->qnbytes -= quotalen;
 344                 spin_unlock(&user->lock);
 345         }
 346         key_user_put(user);
 347 no_memory_1:
 348         key = ERR_PTR(-ENOMEM);
 349         goto error;
 350
 351 no_quota:
 352         spin_unlock(&user->lock);
 353         key_user_put(user);
 354         key = ERR_PTR(-EDQUOT);
 355         goto error;
 356 }
 357 EXPORT_SYMBOL(key_alloc);
 358
 359 /**
 360  * key_payload_reserve - Adjust data quota reservation for the key's payload
 361  * @key: The key to make the reservation for.
 362  * @datalen: The amount of data payload the caller now wants.
 363  *
 364  * Adjust the amount of the owning user's key data quota that a key reserves.
 365  * If the amount is increased, then -EDQUOT may be returned if there isn't
 366  * enough free quota available.
 367  *
 368  * If successful, 0 is returned.
 369  */
 370 int key_payload_reserve(struct key *key, size_t datalen)
 371 {
 372         int delta = (int)datalen - key->datalen;
 373         int ret = 0;
 374
 375         key_check(key);
 376
 377         /* contemplate the quota adjustment */
 378         if (delta != 0 && test_bit(KEY_FLAG_IN_QUOTA, &key->flags)) {
 379                 unsigned maxbytes = uid_eq(key->user->uid, GLOBAL_ROOT_UID) ?
 380                         key_quota_root_maxbytes : key_quota_maxbytes;
 381
 382                 spin_lock(&key->user->lock);
 383
 384                 if (delta > 0 &&
 385                     (key->user->qnbytes + delta >= maxbytes ||
 386                      key->user->qnbytes + delta < key->user->qnbytes)) {
 387                         ret = -EDQUOT;
 388                 }
 389                 else {
 390                         key->user->qnbytes += delta;
 391                         key->quotalen += delta;
 392                 }
 393                 spin_unlock(&key->user->lock);
 394         }
 395
 396         /* change the recorded data length if that didn't generate an error */
 397         if (ret == 0)
 398                 key->datalen = datalen;
 399
 400         return ret;
 401 }
 402 EXPORT_SYMBOL(key_payload_reserve);
 403
 404 /*
 405  * Instantiate a key and link it into the target keyring atomically.  Must be
 406  * called with the target keyring's semaphore writelocked.  The target key's
 407  * semaphore need not be locked as instantiation is serialised by
 408  * key_construction_mutex.
 409  */
 410 static int __key_instantiate_and_link(struct key *key,
 411                                       struct key_preparsed_payload *prep,
 412                                       struct key *keyring,
 413                                       struct key *authkey,
 414                                       struct assoc_array_edit **_edit)
 415 {
 416         int ret, awaken;
 417
 418         key_check(key);
 419         key_check(keyring);
 420
 421         awaken = 0;
 422         ret = -EBUSY;
 423
 424         mutex_lock(&key_construction_mutex);
 425
 426         /* can't instantiate twice */
 427         if (!test_bit(KEY_FLAG_INSTANTIATED, &key->flags)) {
 428                 /* instantiate the key */
 429                 ret = key->type->instantiate(key, prep);
 430
 431                 if (ret == 0) {
 432                         /* mark the key as being instantiated */
 433                         atomic_inc(&key->user->nikeys);
 434                         set_bit(KEY_FLAG_INSTANTIATED, &key->flags);
 435
 436                         if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))
 437                                 awaken = 1;
 438
 439                         /* and link it into the destination keyring */
 440                         if (keyring)
 441                                 __key_link(key, _edit);
 442
 443                         /* disable the authorisation key */
 444                         if (authkey)
 445                                 key_revoke(authkey);
 446                 }
 447         }
 448
 449         mutex_unlock(&key_construction_mutex);
 450
 451         /* wake up anyone waiting for a key to be constructed */
 452         if (awaken)
 453                 wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);
 454
 455         return ret;
 456 }
 457
 458 /**
 459  * key_instantiate_and_link - Instantiate a key and link it into the keyring.
 460  * @key: The key to instantiate.
 461  * @data: The data to use to instantiate the keyring.
 462  * @datalen: The length of @data.
 463  * @keyring: Keyring to create a link in on success (or NULL).
 464  * @authkey: The authorisation token permitting instantiation.
 465  *
 466  * Instantiate a key that's in the uninstantiated state using the provided data
 467  * and, if successful, link it in to the destination keyring if one is
 468  * supplied.
 469  *
 470  * If successful, 0 is returned, the authorisation token is revoked and anyone
 471  * waiting for the key is woken up.  If the key was already instantiated,
 472  * -EBUSY will be returned.
 473  */
 474 int key_instantiate_and_link(struct key *key,
 475                              const void *data,
 476                              size_t datalen,
 477                              struct key *keyring,
 478                              struct key *authkey)
 479 {
 480         struct key_preparsed_payload prep;
 481         struct assoc_array_edit *edit;
 482         int ret;
 483
 484         memset(&prep, 0, sizeof(prep));
 485         prep.data = data;
 486         prep.datalen = datalen;
 487         prep.quotalen = key->type->def_datalen;
 488         if (key->type->preparse) {
 489                 ret = key->type->preparse(&prep);
 490                 if (ret < 0)
 491                         goto error;
 492         }
 493
 494         if (keyring) {
 495                 ret = __key_link_begin(keyring, &key->index_key, &edit);
 496                 if (ret < 0)
 497                         goto error_free_preparse;
 498         }
 499
 500         ret = __key_instantiate_and_link(key, &prep, keyring, authkey, &edit);
 501
 502         if (keyring)
 503                 __key_link_end(keyring, &key->index_key, edit);
 504
 505 error_free_preparse:
 506         if (key->type->preparse)
 507                 key->type->free_preparse(&prep);
 508 error:
 509         return ret;
 510 }
 511
 512 EXPORT_SYMBOL(key_instantiate_and_link);
 513
 514 /**
 515  * key_reject_and_link - Negatively instantiate a key and link it into the keyring.
 516  * @key: The key to instantiate.
 517  * @timeout: The timeout on the negative key.
 518  * @error: The error to return when the key is hit.
 519  * @keyring: Keyring to create a link in on success (or NULL).
 520  * @authkey: The authorisation token permitting instantiation.
 521  *
 522  * Negatively instantiate a key that's in the uninstantiated state and, if
 523  * successful, set its timeout and stored error and link it in to the
 524  * destination keyring if one is supplied.  The key and any links to the key
 525  * will be automatically garbage collected after the timeout expires.
 526  *
 527  * Negative keys are used to rate limit repeated request_key() calls by causing
 528  * them to return the stored error code (typically ENOKEY) until the negative
 529  * key expires.
 530  *
 531  * If successful, 0 is returned, the authorisation token is revoked and anyone
 532  * waiting for the key is woken up.  If the key was already instantiated,
 533  * -EBUSY will be returned.
 534  */
 535 int key_reject_and_link(struct key *key,
 536                         unsigned timeout,
 537                         unsigned error,
 538                         struct key *keyring,
 539                         struct key *authkey)
 540 {
 541         struct assoc_array_edit *edit;
 542         struct timespec now;
 543         int ret, awaken, link_ret = 0;
 544
 545         key_check(key);
 546         key_check(keyring);
 547
 548         awaken = 0;
 549         ret = -EBUSY;
 550
 551         if (keyring)
 552                 link_ret = __key_link_begin(keyring, &key->index_key, &edit);
 553
 554         mutex_lock(&key_construction_mutex);
 555
 556         /* can't instantiate twice */
 557         if (!test_bit(KEY_FLAG_INSTANTIATED, &key->flags)) {
 558                 /* mark the key as being negatively instantiated */
 559                 atomic_inc(&key->user->nikeys);
 560                 set_bit(KEY_FLAG_NEGATIVE, &key->flags);
 561                 set_bit(KEY_FLAG_INSTANTIATED, &key->flags);
 562                 key->type_data.reject_error = -error;
 563                 now = current_kernel_time();
 564                 key->expiry = now.tv_sec + timeout;
 565                 key_schedule_gc(key->expiry + key_gc_delay);
 566
 567                 if (test_and_clear_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags))
 568                         awaken = 1;
 569
 570                 ret = 0;
 571
 572                 /* and link it into the destination keyring */
 573                 if (keyring && link_ret == 0)
 574                         __key_link(key, &edit);
 575
 576                 /* disable the authorisation key */
 577                 if (authkey)
 578                         key_revoke(authkey);
 579         }
 580
 581         mutex_unlock(&key_construction_mutex);
 582
 583         if (keyring)
 584                 __key_link_end(keyring, &key->index_key, edit);
 585
 586         /* wake up anyone waiting for a key to be constructed */
 587         if (awaken)
 588                 wake_up_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT);
 589
 590         return ret == 0 ? link_ret : ret;
 591 }
 592 EXPORT_SYMBOL(key_reject_and_link);
 593
 594 /**
 595  * key_put - Discard a reference to a key.
 596  * @key: The key to discard a reference from.
 597  *
 598  * Discard a reference to a key, and when all the references are gone, we
 599  * schedule the cleanup task to come and pull it out of the tree in process
 600  * context at some later time.
 601  */
 602 void key_put(struct key *key)
 603 {
 604         if (key) {
 605                 key_check(key);
 606
 607                 if (atomic_dec_and_test(&key->usage))
 608                         schedule_work(&key_gc_work);
 609         }
 610 }
 611 EXPORT_SYMBOL(key_put);
 612
 613 /*
 614  * Find a key by its serial number.
 615  */
 616 struct key *key_lookup(key_serial_t id)
 617 {
 618         struct rb_node *n;
 619         struct key *key;
 620
 621         spin_lock(&key_serial_lock);
 622
 623         /* search the tree for the specified key */
 624         n = key_serial_tree.rb_node;
 625         while (n) {
 626                 key = rb_entry(n, struct key, serial_node);
 627
 628                 if (id < key->serial)
 629                         n = n->rb_left;
 630                 else if (id > key->serial)
 631                         n = n->rb_right;
 632                 else
 633                         goto found;
 634         }
 635
 636 not_found:
 637         key = ERR_PTR(-ENOKEY);
 638         goto error;
 639
 640 found:
 641         /* pretend it doesn't exist if it is awaiting deletion */
 642         if (atomic_read(&key->usage) == 0)
 643                 goto not_found;
 644
 645         /* this races with key_put(), but that doesn't matter since key_put()
 646          * doesn't actually change the key
 647          */
 648         __key_get(key);
 649
 650 error:
 651         spin_unlock(&key_serial_lock);
 652         return key;
 653 }
 654
 655 /*
 656  * Find and lock the specified key type against removal.
 657  *
 658  * We return with the sem read-locked if successful.  If the type wasn't
 659  * available -ENOKEY is returned instead.
 660  */
 661 struct key_type *key_type_lookup(const char *type)
 662 {
 663         struct key_type *ktype;
 664
 665         down_read(&key_types_sem);
 666
 667         /* look up the key type to see if it's one of the registered kernel
 668          * types */
 669         list_for_each_entry(ktype, &key_types_list, link) {
 670                 if (strcmp(ktype->name, type) == 0)
 671                         goto found_kernel_type;
 672         }
 673
 674         up_read(&key_types_sem);
 675         ktype = ERR_PTR(-ENOKEY);
 676
 677 found_kernel_type:
 678         return ktype;
 679 }
 680
 681 void key_set_timeout(struct key *key, unsigned timeout)
 682 {
 683         struct timespec now;
 684         time_t expiry = 0;
 685
 686         /* make the changes with the locks held to prevent races */
 687         down_write(&key->sem);
 688
 689         if (timeout > 0) {
 690                 now = current_kernel_time();
 691                 expiry = now.tv_sec + timeout;
 692         }
 693
 694         key->expiry = expiry;
 695         key_schedule_gc(key->expiry + key_gc_delay);
 696
 697         up_write(&key->sem);
 698 }
 699 EXPORT_SYMBOL_GPL(key_set_timeout);
 700
 701 /*
 702  * Unlock a key type locked by key_type_lookup().
 703  */
 704 void key_type_put(struct key_type *ktype)
 705 {
 706         up_read(&key_types_sem);
 707 }
 708
 709 /*
 710  * Attempt to update an existing key.
 711  *
 712  * The key is given to us with an incremented refcount that we need to discard
 713  * if we get an error.
 714  */
 715 static inline key_ref_t __key_update(key_ref_t key_ref,
 716                                      struct key_preparsed_payload *prep)
 717 {
 718         struct key *key = key_ref_to_ptr(key_ref);
 719         int ret;
 720
 721         /* need write permission on the key to update it */
 722         ret = key_permission(key_ref, KEY_WRITE);
 723         if (ret < 0)
 724                 goto error;
 725
 726         ret = -EEXIST;
 727         if (!key->type->update)
 728                 goto error;
 729
 730         down_write(&key->sem);
 731
 732         ret = key->type->update(key, prep);
 733         if (ret == 0)
 734                 /* updating a negative key instantiates it */
 735                 clear_bit(KEY_FLAG_NEGATIVE, &key->flags);
 736
 737         up_write(&key->sem);
 738
 739         if (ret < 0)
 740                 goto error;
 741 out:
 742         return key_ref;
 743
 744 error:
 745         key_put(key);
 746         key_ref = ERR_PTR(ret);
 747         goto out;
 748 }
 749
 750 /**
 751  * key_create_or_update - Update or create and instantiate a key.
 752  * @keyring_ref: A pointer to the destination keyring with possession flag.
 753  * @type: The type of key.
 754  * @description: The searchable description for the key.
 755  * @payload: The data to use to instantiate or update the key.
 756  * @plen: The length of @payload.
 757  * @perm: The permissions mask for a new key.
 758  * @flags: The quota flags for a new key.
 759  *
 760  * Search the destination keyring for a key of the same description and if one
 761  * is found, update it, otherwise create and instantiate a new one and create a
 762  * link to it from that keyring.
 763  *
 764  * If perm is KEY_PERM_UNDEF then an appropriate key permissions mask will be
 765  * concocted.
 766  *
 767  * Returns a pointer to the new key if successful, -ENODEV if the key type
 768  * wasn't available, -ENOTDIR if the keyring wasn't a keyring, -EACCES if the
 769  * caller isn't permitted to modify the keyring or the LSM did not permit
 770  * creation of the key.
 771  *
 772  * On success, the possession flag from the keyring ref will be tacked on to
 773  * the key ref before it is returned.
 774  */
 775 key_ref_t key_create_or_update(key_ref_t keyring_ref,
 776                                const char *type,
 777                                const char *description,
 778                                const void *payload,
 779                                size_t plen,
 780                                key_perm_t perm,
 781                                unsigned long flags)
 782 {
 783         struct keyring_index_key index_key = {
 784                 .description    = description,
 785         };
 786         struct key_preparsed_payload prep;
 787         struct assoc_array_edit *edit;
 788         const struct cred *cred = current_cred();
 789         struct key *keyring, *key = NULL;
 790         key_ref_t key_ref;
 791         int ret;
 792
 793         /* look up the key type to see if it's one of the registered kernel
 794          * types */
 795         index_key.type = key_type_lookup(type);
 796         if (IS_ERR(index_key.type)) {
 797                 key_ref = ERR_PTR(-ENODEV);
 798                 goto error;
 799         }
 800
 801         key_ref = ERR_PTR(-EINVAL);
 802         if (!index_key.type->match || !index_key.type->instantiate ||
 803             (!index_key.description && !index_key.type->preparse))
 804                 goto error_put_type;
 805
 806         keyring = key_ref_to_ptr(keyring_ref);
 807
 808         key_check(keyring);
 809
 810         key_ref = ERR_PTR(-ENOTDIR);
 811         if (keyring->type != &key_type_keyring)
 812                 goto error_put_type;
 813
 814         memset(&prep, 0, sizeof(prep));
 815         prep.data = payload;
 816         prep.datalen = plen;
 817         prep.quotalen = index_key.type->def_datalen;
 818         prep.trusted = flags & KEY_ALLOC_TRUSTED;
 819         if (index_key.type->preparse) {
 820                 ret = index_key.type->preparse(&prep);
 821                 if (ret < 0) {
 822                         key_ref = ERR_PTR(ret);
 823                         goto error_put_type;
 824                 }
 825                 if (!index_key.description)
 826                         index_key.description = prep.description;
 827                 key_ref = ERR_PTR(-EINVAL);
 828                 if (!index_key.description)
 829                         goto error_free_prep;
 830         }
 831         index_key.desc_len = strlen(index_key.description);
 832
 833         key_ref = ERR_PTR(-EPERM);
 834         if (!prep.trusted && test_bit(KEY_FLAG_TRUSTED_ONLY, &keyring->flags))
 835                 goto error_free_prep;
 836         flags |= prep.trusted ? KEY_ALLOC_TRUSTED : 0;
 837
 838         ret = __key_link_begin(keyring, &index_key, &edit);
 839         if (ret < 0) {
 840                 key_ref = ERR_PTR(ret);
 841                 goto error_free_prep;
 842         }
 843
 844         /* if we're going to allocate a new key, we're going to have
 845          * to modify the keyring */
 846         ret = key_permission(keyring_ref, KEY_WRITE);
 847         if (ret < 0) {
 848                 key_ref = ERR_PTR(ret);
 849                 goto error_link_end;
 850         }
 851
 852         /* if it's possible to update this type of key, search for an existing
 853          * key of the same type and description in the destination keyring and
 854          * update that instead if possible
 855          */
 856         if (index_key.type->update) {
 857                 key_ref = find_key_to_update(keyring_ref, &index_key);
 858                 if (key_ref)
 859                         goto found_matching_key;
 860         }
 861
 862         /* if the client doesn't provide, decide on the permissions we want */
 863         if (perm == KEY_PERM_UNDEF) {
 864                 perm = KEY_POS_VIEW | KEY_POS_SEARCH | KEY_POS_LINK | KEY_POS_SETATTR;
 865                 perm |= KEY_USR_VIEW;
 866
 867                 if (index_key.type->read)
 868                         perm |= KEY_POS_READ;
 869
 870                 if (index_key.type == &key_type_keyring ||
 871                     index_key.type->update)
 872                         perm |= KEY_POS_WRITE;
 873         }
 874
 875         /* allocate a new key */
 876         key = key_alloc(index_key.type, index_key.description,
 877                         cred->fsuid, cred->fsgid, cred, perm, flags);
 878         if (IS_ERR(key)) {
 879                 key_ref = ERR_CAST(key);
 880                 goto error_link_end;
 881         }
 882
 883         /* instantiate it and link it into the target keyring */
 884         ret = __key_instantiate_and_link(key, &prep, keyring, NULL, &edit);
 885         if (ret < 0) {
 886                 key_put(key);
 887                 key_ref = ERR_PTR(ret);
 888                 goto error_link_end;
 889         }
 890
 891         key_ref = make_key_ref(key, is_key_possessed(keyring_ref));
 892
 893 error_link_end:
 894         __key_link_end(keyring, &index_key, edit);
 895 error_free_prep:
 896         if (index_key.type->preparse)
 897                 index_key.type->free_preparse(&prep);
 898 error_put_type:
 899         key_type_put(index_key.type);
 900 error:
 901         return key_ref;
 902
 903  found_matching_key:
 904         /* we found a matching key, so we're going to try to update it
 905          * - we can drop the locks first as we have the key pinned
 906          */
 907         __key_link_end(keyring, &index_key, edit);
 908
 909         key_ref = __key_update(key_ref, &prep);
 910         goto error_free_prep;
 911 }
 912 EXPORT_SYMBOL(key_create_or_update);
 913
 914 /**
 915  * key_update - Update a key's contents.
 916  * @key_ref: The pointer (plus possession flag) to the key.
 917  * @payload: The data to be used to update the key.
 918  * @plen: The length of @payload.
 919  *
 920  * Attempt to update the contents of a key with the given payload data.  The
 921  * caller must be granted Write permission on the key.  Negative keys can be
 922  * instantiated by this method.
 923  *
 924  * Returns 0 on success, -EACCES if not permitted and -EOPNOTSUPP if the key
 925  * type does not support updating.  The key type may return other errors.
 926  */
 927 int key_update(key_ref_t key_ref, const void *payload, size_t plen)
 928 {
 929         struct key_preparsed_payload prep;
 930         struct key *key = key_ref_to_ptr(key_ref);
 931         int ret;
 932
 933         key_check(key);
 934
 935         /* the key must be writable */
 936         ret = key_permission(key_ref, KEY_WRITE);
 937         if (ret < 0)
 938                 goto error;
 939
 940         /* attempt to update it if supported */
 941         ret = -EOPNOTSUPP;
 942         if (!key->type->update)
 943                 goto error;
 944
 945         memset(&prep, 0, sizeof(prep));
 946         prep.data = payload;
 947         prep.datalen = plen;
 948         prep.quotalen = key->type->def_datalen;
 949         if (key->type->preparse) {
 950                 ret = key->type->preparse(&prep);
 951                 if (ret < 0)
 952                         goto error;
 953         }
 954
 955         down_write(&key->sem);
 956
 957         ret = key->type->update(key, &prep);
 958         if (ret == 0)
 959                 /* updating a negative key instantiates it */
 960                 clear_bit(KEY_FLAG_NEGATIVE, &key->flags);
 961
 962         up_write(&key->sem);
 963
 964         if (key->type->preparse)
 965                 key->type->free_preparse(&prep);
 966 error:
 967         return ret;
 968 }
 969 EXPORT_SYMBOL(key_update);
 970
 971 /**
 972  * key_revoke - Revoke a key.
 973  * @key: The key to be revoked.
 974  *
 975  * Mark a key as being revoked and ask the type to free up its resources.  The
 976  * revocation timeout is set and the key and all its links will be
 977  * automatically garbage collected after key_gc_delay amount of time if they
 978  * are not manually dealt with first.
 979  */
 980 void key_revoke(struct key *key)
 981 {
 982         struct timespec now;
 983         time_t time;
 984
 985         key_check(key);
 986
 987         /* make sure no one's trying to change or use the key when we mark it
 988          * - we tell lockdep that we might nest because we might be revoking an
 989          *   authorisation key whilst holding the sem on a key we've just
 990          *   instantiated
 991          */
 992         down_write_nested(&key->sem, 1);
 993         if (!test_and_set_bit(KEY_FLAG_REVOKED, &key->flags) &&
 994             key->type->revoke)
 995                 key->type->revoke(key);
 996
 997         /* set the death time to no more than the expiry time */
 998         now = current_kernel_time();
 999         time = now.tv_sec;
1000         if (key->revoked_at == 0 || key->revoked_at > time) {
1001                 key->revoked_at = time;
1002                 key_schedule_gc(key->revoked_at + key_gc_delay);
1003         }
1004
1005         up_write(&key->sem);
1006 }
1007 EXPORT_SYMBOL(key_revoke);
1008
1009 /**
1010  * key_invalidate - Invalidate a key.
1011  * @key: The key to be invalidated.
1012  *
1013  * Mark a key as being invalidated and have it cleaned up immediately.  The key
1014  * is ignored by all searches and other operations from this point.
1015  */
1016 void key_invalidate(struct key *key)
1017 {
1018         kenter("%d", key_serial(key));
1019
1020         key_check(key);
1021
1022         if (!test_bit(KEY_FLAG_INVALIDATED, &key->flags)) {
1023                 down_write_nested(&key->sem, 1);
1024                 if (!test_and_set_bit(KEY_FLAG_INVALIDATED, &key->flags))
1025                         key_schedule_gc_links();
1026                 up_write(&key->sem);
1027         }
1028 }
1029 EXPORT_SYMBOL(key_invalidate);
1030
1031 /**
1032  * register_key_type - Register a type of key.
1033  * @ktype: The new key type.
1034  *
1035  * Register a new key type.
1036  *
1037  * Returns 0 on success or -EEXIST if a type of this name already exists.
1038  */
1039 int register_key_type(struct key_type *ktype)
1040 {
1041         struct key_type *p;
1042         int ret;
1043
1044         memset(&ktype->lock_class, 0, sizeof(ktype->lock_class));
1045
1046         ret = -EEXIST;
1047         down_write(&key_types_sem);
1048
1049         /* disallow key types with the same name */
1050         list_for_each_entry(p, &key_types_list, link) {
1051                 if (strcmp(p->name, ktype->name) == 0)
1052                         goto out;
1053         }
1054
1055         /* store the type */
1056         list_add(&ktype->link, &key_types_list);
1057
1058         pr_notice("Key type %s registered\n", ktype->name);
1059         ret = 0;
1060
1061 out:
1062         up_write(&key_types_sem);
1063         return ret;
1064 }
1065 EXPORT_SYMBOL(register_key_type);
1066
1067 /**
1068  * unregister_key_type - Unregister a type of key.
1069  * @ktype: The key type.
1070  *
1071  * Unregister a key type and mark all the extant keys of this type as dead.
1072  * Those keys of this type are then destroyed to get rid of their payloads and
1073  * they and their links will be garbage collected as soon as possible.
1074  */
1075 void unregister_key_type(struct key_type *ktype)
1076 {
1077         down_write(&key_types_sem);
1078         list_del_init(&ktype->link);
1079         downgrade_write(&key_types_sem);
1080         key_gc_keytype(ktype);
1081         pr_notice("Key type %s unregistered\n", ktype->name);
1082         up_read(&key_types_sem);
1083 }
1084 EXPORT_SYMBOL(unregister_key_type);
1085
1086 /*
1087  * Initialise the key management state.
1088  */
1089 void __init key_init(void)
1090 {
1091         /* allocate a slab in which we can store keys */
1092         key_jar = kmem_cache_create("key_jar", sizeof(struct key),
1093                         0, SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
1094
1095         /* add the special key types */
1096         list_add_tail(&key_type_keyring.link, &key_types_list);
1097         list_add_tail(&key_type_dead.link, &key_types_list);
1098         list_add_tail(&key_type_user.link, &key_types_list);
1099         list_add_tail(&key_type_logon.link, &key_types_list);
1100
1101         /* record the root user tracking */
1102         rb_link_node(&root_key_user.node,
1103                      NULL,
1104                      &key_user_tree.rb_node);
1105
1106         rb_insert_color(&root_key_user.node,
1107                         &key_user_tree);
1108 }