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