]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - include/linux/cred.h
cred: switch to using atomic_long_t
[thirdparty/kernel/stable.git] / include / linux / cred.h
CommitLineData
af777cd1 1/* Credentials management - see Documentation/security/credentials.rst
9e2b2dc4
DH
2 *
3 * Copyright (C) 2008 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
10 */
11
12#ifndef _LINUX_CRED_H
13#define _LINUX_CRED_H
14
b6dff3ec 15#include <linux/capability.h>
b2e1feaf 16#include <linux/init.h>
b6dff3ec 17#include <linux/key.h>
ed868a56 18#include <linux/selinux.h>
60063497 19#include <linux/atomic.h>
ae2975bc 20#include <linux/uidgid.h>
5b825c3a 21#include <linux/sched.h>
8703e8a4 22#include <linux/sched/user.h>
b6dff3ec 23
b6dff3ec 24struct cred;
3a3b7ce9 25struct inode;
b6dff3ec
DH
26
27/*
28 * COW Supplementary groups list
29 */
b6dff3ec
DH
30struct group_info {
31 atomic_t usage;
32 int ngroups;
81243eac 33 kgid_t gid[0];
3859a271 34} __randomize_layout;
b6dff3ec
DH
35
36/**
37 * get_group_info - Get a reference to a group info structure
38 * @group_info: The group info to reference
39 *
86a264ab
DH
40 * This gets a reference to a set of supplementary groups.
41 *
42 * If the caller is accessing a task's credentials, they must hold the RCU read
43 * lock when reading.
b6dff3ec 44 */
86a264ab
DH
45static inline struct group_info *get_group_info(struct group_info *gi)
46{
47 atomic_inc(&gi->usage);
48 return gi;
49}
b6dff3ec
DH
50
51/**
52 * put_group_info - Release a reference to a group info structure
53 * @group_info: The group info to release
54 */
55#define put_group_info(group_info) \
56do { \
57 if (atomic_dec_and_test(&(group_info)->usage)) \
58 groups_free(group_info); \
59} while (0)
60
18b6e041 61extern struct group_info init_groups;
2813893f
IM
62#ifdef CONFIG_MULTIUSER
63extern struct group_info *groups_alloc(int);
b6dff3ec 64extern void groups_free(struct group_info *);
2813893f
IM
65
66extern int in_group_p(kgid_t);
67extern int in_egroup_p(kgid_t);
68#else
69static inline void groups_free(struct group_info *group_info)
70{
71}
72
73static inline int in_group_p(kgid_t grp)
74{
75 return 1;
76}
77static inline int in_egroup_p(kgid_t grp)
78{
79 return 1;
80}
81#endif
b6dff3ec 82extern int set_current_groups(struct group_info *);
8f6c5ffc 83extern void set_groups(struct cred *, struct group_info *);
ae2975bc 84extern int groups_search(const struct group_info *, kgid_t);
7ff4d90b 85extern bool may_setgroups(void);
c5d9b78d 86extern void groups_sort(struct group_info *);
b6dff3ec 87
b6dff3ec
DH
88/*
89 * The security context of a task
90 *
91 * The parts of the context break down into two categories:
92 *
93 * (1) The objective context of a task. These parts are used when some other
94 * task is attempting to affect this one.
95 *
96 * (2) The subjective context. These details are used when the task is acting
97 * upon another object, be that a file, a task, a key or whatever.
98 *
99 * Note that some members of this structure belong to both categories - the
100 * LSM security pointer for instance.
101 *
102 * A task has two security pointers. task->real_cred points to the objective
103 * context that defines that task's actual details. The objective part of this
104 * context is used whenever that task is acted upon.
105 *
106 * task->cred points to the subjective context that defines the details of how
107 * that task is going to act upon another object. This may be overridden
108 * temporarily to point to another security context, but normally points to the
109 * same context as task->real_cred.
110 */
111struct cred {
eac54659 112 atomic_long_t usage;
e0e81739
DH
113#ifdef CONFIG_DEBUG_CREDENTIALS
114 atomic_t subscribers; /* number of processes subscribed */
115 void *put_addr;
116 unsigned magic;
117#define CRED_MAGIC 0x43736564
118#define CRED_MAGIC_DEAD 0x44656144
119#endif
078de5f7
EB
120 kuid_t uid; /* real UID of the task */
121 kgid_t gid; /* real GID of the task */
122 kuid_t suid; /* saved UID of the task */
123 kgid_t sgid; /* saved GID of the task */
124 kuid_t euid; /* effective UID of the task */
125 kgid_t egid; /* effective GID of the task */
126 kuid_t fsuid; /* UID for VFS ops */
127 kgid_t fsgid; /* GID for VFS ops */
b6dff3ec
DH
128 unsigned securebits; /* SUID-less security management */
129 kernel_cap_t cap_inheritable; /* caps our children can inherit */
130 kernel_cap_t cap_permitted; /* caps we're permitted */
131 kernel_cap_t cap_effective; /* caps we can actually use */
132 kernel_cap_t cap_bset; /* capability bounding set */
58319057 133 kernel_cap_t cap_ambient; /* Ambient capability set */
b6dff3ec
DH
134#ifdef CONFIG_KEYS
135 unsigned char jit_keyring; /* default keyring to attach requested
136 * keys to */
3a50597d
DH
137 struct key __rcu *session_keyring; /* keyring inherited over fork */
138 struct key *process_keyring; /* keyring private to this process */
b6dff3ec
DH
139 struct key *thread_keyring; /* keyring private to this thread */
140 struct key *request_key_auth; /* assumed request_key authority */
141#endif
142#ifdef CONFIG_SECURITY
143 void *security; /* subjective LSM security */
144#endif
145 struct user_struct *user; /* real user ID subscription */
0093ccb6 146 struct user_namespace *user_ns; /* user_ns the caps and keyrings are relative to. */
b6dff3ec 147 struct group_info *group_info; /* supplementary groups for euid/fsgid */
8b941011
LT
148 /* RCU deletion */
149 union {
150 int non_rcu; /* Can we skip RCU deletion? */
151 struct rcu_head rcu; /* RCU deletion hook */
152 };
3859a271 153} __randomize_layout;
b6dff3ec 154
f1752eec 155extern void __put_cred(struct cred *);
e0e81739 156extern void exit_creds(struct task_struct *);
f1752eec 157extern int copy_creds(struct task_struct *, unsigned long);
de09a977 158extern const struct cred *get_task_cred(struct task_struct *);
ee18d64c 159extern struct cred *cred_alloc_blank(void);
d84f4f99 160extern struct cred *prepare_creds(void);
a6f76f23 161extern struct cred *prepare_exec_creds(void);
d84f4f99
DH
162extern int commit_creds(struct cred *);
163extern void abort_creds(struct cred *);
3b11a1de
DH
164extern const struct cred *override_creds(const struct cred *);
165extern void revert_creds(const struct cred *);
3a3b7ce9
DH
166extern struct cred *prepare_kernel_cred(struct task_struct *);
167extern int change_create_files_as(struct cred *, struct inode *);
168extern int set_security_override(struct cred *, u32);
169extern int set_security_override_from_ctx(struct cred *, const char *);
170extern int set_create_files_as(struct cred *, struct inode *);
d84f4f99
DH
171extern void __init cred_init(void);
172
e0e81739
DH
173/*
174 * check for validity of credentials
175 */
176#ifdef CONFIG_DEBUG_CREDENTIALS
177extern void __invalid_creds(const struct cred *, const char *, unsigned);
178extern void __validate_process_creds(struct task_struct *,
179 const char *, unsigned);
180
74908a00 181extern bool creds_are_invalid(const struct cred *cred);
e0e81739
DH
182
183static inline void __validate_creds(const struct cred *cred,
184 const char *file, unsigned line)
185{
186 if (unlikely(creds_are_invalid(cred)))
187 __invalid_creds(cred, file, line);
188}
189
190#define validate_creds(cred) \
191do { \
192 __validate_creds((cred), __FILE__, __LINE__); \
193} while(0)
194
195#define validate_process_creds() \
196do { \
197 __validate_process_creds(current, __FILE__, __LINE__); \
198} while(0)
199
200extern void validate_creds_for_do_exit(struct task_struct *);
201#else
202static inline void validate_creds(const struct cred *cred)
203{
204}
205static inline void validate_creds_for_do_exit(struct task_struct *tsk)
206{
207}
208static inline void validate_process_creds(void)
209{
210}
211#endif
212
58319057
AL
213static inline bool cap_ambient_invariant_ok(const struct cred *cred)
214{
215 return cap_issubset(cred->cap_ambient,
216 cap_intersect(cred->cap_permitted,
217 cred->cap_inheritable));
218}
219
d84f4f99
DH
220/**
221 * get_new_cred - Get a reference on a new set of credentials
222 * @cred: The new credentials to reference
223 *
224 * Get a reference on the specified set of new credentials. The caller must
225 * release the reference.
226 */
227static inline struct cred *get_new_cred(struct cred *cred)
228{
eac54659 229 atomic_long_inc(&cred->usage);
d84f4f99
DH
230 return cred;
231}
f1752eec
DH
232
233/**
234 * get_cred - Get a reference on a set of credentials
235 * @cred: The credentials to reference
236 *
237 * Get a reference on the specified set of credentials. The caller must
babe2c4a 238 * release the reference. If %NULL is passed, it is returned with no action.
98870ab0
DH
239 *
240 * This is used to deal with a committed set of credentials. Although the
241 * pointer is const, this will temporarily discard the const and increment the
242 * usage count. The purpose of this is to attempt to catch at compile time the
243 * accidental alteration of a set of credentials that should be considered
244 * immutable.
f1752eec 245 */
d84f4f99 246static inline const struct cred *get_cred(const struct cred *cred)
f1752eec 247{
1c388ad0 248 struct cred *nonconst_cred = (struct cred *) cred;
babe2c4a
N
249 if (!cred)
250 return cred;
e0e81739 251 validate_creds(cred);
8b941011 252 nonconst_cred->non_rcu = 0;
1c388ad0 253 return get_new_cred(nonconst_cred);
f1752eec
DH
254}
255
256/**
257 * put_cred - Release a reference to a set of credentials
258 * @cred: The credentials to release
259 *
260 * Release a reference to a set of credentials, deleting them when the last ref
babe2c4a 261 * is released. If %NULL is passed, nothing is done.
98870ab0
DH
262 *
263 * This takes a const pointer to a set of credentials because the credentials
264 * on task_struct are attached by const pointers to prevent accidental
265 * alteration of otherwise immutable credential sets.
f1752eec 266 */
c69e8d9c 267static inline void put_cred(const struct cred *_cred)
f1752eec 268{
c69e8d9c 269 struct cred *cred = (struct cred *) _cred;
d84f4f99 270
babe2c4a
N
271 if (cred) {
272 validate_creds(cred);
eac54659 273 if (atomic_long_dec_and_test(&(cred)->usage))
babe2c4a
N
274 __put_cred(cred);
275 }
f1752eec
DH
276}
277
86a264ab 278/**
3b11a1de 279 * current_cred - Access the current task's subjective credentials
86a264ab 280 *
32955148
AV
281 * Access the subjective credentials of the current task. RCU-safe,
282 * since nobody else can modify it.
86a264ab
DH
283 */
284#define current_cred() \
27e4e436 285 rcu_dereference_protected(current->cred, 1)
86a264ab 286
ae4b884f
JL
287/**
288 * current_real_cred - Access the current task's objective credentials
289 *
290 * Access the objective credentials of the current task. RCU-safe,
291 * since nobody else can modify it.
292 */
293#define current_real_cred() \
294 rcu_dereference_protected(current->real_cred, 1)
295
86a264ab 296/**
3b11a1de 297 * __task_cred - Access a task's objective credentials
86a264ab
DH
298 * @task: The task to query
299 *
3b11a1de 300 * Access the objective credentials of a task. The caller must hold the RCU
43e13cc1 301 * readlock.
86a264ab 302 *
8f92054e
DH
303 * The result of this function should not be passed directly to get_cred();
304 * rather get_task_cred() should be used instead.
86a264ab 305 */
43e13cc1
ON
306#define __task_cred(task) \
307 rcu_dereference((task)->real_cred)
86a264ab 308
86a264ab 309/**
3b11a1de 310 * get_current_cred - Get the current task's subjective credentials
86a264ab 311 *
3b11a1de
DH
312 * Get the subjective credentials of the current task, pinning them so that
313 * they can't go away. Accessing the current task's credentials directly is
314 * not permitted.
86a264ab
DH
315 */
316#define get_current_cred() \
317 (get_cred(current_cred()))
318
319/**
320 * get_current_user - Get the current task's user_struct
321 *
322 * Get the user record of the current task, pinning it so that it can't go
323 * away.
324 */
325#define get_current_user() \
326({ \
327 struct user_struct *__u; \
638a8439 328 const struct cred *__cred; \
32955148 329 __cred = current_cred(); \
86a264ab
DH
330 __u = get_uid(__cred->user); \
331 __u; \
332})
333
334/**
335 * get_current_groups - Get the current task's supplementary group list
336 *
337 * Get the supplementary group list of the current task, pinning it so that it
338 * can't go away.
339 */
340#define get_current_groups() \
341({ \
342 struct group_info *__groups; \
638a8439 343 const struct cred *__cred; \
32955148 344 __cred = current_cred(); \
86a264ab
DH
345 __groups = get_group_info(__cred->group_info); \
346 __groups; \
347})
348
d84f4f99
DH
349#define task_cred_xxx(task, xxx) \
350({ \
351 __typeof__(((struct cred *)NULL)->xxx) ___val; \
352 rcu_read_lock(); \
353 ___val = __task_cred((task))->xxx; \
354 rcu_read_unlock(); \
355 ___val; \
86a264ab
DH
356})
357
358#define task_uid(task) (task_cred_xxx((task), uid))
359#define task_euid(task) (task_cred_xxx((task), euid))
360
361#define current_cred_xxx(xxx) \
362({ \
32955148 363 current_cred()->xxx; \
86a264ab
DH
364})
365
366#define current_uid() (current_cred_xxx(uid))
367#define current_gid() (current_cred_xxx(gid))
368#define current_euid() (current_cred_xxx(euid))
369#define current_egid() (current_cred_xxx(egid))
370#define current_suid() (current_cred_xxx(suid))
371#define current_sgid() (current_cred_xxx(sgid))
372#define current_fsuid() (current_cred_xxx(fsuid))
373#define current_fsgid() (current_cred_xxx(fsgid))
374#define current_cap() (current_cred_xxx(cap_effective))
375#define current_user() (current_cred_xxx(user))
376#define current_security() (current_cred_xxx(security))
377
7e6bd8fa 378extern struct user_namespace init_user_ns;
47a150ed 379#ifdef CONFIG_USER_NS
f1c84dae 380#define current_user_ns() (current_cred_xxx(user_ns))
47a150ed 381#else
0335695d
AB
382static inline struct user_namespace *current_user_ns(void)
383{
384 return &init_user_ns;
385}
47a150ed
SH
386#endif
387
3486740a 388
86a264ab
DH
389#define current_uid_gid(_uid, _gid) \
390do { \
391 const struct cred *__cred; \
392 __cred = current_cred(); \
393 *(_uid) = __cred->uid; \
394 *(_gid) = __cred->gid; \
395} while(0)
396
397#define current_euid_egid(_euid, _egid) \
398do { \
399 const struct cred *__cred; \
400 __cred = current_cred(); \
401 *(_euid) = __cred->euid; \
402 *(_egid) = __cred->egid; \
403} while(0)
404
405#define current_fsuid_fsgid(_fsuid, _fsgid) \
406do { \
407 const struct cred *__cred; \
408 __cred = current_cred(); \
409 *(_fsuid) = __cred->fsuid; \
410 *(_fsgid) = __cred->fsgid; \
411} while(0)
412
9e2b2dc4 413#endif /* _LINUX_CRED_H */