capabilities: introduce per-process capability bounding set
[linux-2.6.git] / include / linux / capability.h
1 /*
2  * This is <linux/capability.h>
3  *
4  * Andrew G. Morgan <morgan@kernel.org>
5  * Alexander Kjeldaas <astor@guardian.no>
6  * with help from Aleph1, Roland Buresund and Andrew Main.
7  *
8  * See here for the libcap library ("POSIX draft" compliance):
9  *
10  * ftp://linux.kernel.org/pub/linux/libs/security/linux-privs/kernel-2.6/
11  */
12
13 #ifndef _LINUX_CAPABILITY_H
14 #define _LINUX_CAPABILITY_H
15
16 #include <linux/types.h>
17
18 struct task_struct;
19
20 /* User-level do most of the mapping between kernel and user
21    capabilities based on the version tag given by the kernel. The
22    kernel might be somewhat backwards compatible, but don't bet on
23    it. */
24
25 /* Note, cap_t, is defined by POSIX (draft) to be an "opaque" pointer to
26    a set of three capability sets.  The transposition of 3*the
27    following structure to such a composite is better handled in a user
28    library since the draft standard requires the use of malloc/free
29    etc.. */
30
31 #define _LINUX_CAPABILITY_VERSION_1  0x19980330
32 #define _LINUX_CAPABILITY_U32S_1     1
33
34 #define _LINUX_CAPABILITY_VERSION_2  0x20071026
35 #define _LINUX_CAPABILITY_U32S_2     2
36
37 #define _LINUX_CAPABILITY_VERSION    _LINUX_CAPABILITY_VERSION_2
38 #define _LINUX_CAPABILITY_U32S       _LINUX_CAPABILITY_U32S_2
39
40 typedef struct __user_cap_header_struct {
41         __u32 version;
42         int pid;
43 } __user *cap_user_header_t;
44
45 typedef struct __user_cap_data_struct {
46         __u32 effective;
47         __u32 permitted;
48         __u32 inheritable;
49 } __user *cap_user_data_t;
50
51
52 #define XATTR_CAPS_SUFFIX "capability"
53 #define XATTR_NAME_CAPS XATTR_SECURITY_PREFIX XATTR_CAPS_SUFFIX
54
55 #define VFS_CAP_REVISION_MASK   0xFF000000
56 #define VFS_CAP_FLAGS_MASK      ~VFS_CAP_REVISION_MASK
57 #define VFS_CAP_FLAGS_EFFECTIVE 0x000001
58
59 #define VFS_CAP_REVISION_1      0x01000000
60 #define VFS_CAP_U32_1           1
61 #define XATTR_CAPS_SZ_1         (sizeof(__le32)*(1 + 2*VFS_CAP_U32_1))
62
63 #define VFS_CAP_REVISION_2      0x02000000
64 #define VFS_CAP_U32_2           2
65 #define XATTR_CAPS_SZ_2         (sizeof(__le32)*(1 + 2*VFS_CAP_U32_2))
66
67 #define XATTR_CAPS_SZ           XATTR_CAPS_SZ_2
68 #define VFS_CAP_U32             VFS_CAP_U32_2
69 #define VFS_CAP_REVISION        VFS_CAP_REVISION_2
70
71
72 struct vfs_cap_data {
73         __le32 magic_etc;            /* Little endian */
74         struct {
75                 __le32 permitted;    /* Little endian */
76                 __le32 inheritable;  /* Little endian */
77         } data[VFS_CAP_U32];
78 };
79
80 #ifdef __KERNEL__
81
82 typedef struct kernel_cap_struct {
83         __u32 cap[_LINUX_CAPABILITY_U32S];
84 } kernel_cap_t;
85
86 #define _USER_CAP_HEADER_SIZE  (sizeof(struct __user_cap_header_struct))
87 #define _KERNEL_CAP_T_SIZE     (sizeof(kernel_cap_t))
88
89 #endif
90
91
92 /**
93  ** POSIX-draft defined capabilities.
94  **/
95
96 /* In a system with the [_POSIX_CHOWN_RESTRICTED] option defined, this
97    overrides the restriction of changing file ownership and group
98    ownership. */
99
100 #define CAP_CHOWN            0
101
102 /* Override all DAC access, including ACL execute access if
103    [_POSIX_ACL] is defined. Excluding DAC access covered by
104    CAP_LINUX_IMMUTABLE. */
105
106 #define CAP_DAC_OVERRIDE     1
107
108 /* Overrides all DAC restrictions regarding read and search on files
109    and directories, including ACL restrictions if [_POSIX_ACL] is
110    defined. Excluding DAC access covered by CAP_LINUX_IMMUTABLE. */
111
112 #define CAP_DAC_READ_SEARCH  2
113
114 /* Overrides all restrictions about allowed operations on files, where
115    file owner ID must be equal to the user ID, except where CAP_FSETID
116    is applicable. It doesn't override MAC and DAC restrictions. */
117
118 #define CAP_FOWNER           3
119
120 /* Overrides the following restrictions that the effective user ID
121    shall match the file owner ID when setting the S_ISUID and S_ISGID
122    bits on that file; that the effective group ID (or one of the
123    supplementary group IDs) shall match the file owner ID when setting
124    the S_ISGID bit on that file; that the S_ISUID and S_ISGID bits are
125    cleared on successful return from chown(2) (not implemented). */
126
127 #define CAP_FSETID           4
128
129 /* Overrides the restriction that the real or effective user ID of a
130    process sending a signal must match the real or effective user ID
131    of the process receiving the signal. */
132
133 #define CAP_KILL             5
134
135 /* Allows setgid(2) manipulation */
136 /* Allows setgroups(2) */
137 /* Allows forged gids on socket credentials passing. */
138
139 #define CAP_SETGID           6
140
141 /* Allows set*uid(2) manipulation (including fsuid). */
142 /* Allows forged pids on socket credentials passing. */
143
144 #define CAP_SETUID           7
145
146
147 /**
148  ** Linux-specific capabilities
149  **/
150
151 /* Without VFS support for capabilities:
152  *   Transfer any capability in your permitted set to any pid,
153  *   remove any capability in your permitted set from any pid
154  * With VFS support for capabilities (neither of above, but)
155  *   Add any capability from current's capability bounding set
156  *       to the current process' inheritable set
157  *   Allow taking bits out of capability bounding set
158  */
159
160 #define CAP_SETPCAP          8
161
162 /* Allow modification of S_IMMUTABLE and S_APPEND file attributes */
163
164 #define CAP_LINUX_IMMUTABLE  9
165
166 /* Allows binding to TCP/UDP sockets below 1024 */
167 /* Allows binding to ATM VCIs below 32 */
168
169 #define CAP_NET_BIND_SERVICE 10
170
171 /* Allow broadcasting, listen to multicast */
172
173 #define CAP_NET_BROADCAST    11
174
175 /* Allow interface configuration */
176 /* Allow administration of IP firewall, masquerading and accounting */
177 /* Allow setting debug option on sockets */
178 /* Allow modification of routing tables */
179 /* Allow setting arbitrary process / process group ownership on
180    sockets */
181 /* Allow binding to any address for transparent proxying */
182 /* Allow setting TOS (type of service) */
183 /* Allow setting promiscuous mode */
184 /* Allow clearing driver statistics */
185 /* Allow multicasting */
186 /* Allow read/write of device-specific registers */
187 /* Allow activation of ATM control sockets */
188
189 #define CAP_NET_ADMIN        12
190
191 /* Allow use of RAW sockets */
192 /* Allow use of PACKET sockets */
193
194 #define CAP_NET_RAW          13
195
196 /* Allow locking of shared memory segments */
197 /* Allow mlock and mlockall (which doesn't really have anything to do
198    with IPC) */
199
200 #define CAP_IPC_LOCK         14
201
202 /* Override IPC ownership checks */
203
204 #define CAP_IPC_OWNER        15
205
206 /* Insert and remove kernel modules - modify kernel without limit */
207 #define CAP_SYS_MODULE       16
208
209 /* Allow ioperm/iopl access */
210 /* Allow sending USB messages to any device via /proc/bus/usb */
211
212 #define CAP_SYS_RAWIO        17
213
214 /* Allow use of chroot() */
215
216 #define CAP_SYS_CHROOT       18
217
218 /* Allow ptrace() of any process */
219
220 #define CAP_SYS_PTRACE       19
221
222 /* Allow configuration of process accounting */
223
224 #define CAP_SYS_PACCT        20
225
226 /* Allow configuration of the secure attention key */
227 /* Allow administration of the random device */
228 /* Allow examination and configuration of disk quotas */
229 /* Allow configuring the kernel's syslog (printk behaviour) */
230 /* Allow setting the domainname */
231 /* Allow setting the hostname */
232 /* Allow calling bdflush() */
233 /* Allow mount() and umount(), setting up new smb connection */
234 /* Allow some autofs root ioctls */
235 /* Allow nfsservctl */
236 /* Allow VM86_REQUEST_IRQ */
237 /* Allow to read/write pci config on alpha */
238 /* Allow irix_prctl on mips (setstacksize) */
239 /* Allow flushing all cache on m68k (sys_cacheflush) */
240 /* Allow removing semaphores */
241 /* Used instead of CAP_CHOWN to "chown" IPC message queues, semaphores
242    and shared memory */
243 /* Allow locking/unlocking of shared memory segment */
244 /* Allow turning swap on/off */
245 /* Allow forged pids on socket credentials passing */
246 /* Allow setting readahead and flushing buffers on block devices */
247 /* Allow setting geometry in floppy driver */
248 /* Allow turning DMA on/off in xd driver */
249 /* Allow administration of md devices (mostly the above, but some
250    extra ioctls) */
251 /* Allow tuning the ide driver */
252 /* Allow access to the nvram device */
253 /* Allow administration of apm_bios, serial and bttv (TV) device */
254 /* Allow manufacturer commands in isdn CAPI support driver */
255 /* Allow reading non-standardized portions of pci configuration space */
256 /* Allow DDI debug ioctl on sbpcd driver */
257 /* Allow setting up serial ports */
258 /* Allow sending raw qic-117 commands */
259 /* Allow enabling/disabling tagged queuing on SCSI controllers and sending
260    arbitrary SCSI commands */
261 /* Allow setting encryption key on loopback filesystem */
262 /* Allow setting zone reclaim policy */
263
264 #define CAP_SYS_ADMIN        21
265
266 /* Allow use of reboot() */
267
268 #define CAP_SYS_BOOT         22
269
270 /* Allow raising priority and setting priority on other (different
271    UID) processes */
272 /* Allow use of FIFO and round-robin (realtime) scheduling on own
273    processes and setting the scheduling algorithm used by another
274    process. */
275 /* Allow setting cpu affinity on other processes */
276
277 #define CAP_SYS_NICE         23
278
279 /* Override resource limits. Set resource limits. */
280 /* Override quota limits. */
281 /* Override reserved space on ext2 filesystem */
282 /* Modify data journaling mode on ext3 filesystem (uses journaling
283    resources) */
284 /* NOTE: ext2 honors fsuid when checking for resource overrides, so
285    you can override using fsuid too */
286 /* Override size restrictions on IPC message queues */
287 /* Allow more than 64hz interrupts from the real-time clock */
288 /* Override max number of consoles on console allocation */
289 /* Override max number of keymaps */
290
291 #define CAP_SYS_RESOURCE     24
292
293 /* Allow manipulation of system clock */
294 /* Allow irix_stime on mips */
295 /* Allow setting the real-time clock */
296
297 #define CAP_SYS_TIME         25
298
299 /* Allow configuration of tty devices */
300 /* Allow vhangup() of tty */
301
302 #define CAP_SYS_TTY_CONFIG   26
303
304 /* Allow the privileged aspects of mknod() */
305
306 #define CAP_MKNOD            27
307
308 /* Allow taking of leases on files */
309
310 #define CAP_LEASE            28
311
312 #define CAP_AUDIT_WRITE      29
313
314 #define CAP_AUDIT_CONTROL    30
315
316 #define CAP_SETFCAP          31
317
318 #define CAP_LAST_CAP         CAP_SETFCAP
319
320 #define cap_valid(x) ((x) >= 0 && (x) <= CAP_LAST_CAP)
321
322 /*
323  * Bit location of each capability (used by user-space library and kernel)
324  */
325
326 #define CAP_TO_INDEX(x)     ((x) >> 5)        /* 1 << 5 == bits in __u32 */
327 #define CAP_TO_MASK(x)      (1 << ((x) & 31)) /* mask for indexed __u32 */
328
329 #ifdef __KERNEL__
330
331 /*
332  * Internal kernel functions only
333  */
334
335 #define CAP_FOR_EACH_U32(__capi)  \
336         for (__capi = 0; __capi < _LINUX_CAPABILITY_U32S; ++__capi)
337
338 # define CAP_FS_MASK_B0     (CAP_TO_MASK(CAP_CHOWN)             \
339                             | CAP_TO_MASK(CAP_DAC_OVERRIDE)     \
340                             | CAP_TO_MASK(CAP_DAC_READ_SEARCH)  \
341                             | CAP_TO_MASK(CAP_FOWNER)           \
342                             | CAP_TO_MASK(CAP_FSETID))
343
344 #if _LINUX_CAPABILITY_U32S != 2
345 # error Fix up hand-coded capability macro initializers
346 #else /* HAND-CODED capability initializers */
347
348 # define CAP_EMPTY_SET    {{ 0, 0 }}
349 # define CAP_FULL_SET     {{ ~0, ~0 }}
350 # define CAP_INIT_EFF_SET {{ ~CAP_TO_MASK(CAP_SETPCAP), ~0 }}
351 # define CAP_FS_SET       {{ CAP_FS_MASK_B0, 0 }}
352 # define CAP_NFSD_SET     {{ CAP_FS_MASK_B0|CAP_TO_MASK(CAP_SYS_RESOURCE), 0 }}
353
354 #endif /* _LINUX_CAPABILITY_U32S != 2 */
355
356 #define CAP_INIT_INH_SET    CAP_EMPTY_SET
357
358 # define cap_clear(c)         do { (c) = __cap_empty_set; } while (0)
359 # define cap_set_full(c)      do { (c) = __cap_full_set; } while (0)
360 # define cap_set_init_eff(c)  do { (c) = __cap_init_eff_set; } while (0)
361
362 #define cap_raise(c, flag)  ((c).cap[CAP_TO_INDEX(flag)] |= CAP_TO_MASK(flag))
363 #define cap_lower(c, flag)  ((c).cap[CAP_TO_INDEX(flag)] &= ~CAP_TO_MASK(flag))
364 #define cap_raised(c, flag) ((c).cap[CAP_TO_INDEX(flag)] & CAP_TO_MASK(flag))
365
366 #define CAP_BOP_ALL(c, a, b, OP)                                    \
367 do {                                                                \
368         unsigned __capi;                                            \
369         CAP_FOR_EACH_U32(__capi) {                                  \
370                 c.cap[__capi] = a.cap[__capi] OP b.cap[__capi];     \
371         }                                                           \
372 } while (0)
373
374 #define CAP_UOP_ALL(c, a, OP)                                       \
375 do {                                                                \
376         unsigned __capi;                                            \
377         CAP_FOR_EACH_U32(__capi) {                                  \
378                 c.cap[__capi] = OP a.cap[__capi];                   \
379         }                                                           \
380 } while (0)
381
382 static inline kernel_cap_t cap_combine(const kernel_cap_t a,
383                                        const kernel_cap_t b)
384 {
385         kernel_cap_t dest;
386         CAP_BOP_ALL(dest, a, b, |);
387         return dest;
388 }
389
390 static inline kernel_cap_t cap_intersect(const kernel_cap_t a,
391                                          const kernel_cap_t b)
392 {
393         kernel_cap_t dest;
394         CAP_BOP_ALL(dest, a, b, &);
395         return dest;
396 }
397
398 static inline kernel_cap_t cap_drop(const kernel_cap_t a,
399                                     const kernel_cap_t drop)
400 {
401         kernel_cap_t dest;
402         CAP_BOP_ALL(dest, a, drop, &~);
403         return dest;
404 }
405
406 static inline kernel_cap_t cap_invert(const kernel_cap_t c)
407 {
408         kernel_cap_t dest;
409         CAP_UOP_ALL(dest, c, ~);
410         return dest;
411 }
412
413 static inline int cap_isclear(const kernel_cap_t a)
414 {
415         unsigned __capi;
416         CAP_FOR_EACH_U32(__capi) {
417                 if (a.cap[__capi] != 0)
418                         return 0;
419         }
420         return 1;
421 }
422
423 static inline int cap_issubset(const kernel_cap_t a, const kernel_cap_t set)
424 {
425         kernel_cap_t dest;
426         dest = cap_drop(a, set);
427         return cap_isclear(dest);
428 }
429
430 /* Used to decide between falling back on the old suser() or fsuser(). */
431
432 static inline int cap_is_fs_cap(int cap)
433 {
434         const kernel_cap_t __cap_fs_set = CAP_FS_SET;
435         return !!(CAP_TO_MASK(cap) & __cap_fs_set.cap[CAP_TO_INDEX(cap)]);
436 }
437
438 static inline kernel_cap_t cap_drop_fs_set(const kernel_cap_t a)
439 {
440         const kernel_cap_t __cap_fs_set = CAP_FS_SET;
441         return cap_drop(a, __cap_fs_set);
442 }
443
444 static inline kernel_cap_t cap_raise_fs_set(const kernel_cap_t a,
445                                             const kernel_cap_t permitted)
446 {
447         const kernel_cap_t __cap_fs_set = CAP_FS_SET;
448         return cap_combine(a,
449                            cap_intersect(permitted, __cap_fs_set));
450 }
451
452 static inline kernel_cap_t cap_drop_nfsd_set(const kernel_cap_t a)
453 {
454         const kernel_cap_t __cap_fs_set = CAP_NFSD_SET;
455         return cap_drop(a, __cap_fs_set);
456 }
457
458 static inline kernel_cap_t cap_raise_nfsd_set(const kernel_cap_t a,
459                                               const kernel_cap_t permitted)
460 {
461         const kernel_cap_t __cap_nfsd_set = CAP_NFSD_SET;
462         return cap_combine(a,
463                            cap_intersect(permitted, __cap_nfsd_set));
464 }
465
466 extern const kernel_cap_t __cap_empty_set;
467 extern const kernel_cap_t __cap_full_set;
468 extern const kernel_cap_t __cap_init_eff_set;
469
470 int capable(int cap);
471 int __capable(struct task_struct *t, int cap);
472
473 extern long cap_prctl_drop(unsigned long cap);
474
475 #endif /* __KERNEL__ */
476
477 #endif /* !_LINUX_CAPABILITY_H */