1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Manage a process's keyrings
4 * Copyright (C) 2004-2005, 2008 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/init.h>
9 #include <linux/sched.h>
10 #include <linux/sched/user.h>
11 #include <linux/keyctl.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>
21 /* Session keyring create vs join semaphore */
22 static DEFINE_MUTEX(key_session_mutex);
24 /* User keyring creation semaphore */
25 static DEFINE_MUTEX(key_user_keyring_mutex);
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,
38 * Install the user and user session keyrings for the current process's UID.
40 int install_user_keyrings(void)
42 struct user_struct *user;
43 const struct cred *cred;
44 struct key *uid_keyring, *session_keyring;
45 key_perm_t user_keyring_perm;
50 user_keyring_perm = (KEY_POS_ALL & ~KEY_POS_SETATTR) | KEY_USR_ALL;
51 cred = current_cred();
53 uid = from_kuid(cred->user_ns, user->uid);
55 kenter("%p{%u}", user, uid);
57 if (READ_ONCE(user->uid_keyring) && READ_ONCE(user->session_keyring)) {
58 kleave(" = 0 [exist]");
62 mutex_lock(&key_user_keyring_mutex);
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);
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 |
79 if (IS_ERR(uid_keyring)) {
80 ret = PTR_ERR(uid_keyring);
85 /* get a default session keyring (which might also exist
87 sprintf(buf, "_uid_ses.%u", uid);
89 session_keyring = find_keyring_by_name(buf, true);
90 if (IS_ERR(session_keyring)) {
92 keyring_alloc(buf, user->uid, INVALID_GID,
93 cred, user_keyring_perm,
94 KEY_ALLOC_UID_KEYRING |
97 if (IS_ERR(session_keyring)) {
98 ret = PTR_ERR(session_keyring);
102 /* we install a link from the user session keyring to
103 * the user keyring */
104 ret = key_link(session_keyring, uid_keyring);
106 goto error_release_both;
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);
116 mutex_unlock(&key_user_keyring_mutex);
121 key_put(session_keyring);
123 key_put(uid_keyring);
125 mutex_unlock(&key_user_keyring_mutex);
126 kleave(" = %d", ret);
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.
134 * Return: 0 if a thread keyring is now present; -errno on failure.
136 int install_thread_keyring_to_cred(struct cred *new)
140 if (new->thread_keyring)
143 keyring = keyring_alloc("_tid", new->uid, new->gid, new,
144 KEY_POS_ALL | KEY_USR_VIEW,
145 KEY_ALLOC_QUOTA_OVERRUN,
148 return PTR_ERR(keyring);
150 new->thread_keyring = keyring;
155 * Install a thread keyring to the current task if it didn't have one already.
157 * Return: 0 if a thread keyring is now present; -errno on failure.
159 static int install_thread_keyring(void)
164 new = prepare_creds();
168 ret = install_thread_keyring_to_cred(new);
174 return commit_creds(new);
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.
181 * Return: 0 if a process keyring is now present; -errno on failure.
183 int install_process_keyring_to_cred(struct cred *new)
187 if (new->process_keyring)
190 keyring = keyring_alloc("_pid", new->uid, new->gid, new,
191 KEY_POS_ALL | KEY_USR_VIEW,
192 KEY_ALLOC_QUOTA_OVERRUN,
195 return PTR_ERR(keyring);
197 new->process_keyring = keyring;
202 * Install a process keyring to the current task if it didn't have one already.
204 * Return: 0 if a process keyring is now present; -errno on failure.
206 static int install_process_keyring(void)
211 new = prepare_creds();
215 ret = install_process_keyring_to_cred(new);
221 return commit_creds(new);
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.
230 * Return: 0 on success; -errno on failure.
232 int install_session_keyring_to_cred(struct cred *cred, struct key *keyring)
239 /* create an empty session keyring */
241 flags = KEY_ALLOC_QUOTA_OVERRUN;
242 if (cred->session_keyring)
243 flags = KEY_ALLOC_IN_QUOTA;
245 keyring = keyring_alloc("_ses", cred->uid, cred->gid, cred,
246 KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ,
249 return PTR_ERR(keyring);
254 /* install the keyring */
255 old = cred->session_keyring;
256 cred->session_keyring = keyring;
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.
269 * Return: 0 on success; -errno on failure.
271 static int install_session_keyring(struct key *keyring)
276 new = prepare_creds();
280 ret = install_session_keyring_to_cred(new, keyring);
286 return commit_creds(new);
290 * Handle the fsuid changing.
292 void key_fsuid_changed(struct cred *new_cred)
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);
303 * Handle the fsgid changing.
305 void key_fsgid_changed(struct cred *new_cred)
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);
316 * Search the process keyrings attached to the supplied cred for the first
319 * The search criteria are the type and the match function. The description is
320 * given to the match function as a parameter, but doesn't otherwise influence
321 * the search. Typically the match function will compare the description
322 * parameter to the key's description.
324 * This can only search keyrings that grant Search permission to the supplied
325 * credentials. Keyrings linked to searched keyrings will also be searched if
326 * they grant Search permission too. Keys can only be found if they grant
327 * Search permission to the credentials.
329 * Returns a pointer to the key with the key usage count incremented if
330 * successful, -EAGAIN if we didn't find any matching key or -ENOKEY if we only
331 * matched negative keys.
333 * In the case of a successful return, the possession attribute is set on the
334 * returned key reference.
336 key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx)
338 key_ref_t key_ref, ret, err;
339 const struct cred *cred = ctx->cred;
341 /* we want to return -EAGAIN or -ENOKEY if any of the keyrings were
342 * searchable, but we failed to find a key or we found a negative key;
343 * otherwise we want to return a sample error (probably -EACCES) if
344 * none of the keyrings were searchable
346 * in terms of priority: success > -ENOKEY > -EAGAIN > other error
350 err = ERR_PTR(-EAGAIN);
352 /* search the thread keyring first */
353 if (cred->thread_keyring) {
354 key_ref = keyring_search_aux(
355 make_key_ref(cred->thread_keyring, 1), ctx);
356 if (!IS_ERR(key_ref))
359 switch (PTR_ERR(key_ref)) {
360 case -EAGAIN: /* no key */
361 case -ENOKEY: /* negative key */
370 /* search the process keyring second */
371 if (cred->process_keyring) {
372 key_ref = keyring_search_aux(
373 make_key_ref(cred->process_keyring, 1), ctx);
374 if (!IS_ERR(key_ref))
377 switch (PTR_ERR(key_ref)) {
378 case -EAGAIN: /* no key */
382 case -ENOKEY: /* negative key */
391 /* search the session keyring */
392 if (cred->session_keyring) {
393 key_ref = keyring_search_aux(
394 make_key_ref(cred->session_keyring, 1), ctx);
396 if (!IS_ERR(key_ref))
399 switch (PTR_ERR(key_ref)) {
400 case -EAGAIN: /* no key */
404 case -ENOKEY: /* negative key */
412 /* or search the user-session keyring */
413 else if (READ_ONCE(cred->user->session_keyring)) {
414 key_ref = keyring_search_aux(
415 make_key_ref(READ_ONCE(cred->user->session_keyring), 1),
417 if (!IS_ERR(key_ref))
420 switch (PTR_ERR(key_ref)) {
421 case -EAGAIN: /* no key */
425 case -ENOKEY: /* negative key */
434 /* no key - decide on the error we're going to go for */
435 key_ref = ret ? ret : err;
442 * Search the process keyrings attached to the supplied cred for the first
443 * matching key in the manner of search_my_process_keyrings(), but also search
444 * the keys attached to the assumed authorisation key using its credentials if
447 * Return same as search_my_process_keyrings().
449 key_ref_t search_process_keyrings(struct keyring_search_context *ctx)
451 struct request_key_auth *rka;
452 key_ref_t key_ref, ret = ERR_PTR(-EACCES), err;
456 key_ref = search_my_process_keyrings(ctx);
457 if (!IS_ERR(key_ref))
461 /* if this process has an instantiation authorisation key, then we also
462 * search the keyrings of the process mentioned there
463 * - we don't permit access to request_key auth keys via this method
465 if (ctx->cred->request_key_auth &&
466 ctx->cred == current_cred() &&
467 ctx->index_key.type != &key_type_request_key_auth
469 const struct cred *cred = ctx->cred;
471 /* defend against the auth key being revoked */
472 down_read(&cred->request_key_auth->sem);
474 if (key_validate(ctx->cred->request_key_auth) == 0) {
475 rka = ctx->cred->request_key_auth->payload.data[0];
477 ctx->cred = rka->cred;
478 key_ref = search_process_keyrings(ctx);
481 up_read(&cred->request_key_auth->sem);
483 if (!IS_ERR(key_ref))
488 up_read(&cred->request_key_auth->sem);
492 /* no key - decide on the error we're going to go for */
493 if (err == ERR_PTR(-ENOKEY) || ret == ERR_PTR(-ENOKEY))
494 key_ref = ERR_PTR(-ENOKEY);
495 else if (err == ERR_PTR(-EACCES))
505 * See if the key we're looking at is the target key.
507 bool lookup_user_key_possessed(const struct key *key,
508 const struct key_match_data *match_data)
510 return key == match_data->raw_data;
514 * Look up a key ID given us by userspace with a given permissions mask to get
515 * the key it refers to.
517 * Flags can be passed to request that special keyrings be created if referred
518 * to directly, to permit partially constructed keys to be found and to skip
519 * validity and permission checks on the found key.
521 * Returns a pointer to the key with an incremented usage count if successful;
522 * -EINVAL if the key ID is invalid; -ENOKEY if the key ID does not correspond
523 * to a key or the best found key was a negative key; -EKEYREVOKED or
524 * -EKEYEXPIRED if the best found key was revoked or expired; -EACCES if the
525 * found key doesn't grant the requested permit or the LSM denied access to it;
526 * or -ENOMEM if a special keyring couldn't be created.
528 * In the case of a successful return, the possession attribute is set on the
529 * returned key reference.
531 key_ref_t lookup_user_key(key_serial_t id, unsigned long lflags,
534 struct keyring_search_context ctx = {
535 .match_data.cmp = lookup_user_key_possessed,
536 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
537 .flags = KEYRING_SEARCH_NO_STATE_CHECK,
539 struct request_key_auth *rka;
541 key_ref_t key_ref, skey_ref;
545 ctx.cred = get_current_cred();
546 key_ref = ERR_PTR(-ENOKEY);
549 case KEY_SPEC_THREAD_KEYRING:
550 if (!ctx.cred->thread_keyring) {
551 if (!(lflags & KEY_LOOKUP_CREATE))
554 ret = install_thread_keyring();
556 key_ref = ERR_PTR(ret);
562 key = ctx.cred->thread_keyring;
564 key_ref = make_key_ref(key, 1);
567 case KEY_SPEC_PROCESS_KEYRING:
568 if (!ctx.cred->process_keyring) {
569 if (!(lflags & KEY_LOOKUP_CREATE))
572 ret = install_process_keyring();
574 key_ref = ERR_PTR(ret);
580 key = ctx.cred->process_keyring;
582 key_ref = make_key_ref(key, 1);
585 case KEY_SPEC_SESSION_KEYRING:
586 if (!ctx.cred->session_keyring) {
587 /* always install a session keyring upon access if one
588 * doesn't exist yet */
589 ret = install_user_keyrings();
592 if (lflags & KEY_LOOKUP_CREATE)
593 ret = join_session_keyring(NULL);
595 ret = install_session_keyring(
596 ctx.cred->user->session_keyring);
601 } else if (ctx.cred->session_keyring ==
602 READ_ONCE(ctx.cred->user->session_keyring) &&
603 lflags & KEY_LOOKUP_CREATE) {
604 ret = join_session_keyring(NULL);
610 key = ctx.cred->session_keyring;
612 key_ref = make_key_ref(key, 1);
615 case KEY_SPEC_USER_KEYRING:
616 if (!READ_ONCE(ctx.cred->user->uid_keyring)) {
617 ret = install_user_keyrings();
622 key = ctx.cred->user->uid_keyring;
624 key_ref = make_key_ref(key, 1);
627 case KEY_SPEC_USER_SESSION_KEYRING:
628 if (!READ_ONCE(ctx.cred->user->session_keyring)) {
629 ret = install_user_keyrings();
634 key = ctx.cred->user->session_keyring;
636 key_ref = make_key_ref(key, 1);
639 case KEY_SPEC_GROUP_KEYRING:
640 /* group keyrings are not yet supported */
641 key_ref = ERR_PTR(-EINVAL);
644 case KEY_SPEC_REQKEY_AUTH_KEY:
645 key = ctx.cred->request_key_auth;
650 key_ref = make_key_ref(key, 1);
653 case KEY_SPEC_REQUESTOR_KEYRING:
654 if (!ctx.cred->request_key_auth)
657 down_read(&ctx.cred->request_key_auth->sem);
658 if (test_bit(KEY_FLAG_REVOKED,
659 &ctx.cred->request_key_auth->flags)) {
660 key_ref = ERR_PTR(-EKEYREVOKED);
663 rka = ctx.cred->request_key_auth->payload.data[0];
664 key = rka->dest_keyring;
667 up_read(&ctx.cred->request_key_auth->sem);
670 key_ref = make_key_ref(key, 1);
674 key_ref = ERR_PTR(-EINVAL);
678 key = key_lookup(id);
680 key_ref = ERR_CAST(key);
684 key_ref = make_key_ref(key, 0);
686 /* check to see if we possess the key */
687 ctx.index_key = key->index_key;
688 ctx.match_data.raw_data = key;
689 kdebug("check possessed");
690 skey_ref = search_process_keyrings(&ctx);
691 kdebug("possessed=%p", skey_ref);
693 if (!IS_ERR(skey_ref)) {
701 /* unlink does not use the nominated key in any way, so can skip all
702 * the permission checks as it is only concerned with the keyring */
703 if (lflags & KEY_LOOKUP_FOR_UNLINK) {
708 if (!(lflags & KEY_LOOKUP_PARTIAL)) {
709 ret = wait_for_key_construction(key, true);
720 ret = key_validate(key);
726 if (!(lflags & KEY_LOOKUP_PARTIAL) &&
727 key_read_state(key) == KEY_IS_UNINSTANTIATED)
730 /* check the permissions */
731 ret = key_task_permission(key_ref, ctx.cred, perm);
735 key->last_used_at = ktime_get_real_seconds();
742 key_ref_put(key_ref);
743 key_ref = ERR_PTR(ret);
746 /* if we attempted to install a keyring, then it may have caused new
747 * creds to be installed */
752 EXPORT_SYMBOL(lookup_user_key);
755 * Join the named keyring as the session keyring if possible else attempt to
756 * create a new one of that name and join that.
758 * If the name is NULL, an empty anonymous keyring will be installed as the
761 * Named session keyrings are joined with a semaphore held to prevent the
762 * keyrings from going away whilst the attempt is made to going them and also
763 * to prevent a race in creating compatible session keyrings.
765 long join_session_keyring(const char *name)
767 const struct cred *old;
772 new = prepare_creds();
775 old = current_cred();
777 /* if no name is provided, install an anonymous keyring */
779 ret = install_session_keyring_to_cred(new, NULL);
783 serial = new->session_keyring->serial;
784 ret = commit_creds(new);
790 /* allow the user to join or create a named keyring */
791 mutex_lock(&key_session_mutex);
793 /* look for an existing keyring of this name */
794 keyring = find_keyring_by_name(name, false);
795 if (PTR_ERR(keyring) == -ENOKEY) {
796 /* not found - try and create a new one */
797 keyring = keyring_alloc(
798 name, old->uid, old->gid, old,
799 KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ | KEY_USR_LINK,
800 KEY_ALLOC_IN_QUOTA, NULL, NULL);
801 if (IS_ERR(keyring)) {
802 ret = PTR_ERR(keyring);
805 } else if (IS_ERR(keyring)) {
806 ret = PTR_ERR(keyring);
808 } else if (keyring == new->session_keyring) {
813 /* we've got a keyring - now to install it */
814 ret = install_session_keyring_to_cred(new, keyring);
819 mutex_unlock(&key_session_mutex);
821 ret = keyring->serial;
829 mutex_unlock(&key_session_mutex);
836 * Replace a process's session keyring on behalf of one of its children when
837 * the target process is about to resume userspace execution.
839 void key_change_session_keyring(struct callback_head *twork)
841 const struct cred *old = current_cred();
842 struct cred *new = container_of(twork, struct cred, rcu);
844 if (unlikely(current->flags & PF_EXITING)) {
849 new-> uid = old-> uid;
850 new-> euid = old-> euid;
851 new-> suid = old-> suid;
852 new->fsuid = old->fsuid;
853 new-> gid = old-> gid;
854 new-> egid = old-> egid;
855 new-> sgid = old-> sgid;
856 new->fsgid = old->fsgid;
857 new->user = get_uid(old->user);
858 new->user_ns = get_user_ns(old->user_ns);
859 new->group_info = get_group_info(old->group_info);
861 new->securebits = old->securebits;
862 new->cap_inheritable = old->cap_inheritable;
863 new->cap_permitted = old->cap_permitted;
864 new->cap_effective = old->cap_effective;
865 new->cap_ambient = old->cap_ambient;
866 new->cap_bset = old->cap_bset;
868 new->jit_keyring = old->jit_keyring;
869 new->thread_keyring = key_get(old->thread_keyring);
870 new->process_keyring = key_get(old->process_keyring);
872 security_transfer_creds(new, old);
878 * Make sure that root's user and user-session keyrings exist.
880 static int __init init_root_keyring(void)
882 return install_user_keyrings();
885 late_initcall(init_root_keyring);