security/keys/process_keys.c

   1 /* Manage a process's keyrings
   2  *
   3  * Copyright (C) 2004-2005, 2008 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
  12 #include <linux/init.h>
  13 #include <linux/sched.h>
  14 #include <linux/sched/user.h>
  15 #include <linux/keyctl.h>
  16 #include <linux/fs.h>
  17 #include <linux/err.h>
  18 #include <linux/mutex.h>
  19 #include <linux/security.h>
  20 #include <linux/user_namespace.h>
  21 #include <linux/uaccess.h>
  22 #include <keys/request_key_auth-type.h>
  23 #include "internal.h"
  24
  25 /* Session keyring create vs join semaphore */
  26 static DEFINE_MUTEX(key_session_mutex);
  27
  28 /* User keyring creation semaphore */
  29 static DEFINE_MUTEX(key_user_keyring_mutex);
  30
  31 /* The root user's tracking struct */
  32 struct key_user root_key_user = {
  33         .usage          = REFCOUNT_INIT(3),
  34         .cons_lock      = __MUTEX_INITIALIZER(root_key_user.cons_lock),
  35         .lock           = __SPIN_LOCK_UNLOCKED(root_key_user.lock),
  36         .nkeys          = ATOMIC_INIT(2),
  37         .nikeys         = ATOMIC_INIT(2),
  38         .uid            = GLOBAL_ROOT_UID,
  39 };
  40
  41 /*
  42  * Install the user and user session keyrings for the current process's UID.
  43  */
  44 int install_user_keyrings(void)
  45 {
  46         struct user_struct *user;
  47         const struct cred *cred;
  48         struct key *uid_keyring, *session_keyring;
  49         key_perm_t user_keyring_perm;
  50         char buf[20];
  51         int ret;
  52         uid_t uid;
  53
  54         user_keyring_perm = (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL;
  55         cred = current_cred();
  56         user = cred->user;
  57         uid = from_kuid(cred->user_ns, user->uid);
  58
  59         kenter("%p{%u}", user, uid);
  60
  61         if (READ_ONCE(user->uid_keyring) && READ_ONCE(user->session_keyring)) {
  62                 kleave(" = 0 [exist]");
  63                 return 0;
  64         }
  65
  66         mutex_lock(&key_user_keyring_mutex);
  67         ret = 0;
  68
  69         if (!user->uid_keyring) {
  70                 /* get the UID-specific keyring
  71                  * - there may be one in existence already as it may have been
  72                  *   pinned by a session, but the user_struct pointing to it
  73                  *   may have been destroyed by setuid */
  74                 sprintf(buf, "_uid.%u", uid);
  75
  76                 uid_keyring = find_keyring_by_name(buf, true);
  77                 if (IS_ERR(uid_keyring)) {
  78                         uid_keyring = keyring_alloc(buf, user->uid, INVALID_GID,
  79                                                     cred, user_keyring_perm,
  80                                                     KEY_ALLOC_UID_KEYRING |
  81                                                         KEY_ALLOC_IN_QUOTA,
  82                                                     NULL, NULL);
  83                         if (IS_ERR(uid_keyring)) {
  84                                 ret = PTR_ERR(uid_keyring);
  85                                 goto error;
  86                         }
  87                 }
  88
  89                 /* get a default session keyring (which might also exist
  90                  * already) */
  91                 sprintf(buf, "_uid_ses.%u", uid);
  92
  93                 session_keyring = find_keyring_by_name(buf, true);
  94                 if (IS_ERR(session_keyring)) {
  95                         session_keyring =
  96                                 keyring_alloc(buf, user->uid, INVALID_GID,
  97                                               cred, user_keyring_perm,
  98                                               KEY_ALLOC_UID_KEYRING |
  99                                                   KEY_ALLOC_IN_QUOTA,
 100                                               NULL, NULL);
 101                         if (IS_ERR(session_keyring)) {
 102                                 ret = PTR_ERR(session_keyring);
 103                                 goto error_release;
 104                         }
 105
 106                         /* we install a link from the user session keyring to
 107                          * the user keyring */
 108                         ret = key_link(session_keyring, uid_keyring);
 109                         if (ret < 0)
 110                                 goto error_release_both;
 111                 }
 112
 113                 /* install the keyrings */
 114                 /* paired with READ_ONCE() */
 115                 smp_store_release(&user->uid_keyring, uid_keyring);
 116                 /* paired with READ_ONCE() */
 117                 smp_store_release(&user->session_keyring, session_keyring);
 118         }
 119
 120         mutex_unlock(&key_user_keyring_mutex);
 121         kleave(" = 0");
 122         return 0;
 123
 124 error_release_both:
 125         key_put(session_keyring);
 126 error_release:
 127         key_put(uid_keyring);
 128 error:
 129         mutex_unlock(&key_user_keyring_mutex);
 130         kleave(" = %d", ret);
 131         return ret;
 132 }
 133
 134 /*
 135  * Install a thread keyring to the given credentials struct if it didn't have
 136  * one already.  This is allowed to overrun the quota.
 137  *
 138  * Return: 0 if a thread keyring is now present; -errno on failure.
 139  */
 140 int install_thread_keyring_to_cred(struct cred *new)
 141 {
 142         struct key *keyring;
 143
 144         if (new->thread_keyring)
 145                 return 0;
 146
 147         keyring = keyring_alloc("_tid", new->uid, new->gid, new,
 148                                 KEY_POS_ALL | KEY_USR_VIEW,
 149                                 KEY_ALLOC_QUOTA_OVERRUN,
 150                                 NULL, NULL);
 151         if (IS_ERR(keyring))
 152                 return PTR_ERR(keyring);
 153
 154         new->thread_keyring = keyring;
 155         return 0;
 156 }
 157
 158 /*
 159  * Install a thread keyring to the current task if it didn't have one already.
 160  *
 161  * Return: 0 if a thread keyring is now present; -errno on failure.
 162  */
 163 static int install_thread_keyring(void)
 164 {
 165         struct cred *new;
 166         int ret;
 167
 168         new = prepare_creds();
 169         if (!new)
 170                 return -ENOMEM;
 171
 172         ret = install_thread_keyring_to_cred(new);
 173         if (ret < 0) {
 174                 abort_creds(new);
 175                 return ret;
 176         }
 177
 178         return commit_creds(new);
 179 }
 180
 181 /*
 182  * Install a process keyring to the given credentials struct if it didn't have
 183  * one already.  This is allowed to overrun the quota.
 184  *
 185  * Return: 0 if a process keyring is now present; -errno on failure.
 186  */
 187 int install_process_keyring_to_cred(struct cred *new)
 188 {
 189         struct key *keyring;
 190
 191         if (new->process_keyring)
 192                 return 0;
 193
 194         keyring = keyring_alloc("_pid", new->uid, new->gid, new,
 195                                 KEY_POS_ALL | KEY_USR_VIEW,
 196                                 KEY_ALLOC_QUOTA_OVERRUN,
 197                                 NULL, NULL);
 198         if (IS_ERR(keyring))
 199                 return PTR_ERR(keyring);
 200
 201         new->process_keyring = keyring;
 202         return 0;
 203 }
 204
 205 /*
 206  * Install a process keyring to the current task if it didn't have one already.
 207  *
 208  * Return: 0 if a process keyring is now present; -errno on failure.
 209  */
 210 static int install_process_keyring(void)
 211 {
 212         struct cred *new;
 213         int ret;
 214
 215         new = prepare_creds();
 216         if (!new)
 217                 return -ENOMEM;
 218
 219         ret = install_process_keyring_to_cred(new);
 220         if (ret < 0) {
 221                 abort_creds(new);
 222                 return ret;
 223         }
 224
 225         return commit_creds(new);
 226 }
 227
 228 /*
 229  * Install the given keyring as the session keyring of the given credentials
 230  * struct, replacing the existing one if any.  If the given keyring is NULL,
 231  * then install a new anonymous session keyring.
 232  * @cred can not be in use by any task yet.
 233  *
 234  * Return: 0 on success; -errno on failure.
 235  */
 236 int install_session_keyring_to_cred(struct cred *cred, struct key *keyring)
 237 {
 238         unsigned long flags;
 239         struct key *old;
 240
 241         might_sleep();
 242
 243         /* create an empty session keyring */
 244         if (!keyring) {
 245                 flags = KEY_ALLOC_QUOTA_OVERRUN;
 246                 if (cred->session_keyring)
 247                         flags = KEY_ALLOC_IN_QUOTA;
 248
 249                 keyring = keyring_alloc("_ses", cred->uid, cred->gid, cred,
 250                                         KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ,
 251                                         flags, NULL, NULL);
 252                 if (IS_ERR(keyring))
 253                         return PTR_ERR(keyring);
 254         } else {
 255                 __key_get(keyring);
 256         }
 257
 258         /* install the keyring */
 259         old = cred->session_keyring;
 260         cred->session_keyring = keyring;
 261
 262         if (old)
 263                 key_put(old);
 264
 265         return 0;
 266 }
 267
 268 /*
 269  * Install the given keyring as the session keyring of the current task,
 270  * replacing the existing one if any.  If the given keyring is NULL, then
 271  * install a new anonymous session keyring.
 272  *
 273  * Return: 0 on success; -errno on failure.
 274  */
 275 static int install_session_keyring(struct key *keyring)
 276 {
 277         struct cred *new;
 278         int ret;
 279
 280         new = prepare_creds();
 281         if (!new)
 282                 return -ENOMEM;
 283
 284         ret = install_session_keyring_to_cred(new, keyring);
 285         if (ret < 0) {
 286                 abort_creds(new);
 287                 return ret;
 288         }
 289
 290         return commit_creds(new);
 291 }
 292
 293 /*
 294  * Handle the fsuid changing.
 295  */
 296 void key_fsuid_changed(struct task_struct *tsk)
 297 {
 298         /* update the ownership of the thread keyring */
 299         BUG_ON(!tsk->cred);
 300         if (tsk->cred->thread_keyring) {
 301                 down_write(&tsk->cred->thread_keyring->sem);
 302                 tsk->cred->thread_keyring->uid = tsk->cred->fsuid;
 303                 up_write(&tsk->cred->thread_keyring->sem);
 304         }
 305 }
 306
 307 /*
 308  * Handle the fsgid changing.
 309  */
 310 void key_fsgid_changed(struct task_struct *tsk)
 311 {
 312         /* update the ownership of the thread keyring */
 313         BUG_ON(!tsk->cred);
 314         if (tsk->cred->thread_keyring) {
 315                 down_write(&tsk->cred->thread_keyring->sem);
 316                 tsk->cred->thread_keyring->gid = tsk->cred->fsgid;
 317                 up_write(&tsk->cred->thread_keyring->sem);
 318         }
 319 }
 320
 321 /*
 322  * Search the process keyrings attached to the supplied cred for the first
 323  * matching key.
 324  *
 325  * The search criteria are the type and the match function.  The description is
 326  * given to the match function as a parameter, but doesn't otherwise influence
 327  * the search.  Typically the match function will compare the description
 328  * parameter to the key's description.
 329  *
 330  * This can only search keyrings that grant Search permission to the supplied
 331  * credentials.  Keyrings linked to searched keyrings will also be searched if
 332  * they grant Search permission too.  Keys can only be found if they grant
 333  * Search permission to the credentials.
 334  *
 335  * Returns a pointer to the key with the key usage count incremented if
 336  * successful, -EAGAIN if we didn't find any matching key or -ENOKEY if we only
 337  * matched negative keys.
 338  *
 339  * In the case of a successful return, the possession attribute is set on the
 340  * returned key reference.
 341  */
 342 key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx)
 343 {
 344         key_ref_t key_ref, ret, err;
 345         const struct cred *cred = ctx->cred;
 346
 347         /* we want to return -EAGAIN or -ENOKEY if any of the keyrings were
 348          * searchable, but we failed to find a key or we found a negative key;
 349          * otherwise we want to return a sample error (probably -EACCES) if
 350          * none of the keyrings were searchable
 351          *
 352          * in terms of priority: success > -ENOKEY > -EAGAIN > other error
 353          */
 354         key_ref = NULL;
 355         ret = NULL;
 356         err = ERR_PTR(-EAGAIN);
 357
 358         /* search the thread keyring first */
 359         if (cred->thread_keyring) {
 360                 key_ref = keyring_search_aux(
 361                         make_key_ref(cred->thread_keyring, 1), ctx);
 362                 if (!IS_ERR(key_ref))
 363                         goto found;
 364
 365                 switch (PTR_ERR(key_ref)) {
 366                 case -EAGAIN: /* no key */
 367                 case -ENOKEY: /* negative key */
 368                         ret = key_ref;
 369                         break;
 370                 default:
 371                         err = key_ref;
 372                         break;
 373                 }
 374         }
 375
 376         /* search the process keyring second */
 377         if (cred->process_keyring) {
 378                 key_ref = keyring_search_aux(
 379                         make_key_ref(cred->process_keyring, 1), ctx);
 380                 if (!IS_ERR(key_ref))
 381                         goto found;
 382
 383                 switch (PTR_ERR(key_ref)) {
 384                 case -EAGAIN: /* no key */
 385                         if (ret)
 386                                 break;
 387                         /* fall through */
 388                 case -ENOKEY: /* negative key */
 389                         ret = key_ref;
 390                         break;
 391                 default:
 392                         err = key_ref;
 393                         break;
 394                 }
 395         }
 396
 397         /* search the session keyring */
 398         if (cred->session_keyring) {
 399                 key_ref = keyring_search_aux(
 400                         make_key_ref(cred->session_keyring, 1), ctx);
 401
 402                 if (!IS_ERR(key_ref))
 403                         goto found;
 404
 405                 switch (PTR_ERR(key_ref)) {
 406                 case -EAGAIN: /* no key */
 407                         if (ret)
 408                                 break;
 409                         /* fall through */
 410                 case -ENOKEY: /* negative key */
 411                         ret = key_ref;
 412                         break;
 413                 default:
 414                         err = key_ref;
 415                         break;
 416                 }
 417         }
 418         /* or search the user-session keyring */
 419         else if (READ_ONCE(cred->user->session_keyring)) {
 420                 key_ref = keyring_search_aux(
 421                         make_key_ref(READ_ONCE(cred->user->session_keyring), 1),
 422                         ctx);
 423                 if (!IS_ERR(key_ref))
 424                         goto found;
 425
 426                 switch (PTR_ERR(key_ref)) {
 427                 case -EAGAIN: /* no key */
 428                         if (ret)
 429                                 break;
 430                         /* fall through */
 431                 case -ENOKEY: /* negative key */
 432                         ret = key_ref;
 433                         break;
 434                 default:
 435                         err = key_ref;
 436                         break;
 437                 }
 438         }
 439
 440         /* no key - decide on the error we're going to go for */
 441         key_ref = ret ? ret : err;
 442
 443 found:
 444         return key_ref;
 445 }
 446
 447 /*
 448  * Search the process keyrings attached to the supplied cred for the first
 449  * matching key in the manner of search_my_process_keyrings(), but also search
 450  * the keys attached to the assumed authorisation key using its credentials if
 451  * one is available.
 452  *
 453  * Return same as search_my_process_keyrings().
 454  */
 455 key_ref_t search_process_keyrings(struct keyring_search_context *ctx)
 456 {
 457         struct request_key_auth *rka;
 458         key_ref_t key_ref, ret = ERR_PTR(-EACCES), err;
 459
 460         might_sleep();
 461
 462         key_ref = search_my_process_keyrings(ctx);
 463         if (!IS_ERR(key_ref))
 464                 goto found;
 465         err = key_ref;
 466
 467         /* if this process has an instantiation authorisation key, then we also
 468          * search the keyrings of the process mentioned there
 469          * - we don't permit access to request_key auth keys via this method
 470          */
 471         if (ctx->cred->request_key_auth &&
 472             ctx->cred == current_cred() &&
 473             ctx->index_key.type != &key_type_request_key_auth
 474             ) {
 475                 const struct cred *cred = ctx->cred;
 476
 477                 /* defend against the auth key being revoked */
 478                 down_read(&cred->request_key_auth->sem);
 479
 480                 if (key_validate(ctx->cred->request_key_auth) == 0) {
 481                         rka = ctx->cred->request_key_auth->payload.data[0];
 482
 483                         ctx->cred = rka->cred;
 484                         key_ref = search_process_keyrings(ctx);
 485                         ctx->cred = cred;
 486
 487                         up_read(&cred->request_key_auth->sem);
 488
 489                         if (!IS_ERR(key_ref))
 490                                 goto found;
 491
 492                         ret = key_ref;
 493                 } else {
 494                         up_read(&cred->request_key_auth->sem);
 495                 }
 496         }
 497
 498         /* no key - decide on the error we're going to go for */
 499         if (err == ERR_PTR(-ENOKEY) || ret == ERR_PTR(-ENOKEY))
 500                 key_ref = ERR_PTR(-ENOKEY);
 501         else if (err == ERR_PTR(-EACCES))
 502                 key_ref = ret;
 503         else
 504                 key_ref = err;
 505
 506 found:
 507         return key_ref;
 508 }
 509
 510 /*
 511  * See if the key we're looking at is the target key.
 512  */
 513 bool lookup_user_key_possessed(const struct key *key,
 514                                const struct key_match_data *match_data)
 515 {
 516         return key == match_data->raw_data;
 517 }
 518
 519 /*
 520  * Look up a key ID given us by userspace with a given permissions mask to get
 521  * the key it refers to.
 522  *
 523  * Flags can be passed to request that special keyrings be created if referred
 524  * to directly, to permit partially constructed keys to be found and to skip
 525  * validity and permission checks on the found key.
 526  *
 527  * Returns a pointer to the key with an incremented usage count if successful;
 528  * -EINVAL if the key ID is invalid; -ENOKEY if the key ID does not correspond
 529  * to a key or the best found key was a negative key; -EKEYREVOKED or
 530  * -EKEYEXPIRED if the best found key was revoked or expired; -EACCES if the
 531  * found key doesn't grant the requested permit or the LSM denied access to it;
 532  * or -ENOMEM if a special keyring couldn't be created.
 533  *
 534  * In the case of a successful return, the possession attribute is set on the
 535  * returned key reference.
 536  */
 537 key_ref_t lookup_user_key(key_serial_t id, unsigned long lflags,
 538                           key_perm_t perm)
 539 {
 540         struct keyring_search_context ctx = {
 541                 .match_data.cmp         = lookup_user_key_possessed,
 542                 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
 543                 .flags                  = KEYRING_SEARCH_NO_STATE_CHECK,
 544         };
 545         struct request_key_auth *rka;
 546         struct key *key;
 547         key_ref_t key_ref, skey_ref;
 548         int ret;
 549
 550 try_again:
 551         ctx.cred = get_current_cred();
 552         key_ref = ERR_PTR(-ENOKEY);
 553
 554         switch (id) {
 555         case KEY_SPEC_THREAD_KEYRING:
 556                 if (!ctx.cred->thread_keyring) {
 557                         if (!(lflags & KEY_LOOKUP_CREATE))
 558                                 goto error;
 559
 560                         ret = install_thread_keyring();
 561                         if (ret < 0) {
 562                                 key_ref = ERR_PTR(ret);
 563                                 goto error;
 564                         }
 565                         goto reget_creds;
 566                 }
 567
 568                 key = ctx.cred->thread_keyring;
 569                 __key_get(key);
 570                 key_ref = make_key_ref(key, 1);
 571                 break;
 572
 573         case KEY_SPEC_PROCESS_KEYRING:
 574                 if (!ctx.cred->process_keyring) {
 575                         if (!(lflags & KEY_LOOKUP_CREATE))
 576                                 goto error;
 577
 578                         ret = install_process_keyring();
 579                         if (ret < 0) {
 580                                 key_ref = ERR_PTR(ret);
 581                                 goto error;
 582                         }
 583                         goto reget_creds;
 584                 }
 585
 586                 key = ctx.cred->process_keyring;
 587                 __key_get(key);
 588                 key_ref = make_key_ref(key, 1);
 589                 break;
 590
 591         case KEY_SPEC_SESSION_KEYRING:
 592                 if (!ctx.cred->session_keyring) {
 593                         /* always install a session keyring upon access if one
 594                          * doesn't exist yet */
 595                         ret = install_user_keyrings();
 596                         if (ret < 0)
 597                                 goto error;
 598                         if (lflags & KEY_LOOKUP_CREATE)
 599                                 ret = join_session_keyring(NULL);
 600                         else
 601                                 ret = install_session_keyring(
 602                                         ctx.cred->user->session_keyring);
 603
 604                         if (ret < 0)
 605                                 goto error;
 606                         goto reget_creds;
 607                 } else if (ctx.cred->session_keyring ==
 608                            READ_ONCE(ctx.cred->user->session_keyring) &&
 609                            lflags & KEY_LOOKUP_CREATE) {
 610                         ret = join_session_keyring(NULL);
 611                         if (ret < 0)
 612                                 goto error;
 613                         goto reget_creds;
 614                 }
 615
 616                 key = ctx.cred->session_keyring;
 617                 __key_get(key);
 618                 key_ref = make_key_ref(key, 1);
 619                 break;
 620
 621         case KEY_SPEC_USER_KEYRING:
 622                 if (!READ_ONCE(ctx.cred->user->uid_keyring)) {
 623                         ret = install_user_keyrings();
 624                         if (ret < 0)
 625                                 goto error;
 626                 }
 627
 628                 key = ctx.cred->user->uid_keyring;
 629                 __key_get(key);
 630                 key_ref = make_key_ref(key, 1);
 631                 break;
 632
 633         case KEY_SPEC_USER_SESSION_KEYRING:
 634                 if (!READ_ONCE(ctx.cred->user->session_keyring)) {
 635                         ret = install_user_keyrings();
 636                         if (ret < 0)
 637                                 goto error;
 638                 }
 639
 640                 key = ctx.cred->user->session_keyring;
 641                 __key_get(key);
 642                 key_ref = make_key_ref(key, 1);
 643                 break;
 644
 645         case KEY_SPEC_GROUP_KEYRING:
 646                 /* group keyrings are not yet supported */
 647                 key_ref = ERR_PTR(-EINVAL);
 648                 goto error;
 649
 650         case KEY_SPEC_REQKEY_AUTH_KEY:
 651                 key = ctx.cred->request_key_auth;
 652                 if (!key)
 653                         goto error;
 654
 655                 __key_get(key);
 656                 key_ref = make_key_ref(key, 1);
 657                 break;
 658
 659         case KEY_SPEC_REQUESTOR_KEYRING:
 660                 if (!ctx.cred->request_key_auth)
 661                         goto error;
 662
 663                 down_read(&ctx.cred->request_key_auth->sem);
 664                 if (test_bit(KEY_FLAG_REVOKED,
 665                              &ctx.cred->request_key_auth->flags)) {
 666                         key_ref = ERR_PTR(-EKEYREVOKED);
 667                         key = NULL;
 668                 } else {
 669                         rka = ctx.cred->request_key_auth->payload.data[0];
 670                         key = rka->dest_keyring;
 671                         __key_get(key);
 672                 }
 673                 up_read(&ctx.cred->request_key_auth->sem);
 674                 if (!key)
 675                         goto error;
 676                 key_ref = make_key_ref(key, 1);
 677                 break;
 678
 679         default:
 680                 key_ref = ERR_PTR(-EINVAL);
 681                 if (id < 1)
 682                         goto error;
 683
 684                 key = key_lookup(id);
 685                 if (IS_ERR(key)) {
 686                         key_ref = ERR_CAST(key);
 687                         goto error;
 688                 }
 689
 690                 key_ref = make_key_ref(key, 0);
 691
 692                 /* check to see if we possess the key */
 693                 ctx.index_key.type              = key->type;
 694                 ctx.index_key.description       = key->description;
 695                 ctx.index_key.desc_len          = strlen(key->description);
 696                 ctx.match_data.raw_data         = key;
 697                 kdebug("check possessed");
 698                 skey_ref = search_process_keyrings(&ctx);
 699                 kdebug("possessed=%p", skey_ref);
 700
 701                 if (!IS_ERR(skey_ref)) {
 702                         key_put(key);
 703                         key_ref = skey_ref;
 704                 }
 705
 706                 break;
 707         }
 708
 709         /* unlink does not use the nominated key in any way, so can skip all
 710          * the permission checks as it is only concerned with the keyring */
 711         if (lflags & KEY_LOOKUP_FOR_UNLINK) {
 712                 ret = 0;
 713                 goto error;
 714         }
 715
 716         if (!(lflags & KEY_LOOKUP_PARTIAL)) {
 717                 ret = wait_for_key_construction(key, true);
 718                 switch (ret) {
 719                 case -ERESTARTSYS:
 720                         goto invalid_key;
 721                 default:
 722                         if (perm)
 723                                 goto invalid_key;
 724                 case 0:
 725                         break;
 726                 }
 727         } else if (perm) {
 728                 ret = key_validate(key);
 729                 if (ret < 0)
 730                         goto invalid_key;
 731         }
 732
 733         ret = -EIO;
 734         if (!(lflags & KEY_LOOKUP_PARTIAL) &&
 735             key_read_state(key) == KEY_IS_UNINSTANTIATED)
 736                 goto invalid_key;
 737
 738         /* check the permissions */
 739         ret = key_task_permission(key_ref, ctx.cred, perm);
 740         if (ret < 0)
 741                 goto invalid_key;
 742
 743         key->last_used_at = ktime_get_real_seconds();
 744
 745 error:
 746         put_cred(ctx.cred);
 747         return key_ref;
 748
 749 invalid_key:
 750         key_ref_put(key_ref);
 751         key_ref = ERR_PTR(ret);
 752         goto error;
 753
 754         /* if we attempted to install a keyring, then it may have caused new
 755          * creds to be installed */
 756 reget_creds:
 757         put_cred(ctx.cred);
 758         goto try_again;
 759 }
 760 EXPORT_SYMBOL(lookup_user_key);
 761
 762 /*
 763  * Join the named keyring as the session keyring if possible else attempt to
 764  * create a new one of that name and join that.
 765  *
 766  * If the name is NULL, an empty anonymous keyring will be installed as the
 767  * session keyring.
 768  *
 769  * Named session keyrings are joined with a semaphore held to prevent the
 770  * keyrings from going away whilst the attempt is made to going them and also
 771  * to prevent a race in creating compatible session keyrings.
 772  */
 773 long join_session_keyring(const char *name)
 774 {
 775         const struct cred *old;
 776         struct cred *new;
 777         struct key *keyring;
 778         long ret, serial;
 779
 780         new = prepare_creds();
 781         if (!new)
 782                 return -ENOMEM;
 783         old = current_cred();
 784
 785         /* if no name is provided, install an anonymous keyring */
 786         if (!name) {
 787                 ret = install_session_keyring_to_cred(new, NULL);
 788                 if (ret < 0)
 789                         goto error;
 790
 791                 serial = new->session_keyring->serial;
 792                 ret = commit_creds(new);
 793                 if (ret == 0)
 794                         ret = serial;
 795                 goto okay;
 796         }
 797
 798         /* allow the user to join or create a named keyring */
 799         mutex_lock(&key_session_mutex);
 800
 801         /* look for an existing keyring of this name */
 802         keyring = find_keyring_by_name(name, false);
 803         if (PTR_ERR(keyring) == -ENOKEY) {
 804                 /* not found - try and create a new one */
 805                 keyring = keyring_alloc(
 806                         name, old->uid, old->gid, old,
 807                         KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ | KEY_USR_LINK,
 808                         KEY_ALLOC_IN_QUOTA, NULL, NULL);
 809                 if (IS_ERR(keyring)) {
 810                         ret = PTR_ERR(keyring);
 811                         goto error2;
 812                 }
 813         } else if (IS_ERR(keyring)) {
 814                 ret = PTR_ERR(keyring);
 815                 goto error2;
 816         } else if (keyring == new->session_keyring) {
 817                 ret = 0;
 818                 goto error3;
 819         }
 820
 821         /* we've got a keyring - now to install it */
 822         ret = install_session_keyring_to_cred(new, keyring);
 823         if (ret < 0)
 824                 goto error3;
 825
 826         commit_creds(new);
 827         mutex_unlock(&key_session_mutex);
 828
 829         ret = keyring->serial;
 830         key_put(keyring);
 831 okay:
 832         return ret;
 833
 834 error3:
 835         key_put(keyring);
 836 error2:
 837         mutex_unlock(&key_session_mutex);
 838 error:
 839         abort_creds(new);
 840         return ret;
 841 }
 842
 843 /*
 844  * Replace a process's session keyring on behalf of one of its children when
 845  * the target  process is about to resume userspace execution.
 846  */
 847 void key_change_session_keyring(struct callback_head *twork)
 848 {
 849         const struct cred *old = current_cred();
 850         struct cred *new = container_of(twork, struct cred, rcu);
 851
 852         if (unlikely(current->flags & PF_EXITING)) {
 853                 put_cred(new);
 854                 return;
 855         }
 856
 857         new->  uid      = old->  uid;
 858         new-> euid      = old-> euid;
 859         new-> suid      = old-> suid;
 860         new->fsuid      = old->fsuid;
 861         new->  gid      = old->  gid;
 862         new-> egid      = old-> egid;
 863         new-> sgid      = old-> sgid;
 864         new->fsgid      = old->fsgid;
 865         new->user       = get_uid(old->user);
 866         new->user_ns    = get_user_ns(old->user_ns);
 867         new->group_info = get_group_info(old->group_info);
 868
 869         new->securebits = old->securebits;
 870         new->cap_inheritable    = old->cap_inheritable;
 871         new->cap_permitted      = old->cap_permitted;
 872         new->cap_effective      = old->cap_effective;
 873         new->cap_ambient        = old->cap_ambient;
 874         new->cap_bset           = old->cap_bset;
 875
 876         new->jit_keyring        = old->jit_keyring;
 877         new->thread_keyring     = key_get(old->thread_keyring);
 878         new->process_keyring    = key_get(old->process_keyring);
 879
 880         security_transfer_creds(new, old);
 881
 882         commit_creds(new);
 883 }
 884
 885 /*
 886  * Make sure that root's user and user-session keyrings exist.
 887  */
 888 static int __init init_root_keyring(void)
 889 {
 890         return install_user_keyrings();
 891 }
 892
 893 late_initcall(init_root_keyring);