security/keys/key.c

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