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 = ATOMIC_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)
121 kdebug("exit_creds(%u,%p,%p,{%ld})", tsk->pid, tsk->real_cred, tsk->cred,
122 atomic_long_read(&tsk->cred->usage));
124 cred = (struct cred *) tsk->real_cred;
125 tsk->real_cred = NULL;
128 cred = (struct cred *) tsk->cred;
132 #ifdef CONFIG_KEYS_REQUEST_CACHE
133 key_put(tsk->cached_requested_key);
134 tsk->cached_requested_key = NULL;
139 * get_task_cred - Get another task's objective credentials
140 * @task: The task to query
142 * Get the objective credentials of a task, pinning them so that they can't go
143 * away. Accessing a task's credentials directly is not permitted.
145 * The caller must also make sure task doesn't get deleted, either by holding a
146 * ref on task or by holding tasklist_lock to prevent it from being unlinked.
148 const struct cred *get_task_cred(struct task_struct *task)
150 const struct cred *cred;
155 cred = __task_cred((task));
157 } while (!get_cred_rcu(cred));
162 EXPORT_SYMBOL(get_task_cred);
165 * Allocate blank credentials, such that the credentials can be filled in at a
166 * later date without risk of ENOMEM.
168 struct cred *cred_alloc_blank(void)
172 new = kmem_cache_zalloc(cred_jar, GFP_KERNEL);
176 atomic_long_set(&new->usage, 1);
177 if (security_cred_alloc_blank(new, GFP_KERNEL_ACCOUNT) < 0)
188 * prepare_creds - Prepare a new set of credentials for modification
190 * Prepare a new set of task credentials for modification. A task's creds
191 * shouldn't generally be modified directly, therefore this function is used to
192 * prepare a new copy, which the caller then modifies and then commits by
193 * calling commit_creds().
195 * Preparation involves making a copy of the objective creds for modification.
197 * Returns a pointer to the new creds-to-be if successful, NULL otherwise.
199 * Call commit_creds() or abort_creds() to clean up.
201 struct cred *prepare_creds(void)
203 struct task_struct *task = current;
204 const struct cred *old;
207 new = kmem_cache_alloc(cred_jar, GFP_KERNEL);
211 kdebug("prepare_creds() alloc %p", new);
214 memcpy(new, old, sizeof(struct cred));
217 atomic_long_set(&new->usage, 1);
218 get_group_info(new->group_info);
220 get_user_ns(new->user_ns);
223 key_get(new->session_keyring);
224 key_get(new->process_keyring);
225 key_get(new->thread_keyring);
226 key_get(new->request_key_auth);
229 #ifdef CONFIG_SECURITY
230 new->security = NULL;
233 new->ucounts = get_ucounts(new->ucounts);
237 if (security_prepare_creds(new, old, GFP_KERNEL_ACCOUNT) < 0)
246 EXPORT_SYMBOL(prepare_creds);
249 * Prepare credentials for current to perform an execve()
250 * - The caller must hold ->cred_guard_mutex
252 struct cred *prepare_exec_creds(void)
256 new = prepare_creds();
261 /* newly exec'd tasks don't get a thread keyring */
262 key_put(new->thread_keyring);
263 new->thread_keyring = NULL;
265 /* inherit the session keyring; new process keyring */
266 key_put(new->process_keyring);
267 new->process_keyring = NULL;
270 new->suid = new->fsuid = new->euid;
271 new->sgid = new->fsgid = new->egid;
277 * Copy credentials for the new process created by fork()
279 * We share if we can, but under some circumstances we have to generate a new
282 * The new process gets the current process's subjective credentials as its
283 * objective and subjective credentials
285 int copy_creds(struct task_struct *p, unsigned long clone_flags)
290 #ifdef CONFIG_KEYS_REQUEST_CACHE
291 p->cached_requested_key = NULL;
296 !p->cred->thread_keyring &&
298 clone_flags & CLONE_THREAD
300 p->real_cred = get_cred(p->cred);
302 kdebug("share_creds(%p{%ld})",
303 p->cred, atomic_long_read(&p->cred->usage));
304 inc_rlimit_ucounts(task_ucounts(p), UCOUNT_RLIMIT_NPROC, 1);
308 new = prepare_creds();
312 if (clone_flags & CLONE_NEWUSER) {
313 ret = create_user_ns(new);
316 ret = set_cred_ucounts(new);
322 /* new threads get their own thread keyrings if their parent already
324 if (new->thread_keyring) {
325 key_put(new->thread_keyring);
326 new->thread_keyring = NULL;
327 if (clone_flags & CLONE_THREAD)
328 install_thread_keyring_to_cred(new);
331 /* The process keyring is only shared between the threads in a process;
332 * anything outside of those threads doesn't inherit.
334 if (!(clone_flags & CLONE_THREAD)) {
335 key_put(new->process_keyring);
336 new->process_keyring = NULL;
340 p->cred = p->real_cred = get_cred(new);
341 inc_rlimit_ucounts(task_ucounts(p), UCOUNT_RLIMIT_NPROC, 1);
349 static bool cred_cap_issubset(const struct cred *set, const struct cred *subset)
351 const struct user_namespace *set_ns = set->user_ns;
352 const struct user_namespace *subset_ns = subset->user_ns;
354 /* If the two credentials are in the same user namespace see if
355 * the capabilities of subset are a subset of set.
357 if (set_ns == subset_ns)
358 return cap_issubset(subset->cap_permitted, set->cap_permitted);
360 /* The credentials are in a different user namespaces
361 * therefore one is a subset of the other only if a set is an
362 * ancestor of subset and set->euid is owner of subset or one
363 * of subsets ancestors.
365 for (;subset_ns != &init_user_ns; subset_ns = subset_ns->parent) {
366 if ((set_ns == subset_ns->parent) &&
367 uid_eq(subset_ns->owner, set->euid))
375 * commit_creds - Install new credentials upon the current task
376 * @new: The credentials to be assigned
378 * Install a new set of credentials to the current task, using RCU to replace
379 * the old set. Both the objective and the subjective credentials pointers are
380 * updated. This function may not be called if the subjective credentials are
381 * in an overridden state.
383 * This function eats the caller's reference to the new credentials.
385 * Always returns 0 thus allowing this function to be tail-called at the end
386 * of, say, sys_setgid().
388 int commit_creds(struct cred *new)
390 struct task_struct *task = current;
391 const struct cred *old = task->real_cred;
393 kdebug("commit_creds(%p{%ld})", new,
394 atomic_long_read(&new->usage));
396 BUG_ON(task->cred != old);
397 BUG_ON(atomic_long_read(&new->usage) < 1);
399 get_cred(new); /* we will require a ref for the subj creds too */
401 /* dumpability changes */
402 if (!uid_eq(old->euid, new->euid) ||
403 !gid_eq(old->egid, new->egid) ||
404 !uid_eq(old->fsuid, new->fsuid) ||
405 !gid_eq(old->fsgid, new->fsgid) ||
406 !cred_cap_issubset(old, new)) {
408 set_dumpable(task->mm, suid_dumpable);
409 task->pdeath_signal = 0;
411 * If a task drops privileges and becomes nondumpable,
412 * the dumpability change must become visible before
413 * the credential change; otherwise, a __ptrace_may_access()
414 * racing with this change may be able to attach to a task it
415 * shouldn't be able to attach to (as if the task had dropped
416 * privileges without becoming nondumpable).
417 * Pairs with a read barrier in __ptrace_may_access().
422 /* alter the thread keyring */
423 if (!uid_eq(new->fsuid, old->fsuid))
424 key_fsuid_changed(new);
425 if (!gid_eq(new->fsgid, old->fsgid))
426 key_fsgid_changed(new);
429 * RLIMIT_NPROC limits on user->processes have already been checked
432 if (new->user != old->user || new->user_ns != old->user_ns)
433 inc_rlimit_ucounts(new->ucounts, UCOUNT_RLIMIT_NPROC, 1);
434 rcu_assign_pointer(task->real_cred, new);
435 rcu_assign_pointer(task->cred, new);
436 if (new->user != old->user || new->user_ns != old->user_ns)
437 dec_rlimit_ucounts(old->ucounts, UCOUNT_RLIMIT_NPROC, 1);
439 /* send notifications */
440 if (!uid_eq(new->uid, old->uid) ||
441 !uid_eq(new->euid, old->euid) ||
442 !uid_eq(new->suid, old->suid) ||
443 !uid_eq(new->fsuid, old->fsuid))
444 proc_id_connector(task, PROC_EVENT_UID);
446 if (!gid_eq(new->gid, old->gid) ||
447 !gid_eq(new->egid, old->egid) ||
448 !gid_eq(new->sgid, old->sgid) ||
449 !gid_eq(new->fsgid, old->fsgid))
450 proc_id_connector(task, PROC_EVENT_GID);
452 /* release the old obj and subj refs both */
457 EXPORT_SYMBOL(commit_creds);
460 * abort_creds - Discard a set of credentials and unlock the current task
461 * @new: The credentials that were going to be applied
463 * Discard a set of credentials that were under construction and unlock the
466 void abort_creds(struct cred *new)
468 kdebug("abort_creds(%p{%ld})", new,
469 atomic_long_read(&new->usage));
471 BUG_ON(atomic_long_read(&new->usage) < 1);
474 EXPORT_SYMBOL(abort_creds);
477 * override_creds - Override the current process's subjective credentials
478 * @new: The credentials to be assigned
480 * Install a set of temporary override subjective credentials on the current
481 * process, returning the old set for later reversion.
483 const struct cred *override_creds(const struct cred *new)
485 const struct cred *old = current->cred;
487 kdebug("override_creds(%p{%ld})", new,
488 atomic_long_read(&new->usage));
491 * NOTE! This uses 'get_new_cred()' rather than 'get_cred()'.
493 * That means that we do not clear the 'non_rcu' flag, since
494 * we are only installing the cred into the thread-synchronous
495 * '->cred' pointer, not the '->real_cred' pointer that is
496 * visible to other threads under RCU.
498 get_new_cred((struct cred *)new);
499 rcu_assign_pointer(current->cred, new);
501 kdebug("override_creds() = %p{%ld}", old,
502 atomic_long_read(&old->usage));
505 EXPORT_SYMBOL(override_creds);
508 * revert_creds - Revert a temporary subjective credentials override
509 * @old: The credentials to be restored
511 * Revert a temporary set of override subjective credentials to an old set,
512 * discarding the override set.
514 void revert_creds(const struct cred *old)
516 const struct cred *override = current->cred;
518 kdebug("revert_creds(%p{%ld})", old,
519 atomic_long_read(&old->usage));
521 rcu_assign_pointer(current->cred, old);
524 EXPORT_SYMBOL(revert_creds);
527 * cred_fscmp - Compare two credentials with respect to filesystem access.
528 * @a: The first credential
529 * @b: The second credential
531 * cred_cmp() will return zero if both credentials have the same
532 * fsuid, fsgid, and supplementary groups. That is, if they will both
533 * provide the same access to files based on mode/uid/gid.
534 * If the credentials are different, then either -1 or 1 will
535 * be returned depending on whether @a comes before or after @b
536 * respectively in an arbitrary, but stable, ordering of credentials.
538 * Return: -1, 0, or 1 depending on comparison
540 int cred_fscmp(const struct cred *a, const struct cred *b)
542 struct group_info *ga, *gb;
547 if (uid_lt(a->fsuid, b->fsuid))
549 if (uid_gt(a->fsuid, b->fsuid))
552 if (gid_lt(a->fsgid, b->fsgid))
554 if (gid_gt(a->fsgid, b->fsgid))
565 if (ga->ngroups < gb->ngroups)
567 if (ga->ngroups > gb->ngroups)
570 for (g = 0; g < ga->ngroups; g++) {
571 if (gid_lt(ga->gid[g], gb->gid[g]))
573 if (gid_gt(ga->gid[g], gb->gid[g]))
578 EXPORT_SYMBOL(cred_fscmp);
580 int set_cred_ucounts(struct cred *new)
582 struct ucounts *new_ucounts, *old_ucounts = new->ucounts;
585 * This optimization is needed because alloc_ucounts() uses locks
588 if (old_ucounts->ns == new->user_ns && uid_eq(old_ucounts->uid, new->uid))
591 if (!(new_ucounts = alloc_ucounts(new->user_ns, new->uid)))
594 new->ucounts = new_ucounts;
595 put_ucounts(old_ucounts);
601 * initialise the credentials stuff
603 void __init cred_init(void)
605 /* allocate a slab in which we can store credentials */
606 cred_jar = kmem_cache_create("cred_jar", sizeof(struct cred), 0,
607 SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
611 * prepare_kernel_cred - Prepare a set of credentials for a kernel service
612 * @daemon: A userspace daemon to be used as a reference
614 * Prepare a set of credentials for a kernel service. This can then be used to
615 * override a task's own credentials so that work can be done on behalf of that
616 * task that requires a different subjective context.
618 * @daemon is used to provide a base cred, with the security data derived from
619 * that; if this is "&init_task", they'll be set to 0, no groups, full
620 * capabilities, and no keys.
622 * The caller may change these controls afterwards if desired.
624 * Returns the new credentials or NULL if out of memory.
626 struct cred *prepare_kernel_cred(struct task_struct *daemon)
628 const struct cred *old;
631 if (WARN_ON_ONCE(!daemon))
634 new = kmem_cache_alloc(cred_jar, GFP_KERNEL);
638 kdebug("prepare_kernel_cred() alloc %p", new);
640 old = get_task_cred(daemon);
644 atomic_long_set(&new->usage, 1);
646 get_user_ns(new->user_ns);
647 get_group_info(new->group_info);
650 new->session_keyring = NULL;
651 new->process_keyring = NULL;
652 new->thread_keyring = NULL;
653 new->request_key_auth = NULL;
654 new->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
657 #ifdef CONFIG_SECURITY
658 new->security = NULL;
660 new->ucounts = get_ucounts(new->ucounts);
664 if (security_prepare_creds(new, old, GFP_KERNEL_ACCOUNT) < 0)
675 EXPORT_SYMBOL(prepare_kernel_cred);
678 * set_security_override - Set the security ID in a set of credentials
679 * @new: The credentials to alter
680 * @secid: The LSM security ID to set
682 * Set the LSM security ID in a set of credentials so that the subjective
683 * security is overridden when an alternative set of credentials is used.
685 int set_security_override(struct cred *new, u32 secid)
687 return security_kernel_act_as(new, secid);
689 EXPORT_SYMBOL(set_security_override);
692 * set_security_override_from_ctx - Set the security ID in a set of credentials
693 * @new: The credentials to alter
694 * @secctx: The LSM security context to generate the security ID from.
696 * Set the LSM security ID in a set of credentials so that the subjective
697 * security is overridden when an alternative set of credentials is used. The
698 * security ID is specified in string form as a security context to be
699 * interpreted by the LSM.
701 int set_security_override_from_ctx(struct cred *new, const char *secctx)
706 ret = security_secctx_to_secid(secctx, strlen(secctx), &secid);
710 return set_security_override(new, secid);
712 EXPORT_SYMBOL(set_security_override_from_ctx);
715 * set_create_files_as - Set the LSM file create context in a set of credentials
716 * @new: The credentials to alter
717 * @inode: The inode to take the context from
719 * Change the LSM file creation context in a set of credentials to be the same
720 * as the object context of the specified inode, so that the new inodes have
721 * the same MAC context as that inode.
723 int set_create_files_as(struct cred *new, struct inode *inode)
725 if (!uid_valid(inode->i_uid) || !gid_valid(inode->i_gid))
727 new->fsuid = inode->i_uid;
728 new->fsgid = inode->i_gid;
729 return security_kernel_create_files_as(new, inode);
731 EXPORT_SYMBOL(set_create_files_as);