security/keys/request_key.c

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