security/keys/process_keys.c

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