1 /* Manage a process's keyrings
3 * Copyright (C) 2004-2005, 2008 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/sched.h>
15 #include <linux/sched/user.h>
16 #include <linux/keyctl.h>
18 #include <linux/err.h>
19 #include <linux/mutex.h>
20 #include <linux/security.h>
21 #include <linux/user_namespace.h>
22 #include <linux/uaccess.h>
25 /* Session keyring create vs join semaphore */
26 static DEFINE_MUTEX(key_session_mutex
);
28 /* User keyring creation semaphore */
29 static DEFINE_MUTEX(key_user_keyring_mutex
);
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
,
42 * Install the user and user session keyrings for the current process's UID.
44 int install_user_keyrings(void)
46 struct user_struct
*user
;
47 const struct cred
*cred
;
48 struct key
*uid_keyring
, *session_keyring
;
49 key_perm_t user_keyring_perm
;
54 user_keyring_perm
= (KEY_POS_ALL
& ~KEY_POS_SETATTR
) | KEY_USR_ALL
;
55 cred
= current_cred();
57 uid
= from_kuid(cred
->user_ns
, user
->uid
);
59 kenter("%p{%u}", user
, uid
);
61 if (user
->uid_keyring
&& user
->session_keyring
) {
62 kleave(" = 0 [exist]");
66 mutex_lock(&key_user_keyring_mutex
);
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
);
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
|
83 if (IS_ERR(uid_keyring
)) {
84 ret
= PTR_ERR(uid_keyring
);
89 /* get a default session keyring (which might also exist
91 sprintf(buf
, "_uid_ses.%u", uid
);
93 session_keyring
= find_keyring_by_name(buf
, true);
94 if (IS_ERR(session_keyring
)) {
96 keyring_alloc(buf
, user
->uid
, INVALID_GID
,
97 cred
, user_keyring_perm
,
98 KEY_ALLOC_UID_KEYRING
|
101 if (IS_ERR(session_keyring
)) {
102 ret
= PTR_ERR(session_keyring
);
106 /* we install a link from the user session keyring to
107 * the user keyring */
108 ret
= key_link(session_keyring
, uid_keyring
);
110 goto error_release_both
;
113 /* install the keyrings */
114 user
->uid_keyring
= uid_keyring
;
115 user
->session_keyring
= session_keyring
;
118 mutex_unlock(&key_user_keyring_mutex
);
123 key_put(session_keyring
);
125 key_put(uid_keyring
);
127 mutex_unlock(&key_user_keyring_mutex
);
128 kleave(" = %d", ret
);
133 * Install a thread keyring to the given credentials struct if it didn't have
134 * one already. This is allowed to overrun the quota.
136 * Return: 0 if a thread keyring is now present; -errno on failure.
138 int install_thread_keyring_to_cred(struct cred
*new)
142 if (new->thread_keyring
)
145 keyring
= keyring_alloc("_tid", new->uid
, new->gid
, new,
146 KEY_POS_ALL
| KEY_USR_VIEW
,
147 KEY_ALLOC_QUOTA_OVERRUN
,
150 return PTR_ERR(keyring
);
152 new->thread_keyring
= keyring
;
157 * Install a thread keyring to the current task if it didn't have one already.
159 * Return: 0 if a thread keyring is now present; -errno on failure.
161 static int install_thread_keyring(void)
166 new = prepare_creds();
170 ret
= install_thread_keyring_to_cred(new);
176 return commit_creds(new);
180 * Install a process keyring to the given credentials struct if it didn't have
181 * one already. This is allowed to overrun the quota.
183 * Return: 0 if a process keyring is now present; -errno on failure.
185 int install_process_keyring_to_cred(struct cred
*new)
189 if (new->process_keyring
)
192 keyring
= keyring_alloc("_pid", new->uid
, new->gid
, new,
193 KEY_POS_ALL
| KEY_USR_VIEW
,
194 KEY_ALLOC_QUOTA_OVERRUN
,
197 return PTR_ERR(keyring
);
199 new->process_keyring
= keyring
;
204 * Install a process keyring to the current task if it didn't have one already.
206 * Return: 0 if a process keyring is now present; -errno on failure.
208 static int install_process_keyring(void)
213 new = prepare_creds();
217 ret
= install_process_keyring_to_cred(new);
223 return commit_creds(new);
227 * Install the given keyring as the session keyring of the given credentials
228 * struct, replacing the existing one if any. If the given keyring is NULL,
229 * then install a new anonymous session keyring.
231 * Return: 0 on success; -errno on failure.
233 int install_session_keyring_to_cred(struct cred
*cred
, struct key
*keyring
)
240 /* create an empty session keyring */
242 flags
= KEY_ALLOC_QUOTA_OVERRUN
;
243 if (cred
->session_keyring
)
244 flags
= KEY_ALLOC_IN_QUOTA
;
246 keyring
= keyring_alloc("_ses", cred
->uid
, cred
->gid
, cred
,
247 KEY_POS_ALL
| KEY_USR_VIEW
| KEY_USR_READ
,
250 return PTR_ERR(keyring
);
255 /* install the keyring */
256 old
= cred
->session_keyring
;
257 rcu_assign_pointer(cred
->session_keyring
, keyring
);
266 * Install the given keyring as the session keyring of the current task,
267 * replacing the existing one if any. If the given keyring is NULL, then
268 * install a new anonymous session keyring.
270 * Return: 0 on success; -errno on failure.
272 static int install_session_keyring(struct key
*keyring
)
277 new = prepare_creds();
281 ret
= install_session_keyring_to_cred(new, keyring
);
287 return commit_creds(new);
291 * Handle the fsuid changing.
293 void key_fsuid_changed(struct task_struct
*tsk
)
295 /* update the ownership of the thread keyring */
297 if (tsk
->cred
->thread_keyring
) {
298 down_write(&tsk
->cred
->thread_keyring
->sem
);
299 tsk
->cred
->thread_keyring
->uid
= tsk
->cred
->fsuid
;
300 up_write(&tsk
->cred
->thread_keyring
->sem
);
305 * Handle the fsgid changing.
307 void key_fsgid_changed(struct task_struct
*tsk
)
309 /* update the ownership of the thread keyring */
311 if (tsk
->cred
->thread_keyring
) {
312 down_write(&tsk
->cred
->thread_keyring
->sem
);
313 tsk
->cred
->thread_keyring
->gid
= tsk
->cred
->fsgid
;
314 up_write(&tsk
->cred
->thread_keyring
->sem
);
319 * Search the process keyrings attached to the supplied cred for the first
322 * The search criteria are the type and the match function. The description is
323 * given to the match function as a parameter, but doesn't otherwise influence
324 * the search. Typically the match function will compare the description
325 * parameter to the key's description.
327 * This can only search keyrings that grant Search permission to the supplied
328 * credentials. Keyrings linked to searched keyrings will also be searched if
329 * they grant Search permission too. Keys can only be found if they grant
330 * Search permission to the credentials.
332 * Returns a pointer to the key with the key usage count incremented if
333 * successful, -EAGAIN if we didn't find any matching key or -ENOKEY if we only
334 * matched negative keys.
336 * In the case of a successful return, the possession attribute is set on the
337 * returned key reference.
339 key_ref_t
search_my_process_keyrings(struct keyring_search_context
*ctx
)
341 key_ref_t key_ref
, ret
, err
;
343 /* we want to return -EAGAIN or -ENOKEY if any of the keyrings were
344 * searchable, but we failed to find a key or we found a negative key;
345 * otherwise we want to return a sample error (probably -EACCES) if
346 * none of the keyrings were searchable
348 * in terms of priority: success > -ENOKEY > -EAGAIN > other error
352 err
= ERR_PTR(-EAGAIN
);
354 /* search the thread keyring first */
355 if (ctx
->cred
->thread_keyring
) {
356 key_ref
= keyring_search_aux(
357 make_key_ref(ctx
->cred
->thread_keyring
, 1), ctx
);
358 if (!IS_ERR(key_ref
))
361 switch (PTR_ERR(key_ref
)) {
362 case -EAGAIN
: /* no key */
363 case -ENOKEY
: /* negative key */
372 /* search the process keyring second */
373 if (ctx
->cred
->process_keyring
) {
374 key_ref
= keyring_search_aux(
375 make_key_ref(ctx
->cred
->process_keyring
, 1), ctx
);
376 if (!IS_ERR(key_ref
))
379 switch (PTR_ERR(key_ref
)) {
380 case -EAGAIN
: /* no key */
383 case -ENOKEY
: /* negative key */
392 /* search the session keyring */
393 if (ctx
->cred
->session_keyring
) {
395 key_ref
= keyring_search_aux(
396 make_key_ref(rcu_dereference(ctx
->cred
->session_keyring
), 1),
400 if (!IS_ERR(key_ref
))
403 switch (PTR_ERR(key_ref
)) {
404 case -EAGAIN
: /* no key */
407 case -ENOKEY
: /* negative key */
415 /* or search the user-session keyring */
416 else if (ctx
->cred
->user
->session_keyring
) {
417 key_ref
= keyring_search_aux(
418 make_key_ref(ctx
->cred
->user
->session_keyring
, 1),
420 if (!IS_ERR(key_ref
))
423 switch (PTR_ERR(key_ref
)) {
424 case -EAGAIN
: /* no key */
427 case -ENOKEY
: /* negative key */
436 /* no key - decide on the error we're going to go for */
437 key_ref
= ret
? ret
: err
;
444 * Search the process keyrings attached to the supplied cred for the first
445 * matching key in the manner of search_my_process_keyrings(), but also search
446 * the keys attached to the assumed authorisation key using its credentials if
449 * Return same as search_my_process_keyrings().
451 key_ref_t
search_process_keyrings(struct keyring_search_context
*ctx
)
453 struct request_key_auth
*rka
;
454 key_ref_t key_ref
, ret
= ERR_PTR(-EACCES
), err
;
458 key_ref
= search_my_process_keyrings(ctx
);
459 if (!IS_ERR(key_ref
))
463 /* if this process has an instantiation authorisation key, then we also
464 * search the keyrings of the process mentioned there
465 * - we don't permit access to request_key auth keys via this method
467 if (ctx
->cred
->request_key_auth
&&
468 ctx
->cred
== current_cred() &&
469 ctx
->index_key
.type
!= &key_type_request_key_auth
471 const struct cred
*cred
= ctx
->cred
;
473 /* defend against the auth key being revoked */
474 down_read(&cred
->request_key_auth
->sem
);
476 if (key_validate(ctx
->cred
->request_key_auth
) == 0) {
477 rka
= ctx
->cred
->request_key_auth
->payload
.data
[0];
479 ctx
->cred
= rka
->cred
;
480 key_ref
= search_process_keyrings(ctx
);
483 up_read(&cred
->request_key_auth
->sem
);
485 if (!IS_ERR(key_ref
))
490 up_read(&cred
->request_key_auth
->sem
);
494 /* no key - decide on the error we're going to go for */
495 if (err
== ERR_PTR(-ENOKEY
) || ret
== ERR_PTR(-ENOKEY
))
496 key_ref
= ERR_PTR(-ENOKEY
);
497 else if (err
== ERR_PTR(-EACCES
))
507 * See if the key we're looking at is the target key.
509 bool lookup_user_key_possessed(const struct key
*key
,
510 const struct key_match_data
*match_data
)
512 return key
== match_data
->raw_data
;
516 * Look up a key ID given us by userspace with a given permissions mask to get
517 * the key it refers to.
519 * Flags can be passed to request that special keyrings be created if referred
520 * to directly, to permit partially constructed keys to be found and to skip
521 * validity and permission checks on the found key.
523 * Returns a pointer to the key with an incremented usage count if successful;
524 * -EINVAL if the key ID is invalid; -ENOKEY if the key ID does not correspond
525 * to a key or the best found key was a negative key; -EKEYREVOKED or
526 * -EKEYEXPIRED if the best found key was revoked or expired; -EACCES if the
527 * found key doesn't grant the requested permit or the LSM denied access to it;
528 * or -ENOMEM if a special keyring couldn't be created.
530 * In the case of a successful return, the possession attribute is set on the
531 * returned key reference.
533 key_ref_t
lookup_user_key(key_serial_t id
, unsigned long lflags
,
536 struct keyring_search_context ctx
= {
537 .match_data
.cmp
= lookup_user_key_possessed
,
538 .match_data
.lookup_type
= KEYRING_SEARCH_LOOKUP_DIRECT
,
539 .flags
= KEYRING_SEARCH_NO_STATE_CHECK
,
541 struct request_key_auth
*rka
;
543 key_ref_t key_ref
, skey_ref
;
547 ctx
.cred
= get_current_cred();
548 key_ref
= ERR_PTR(-ENOKEY
);
551 case KEY_SPEC_THREAD_KEYRING
:
552 if (!ctx
.cred
->thread_keyring
) {
553 if (!(lflags
& KEY_LOOKUP_CREATE
))
556 ret
= install_thread_keyring();
558 key_ref
= ERR_PTR(ret
);
564 key
= ctx
.cred
->thread_keyring
;
566 key_ref
= make_key_ref(key
, 1);
569 case KEY_SPEC_PROCESS_KEYRING
:
570 if (!ctx
.cred
->process_keyring
) {
571 if (!(lflags
& KEY_LOOKUP_CREATE
))
574 ret
= install_process_keyring();
576 key_ref
= ERR_PTR(ret
);
582 key
= ctx
.cred
->process_keyring
;
584 key_ref
= make_key_ref(key
, 1);
587 case KEY_SPEC_SESSION_KEYRING
:
588 if (!ctx
.cred
->session_keyring
) {
589 /* always install a session keyring upon access if one
590 * doesn't exist yet */
591 ret
= install_user_keyrings();
594 if (lflags
& KEY_LOOKUP_CREATE
)
595 ret
= join_session_keyring(NULL
);
597 ret
= install_session_keyring(
598 ctx
.cred
->user
->session_keyring
);
603 } else if (ctx
.cred
->session_keyring
==
604 ctx
.cred
->user
->session_keyring
&&
605 lflags
& KEY_LOOKUP_CREATE
) {
606 ret
= join_session_keyring(NULL
);
613 key
= rcu_dereference(ctx
.cred
->session_keyring
);
616 key_ref
= make_key_ref(key
, 1);
619 case KEY_SPEC_USER_KEYRING
:
620 if (!ctx
.cred
->user
->uid_keyring
) {
621 ret
= install_user_keyrings();
626 key
= ctx
.cred
->user
->uid_keyring
;
628 key_ref
= make_key_ref(key
, 1);
631 case KEY_SPEC_USER_SESSION_KEYRING
:
632 if (!ctx
.cred
->user
->session_keyring
) {
633 ret
= install_user_keyrings();
638 key
= ctx
.cred
->user
->session_keyring
;
640 key_ref
= make_key_ref(key
, 1);
643 case KEY_SPEC_GROUP_KEYRING
:
644 /* group keyrings are not yet supported */
645 key_ref
= ERR_PTR(-EINVAL
);
648 case KEY_SPEC_REQKEY_AUTH_KEY
:
649 key
= ctx
.cred
->request_key_auth
;
654 key_ref
= make_key_ref(key
, 1);
657 case KEY_SPEC_REQUESTOR_KEYRING
:
658 if (!ctx
.cred
->request_key_auth
)
661 down_read(&ctx
.cred
->request_key_auth
->sem
);
662 if (test_bit(KEY_FLAG_REVOKED
,
663 &ctx
.cred
->request_key_auth
->flags
)) {
664 key_ref
= ERR_PTR(-EKEYREVOKED
);
667 rka
= ctx
.cred
->request_key_auth
->payload
.data
[0];
668 key
= rka
->dest_keyring
;
671 up_read(&ctx
.cred
->request_key_auth
->sem
);
674 key_ref
= make_key_ref(key
, 1);
678 key_ref
= ERR_PTR(-EINVAL
);
682 key
= key_lookup(id
);
684 key_ref
= ERR_CAST(key
);
688 key_ref
= make_key_ref(key
, 0);
690 /* check to see if we possess the key */
691 ctx
.index_key
.type
= key
->type
;
692 ctx
.index_key
.description
= key
->description
;
693 ctx
.index_key
.desc_len
= strlen(key
->description
);
694 ctx
.match_data
.raw_data
= key
;
695 kdebug("check possessed");
696 skey_ref
= search_process_keyrings(&ctx
);
697 kdebug("possessed=%p", skey_ref
);
699 if (!IS_ERR(skey_ref
)) {
707 /* unlink does not use the nominated key in any way, so can skip all
708 * the permission checks as it is only concerned with the keyring */
709 if (lflags
& KEY_LOOKUP_FOR_UNLINK
) {
714 if (!(lflags
& KEY_LOOKUP_PARTIAL
)) {
715 ret
= wait_for_key_construction(key
, true);
726 ret
= key_validate(key
);
732 if (!(lflags
& KEY_LOOKUP_PARTIAL
) &&
733 key_read_state(key
) == KEY_IS_UNINSTANTIATED
)
736 /* check the permissions */
737 ret
= key_task_permission(key_ref
, ctx
.cred
, perm
);
741 key
->last_used_at
= ktime_get_real_seconds();
748 key_ref_put(key_ref
);
749 key_ref
= ERR_PTR(ret
);
752 /* if we attempted to install a keyring, then it may have caused new
753 * creds to be installed */
760 * Join the named keyring as the session keyring if possible else attempt to
761 * create a new one of that name and join that.
763 * If the name is NULL, an empty anonymous keyring will be installed as the
766 * Named session keyrings are joined with a semaphore held to prevent the
767 * keyrings from going away whilst the attempt is made to going them and also
768 * to prevent a race in creating compatible session keyrings.
770 long join_session_keyring(const char *name
)
772 const struct cred
*old
;
777 new = prepare_creds();
780 old
= current_cred();
782 /* if no name is provided, install an anonymous keyring */
784 ret
= install_session_keyring_to_cred(new, NULL
);
788 serial
= new->session_keyring
->serial
;
789 ret
= commit_creds(new);
795 /* allow the user to join or create a named keyring */
796 mutex_lock(&key_session_mutex
);
798 /* look for an existing keyring of this name */
799 keyring
= find_keyring_by_name(name
, false);
800 if (PTR_ERR(keyring
) == -ENOKEY
) {
801 /* not found - try and create a new one */
802 keyring
= keyring_alloc(
803 name
, old
->uid
, old
->gid
, old
,
804 KEY_POS_ALL
| KEY_USR_VIEW
| KEY_USR_READ
| KEY_USR_LINK
,
805 KEY_ALLOC_IN_QUOTA
, NULL
, NULL
);
806 if (IS_ERR(keyring
)) {
807 ret
= PTR_ERR(keyring
);
810 } else if (IS_ERR(keyring
)) {
811 ret
= PTR_ERR(keyring
);
813 } else if (keyring
== new->session_keyring
) {
818 /* we've got a keyring - now to install it */
819 ret
= install_session_keyring_to_cred(new, keyring
);
824 mutex_unlock(&key_session_mutex
);
826 ret
= keyring
->serial
;
834 mutex_unlock(&key_session_mutex
);
841 * Replace a process's session keyring on behalf of one of its children when
842 * the target process is about to resume userspace execution.
844 void key_change_session_keyring(struct callback_head
*twork
)
846 const struct cred
*old
= current_cred();
847 struct cred
*new = container_of(twork
, struct cred
, rcu
);
849 if (unlikely(current
->flags
& PF_EXITING
)) {
854 new-> uid
= old
-> uid
;
855 new-> euid
= old
-> euid
;
856 new-> suid
= old
-> suid
;
857 new->fsuid
= old
->fsuid
;
858 new-> gid
= old
-> gid
;
859 new-> egid
= old
-> egid
;
860 new-> sgid
= old
-> sgid
;
861 new->fsgid
= old
->fsgid
;
862 new->user
= get_uid(old
->user
);
863 new->user_ns
= get_user_ns(old
->user_ns
);
864 new->group_info
= get_group_info(old
->group_info
);
866 new->securebits
= old
->securebits
;
867 new->cap_inheritable
= old
->cap_inheritable
;
868 new->cap_permitted
= old
->cap_permitted
;
869 new->cap_effective
= old
->cap_effective
;
870 new->cap_ambient
= old
->cap_ambient
;
871 new->cap_bset
= old
->cap_bset
;
873 new->jit_keyring
= old
->jit_keyring
;
874 new->thread_keyring
= key_get(old
->thread_keyring
);
875 new->process_keyring
= key_get(old
->process_keyring
);
877 security_transfer_creds(new, old
);
883 * Make sure that root's user and user-session keyrings exist.
885 static int __init
init_root_keyring(void)
887 return install_user_keyrings();
890 late_initcall(init_root_keyring
);