2 * Copyright (c) 2006 nCircle Network Security, Inc.
5 * This software was developed by Robert N. M. Watson for the TrustedBSD
6 * Project under contract to nCircle Network Security, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR, NCIRCLE NETWORK SECURITY,
21 * INC., OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
23 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * Privilege checking interface for BSD kernel.
39 * Privilege list, sorted loosely by kernel subsystem.
41 * Think carefully before adding or reusing one of these privileges -- are
42 * there existing instances referring to the same privilege? Third party
43 * vendors may request the assignment of privileges to be used in loadable
44 * modules. Particular numeric privilege assignments are part of the
45 * loadable kernel module ABI, and should not be changed across minor
48 * When adding a new privilege, remember to determine if it's appropriate for
49 * use in jail, and update the privilege switch in kern_jail.c as necessary.
53 * Track beginning of privilege list.
55 #define _PRIV_LOWEST 1
58 * The remaining privileges typically correspond to one or a small
59 * number of specific privilege checks, and have (relatively) precise
60 * meanings. They are loosely sorted into a set of base system
61 * privileges, such as the ability to reboot, and then loosely by
62 * subsystem, indicated by a subsystem name.
64 #define _PRIV_ROOT 1 /* Removed. */
65 #define PRIV_ACCT 2 /* Manage process accounting. */
66 #define PRIV_MAXFILES 3 /* Exceed system open files limit. */
67 #define PRIV_MAXPROC 4 /* Exceed system processes limit. */
68 #define PRIV_KTRACE 5 /* Set/clear KTRFAC_ROOT on ktrace. */
69 #define PRIV_SETDUMPER 6 /* Configure dump device. */
70 #define PRIV_REBOOT 8 /* Can reboot system. */
71 #define PRIV_SWAPON 9 /* Can swapon(). */
72 #define PRIV_SWAPOFF 10 /* Can swapoff(). */
73 #define PRIV_MSGBUF 11 /* Can read kernel message buffer. */
74 #define PRIV_IO 12 /* Can perform low-level I/O. */
75 #define PRIV_KEYBOARD 13 /* Reprogram keyboard. */
76 #define PRIV_DRIVER 14 /* Low-level driver privilege. */
77 #define PRIV_ADJTIME 15 /* Set time adjustment. */
78 #define PRIV_NTP_ADJTIME 16 /* Set NTP time adjustment. */
79 #define PRIV_CLOCK_SETTIME 17 /* Can call clock_settime. */
80 #define PRIV_SETTIMEOFDAY 18 /* Can call settimeofday. */
81 #define _PRIV_SETHOSTID 19 /* Removed. */
82 #define _PRIV_SETDOMAINNAME 20 /* Removed. */
85 * Audit subsystem privileges.
87 #define PRIV_AUDIT_CONTROL 40 /* Can configure audit. */
88 #define PRIV_AUDIT_FAILSTOP 41 /* Can run during audit fail stop. */
89 #define PRIV_AUDIT_GETAUDIT 42 /* Can get proc audit properties. */
90 #define PRIV_AUDIT_SETAUDIT 43 /* Can set proc audit properties. */
91 #define PRIV_AUDIT_SUBMIT 44 /* Can submit an audit record. */
94 * Credential management privileges.
96 #define PRIV_CRED_SETUID 50 /* setuid. */
97 #define PRIV_CRED_SETEUID 51 /* seteuid to !ruid and !svuid. */
98 #define PRIV_CRED_SETGID 52 /* setgid. */
99 #define PRIV_CRED_SETEGID 53 /* setgid to !rgid and !svgid. */
100 #define PRIV_CRED_SETGROUPS 54 /* Set process additional groups. */
101 #define PRIV_CRED_SETREUID 55 /* setreuid. */
102 #define PRIV_CRED_SETREGID 56 /* setregid. */
103 #define PRIV_CRED_SETRESUID 57 /* setresuid. */
104 #define PRIV_CRED_SETRESGID 58 /* setresgid. */
105 #define PRIV_SEEOTHERGIDS 59 /* Exempt bsd.seeothergids. */
106 #define PRIV_SEEOTHERUIDS 60 /* Exempt bsd.seeotheruids. */
109 * Debugging privileges.
111 #define PRIV_DEBUG_DIFFCRED 80 /* Exempt debugging other users. */
112 #define PRIV_DEBUG_SUGID 81 /* Exempt debugging setuid proc. */
113 #define PRIV_DEBUG_UNPRIV 82 /* Exempt unprivileged debug limit. */
118 #define PRIV_DTRACE_KERNEL 90 /* Allow use of DTrace on the kernel. */
119 #define PRIV_DTRACE_PROC 91 /* Allow attaching DTrace to process. */
120 #define PRIV_DTRACE_USER 92 /* Process may submit DTrace events. */
123 * Firmware privilegs.
125 #define PRIV_FIRMWARE_LOAD 100 /* Can load firmware. */
130 #define PRIV_JAIL_ATTACH 110 /* Attach to a jail. */
131 #define PRIV_JAIL_SET 111 /* Set jail parameters. */
132 #define PRIV_JAIL_REMOVE 112 /* Remove a jail. */
135 * Kernel environment priveleges.
137 #define PRIV_KENV_SET 120 /* Set kernel env. variables. */
138 #define PRIV_KENV_UNSET 121 /* Unset kernel env. variables. */
141 * Loadable kernel module privileges.
143 #define PRIV_KLD_LOAD 130 /* Load a kernel module. */
144 #define PRIV_KLD_UNLOAD 131 /* Unload a kernel module. */
147 * Privileges associated with the MAC Framework and specific MAC policy
150 #define PRIV_MAC_PARTITION 140 /* Privilege in mac_partition policy. */
151 #define PRIV_MAC_PRIVS 141 /* Privilege in the mac_privs policy. */
154 * Process-related privileges.
156 #define PRIV_PROC_LIMIT 160 /* Exceed user process limit. */
157 #define PRIV_PROC_SETLOGIN 161 /* Can call setlogin. */
158 #define PRIV_PROC_SETRLIMIT 162 /* Can raise resources limits. */
160 /* System V IPC privileges.
162 #define PRIV_IPC_READ 170 /* Can override IPC read perm. */
163 #define PRIV_IPC_WRITE 171 /* Can override IPC write perm. */
164 #define PRIV_IPC_ADMIN 172 /* Can override IPC owner-only perm. */
165 #define PRIV_IPC_MSGSIZE 173 /* Exempt IPC message queue limit. */
168 * POSIX message queue privileges.
170 #define PRIV_MQ_ADMIN 180 /* Can override msgq owner-only perm. */
173 * Performance monitoring counter privileges.
175 #define PRIV_PMC_MANAGE 190 /* Can administer PMC. */
176 #define PRIV_PMC_SYSTEM 191 /* Can allocate a system-wide PMC. */
179 * Scheduling privileges.
181 #define PRIV_SCHED_DIFFCRED 200 /* Exempt scheduling other users. */
182 #define PRIV_SCHED_SETPRIORITY 201 /* Can set lower nice value for proc. */
183 #define PRIV_SCHED_RTPRIO 202 /* Can set real time scheduling. */
184 #define PRIV_SCHED_SETPOLICY 203 /* Can set scheduler policy. */
185 #define PRIV_SCHED_SET 204 /* Can set thread scheduler. */
186 #define PRIV_SCHED_SETPARAM 205 /* Can set thread scheduler params. */
187 #define PRIV_SCHED_CPUSET 206 /* Can manipulate cpusets. */
188 #define PRIV_SCHED_CPUSET_INTR 207 /* Can adjust IRQ to CPU binding. */
191 * POSIX semaphore privileges.
193 #define PRIV_SEM_WRITE 220 /* Can override sem write perm. */
198 #define PRIV_SIGNAL_DIFFCRED 230 /* Exempt signalling other users. */
199 #define PRIV_SIGNAL_SUGID 231 /* Non-conserv signal setuid proc. */
204 #define PRIV_SYSCTL_DEBUG 240 /* Can invoke sysctl.debug. */
205 #define PRIV_SYSCTL_WRITE 241 /* Can write sysctls. */
206 #define PRIV_SYSCTL_WRITEJAIL 242 /* Can write sysctls, jail permitted. */
211 #define PRIV_TTY_CONSOLE 250 /* Set console to tty. */
212 #define PRIV_TTY_DRAINWAIT 251 /* Set tty drain wait time. */
213 #define PRIV_TTY_DTRWAIT 252 /* Set DTR wait on tty. */
214 #define PRIV_TTY_EXCLUSIVE 253 /* Override tty exclusive flag. */
215 #define _PRIV_TTY_PRISON 254 /* Removed. */
216 #define PRIV_TTY_STI 255 /* Simulate input on another tty. */
217 #define PRIV_TTY_SETA 256 /* Set tty termios structure. */
220 * UFS-specific privileges.
222 #define PRIV_UFS_EXTATTRCTL 270 /* Can configure EAs on UFS1. */
223 #define PRIV_UFS_QUOTAOFF 271 /* quotaoff(). */
224 #define PRIV_UFS_QUOTAON 272 /* quotaon(). */
225 #define PRIV_UFS_SETUSE 273 /* setuse(). */
228 * ZFS-specific privileges.
230 #define PRIV_ZFS_POOL_CONFIG 280 /* Can configure ZFS pools. */
231 #define PRIV_ZFS_INJECT 281 /* Can inject faults in the ZFS fault
232 injection framework. */
233 #define PRIV_ZFS_JAIL 282 /* Can attach/detach ZFS file systems
237 * NFS-specific privileges.
239 #define PRIV_NFS_DAEMON 290 /* Can become the NFS daemon. */
240 #define PRIV_NFS_LOCKD 291 /* Can become NFS lock daemon. */
245 #define PRIV_VFS_READ 310 /* Override vnode DAC read perm. */
246 #define PRIV_VFS_WRITE 311 /* Override vnode DAC write perm. */
247 #define PRIV_VFS_ADMIN 312 /* Override vnode DAC admin perm. */
248 #define PRIV_VFS_EXEC 313 /* Override vnode DAC exec perm. */
249 #define PRIV_VFS_LOOKUP 314 /* Override vnode DAC lookup perm. */
250 #define PRIV_VFS_BLOCKRESERVE 315 /* Can use free block reserve. */
251 #define PRIV_VFS_CHFLAGS_DEV 316 /* Can chflags() a device node. */
252 #define PRIV_VFS_CHOWN 317 /* Can set user; group to non-member. */
253 #define PRIV_VFS_CHROOT 318 /* chroot(). */
254 #define PRIV_VFS_RETAINSUGID 319 /* Can retain sugid bits on change. */
255 #define PRIV_VFS_EXCEEDQUOTA 320 /* Exempt from quota restrictions. */
256 #define PRIV_VFS_EXTATTR_SYSTEM 321 /* Operate on system EA namespace. */
257 #define PRIV_VFS_FCHROOT 322 /* fchroot(). */
258 #define PRIV_VFS_FHOPEN 323 /* Can fhopen(). */
259 #define PRIV_VFS_FHSTAT 324 /* Can fhstat(). */
260 #define PRIV_VFS_FHSTATFS 325 /* Can fhstatfs(). */
261 #define PRIV_VFS_GENERATION 326 /* stat() returns generation number. */
262 #define PRIV_VFS_GETFH 327 /* Can retrieve file handles. */
263 #define PRIV_VFS_GETQUOTA 328 /* getquota(). */
264 #define PRIV_VFS_LINK 329 /* bsd.hardlink_check_uid */
265 #define PRIV_VFS_MKNOD_BAD 330 /* Can mknod() to mark bad inodes. */
266 #define PRIV_VFS_MKNOD_DEV 331 /* Can mknod() to create dev nodes. */
267 #define PRIV_VFS_MKNOD_WHT 332 /* Can mknod() to create whiteout. */
268 #define PRIV_VFS_MOUNT 333 /* Can mount(). */
269 #define PRIV_VFS_MOUNT_OWNER 334 /* Can manage other users' file systems. */
270 #define PRIV_VFS_MOUNT_EXPORTED 335 /* Can set MNT_EXPORTED on mount. */
271 #define PRIV_VFS_MOUNT_PERM 336 /* Override dev node perms at mount. */
272 #define PRIV_VFS_MOUNT_SUIDDIR 337 /* Can set MNT_SUIDDIR on mount. */
273 #define PRIV_VFS_MOUNT_NONUSER 338 /* Can perform a non-user mount. */
274 #define PRIV_VFS_SETGID 339 /* Can setgid if not in group. */
275 #define PRIV_VFS_SETQUOTA 340 /* setquota(). */
276 #define PRIV_VFS_STICKYFILE 341 /* Can set sticky bit on file. */
277 #define PRIV_VFS_SYSFLAGS 342 /* Can modify system flags. */
278 #define PRIV_VFS_UNMOUNT 343 /* Can unmount(). */
279 #define PRIV_VFS_STAT 344 /* Override vnode MAC stat perm. */
282 * Virtual memory privileges.
284 #define PRIV_VM_MADV_PROTECT 360 /* Can set MADV_PROTECT. */
285 #define PRIV_VM_MLOCK 361 /* Can mlock(), mlockall(). */
286 #define PRIV_VM_MUNLOCK 362 /* Can munlock(), munlockall(). */
287 #define PRIV_VM_SWAP_NOQUOTA 363 /*
288 * Can override the global
289 * swap reservation limits.
291 #define PRIV_VM_SWAP_NORLIMIT 364 /*
292 * Can override the per-uid
293 * swap reservation limits.
297 * Device file system privileges.
299 #define PRIV_DEVFS_RULE 370 /* Can manage devfs rules. */
300 #define PRIV_DEVFS_SYMLINK 371 /* Can create symlinks in devfs. */
303 * Random number generator privileges.
305 #define PRIV_RANDOM_RESEED 380 /* Closing /dev/random reseeds. */
308 * Network stack privileges.
310 #define PRIV_NET_BRIDGE 390 /* Administer bridge. */
311 #define PRIV_NET_GRE 391 /* Administer GRE. */
312 #define _PRIV_NET_PPP 392 /* Removed. */
313 #define _PRIV_NET_SLIP 393 /* Removed. */
314 #define PRIV_NET_BPF 394 /* Monitor BPF. */
315 #define PRIV_NET_RAW 395 /* Open raw socket. */
316 #define PRIV_NET_ROUTE 396 /* Administer routing. */
317 #define PRIV_NET_TAP 397 /* Can open tap device. */
318 #define PRIV_NET_SETIFMTU 398 /* Set interface MTU. */
319 #define PRIV_NET_SETIFFLAGS 399 /* Set interface flags. */
320 #define PRIV_NET_SETIFCAP 400 /* Set interface capabilities. */
321 #define PRIV_NET_SETIFNAME 401 /* Set interface name. */
322 #define PRIV_NET_SETIFMETRIC 402 /* Set interface metrics. */
323 #define PRIV_NET_SETIFPHYS 403 /* Set interface physical layer prop. */
324 #define PRIV_NET_SETIFMAC 404 /* Set interface MAC label. */
325 #define PRIV_NET_ADDMULTI 405 /* Add multicast addr. to ifnet. */
326 #define PRIV_NET_DELMULTI 406 /* Delete multicast addr. from ifnet. */
327 #define PRIV_NET_HWIOCTL 407 /* Issue hardware ioctl on ifnet. */
328 #define PRIV_NET_SETLLADDR 408 /* Set interface link-level address. */
329 #define PRIV_NET_ADDIFGROUP 409 /* Add new interface group. */
330 #define PRIV_NET_DELIFGROUP 410 /* Delete interface group. */
331 #define PRIV_NET_IFCREATE 411 /* Create cloned interface. */
332 #define PRIV_NET_IFDESTROY 412 /* Destroy cloned interface. */
333 #define PRIV_NET_ADDIFADDR 413 /* Add protocol addr to interface. */
334 #define PRIV_NET_DELIFADDR 414 /* Delete protocol addr on interface. */
335 #define PRIV_NET_LAGG 415 /* Administer lagg interface. */
336 #define PRIV_NET_GIF 416 /* Administer gif interface. */
337 #define PRIV_NET_SETIFVNET 417 /* Move interface to vnet. */
338 #define PRIV_NET_SETIFDESCR 418 /* Set interface description. */
339 #define PRIV_NET_SETIFFIB 419 /* Set interface fib. */
342 * 802.11-related privileges.
344 #define PRIV_NET80211_GETKEY 440 /* Query 802.11 keys. */
345 #define PRIV_NET80211_MANAGE 441 /* Administer 802.11. */
348 * AppleTalk privileges.
350 #define PRIV_NETATALK_RESERVEDPORT 450 /* Bind low port number. */
355 #define PRIV_NETATM_CFG 460
356 #define PRIV_NETATM_ADD 461
357 #define PRIV_NETATM_DEL 462
358 #define PRIV_NETATM_SET 463
361 * Bluetooth privileges.
363 #define PRIV_NETBLUETOOTH_RAW 470 /* Open raw bluetooth socket. */
366 * Netgraph and netgraph module privileges.
368 #define PRIV_NETGRAPH_CONTROL 480 /* Open netgraph control socket. */
369 #define PRIV_NETGRAPH_TTY 481 /* Configure tty for netgraph. */
372 * IPv4 and IPv6 privileges.
374 #define PRIV_NETINET_RESERVEDPORT 490 /* Bind low port number. */
375 #define PRIV_NETINET_IPFW 491 /* Administer IPFW firewall. */
376 #define PRIV_NETINET_DIVERT 492 /* Open IP divert socket. */
377 #define PRIV_NETINET_PF 493 /* Administer pf firewall. */
378 #define PRIV_NETINET_DUMMYNET 494 /* Administer DUMMYNET. */
379 #define PRIV_NETINET_CARP 495 /* Administer CARP. */
380 #define PRIV_NETINET_MROUTE 496 /* Administer multicast routing. */
381 #define PRIV_NETINET_RAW 497 /* Open netinet raw socket. */
382 #define PRIV_NETINET_GETCRED 498 /* Query netinet pcb credentials. */
383 #define PRIV_NETINET_ADDRCTRL6 499 /* Administer IPv6 address scopes. */
384 #define PRIV_NETINET_ND6 500 /* Administer IPv6 neighbor disc. */
385 #define PRIV_NETINET_SCOPE6 501 /* Administer IPv6 address scopes. */
386 #define PRIV_NETINET_ALIFETIME6 502 /* Administer IPv6 address lifetimes. */
387 #define PRIV_NETINET_IPSEC 503 /* Administer IPSEC. */
388 #define PRIV_NETINET_REUSEPORT 504 /* Allow [rapid] port/address reuse. */
389 #define PRIV_NETINET_SETHDROPTS 505 /* Set certain IPv4/6 header options. */
390 #define PRIV_NETINET_BINDANY 506 /* Allow bind to any address. */
393 * IPX/SPX privileges.
395 #define PRIV_NETIPX_RESERVEDPORT 520 /* Bind low port number. */
396 #define PRIV_NETIPX_RAW 521 /* Open netipx raw socket. */
401 #define PRIV_NETNCP 530 /* Use another user's connection. */
406 #define PRIV_NETSMB 540 /* Use another user's connection. */
411 #define PRIV_VM86_INTCALL 550 /* Allow invoking vm86 int handlers. */
414 * Set of reserved privilege values, which will be allocated to code as
415 * needed, in order to avoid renumbering later privileges due to insertion.
417 #define _PRIV_RESERVED0 560
418 #define _PRIV_RESERVED1 561
419 #define _PRIV_RESERVED2 562
420 #define _PRIV_RESERVED3 563
421 #define _PRIV_RESERVED4 564
422 #define _PRIV_RESERVED5 565
423 #define _PRIV_RESERVED6 566
424 #define _PRIV_RESERVED7 567
425 #define _PRIV_RESERVED8 568
426 #define _PRIV_RESERVED9 569
427 #define _PRIV_RESERVED10 570
428 #define _PRIV_RESERVED11 571
429 #define _PRIV_RESERVED12 572
430 #define _PRIV_RESERVED13 573
431 #define _PRIV_RESERVED14 574
432 #define _PRIV_RESERVED15 575
435 * Define a set of valid privilege numbers that can be used by loadable
436 * modules that don't yet have privilege reservations. Ideally, these should
437 * not be used, since their meaning is opaque to any policies that are aware
438 * of specific privileges, such as jail, and as such may be arbitrarily
441 #define PRIV_MODULE0 600
442 #define PRIV_MODULE1 601
443 #define PRIV_MODULE2 602
444 #define PRIV_MODULE3 603
445 #define PRIV_MODULE4 604
446 #define PRIV_MODULE5 605
447 #define PRIV_MODULE6 606
448 #define PRIV_MODULE7 607
449 #define PRIV_MODULE8 608
450 #define PRIV_MODULE9 609
451 #define PRIV_MODULE10 610
452 #define PRIV_MODULE11 611
453 #define PRIV_MODULE12 612
454 #define PRIV_MODULE13 613
455 #define PRIV_MODULE14 614
456 #define PRIV_MODULE15 615
461 #define PRIV_DDB_CAPTURE 620 /* Allow reading of DDB capture log. */
464 * Arla/nnpfs privileges.
466 #define PRIV_NNPFS_DEBUG 630 /* Perforn ARLA_VIOC_NNPFSDEBUG. */
469 * cpuctl(4) privileges.
471 #define PRIV_CPUCTL_WRMSR 640 /* Write model-specific register. */
472 #define PRIV_CPUCTL_UPDATE 641 /* Update cpu microcode. */
475 * Capi4BSD privileges.
477 #define PRIV_C4B_RESET_CTLR 650 /* Load firmware, reset controller. */
478 #define PRIV_C4B_TRACE 651 /* Unrestricted CAPI message tracing. */
481 * OpenAFS privileges.
483 #define PRIV_AFS_ADMIN 660 /* Can change AFS client settings. */
484 #define PRIV_AFS_DAEMON 661 /* Can become the AFS daemon. */
487 * Track end of privilege list.
489 #define _PRIV_HIGHEST 662
492 * Validate that a named privilege is known by the privilege system. Invalid
493 * privileges presented to the privilege system by a priv_check interface
494 * will result in a panic. This is only approximate due to sparse allocation
495 * of the privilege space.
497 #define PRIV_VALID(x) ((x) > _PRIV_LOWEST && (x) < _PRIV_HIGHEST)
501 * Privilege check interfaces, modeled after historic suser() interfaces, but
502 * with the addition of a specific privilege name. No flags are currently
503 * defined for the API. Historically, flags specified using the real uid
504 * instead of the effective uid, and whether or not the check should be
509 int priv_check(struct thread *td, int priv);
510 int priv_check_cred(struct ucred *cred, int priv, int flags);
513 #endif /* !_SYS_PRIV_H_ */