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