selinux: Support for the new TUN LSM hooks
[linux-block.git] / include / linux / cred.h
CommitLineData
98870ab0 1/* Credentials management - see Documentation/credentials.txt
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
DH
17#include <linux/key.h>
18#include <asm/atomic.h>
19
20struct user_struct;
21struct cred;
3a3b7ce9 22struct inode;
b6dff3ec
DH
23
24/*
25 * COW Supplementary groups list
26 */
27#define NGROUPS_SMALL 32
28#define NGROUPS_PER_BLOCK ((unsigned int)(PAGE_SIZE / sizeof(gid_t)))
29
30struct group_info {
31 atomic_t usage;
32 int ngroups;
33 int nblocks;
34 gid_t small_block[NGROUPS_SMALL];
35 gid_t *blocks[0];
36};
37
38/**
39 * get_group_info - Get a reference to a group info structure
40 * @group_info: The group info to reference
41 *
86a264ab
DH
42 * This gets a reference to a set of supplementary groups.
43 *
44 * If the caller is accessing a task's credentials, they must hold the RCU read
45 * lock when reading.
b6dff3ec 46 */
86a264ab
DH
47static inline struct group_info *get_group_info(struct group_info *gi)
48{
49 atomic_inc(&gi->usage);
50 return gi;
51}
b6dff3ec
DH
52
53/**
54 * put_group_info - Release a reference to a group info structure
55 * @group_info: The group info to release
56 */
57#define put_group_info(group_info) \
58do { \
59 if (atomic_dec_and_test(&(group_info)->usage)) \
60 groups_free(group_info); \
61} while (0)
62
63extern struct group_info *groups_alloc(int);
18b6e041 64extern struct group_info init_groups;
b6dff3ec
DH
65extern void groups_free(struct group_info *);
66extern int set_current_groups(struct group_info *);
67extern int set_groups(struct cred *, struct group_info *);
86a264ab 68extern int groups_search(const struct group_info *, gid_t);
b6dff3ec
DH
69
70/* access the groups "array" with this macro */
71#define GROUP_AT(gi, i) \
72 ((gi)->blocks[(i) / NGROUPS_PER_BLOCK][(i) % NGROUPS_PER_BLOCK])
73
74extern int in_group_p(gid_t);
75extern int in_egroup_p(gid_t);
76
bb952bb9
DH
77/*
78 * The common credentials for a thread group
79 * - shared by CLONE_THREAD
80 */
81#ifdef CONFIG_KEYS
82struct thread_group_cred {
83 atomic_t usage;
84 pid_t tgid; /* thread group process ID */
85 spinlock_t lock;
86 struct key *session_keyring; /* keyring inherited over fork */
87 struct key *process_keyring; /* keyring private to this process */
88 struct rcu_head rcu; /* RCU deletion hook */
89};
90#endif
91
b6dff3ec
DH
92/*
93 * The security context of a task
94 *
95 * The parts of the context break down into two categories:
96 *
97 * (1) The objective context of a task. These parts are used when some other
98 * task is attempting to affect this one.
99 *
100 * (2) The subjective context. These details are used when the task is acting
101 * upon another object, be that a file, a task, a key or whatever.
102 *
103 * Note that some members of this structure belong to both categories - the
104 * LSM security pointer for instance.
105 *
106 * A task has two security pointers. task->real_cred points to the objective
107 * context that defines that task's actual details. The objective part of this
108 * context is used whenever that task is acted upon.
109 *
110 * task->cred points to the subjective context that defines the details of how
111 * that task is going to act upon another object. This may be overridden
112 * temporarily to point to another security context, but normally points to the
113 * same context as task->real_cred.
114 */
115struct cred {
116 atomic_t usage;
117 uid_t uid; /* real UID of the task */
118 gid_t gid; /* real GID of the task */
119 uid_t suid; /* saved UID of the task */
120 gid_t sgid; /* saved GID of the task */
121 uid_t euid; /* effective UID of the task */
122 gid_t egid; /* effective GID of the task */
123 uid_t fsuid; /* UID for VFS ops */
124 gid_t fsgid; /* GID for VFS ops */
125 unsigned securebits; /* SUID-less security management */
126 kernel_cap_t cap_inheritable; /* caps our children can inherit */
127 kernel_cap_t cap_permitted; /* caps we're permitted */
128 kernel_cap_t cap_effective; /* caps we can actually use */
129 kernel_cap_t cap_bset; /* capability bounding set */
130#ifdef CONFIG_KEYS
131 unsigned char jit_keyring; /* default keyring to attach requested
132 * keys to */
133 struct key *thread_keyring; /* keyring private to this thread */
134 struct key *request_key_auth; /* assumed request_key authority */
bb952bb9 135 struct thread_group_cred *tgcred; /* thread-group shared credentials */
b6dff3ec
DH
136#endif
137#ifdef CONFIG_SECURITY
138 void *security; /* subjective LSM security */
139#endif
140 struct user_struct *user; /* real user ID subscription */
141 struct group_info *group_info; /* supplementary groups for euid/fsgid */
142 struct rcu_head rcu; /* RCU deletion hook */
b6dff3ec
DH
143};
144
f1752eec
DH
145extern void __put_cred(struct cred *);
146extern int copy_creds(struct task_struct *, unsigned long);
d84f4f99 147extern struct cred *prepare_creds(void);
a6f76f23 148extern struct cred *prepare_exec_creds(void);
d84f4f99
DH
149extern struct cred *prepare_usermodehelper_creds(void);
150extern int commit_creds(struct cred *);
151extern void abort_creds(struct cred *);
3b11a1de
DH
152extern const struct cred *override_creds(const struct cred *);
153extern void revert_creds(const struct cred *);
3a3b7ce9
DH
154extern struct cred *prepare_kernel_cred(struct task_struct *);
155extern int change_create_files_as(struct cred *, struct inode *);
156extern int set_security_override(struct cred *, u32);
157extern int set_security_override_from_ctx(struct cred *, const char *);
158extern int set_create_files_as(struct cred *, struct inode *);
d84f4f99
DH
159extern void __init cred_init(void);
160
161/**
162 * get_new_cred - Get a reference on a new set of credentials
163 * @cred: The new credentials to reference
164 *
165 * Get a reference on the specified set of new credentials. The caller must
166 * release the reference.
167 */
168static inline struct cred *get_new_cred(struct cred *cred)
169{
170 atomic_inc(&cred->usage);
171 return cred;
172}
f1752eec
DH
173
174/**
175 * get_cred - Get a reference on a set of credentials
176 * @cred: The credentials to reference
177 *
178 * Get a reference on the specified set of credentials. The caller must
179 * release the reference.
98870ab0
DH
180 *
181 * This is used to deal with a committed set of credentials. Although the
182 * pointer is const, this will temporarily discard the const and increment the
183 * usage count. The purpose of this is to attempt to catch at compile time the
184 * accidental alteration of a set of credentials that should be considered
185 * immutable.
f1752eec 186 */
d84f4f99 187static inline const struct cred *get_cred(const struct cred *cred)
f1752eec 188{
1c388ad0
PM
189 struct cred *nonconst_cred = (struct cred *) cred;
190 return get_new_cred(nonconst_cred);
f1752eec
DH
191}
192
193/**
194 * put_cred - Release a reference to a set of credentials
195 * @cred: The credentials to release
196 *
197 * Release a reference to a set of credentials, deleting them when the last ref
198 * is released.
98870ab0
DH
199 *
200 * This takes a const pointer to a set of credentials because the credentials
201 * on task_struct are attached by const pointers to prevent accidental
202 * alteration of otherwise immutable credential sets.
f1752eec 203 */
c69e8d9c 204static inline void put_cred(const struct cred *_cred)
f1752eec 205{
c69e8d9c 206 struct cred *cred = (struct cred *) _cred;
d84f4f99
DH
207
208 BUG_ON(atomic_read(&(cred)->usage) <= 0);
f1752eec
DH
209 if (atomic_dec_and_test(&(cred)->usage))
210 __put_cred(cred);
211}
212
86a264ab 213/**
3b11a1de 214 * current_cred - Access the current task's subjective credentials
86a264ab 215 *
3b11a1de 216 * Access the subjective credentials of the current task.
86a264ab
DH
217 */
218#define current_cred() \
219 (current->cred)
220
221/**
3b11a1de 222 * __task_cred - Access a task's objective credentials
86a264ab
DH
223 * @task: The task to query
224 *
3b11a1de
DH
225 * Access the objective credentials of a task. The caller must hold the RCU
226 * readlock.
86a264ab
DH
227 *
228 * The caller must make sure task doesn't go away, either by holding a ref on
229 * task or by holding tasklist_lock to prevent it from being unlinked.
230 */
231#define __task_cred(task) \
3b11a1de 232 ((const struct cred *)(rcu_dereference((task)->real_cred)))
86a264ab
DH
233
234/**
3b11a1de 235 * get_task_cred - Get another task's objective credentials
86a264ab
DH
236 * @task: The task to query
237 *
3b11a1de
DH
238 * Get the objective credentials of a task, pinning them so that they can't go
239 * away. Accessing a task's credentials directly is not permitted.
86a264ab
DH
240 *
241 * The caller must make sure task doesn't go away, either by holding a ref on
242 * task or by holding tasklist_lock to prevent it from being unlinked.
243 */
244#define get_task_cred(task) \
245({ \
246 struct cred *__cred; \
247 rcu_read_lock(); \
248 __cred = (struct cred *) __task_cred((task)); \
249 get_cred(__cred); \
250 rcu_read_unlock(); \
251 __cred; \
252})
253
254/**
3b11a1de 255 * get_current_cred - Get the current task's subjective credentials
86a264ab 256 *
3b11a1de
DH
257 * Get the subjective credentials of the current task, pinning them so that
258 * they can't go away. Accessing the current task's credentials directly is
259 * not permitted.
86a264ab
DH
260 */
261#define get_current_cred() \
262 (get_cred(current_cred()))
263
264/**
265 * get_current_user - Get the current task's user_struct
266 *
267 * Get the user record of the current task, pinning it so that it can't go
268 * away.
269 */
270#define get_current_user() \
271({ \
272 struct user_struct *__u; \
273 struct cred *__cred; \
274 __cred = (struct cred *) current_cred(); \
275 __u = get_uid(__cred->user); \
276 __u; \
277})
278
279/**
280 * get_current_groups - Get the current task's supplementary group list
281 *
282 * Get the supplementary group list of the current task, pinning it so that it
283 * can't go away.
284 */
285#define get_current_groups() \
286({ \
287 struct group_info *__groups; \
288 struct cred *__cred; \
289 __cred = (struct cred *) current_cred(); \
290 __groups = get_group_info(__cred->group_info); \
291 __groups; \
292})
293
d84f4f99
DH
294#define task_cred_xxx(task, xxx) \
295({ \
296 __typeof__(((struct cred *)NULL)->xxx) ___val; \
297 rcu_read_lock(); \
298 ___val = __task_cred((task))->xxx; \
299 rcu_read_unlock(); \
300 ___val; \
86a264ab
DH
301})
302
303#define task_uid(task) (task_cred_xxx((task), uid))
304#define task_euid(task) (task_cred_xxx((task), euid))
305
306#define current_cred_xxx(xxx) \
307({ \
308 current->cred->xxx; \
309})
310
311#define current_uid() (current_cred_xxx(uid))
312#define current_gid() (current_cred_xxx(gid))
313#define current_euid() (current_cred_xxx(euid))
314#define current_egid() (current_cred_xxx(egid))
315#define current_suid() (current_cred_xxx(suid))
316#define current_sgid() (current_cred_xxx(sgid))
317#define current_fsuid() (current_cred_xxx(fsuid))
318#define current_fsgid() (current_cred_xxx(fsgid))
319#define current_cap() (current_cred_xxx(cap_effective))
320#define current_user() (current_cred_xxx(user))
18b6e041 321#define current_user_ns() (current_cred_xxx(user)->user_ns)
86a264ab
DH
322#define current_security() (current_cred_xxx(security))
323
324#define current_uid_gid(_uid, _gid) \
325do { \
326 const struct cred *__cred; \
327 __cred = current_cred(); \
328 *(_uid) = __cred->uid; \
329 *(_gid) = __cred->gid; \
330} while(0)
331
332#define current_euid_egid(_euid, _egid) \
333do { \
334 const struct cred *__cred; \
335 __cred = current_cred(); \
336 *(_euid) = __cred->euid; \
337 *(_egid) = __cred->egid; \
338} while(0)
339
340#define current_fsuid_fsgid(_fsuid, _fsgid) \
341do { \
342 const struct cred *__cred; \
343 __cred = current_cred(); \
344 *(_fsuid) = __cred->fsuid; \
345 *(_fsgid) = __cred->fsgid; \
346} while(0)
347
9e2b2dc4 348#endif /* _LINUX_CRED_H */