1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Task credentials management - see Documentation/security/credentials.rst
4 * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #define pr_fmt(fmt) "CRED: " fmt
10 #include <linux/export.h>
11 #include <linux/cred.h>
12 #include <linux/slab.h>
13 #include <linux/sched.h>
14 #include <linux/sched/coredump.h>
15 #include <linux/key.h>
16 #include <linux/keyctl.h>
17 #include <linux/init_task.h>
18 #include <linux/security.h>
19 #include <linux/binfmts.h>
20 #include <linux/cn_proc.h>
21 #include <linux/uidgid.h>
24 #define kdebug(FMT, ...) \
25 printk("[%-5.5s%5u] " FMT "\n", \
26 current->comm, current->pid, ##__VA_ARGS__)
28 #define kdebug(FMT, ...) \
31 no_printk("[%-5.5s%5u] " FMT "\n", \
32 current->comm, current->pid, ##__VA_ARGS__); \
36 static struct kmem_cache
*cred_jar
;
38 /* init to 2 - one for init_task, one to ensure it is never freed */
39 static struct group_info init_groups
= { .usage
= REFCOUNT_INIT(2) };
42 * The initial credentials for the initial task
44 struct cred init_cred
= {
45 .usage
= ATOMIC_INIT(4),
46 .uid
= GLOBAL_ROOT_UID
,
47 .gid
= GLOBAL_ROOT_GID
,
48 .suid
= GLOBAL_ROOT_UID
,
49 .sgid
= GLOBAL_ROOT_GID
,
50 .euid
= GLOBAL_ROOT_UID
,
51 .egid
= GLOBAL_ROOT_GID
,
52 .fsuid
= GLOBAL_ROOT_UID
,
53 .fsgid
= GLOBAL_ROOT_GID
,
54 .securebits
= SECUREBITS_DEFAULT
,
55 .cap_inheritable
= CAP_EMPTY_SET
,
56 .cap_permitted
= CAP_FULL_SET
,
57 .cap_effective
= CAP_FULL_SET
,
58 .cap_bset
= CAP_FULL_SET
,
60 .user_ns
= &init_user_ns
,
61 .group_info
= &init_groups
,
62 .ucounts
= &init_ucounts
,
66 * The RCU callback to actually dispose of a set of credentials
68 static void put_cred_rcu(struct rcu_head
*rcu
)
70 struct cred
*cred
= container_of(rcu
, struct cred
, rcu
);
72 kdebug("put_cred_rcu(%p)", cred
);
74 if (atomic_long_read(&cred
->usage
) != 0)
75 panic("CRED: put_cred_rcu() sees %p with usage %ld\n",
76 cred
, atomic_long_read(&cred
->usage
));
78 security_cred_free(cred
);
79 key_put(cred
->session_keyring
);
80 key_put(cred
->process_keyring
);
81 key_put(cred
->thread_keyring
);
82 key_put(cred
->request_key_auth
);
84 put_group_info(cred
->group_info
);
87 put_ucounts(cred
->ucounts
);
88 put_user_ns(cred
->user_ns
);
89 kmem_cache_free(cred_jar
, cred
);
93 * __put_cred - Destroy a set of credentials
94 * @cred: The record to release
96 * Destroy a set of credentials on which no references remain.
98 void __put_cred(struct cred
*cred
)
100 kdebug("__put_cred(%p{%ld})", cred
,
101 atomic_long_read(&cred
->usage
));
103 BUG_ON(atomic_long_read(&cred
->usage
) != 0);
104 BUG_ON(cred
== current
->cred
);
105 BUG_ON(cred
== current
->real_cred
);
108 put_cred_rcu(&cred
->rcu
);
110 call_rcu(&cred
->rcu
, put_cred_rcu
);
112 EXPORT_SYMBOL(__put_cred
);
115 * Clean up a task's credentials when it exits
117 void exit_creds(struct task_struct
*tsk
)
119 struct cred
*real_cred
, *cred
;
121 kdebug("exit_creds(%u,%p,%p,{%ld})", tsk
->pid
, tsk
->real_cred
, tsk
->cred
,
122 atomic_long_read(&tsk
->cred
->usage
));
124 real_cred
= (struct cred
*) tsk
->real_cred
;
125 tsk
->real_cred
= NULL
;
127 cred
= (struct cred
*) tsk
->cred
;
130 if (real_cred
== cred
) {
131 put_cred_many(cred
, 2);
137 #ifdef CONFIG_KEYS_REQUEST_CACHE
138 key_put(tsk
->cached_requested_key
);
139 tsk
->cached_requested_key
= NULL
;
144 * get_task_cred - Get another task's objective credentials
145 * @task: The task to query
147 * Get the objective credentials of a task, pinning them so that they can't go
148 * away. Accessing a task's credentials directly is not permitted.
150 * The caller must also make sure task doesn't get deleted, either by holding a
151 * ref on task or by holding tasklist_lock to prevent it from being unlinked.
153 const struct cred
*get_task_cred(struct task_struct
*task
)
155 const struct cred
*cred
;
160 cred
= __task_cred((task
));
162 } while (!get_cred_rcu(cred
));
167 EXPORT_SYMBOL(get_task_cred
);
170 * Allocate blank credentials, such that the credentials can be filled in at a
171 * later date without risk of ENOMEM.
173 struct cred
*cred_alloc_blank(void)
177 new = kmem_cache_zalloc(cred_jar
, GFP_KERNEL
);
181 atomic_long_set(&new->usage
, 1);
182 if (security_cred_alloc_blank(new, GFP_KERNEL_ACCOUNT
) < 0)
193 * prepare_creds - Prepare a new set of credentials for modification
195 * Prepare a new set of task credentials for modification. A task's creds
196 * shouldn't generally be modified directly, therefore this function is used to
197 * prepare a new copy, which the caller then modifies and then commits by
198 * calling commit_creds().
200 * Preparation involves making a copy of the objective creds for modification.
202 * Returns a pointer to the new creds-to-be if successful, NULL otherwise.
204 * Call commit_creds() or abort_creds() to clean up.
206 struct cred
*prepare_creds(void)
208 struct task_struct
*task
= current
;
209 const struct cred
*old
;
212 new = kmem_cache_alloc(cred_jar
, GFP_KERNEL
);
216 kdebug("prepare_creds() alloc %p", new);
219 memcpy(new, old
, sizeof(struct cred
));
222 atomic_long_set(&new->usage
, 1);
223 get_group_info(new->group_info
);
225 get_user_ns(new->user_ns
);
228 key_get(new->session_keyring
);
229 key_get(new->process_keyring
);
230 key_get(new->thread_keyring
);
231 key_get(new->request_key_auth
);
234 #ifdef CONFIG_SECURITY
235 new->security
= NULL
;
238 new->ucounts
= get_ucounts(new->ucounts
);
242 if (security_prepare_creds(new, old
, GFP_KERNEL_ACCOUNT
) < 0)
251 EXPORT_SYMBOL(prepare_creds
);
254 * Prepare credentials for current to perform an execve()
255 * - The caller must hold ->cred_guard_mutex
257 struct cred
*prepare_exec_creds(void)
261 new = prepare_creds();
266 /* newly exec'd tasks don't get a thread keyring */
267 key_put(new->thread_keyring
);
268 new->thread_keyring
= NULL
;
270 /* inherit the session keyring; new process keyring */
271 key_put(new->process_keyring
);
272 new->process_keyring
= NULL
;
275 new->suid
= new->fsuid
= new->euid
;
276 new->sgid
= new->fsgid
= new->egid
;
282 * Copy credentials for the new process created by fork()
284 * We share if we can, but under some circumstances we have to generate a new
287 * The new process gets the current process's subjective credentials as its
288 * objective and subjective credentials
290 int copy_creds(struct task_struct
*p
, unsigned long clone_flags
)
295 #ifdef CONFIG_KEYS_REQUEST_CACHE
296 p
->cached_requested_key
= NULL
;
301 !p
->cred
->thread_keyring
&&
303 clone_flags
& CLONE_THREAD
305 p
->real_cred
= get_cred_many(p
->cred
, 2);
306 kdebug("share_creds(%p{%ld})",
307 p
->cred
, atomic_long_read(&p
->cred
->usage
));
308 inc_rlimit_ucounts(task_ucounts(p
), UCOUNT_RLIMIT_NPROC
, 1);
312 new = prepare_creds();
316 if (clone_flags
& CLONE_NEWUSER
) {
317 ret
= create_user_ns(new);
320 ret
= set_cred_ucounts(new);
326 /* new threads get their own thread keyrings if their parent already
328 if (new->thread_keyring
) {
329 key_put(new->thread_keyring
);
330 new->thread_keyring
= NULL
;
331 if (clone_flags
& CLONE_THREAD
)
332 install_thread_keyring_to_cred(new);
335 /* The process keyring is only shared between the threads in a process;
336 * anything outside of those threads doesn't inherit.
338 if (!(clone_flags
& CLONE_THREAD
)) {
339 key_put(new->process_keyring
);
340 new->process_keyring
= NULL
;
344 p
->cred
= p
->real_cred
= get_cred(new);
345 inc_rlimit_ucounts(task_ucounts(p
), UCOUNT_RLIMIT_NPROC
, 1);
353 static bool cred_cap_issubset(const struct cred
*set
, const struct cred
*subset
)
355 const struct user_namespace
*set_ns
= set
->user_ns
;
356 const struct user_namespace
*subset_ns
= subset
->user_ns
;
358 /* If the two credentials are in the same user namespace see if
359 * the capabilities of subset are a subset of set.
361 if (set_ns
== subset_ns
)
362 return cap_issubset(subset
->cap_permitted
, set
->cap_permitted
);
364 /* The credentials are in a different user namespaces
365 * therefore one is a subset of the other only if a set is an
366 * ancestor of subset and set->euid is owner of subset or one
367 * of subsets ancestors.
369 for (;subset_ns
!= &init_user_ns
; subset_ns
= subset_ns
->parent
) {
370 if ((set_ns
== subset_ns
->parent
) &&
371 uid_eq(subset_ns
->owner
, set
->euid
))
379 * commit_creds - Install new credentials upon the current task
380 * @new: The credentials to be assigned
382 * Install a new set of credentials to the current task, using RCU to replace
383 * the old set. Both the objective and the subjective credentials pointers are
384 * updated. This function may not be called if the subjective credentials are
385 * in an overridden state.
387 * This function eats the caller's reference to the new credentials.
389 * Always returns 0 thus allowing this function to be tail-called at the end
390 * of, say, sys_setgid().
392 int commit_creds(struct cred
*new)
394 struct task_struct
*task
= current
;
395 const struct cred
*old
= task
->real_cred
;
397 kdebug("commit_creds(%p{%ld})", new,
398 atomic_long_read(&new->usage
));
400 BUG_ON(task
->cred
!= old
);
401 BUG_ON(atomic_long_read(&new->usage
) < 1);
403 get_cred(new); /* we will require a ref for the subj creds too */
405 /* dumpability changes */
406 if (!uid_eq(old
->euid
, new->euid
) ||
407 !gid_eq(old
->egid
, new->egid
) ||
408 !uid_eq(old
->fsuid
, new->fsuid
) ||
409 !gid_eq(old
->fsgid
, new->fsgid
) ||
410 !cred_cap_issubset(old
, new)) {
412 set_dumpable(task
->mm
, suid_dumpable
);
413 task
->pdeath_signal
= 0;
415 * If a task drops privileges and becomes nondumpable,
416 * the dumpability change must become visible before
417 * the credential change; otherwise, a __ptrace_may_access()
418 * racing with this change may be able to attach to a task it
419 * shouldn't be able to attach to (as if the task had dropped
420 * privileges without becoming nondumpable).
421 * Pairs with a read barrier in __ptrace_may_access().
426 /* alter the thread keyring */
427 if (!uid_eq(new->fsuid
, old
->fsuid
))
428 key_fsuid_changed(new);
429 if (!gid_eq(new->fsgid
, old
->fsgid
))
430 key_fsgid_changed(new);
433 * RLIMIT_NPROC limits on user->processes have already been checked
436 if (new->user
!= old
->user
|| new->user_ns
!= old
->user_ns
)
437 inc_rlimit_ucounts(new->ucounts
, UCOUNT_RLIMIT_NPROC
, 1);
438 rcu_assign_pointer(task
->real_cred
, new);
439 rcu_assign_pointer(task
->cred
, new);
440 if (new->user
!= old
->user
|| new->user_ns
!= old
->user_ns
)
441 dec_rlimit_ucounts(old
->ucounts
, UCOUNT_RLIMIT_NPROC
, 1);
443 /* send notifications */
444 if (!uid_eq(new->uid
, old
->uid
) ||
445 !uid_eq(new->euid
, old
->euid
) ||
446 !uid_eq(new->suid
, old
->suid
) ||
447 !uid_eq(new->fsuid
, old
->fsuid
))
448 proc_id_connector(task
, PROC_EVENT_UID
);
450 if (!gid_eq(new->gid
, old
->gid
) ||
451 !gid_eq(new->egid
, old
->egid
) ||
452 !gid_eq(new->sgid
, old
->sgid
) ||
453 !gid_eq(new->fsgid
, old
->fsgid
))
454 proc_id_connector(task
, PROC_EVENT_GID
);
456 /* release the old obj and subj refs both */
457 put_cred_many(old
, 2);
460 EXPORT_SYMBOL(commit_creds
);
463 * abort_creds - Discard a set of credentials and unlock the current task
464 * @new: The credentials that were going to be applied
466 * Discard a set of credentials that were under construction and unlock the
469 void abort_creds(struct cred
*new)
471 kdebug("abort_creds(%p{%ld})", new,
472 atomic_long_read(&new->usage
));
474 BUG_ON(atomic_long_read(&new->usage
) < 1);
477 EXPORT_SYMBOL(abort_creds
);
480 * override_creds - Override the current process's subjective credentials
481 * @new: The credentials to be assigned
483 * Install a set of temporary override subjective credentials on the current
484 * process, returning the old set for later reversion.
486 const struct cred
*override_creds(const struct cred
*new)
488 const struct cred
*old
= current
->cred
;
490 kdebug("override_creds(%p{%ld})", new,
491 atomic_long_read(&new->usage
));
494 * NOTE! This uses 'get_new_cred()' rather than 'get_cred()'.
496 * That means that we do not clear the 'non_rcu' flag, since
497 * we are only installing the cred into the thread-synchronous
498 * '->cred' pointer, not the '->real_cred' pointer that is
499 * visible to other threads under RCU.
501 get_new_cred((struct cred
*)new);
502 rcu_assign_pointer(current
->cred
, new);
504 kdebug("override_creds() = %p{%ld}", old
,
505 atomic_long_read(&old
->usage
));
508 EXPORT_SYMBOL(override_creds
);
511 * revert_creds - Revert a temporary subjective credentials override
512 * @old: The credentials to be restored
514 * Revert a temporary set of override subjective credentials to an old set,
515 * discarding the override set.
517 void revert_creds(const struct cred
*old
)
519 const struct cred
*override
= current
->cred
;
521 kdebug("revert_creds(%p{%ld})", old
,
522 atomic_long_read(&old
->usage
));
524 rcu_assign_pointer(current
->cred
, old
);
527 EXPORT_SYMBOL(revert_creds
);
530 * cred_fscmp - Compare two credentials with respect to filesystem access.
531 * @a: The first credential
532 * @b: The second credential
534 * cred_cmp() will return zero if both credentials have the same
535 * fsuid, fsgid, and supplementary groups. That is, if they will both
536 * provide the same access to files based on mode/uid/gid.
537 * If the credentials are different, then either -1 or 1 will
538 * be returned depending on whether @a comes before or after @b
539 * respectively in an arbitrary, but stable, ordering of credentials.
541 * Return: -1, 0, or 1 depending on comparison
543 int cred_fscmp(const struct cred
*a
, const struct cred
*b
)
545 struct group_info
*ga
, *gb
;
550 if (uid_lt(a
->fsuid
, b
->fsuid
))
552 if (uid_gt(a
->fsuid
, b
->fsuid
))
555 if (gid_lt(a
->fsgid
, b
->fsgid
))
557 if (gid_gt(a
->fsgid
, b
->fsgid
))
568 if (ga
->ngroups
< gb
->ngroups
)
570 if (ga
->ngroups
> gb
->ngroups
)
573 for (g
= 0; g
< ga
->ngroups
; g
++) {
574 if (gid_lt(ga
->gid
[g
], gb
->gid
[g
]))
576 if (gid_gt(ga
->gid
[g
], gb
->gid
[g
]))
581 EXPORT_SYMBOL(cred_fscmp
);
583 int set_cred_ucounts(struct cred
*new)
585 struct ucounts
*new_ucounts
, *old_ucounts
= new->ucounts
;
588 * This optimization is needed because alloc_ucounts() uses locks
591 if (old_ucounts
->ns
== new->user_ns
&& uid_eq(old_ucounts
->uid
, new->uid
))
594 if (!(new_ucounts
= alloc_ucounts(new->user_ns
, new->uid
)))
597 new->ucounts
= new_ucounts
;
598 put_ucounts(old_ucounts
);
604 * initialise the credentials stuff
606 void __init
cred_init(void)
608 /* allocate a slab in which we can store credentials */
609 cred_jar
= KMEM_CACHE(cred
,
610 SLAB_HWCACHE_ALIGN
| SLAB_PANIC
| SLAB_ACCOUNT
);
614 * prepare_kernel_cred - Prepare a set of credentials for a kernel service
615 * @daemon: A userspace daemon to be used as a reference
617 * Prepare a set of credentials for a kernel service. This can then be used to
618 * override a task's own credentials so that work can be done on behalf of that
619 * task that requires a different subjective context.
621 * @daemon is used to provide a base cred, with the security data derived from
622 * that; if this is "&init_task", they'll be set to 0, no groups, full
623 * capabilities, and no keys.
625 * The caller may change these controls afterwards if desired.
627 * Returns the new credentials or NULL if out of memory.
629 struct cred
*prepare_kernel_cred(struct task_struct
*daemon
)
631 const struct cred
*old
;
634 if (WARN_ON_ONCE(!daemon
))
637 new = kmem_cache_alloc(cred_jar
, GFP_KERNEL
);
641 kdebug("prepare_kernel_cred() alloc %p", new);
643 old
= get_task_cred(daemon
);
647 atomic_long_set(&new->usage
, 1);
649 get_user_ns(new->user_ns
);
650 get_group_info(new->group_info
);
653 new->session_keyring
= NULL
;
654 new->process_keyring
= NULL
;
655 new->thread_keyring
= NULL
;
656 new->request_key_auth
= NULL
;
657 new->jit_keyring
= KEY_REQKEY_DEFL_THREAD_KEYRING
;
660 #ifdef CONFIG_SECURITY
661 new->security
= NULL
;
663 new->ucounts
= get_ucounts(new->ucounts
);
667 if (security_prepare_creds(new, old
, GFP_KERNEL_ACCOUNT
) < 0)
678 EXPORT_SYMBOL(prepare_kernel_cred
);
681 * set_security_override - Set the security ID in a set of credentials
682 * @new: The credentials to alter
683 * @secid: The LSM security ID to set
685 * Set the LSM security ID in a set of credentials so that the subjective
686 * security is overridden when an alternative set of credentials is used.
688 int set_security_override(struct cred
*new, u32 secid
)
690 return security_kernel_act_as(new, secid
);
692 EXPORT_SYMBOL(set_security_override
);
695 * set_security_override_from_ctx - Set the security ID in a set of credentials
696 * @new: The credentials to alter
697 * @secctx: The LSM security context to generate the security ID from.
699 * Set the LSM security ID in a set of credentials so that the subjective
700 * security is overridden when an alternative set of credentials is used. The
701 * security ID is specified in string form as a security context to be
702 * interpreted by the LSM.
704 int set_security_override_from_ctx(struct cred
*new, const char *secctx
)
709 ret
= security_secctx_to_secid(secctx
, strlen(secctx
), &secid
);
713 return set_security_override(new, secid
);
715 EXPORT_SYMBOL(set_security_override_from_ctx
);
718 * set_create_files_as - Set the LSM file create context in a set of credentials
719 * @new: The credentials to alter
720 * @inode: The inode to take the context from
722 * Change the LSM file creation context in a set of credentials to be the same
723 * as the object context of the specified inode, so that the new inodes have
724 * the same MAC context as that inode.
726 int set_create_files_as(struct cred
*new, struct inode
*inode
)
728 if (!uid_valid(inode
->i_uid
) || !gid_valid(inode
->i_gid
))
730 new->fsuid
= inode
->i_uid
;
731 new->fsgid
= inode
->i_gid
;
732 return security_kernel_create_files_as(new, inode
);
734 EXPORT_SYMBOL(set_create_files_as
);