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