security/keys/request_key.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /* Request a key from userspace
   3  *
   4  * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
   5  * Written by David Howells (dhowells@redhat.com)
   6  *
   7  * See Documentation/security/keys/request-key.rst
   8  */
   9
  10 #include <linux/export.h>
  11 #include <linux/sched.h>
  12 #include <linux/kmod.h>
  13 #include <linux/err.h>
  14 #include <linux/keyctl.h>
  15 #include <linux/slab.h>
  16 #include <net/net_namespace.h>
  17 #include "internal.h"
  18 #include <keys/request_key_auth-type.h>
  19
  20 #define key_negative_timeout    60      /* default timeout on a negative key's existence */
  21
  22 static struct key *check_cached_key(struct keyring_search_context *ctx)
  23 {
  24 #ifdef CONFIG_KEYS_REQUEST_CACHE
  25         struct key *key = current->cached_requested_key;
  26
  27         if (key &&
  28             ctx->match_data.cmp(key, &ctx->match_data) &&
  29             !(key->flags & ((1 << KEY_FLAG_INVALIDATED) |
  30                             (1 << KEY_FLAG_REVOKED))))
  31                 return key_get(key);
  32 #endif
  33         return NULL;
  34 }
  35
  36 static void cache_requested_key(struct key *key)
  37 {
  38 #ifdef CONFIG_KEYS_REQUEST_CACHE
  39         struct task_struct *t = current;
  40
  41         /* Do not cache key if it is a kernel thread */
  42         if (!(t->flags & PF_KTHREAD)) {
  43                 key_put(t->cached_requested_key);
  44                 t->cached_requested_key = key_get(key);
  45                 set_tsk_thread_flag(t, TIF_NOTIFY_RESUME);
  46         }
  47 #endif
  48 }
  49
  50 /**
  51  * complete_request_key - Complete the construction of a key.
  52  * @authkey: The authorisation key.
  53  * @error: The success or failute of the construction.
  54  *
  55  * Complete the attempt to construct a key.  The key will be negated
  56  * if an error is indicated.  The authorisation key will be revoked
  57  * unconditionally.
  58  */
  59 void complete_request_key(struct key *authkey, int error)
  60 {
  61         struct request_key_auth *rka = get_request_key_auth(authkey);
  62         struct key *key = rka->target_key;
  63
  64         kenter("%d{%d},%d", authkey->serial, key->serial, error);
  65
  66         if (error < 0)
  67                 key_negate_and_link(key, key_negative_timeout, NULL, authkey);
  68         else
  69                 key_revoke(authkey);
  70 }
  71 EXPORT_SYMBOL(complete_request_key);
  72
  73 /*
  74  * Initialise a usermode helper that is going to have a specific session
  75  * keyring.
  76  *
  77  * This is called in context of freshly forked kthread before kernel_execve(),
  78  * so we can simply install the desired session_keyring at this point.
  79  */
  80 static int umh_keys_init(struct subprocess_info *info, struct cred *cred)
  81 {
  82         struct key *keyring = info->data;
  83
  84         return install_session_keyring_to_cred(cred, keyring);
  85 }
  86
  87 /*
  88  * Clean up a usermode helper with session keyring.
  89  */
  90 static void umh_keys_cleanup(struct subprocess_info *info)
  91 {
  92         struct key *keyring = info->data;
  93         key_put(keyring);
  94 }
  95
  96 /*
  97  * Call a usermode helper with a specific session keyring.
  98  */
  99 static int call_usermodehelper_keys(const char *path, char **argv, char **envp,
 100                                         struct key *session_keyring, int wait)
 101 {
 102         struct subprocess_info *info;
 103
 104         info = call_usermodehelper_setup(path, argv, envp, GFP_KERNEL,
 105                                           umh_keys_init, umh_keys_cleanup,
 106                                           session_keyring);
 107         if (!info)
 108                 return -ENOMEM;
 109
 110         key_get(session_keyring);
 111         return call_usermodehelper_exec(info, wait);
 112 }
 113
 114 /*
 115  * Request userspace finish the construction of a key
 116  * - execute "/sbin/request-key <op> <key> <uid> <gid> <keyring> <keyring> <keyring>"
 117  */
 118 static int call_sbin_request_key(struct key *authkey, void *aux)
 119 {
 120         static char const request_key[] = "/sbin/request-key";
 121         struct request_key_auth *rka = get_request_key_auth(authkey);
 122         const struct cred *cred = current_cred();
 123         key_serial_t prkey, sskey;
 124         struct key *key = rka->target_key, *keyring, *session, *user_session;
 125         char *argv[9], *envp[3], uid_str[12], gid_str[12];
 126         char key_str[12], keyring_str[3][12];
 127         char desc[20];
 128         int ret, i;
 129
 130         kenter("{%d},{%d},%s", key->serial, authkey->serial, rka->op);
 131
 132         ret = look_up_user_keyrings(NULL, &user_session);
 133         if (ret < 0)
 134                 goto error_us;
 135
 136         /* allocate a new session keyring */
 137         sprintf(desc, "_req.%u", key->serial);
 138
 139         cred = get_current_cred();
 140         keyring = keyring_alloc(desc, cred->fsuid, cred->fsgid, cred,
 141                                 KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ,
 142                                 KEY_ALLOC_QUOTA_OVERRUN, NULL, NULL);
 143         put_cred(cred);
 144         if (IS_ERR(keyring)) {
 145                 ret = PTR_ERR(keyring);
 146                 goto error_alloc;
 147         }
 148
 149         /* attach the auth key to the session keyring */
 150         ret = key_link(keyring, authkey);
 151         if (ret < 0)
 152                 goto error_link;
 153
 154         /* record the UID and GID */
 155         sprintf(uid_str, "%d", from_kuid(&init_user_ns, cred->fsuid));
 156         sprintf(gid_str, "%d", from_kgid(&init_user_ns, cred->fsgid));
 157
 158         /* we say which key is under construction */
 159         sprintf(key_str, "%d", key->serial);
 160
 161         /* we specify the process's default keyrings */
 162         sprintf(keyring_str[0], "%d",
 163                 cred->thread_keyring ? cred->thread_keyring->serial : 0);
 164
 165         prkey = 0;
 166         if (cred->process_keyring)
 167                 prkey = cred->process_keyring->serial;
 168         sprintf(keyring_str[1], "%d", prkey);
 169
 170         session = cred->session_keyring;
 171         if (!session)
 172                 session = user_session;
 173         sskey = session->serial;
 174
 175         sprintf(keyring_str[2], "%d", sskey);
 176
 177         /* set up a minimal environment */
 178         i = 0;
 179         envp[i++] = "HOME=/";
 180         envp[i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
 181         envp[i] = NULL;
 182
 183         /* set up the argument list */
 184         i = 0;
 185         argv[i++] = (char *)request_key;
 186         argv[i++] = (char *)rka->op;
 187         argv[i++] = key_str;
 188         argv[i++] = uid_str;
 189         argv[i++] = gid_str;
 190         argv[i++] = keyring_str[0];
 191         argv[i++] = keyring_str[1];
 192         argv[i++] = keyring_str[2];
 193         argv[i] = NULL;
 194
 195         /* do it */
 196         ret = call_usermodehelper_keys(request_key, argv, envp, keyring,
 197                                        UMH_WAIT_PROC);
 198         kdebug("usermode -> 0x%x", ret);
 199         if (ret >= 0) {
 200                 /* ret is the exit/wait code */
 201                 if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags) ||
 202                     key_validate(key) < 0)
 203                         ret = -ENOKEY;
 204                 else
 205                         /* ignore any errors from userspace if the key was
 206                          * instantiated */
 207                         ret = 0;
 208         }
 209
 210 error_link:
 211         key_put(keyring);
 212
 213 error_alloc:
 214         key_put(user_session);
 215 error_us:
 216         complete_request_key(authkey, ret);
 217         kleave(" = %d", ret);
 218         return ret;
 219 }
 220
 221 /*
 222  * Call out to userspace for key construction.
 223  *
 224  * Program failure is ignored in favour of key status.
 225  */
 226 static int construct_key(struct key *key, const void *callout_info,
 227                          size_t callout_len, void *aux,
 228                          struct key *dest_keyring)
 229 {
 230         request_key_actor_t actor;
 231         struct key *authkey;
 232         int ret;
 233
 234         kenter("%d,%p,%zu,%p", key->serial, callout_info, callout_len, aux);
 235
 236         /* allocate an authorisation key */
 237         authkey = request_key_auth_new(key, "create", callout_info, callout_len,
 238                                        dest_keyring);
 239         if (IS_ERR(authkey))
 240                 return PTR_ERR(authkey);
 241
 242         /* Make the call */
 243         actor = call_sbin_request_key;
 244         if (key->type->request_key)
 245                 actor = key->type->request_key;
 246
 247         ret = actor(authkey, aux);
 248
 249         /* check that the actor called complete_request_key() prior to
 250          * returning an error */
 251         WARN_ON(ret < 0 &&
 252                 !test_bit(KEY_FLAG_INVALIDATED, &authkey->flags));
 253
 254         key_put(authkey);
 255         kleave(" = %d", ret);
 256         return ret;
 257 }
 258
 259 /*
 260  * Get the appropriate destination keyring for the request.
 261  *
 262  * The keyring selected is returned with an extra reference upon it which the
 263  * caller must release.
 264  */
 265 static int construct_get_dest_keyring(struct key **_dest_keyring)
 266 {
 267         struct request_key_auth *rka;
 268         const struct cred *cred = current_cred();
 269         struct key *dest_keyring = *_dest_keyring, *authkey;
 270         int ret;
 271
 272         kenter("%p", dest_keyring);
 273
 274         /* find the appropriate keyring */
 275         if (dest_keyring) {
 276                 /* the caller supplied one */
 277                 key_get(dest_keyring);
 278         } else {
 279                 bool do_perm_check = true;
 280
 281                 /* use a default keyring; falling through the cases until we
 282                  * find one that we actually have */
 283                 switch (cred->jit_keyring) {
 284                 case KEY_REQKEY_DEFL_DEFAULT:
 285                 case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
 286                         if (cred->request_key_auth) {
 287                                 authkey = cred->request_key_auth;
 288                                 down_read(&authkey->sem);
 289                                 rka = get_request_key_auth(authkey);
 290                                 if (!test_bit(KEY_FLAG_REVOKED,
 291                                               &authkey->flags))
 292                                         dest_keyring =
 293                                                 key_get(rka->dest_keyring);
 294                                 up_read(&authkey->sem);
 295                                 if (dest_keyring) {
 296                                         do_perm_check = false;
 297                                         break;
 298                                 }
 299                         }
 300
 301                         /* fall through */
 302                 case KEY_REQKEY_DEFL_THREAD_KEYRING:
 303                         dest_keyring = key_get(cred->thread_keyring);
 304                         if (dest_keyring)
 305                                 break;
 306
 307                         /* fall through */
 308                 case KEY_REQKEY_DEFL_PROCESS_KEYRING:
 309                         dest_keyring = key_get(cred->process_keyring);
 310                         if (dest_keyring)
 311                                 break;
 312
 313                         /* fall through */
 314                 case KEY_REQKEY_DEFL_SESSION_KEYRING:
 315                         dest_keyring = key_get(cred->session_keyring);
 316
 317                         if (dest_keyring)
 318                                 break;
 319
 320                         /* fall through */
 321                 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
 322                         ret = look_up_user_keyrings(NULL, &dest_keyring);
 323                         if (ret < 0)
 324                                 return ret;
 325                         break;
 326
 327                 case KEY_REQKEY_DEFL_USER_KEYRING:
 328                         ret = look_up_user_keyrings(&dest_keyring, NULL);
 329                         if (ret < 0)
 330                                 return ret;
 331                         break;
 332
 333                 case KEY_REQKEY_DEFL_GROUP_KEYRING:
 334                 default:
 335                         BUG();
 336                 }
 337
 338                 /*
 339                  * Require Write permission on the keyring.  This is essential
 340                  * because the default keyring may be the session keyring, and
 341                  * joining a keyring only requires Search permission.
 342                  *
 343                  * However, this check is skipped for the "requestor keyring" so
 344                  * that /sbin/request-key can itself use request_key() to add
 345                  * keys to the original requestor's destination keyring.
 346                  */
 347                 if (dest_keyring && do_perm_check) {
 348                         ret = key_permission(make_key_ref(dest_keyring, 1),
 349                                              KEY_NEED_WRITE);
 350                         if (ret) {
 351                                 key_put(dest_keyring);
 352                                 return ret;
 353                         }
 354                 }
 355         }
 356
 357         *_dest_keyring = dest_keyring;
 358         kleave(" [dk %d]", key_serial(dest_keyring));
 359         return 0;
 360 }
 361
 362 /*
 363  * Allocate a new key in under-construction state and attempt to link it in to
 364  * the requested keyring.
 365  *
 366  * May return a key that's already under construction instead if there was a
 367  * race between two thread calling request_key().
 368  */
 369 static int construct_alloc_key(struct keyring_search_context *ctx,
 370                                struct key *dest_keyring,
 371                                unsigned long flags,
 372                                struct key_user *user,
 373                                struct key **_key)
 374 {
 375         struct assoc_array_edit *edit = NULL;
 376         struct key *key;
 377         key_perm_t perm;
 378         key_ref_t key_ref;
 379         int ret;
 380
 381         kenter("%s,%s,,,",
 382                ctx->index_key.type->name, ctx->index_key.description);
 383
 384         *_key = NULL;
 385         mutex_lock(&user->cons_lock);
 386
 387         perm = KEY_POS_VIEW | KEY_POS_SEARCH | KEY_POS_LINK | KEY_POS_SETATTR;
 388         perm |= KEY_USR_VIEW;
 389         if (ctx->index_key.type->read)
 390                 perm |= KEY_POS_READ;
 391         if (ctx->index_key.type == &key_type_keyring ||
 392             ctx->index_key.type->update)
 393                 perm |= KEY_POS_WRITE;
 394
 395         key = key_alloc(ctx->index_key.type, ctx->index_key.description,
 396                         ctx->cred->fsuid, ctx->cred->fsgid, ctx->cred,
 397                         perm, flags, NULL);
 398         if (IS_ERR(key))
 399                 goto alloc_failed;
 400
 401         set_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags);
 402
 403         if (dest_keyring) {
 404                 ret = __key_link_lock(dest_keyring, &ctx->index_key);
 405                 if (ret < 0)
 406                         goto link_lock_failed;
 407                 ret = __key_link_begin(dest_keyring, &ctx->index_key, &edit);
 408                 if (ret < 0)
 409                         goto link_prealloc_failed;
 410         }
 411
 412         /* attach the key to the destination keyring under lock, but we do need
 413          * to do another check just in case someone beat us to it whilst we
 414          * waited for locks */
 415         mutex_lock(&key_construction_mutex);
 416
 417         rcu_read_lock();
 418         key_ref = search_process_keyrings_rcu(ctx);
 419         rcu_read_unlock();
 420         if (!IS_ERR(key_ref))
 421                 goto key_already_present;
 422
 423         if (dest_keyring)
 424                 __key_link(key, &edit);
 425
 426         mutex_unlock(&key_construction_mutex);
 427         if (dest_keyring)
 428                 __key_link_end(dest_keyring, &ctx->index_key, edit);
 429         mutex_unlock(&user->cons_lock);
 430         *_key = key;
 431         kleave(" = 0 [%d]", key_serial(key));
 432         return 0;
 433
 434         /* the key is now present - we tell the caller that we found it by
 435          * returning -EINPROGRESS  */
 436 key_already_present:
 437         key_put(key);
 438         mutex_unlock(&key_construction_mutex);
 439         key = key_ref_to_ptr(key_ref);
 440         if (dest_keyring) {
 441                 ret = __key_link_check_live_key(dest_keyring, key);
 442                 if (ret == 0)
 443                         __key_link(key, &edit);
 444                 __key_link_end(dest_keyring, &ctx->index_key, edit);
 445                 if (ret < 0)
 446                         goto link_check_failed;
 447         }
 448         mutex_unlock(&user->cons_lock);
 449         *_key = key;
 450         kleave(" = -EINPROGRESS [%d]", key_serial(key));
 451         return -EINPROGRESS;
 452
 453 link_check_failed:
 454         mutex_unlock(&user->cons_lock);
 455         key_put(key);
 456         kleave(" = %d [linkcheck]", ret);
 457         return ret;
 458
 459 link_prealloc_failed:
 460         __key_link_end(dest_keyring, &ctx->index_key, edit);
 461 link_lock_failed:
 462         mutex_unlock(&user->cons_lock);
 463         key_put(key);
 464         kleave(" = %d [prelink]", ret);
 465         return ret;
 466
 467 alloc_failed:
 468         mutex_unlock(&user->cons_lock);
 469         kleave(" = %ld", PTR_ERR(key));
 470         return PTR_ERR(key);
 471 }
 472
 473 /*
 474  * Commence key construction.
 475  */
 476 static struct key *construct_key_and_link(struct keyring_search_context *ctx,
 477                                           const char *callout_info,
 478                                           size_t callout_len,
 479                                           void *aux,
 480                                           struct key *dest_keyring,
 481                                           unsigned long flags)
 482 {
 483         struct key_user *user;
 484         struct key *key;
 485         int ret;
 486
 487         kenter("");
 488
 489         if (ctx->index_key.type == &key_type_keyring)
 490                 return ERR_PTR(-EPERM);
 491
 492         ret = construct_get_dest_keyring(&dest_keyring);
 493         if (ret)
 494                 goto error;
 495
 496         user = key_user_lookup(current_fsuid());
 497         if (!user) {
 498                 ret = -ENOMEM;
 499                 goto error_put_dest_keyring;
 500         }
 501
 502         ret = construct_alloc_key(ctx, dest_keyring, flags, user, &key);
 503         key_user_put(user);
 504
 505         if (ret == 0) {
 506                 ret = construct_key(key, callout_info, callout_len, aux,
 507                                     dest_keyring);
 508                 if (ret < 0) {
 509                         kdebug("cons failed");
 510                         goto construction_failed;
 511                 }
 512         } else if (ret == -EINPROGRESS) {
 513                 ret = 0;
 514         } else {
 515                 goto error_put_dest_keyring;
 516         }
 517
 518         key_put(dest_keyring);
 519         kleave(" = key %d", key_serial(key));
 520         return key;
 521
 522 construction_failed:
 523         key_negate_and_link(key, key_negative_timeout, NULL, NULL);
 524         key_put(key);
 525 error_put_dest_keyring:
 526         key_put(dest_keyring);
 527 error:
 528         kleave(" = %d", ret);
 529         return ERR_PTR(ret);
 530 }
 531
 532 /**
 533  * request_key_and_link - Request a key and cache it in a keyring.
 534  * @type: The type of key we want.
 535  * @description: The searchable description of the key.
 536  * @domain_tag: The domain in which the key operates.
 537  * @callout_info: The data to pass to the instantiation upcall (or NULL).
 538  * @callout_len: The length of callout_info.
 539  * @aux: Auxiliary data for the upcall.
 540  * @dest_keyring: Where to cache the key.
 541  * @flags: Flags to key_alloc().
 542  *
 543  * A key matching the specified criteria (type, description, domain_tag) is
 544  * searched for in the process's keyrings and returned with its usage count
 545  * incremented if found.  Otherwise, if callout_info is not NULL, a key will be
 546  * allocated and some service (probably in userspace) will be asked to
 547  * instantiate it.
 548  *
 549  * If successfully found or created, the key will be linked to the destination
 550  * keyring if one is provided.
 551  *
 552  * Returns a pointer to the key if successful; -EACCES, -ENOKEY, -EKEYREVOKED
 553  * or -EKEYEXPIRED if an inaccessible, negative, revoked or expired key was
 554  * found; -ENOKEY if no key was found and no @callout_info was given; -EDQUOT
 555  * if insufficient key quota was available to create a new key; or -ENOMEM if
 556  * insufficient memory was available.
 557  *
 558  * If the returned key was created, then it may still be under construction,
 559  * and wait_for_key_construction() should be used to wait for that to complete.
 560  */
 561 struct key *request_key_and_link(struct key_type *type,
 562                                  const char *description,
 563                                  struct key_tag *domain_tag,
 564                                  const void *callout_info,
 565                                  size_t callout_len,
 566                                  void *aux,
 567                                  struct key *dest_keyring,
 568                                  unsigned long flags)
 569 {
 570         struct keyring_search_context ctx = {
 571                 .index_key.type         = type,
 572                 .index_key.domain_tag   = domain_tag,
 573                 .index_key.description  = description,
 574                 .index_key.desc_len     = strlen(description),
 575                 .cred                   = current_cred(),
 576                 .match_data.cmp         = key_default_cmp,
 577                 .match_data.raw_data    = description,
 578                 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
 579                 .flags                  = (KEYRING_SEARCH_DO_STATE_CHECK |
 580                                            KEYRING_SEARCH_SKIP_EXPIRED |
 581                                            KEYRING_SEARCH_RECURSE),
 582         };
 583         struct key *key;
 584         key_ref_t key_ref;
 585         int ret;
 586
 587         kenter("%s,%s,%p,%zu,%p,%p,%lx",
 588                ctx.index_key.type->name, ctx.index_key.description,
 589                callout_info, callout_len, aux, dest_keyring, flags);
 590
 591         if (type->match_preparse) {
 592                 ret = type->match_preparse(&ctx.match_data);
 593                 if (ret < 0) {
 594                         key = ERR_PTR(ret);
 595                         goto error;
 596                 }
 597         }
 598
 599         key = check_cached_key(&ctx);
 600         if (key)
 601                 goto error_free;
 602
 603         /* search all the process keyrings for a key */
 604         rcu_read_lock();
 605         key_ref = search_process_keyrings_rcu(&ctx);
 606         rcu_read_unlock();
 607
 608         if (!IS_ERR(key_ref)) {
 609                 if (dest_keyring) {
 610                         ret = key_task_permission(key_ref, current_cred(),
 611                                                   KEY_NEED_LINK);
 612                         if (ret < 0) {
 613                                 key_ref_put(key_ref);
 614                                 key = ERR_PTR(ret);
 615                                 goto error_free;
 616                         }
 617                 }
 618
 619                 key = key_ref_to_ptr(key_ref);
 620                 if (dest_keyring) {
 621                         ret = key_link(dest_keyring, key);
 622                         if (ret < 0) {
 623                                 key_put(key);
 624                                 key = ERR_PTR(ret);
 625                                 goto error_free;
 626                         }
 627                 }
 628
 629                 /* Only cache the key on immediate success */
 630                 cache_requested_key(key);
 631         } else if (PTR_ERR(key_ref) != -EAGAIN) {
 632                 key = ERR_CAST(key_ref);
 633         } else  {
 634                 /* the search failed, but the keyrings were searchable, so we
 635                  * should consult userspace if we can */
 636                 key = ERR_PTR(-ENOKEY);
 637                 if (!callout_info)
 638                         goto error_free;
 639
 640                 key = construct_key_and_link(&ctx, callout_info, callout_len,
 641                                              aux, dest_keyring, flags);
 642         }
 643
 644 error_free:
 645         if (type->match_free)
 646                 type->match_free(&ctx.match_data);
 647 error:
 648         kleave(" = %p", key);
 649         return key;
 650 }
 651
 652 /**
 653  * wait_for_key_construction - Wait for construction of a key to complete
 654  * @key: The key being waited for.
 655  * @intr: Whether to wait interruptibly.
 656  *
 657  * Wait for a key to finish being constructed.
 658  *
 659  * Returns 0 if successful; -ERESTARTSYS if the wait was interrupted; -ENOKEY
 660  * if the key was negated; or -EKEYREVOKED or -EKEYEXPIRED if the key was
 661  * revoked or expired.
 662  */
 663 int wait_for_key_construction(struct key *key, bool intr)
 664 {
 665         int ret;
 666
 667         ret = wait_on_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT,
 668                           intr ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE);
 669         if (ret)
 670                 return -ERESTARTSYS;
 671         ret = key_read_state(key);
 672         if (ret < 0)
 673                 return ret;
 674         return key_validate(key);
 675 }
 676 EXPORT_SYMBOL(wait_for_key_construction);
 677
 678 /**
 679  * request_key_tag - Request a key and wait for construction
 680  * @type: Type of key.
 681  * @description: The searchable description of the key.
 682  * @domain_tag: The domain in which the key operates.
 683  * @callout_info: The data to pass to the instantiation upcall (or NULL).
 684  *
 685  * As for request_key_and_link() except that it does not add the returned key
 686  * to a keyring if found, new keys are always allocated in the user's quota,
 687  * the callout_info must be a NUL-terminated string and no auxiliary data can
 688  * be passed.
 689  *
 690  * Furthermore, it then works as wait_for_key_construction() to wait for the
 691  * completion of keys undergoing construction with a non-interruptible wait.
 692  */
 693 struct key *request_key_tag(struct key_type *type,
 694                             const char *description,
 695                             struct key_tag *domain_tag,
 696                             const char *callout_info)
 697 {
 698         struct key *key;
 699         size_t callout_len = 0;
 700         int ret;
 701
 702         if (callout_info)
 703                 callout_len = strlen(callout_info);
 704         key = request_key_and_link(type, description, domain_tag,
 705                                    callout_info, callout_len,
 706                                    NULL, NULL, KEY_ALLOC_IN_QUOTA);
 707         if (!IS_ERR(key)) {
 708                 ret = wait_for_key_construction(key, false);
 709                 if (ret < 0) {
 710                         key_put(key);
 711                         return ERR_PTR(ret);
 712                 }
 713         }
 714         return key;
 715 }
 716 EXPORT_SYMBOL(request_key_tag);
 717
 718 /**
 719  * request_key_with_auxdata - Request a key with auxiliary data for the upcaller
 720  * @type: The type of key we want.
 721  * @description: The searchable description of the key.
 722  * @domain_tag: The domain in which the key operates.
 723  * @callout_info: The data to pass to the instantiation upcall (or NULL).
 724  * @callout_len: The length of callout_info.
 725  * @aux: Auxiliary data for the upcall.
 726  *
 727  * As for request_key_and_link() except that it does not add the returned key
 728  * to a keyring if found and new keys are always allocated in the user's quota.
 729  *
 730  * Furthermore, it then works as wait_for_key_construction() to wait for the
 731  * completion of keys undergoing construction with a non-interruptible wait.
 732  */
 733 struct key *request_key_with_auxdata(struct key_type *type,
 734                                      const char *description,
 735                                      struct key_tag *domain_tag,
 736                                      const void *callout_info,
 737                                      size_t callout_len,
 738                                      void *aux)
 739 {
 740         struct key *key;
 741         int ret;
 742
 743         key = request_key_and_link(type, description, domain_tag,
 744                                    callout_info, callout_len,
 745                                    aux, NULL, KEY_ALLOC_IN_QUOTA);
 746         if (!IS_ERR(key)) {
 747                 ret = wait_for_key_construction(key, false);
 748                 if (ret < 0) {
 749                         key_put(key);
 750                         return ERR_PTR(ret);
 751                 }
 752         }
 753         return key;
 754 }
 755 EXPORT_SYMBOL(request_key_with_auxdata);
 756
 757 /**
 758  * request_key_rcu - Request key from RCU-read-locked context
 759  * @type: The type of key we want.
 760  * @description: The name of the key we want.
 761  * @domain_tag: The domain in which the key operates.
 762  *
 763  * Request a key from a context that we may not sleep in (such as RCU-mode
 764  * pathwalk).  Keys under construction are ignored.
 765  *
 766  * Return a pointer to the found key if successful, -ENOKEY if we couldn't find
 767  * a key or some other error if the key found was unsuitable or inaccessible.
 768  */
 769 struct key *request_key_rcu(struct key_type *type,
 770                             const char *description,
 771                             struct key_tag *domain_tag)
 772 {
 773         struct keyring_search_context ctx = {
 774                 .index_key.type         = type,
 775                 .index_key.domain_tag   = domain_tag,
 776                 .index_key.description  = description,
 777                 .index_key.desc_len     = strlen(description),
 778                 .cred                   = current_cred(),
 779                 .match_data.cmp         = key_default_cmp,
 780                 .match_data.raw_data    = description,
 781                 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
 782                 .flags                  = (KEYRING_SEARCH_DO_STATE_CHECK |
 783                                            KEYRING_SEARCH_SKIP_EXPIRED),
 784         };
 785         struct key *key;
 786         key_ref_t key_ref;
 787
 788         kenter("%s,%s", type->name, description);
 789
 790         key = check_cached_key(&ctx);
 791         if (key)
 792                 return key;
 793
 794         /* search all the process keyrings for a key */
 795         key_ref = search_process_keyrings_rcu(&ctx);
 796         if (IS_ERR(key_ref)) {
 797                 key = ERR_CAST(key_ref);
 798                 if (PTR_ERR(key_ref) == -EAGAIN)
 799                         key = ERR_PTR(-ENOKEY);
 800         } else {
 801                 key = key_ref_to_ptr(key_ref);
 802                 cache_requested_key(key);
 803         }
 804
 805         kleave(" = %p", key);
 806         return key;
 807 }
 808 EXPORT_SYMBOL(request_key_rcu);