2 * Copyright (c) 1999-2002 Robert N. M. Watson
3 * Copyright (c) 2001-2005 Networks Associates Technology, Inc.
6 * This software was developed by Robert Watson for the TrustedBSD Project.
8 * This software was developed for the FreeBSD Project in part by Network
9 * Associates Laboratories, the Security Research Division of Network
10 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
11 * as part of the DARPA CHATS research program.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Userland/kernel interface for Mandatory Access Control.
39 * The POSIX.1e implementation page may be reached at:
40 * http://www.trustedbsd.org/
46 #include <sys/_label.h>
53 * MAC framework-related constants and limits.
55 #define MAC_MAX_POLICY_NAME 32
56 #define MAC_MAX_LABEL_ELEMENT_NAME 32
57 #define MAC_MAX_LABEL_ELEMENT_DATA 4096
58 #define MAC_MAX_LABEL_BUF_LEN 8192
65 typedef struct mac *mac_t;
70 * Location of the userland MAC framework configuration file. mac.conf
71 * binds policy names to shared libraries that understand those policies,
72 * as well as setting defaults for MAC-aware applications.
74 #define MAC_CONFFILE "/etc/mac.conf"
77 * Extended non-POSIX.1e interfaces that offer additional services
78 * available from the userland and kernel MAC frameworks.
81 int mac_execve(char *fname, char **argv, char **envv, mac_t _label);
82 int mac_free(mac_t _label);
83 int mac_from_text(mac_t *_label, const char *_text);
84 int mac_get_fd(int _fd, mac_t _label);
85 int mac_get_file(const char *_path, mac_t _label);
86 int mac_get_link(const char *_path, mac_t _label);
87 int mac_get_peer(int _fd, mac_t _label);
88 int mac_get_pid(pid_t _pid, mac_t _label);
89 int mac_get_proc(mac_t _label);
90 int mac_is_present(const char *_policyname);
91 int mac_prepare(mac_t *_label, const char *_elements);
92 int mac_prepare_file_label(mac_t *_label);
93 int mac_prepare_ifnet_label(mac_t *_label);
94 int mac_prepare_process_label(mac_t *_label);
95 int mac_prepare_type(mac_t *_label, const char *_type);
96 int mac_set_fd(int _fildes, const mac_t _label);
97 int mac_set_file(const char *_path, mac_t _label);
98 int mac_set_link(const char *_path, mac_t _label);
99 int mac_set_proc(const mac_t _label);
100 int mac_syscall(const char *_policyname, int _call, void *_arg);
101 int mac_to_text(mac_t mac, char **_text);
107 * Kernel functions to manage and evaluate labels.
111 struct componentname;
140 #include <sys/acl.h> /* XXX acl_type_t */
142 struct vop_setlabel_args;
147 void mac_init_bpfdesc(struct bpf_d *);
148 void mac_init_cred(struct ucred *);
149 void mac_init_devfsdirent(struct devfs_dirent *);
150 void mac_init_ifnet(struct ifnet *);
151 int mac_init_inpcb(struct inpcb *, int flag);
152 void mac_init_sysv_msgmsg(struct msg *);
153 void mac_init_sysv_msgqueue(struct msqid_kernel*);
154 void mac_init_sysv_sema(struct semid_kernel*);
155 void mac_init_sysv_shm(struct shmid_kernel*);
156 int mac_init_ipq(struct ipq *, int flag);
157 int mac_init_socket(struct socket *, int flag);
158 void mac_init_pipe(struct pipepair *);
159 void mac_init_posix_sem(struct ksem *);
160 int mac_init_mbuf(struct mbuf *mbuf, int flag);
161 int mac_init_mbuf_tag(struct m_tag *, int flag);
162 void mac_init_mount(struct mount *);
163 void mac_init_proc(struct proc *);
164 void mac_init_vnode(struct vnode *);
165 void mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
166 void mac_copy_vnode_label(struct label *, struct label *label);
167 void mac_destroy_bpfdesc(struct bpf_d *);
168 void mac_destroy_cred(struct ucred *);
169 void mac_destroy_devfsdirent(struct devfs_dirent *);
170 void mac_destroy_ifnet(struct ifnet *);
171 void mac_destroy_inpcb(struct inpcb *);
172 void mac_destroy_sysv_msgmsg(struct msg *);
173 void mac_destroy_sysv_msgqueue(struct msqid_kernel *);
174 void mac_destroy_sysv_sema(struct semid_kernel *);
175 void mac_destroy_sysv_shm(struct shmid_kernel *);
176 void mac_destroy_ipq(struct ipq *);
177 void mac_destroy_socket(struct socket *);
178 void mac_destroy_pipe(struct pipepair *);
179 void mac_destroy_posix_sem(struct ksem *);
180 void mac_destroy_proc(struct proc *);
181 void mac_destroy_mbuf_tag(struct m_tag *);
182 void mac_destroy_mount(struct mount *);
183 void mac_destroy_vnode(struct vnode *);
185 struct label *mac_cred_label_alloc(void);
186 void mac_cred_label_free(struct label *label);
187 struct label *mac_vnode_label_alloc(void);
188 void mac_vnode_label_free(struct label *label);
191 * Labeling event operations: file system objects, and things that
192 * look a lot like file system objects.
194 void mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
196 int mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
197 void mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
198 void mac_create_devfs_device(struct mount *mp, struct cdev *dev,
199 struct devfs_dirent *de);
200 void mac_create_devfs_directory(struct mount *mp, char *dirname,
201 int dirnamelen, struct devfs_dirent *de);
202 void mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
203 struct devfs_dirent *dd, struct devfs_dirent *de);
204 int mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
205 struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
206 void mac_create_mount(struct ucred *cred, struct mount *mp);
207 void mac_create_root_mount(struct ucred *cred, struct mount *mp);
208 void mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
209 struct label *newlabel);
210 void mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
214 * Labeling event operations: IPC objects.
216 void mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
217 void mac_create_socket(struct ucred *cred, struct socket *socket);
218 void mac_create_socket_from_socket(struct socket *oldsocket,
219 struct socket *newsocket);
220 void mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
221 struct socket *socket);
222 void mac_set_socket_peer_from_socket(struct socket *oldsocket,
223 struct socket *newsocket);
224 void mac_create_pipe(struct ucred *cred, struct pipepair *pp);
227 * Labeling event operations: System V IPC primitives
229 void mac_create_sysv_msgmsg(struct ucred *cred,
230 struct msqid_kernel *msqkptr, struct msg *msgptr);
231 void mac_create_sysv_msgqueue(struct ucred *cred,
232 struct msqid_kernel *msqkptr);
233 void mac_create_sysv_sema(struct ucred *cred,
234 struct semid_kernel *semakptr);
235 void mac_create_sysv_shm(struct ucred *cred,
236 struct shmid_kernel *shmsegptr);
239 * Labeling event operations: POSIX (global/inter-process) semaphores.
241 void mac_create_posix_sem(struct ucred *cred, struct ksem *ksemptr);
245 * Labeling event operations: network objects.
247 void mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
248 void mac_create_ifnet(struct ifnet *ifp);
249 void mac_create_inpcb_from_socket(struct socket *so, struct inpcb *inp);
250 void mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
251 void mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
252 void mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
253 void mac_create_mbuf_from_inpcb(struct inpcb *inp, struct mbuf *m);
254 void mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
255 void mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
256 void mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
257 void mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
258 void mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
259 struct ifnet *ifnet, struct mbuf *newmbuf);
260 void mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
261 int mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
262 void mac_reflect_mbuf_icmp(struct mbuf *m);
263 void mac_reflect_mbuf_tcp(struct mbuf *m);
264 void mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
265 void mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
268 * Labeling event operations: processes.
270 void mac_copy_cred(struct ucred *cr1, struct ucred *cr2);
271 int mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
272 void mac_execve_exit(struct image_params *imgp);
273 void mac_execve_transition(struct ucred *old, struct ucred *new,
274 struct vnode *vp, struct label *interpvnodelabel,
275 struct image_params *imgp);
276 int mac_execve_will_transition(struct ucred *old, struct vnode *vp,
277 struct label *interpvnodelabel, struct image_params *imgp);
278 void mac_create_proc0(struct ucred *cred);
279 void mac_create_proc1(struct ucred *cred);
280 void mac_thread_userret(struct thread *td);
283 * Label cleanup operation: This is the inverse complement for the
284 * mac_create and associate type of hooks. This hook lets the policy
285 * module(s) perform a cleanup/flushing operation on the label
286 * associated with the objects, without freeing up the space allocated.
287 * This hook is useful in cases where it is desirable to remove any
288 * labeling reference when recycling any object to a pool. This hook
289 * does not replace the mac_destroy hooks.
291 void mac_cleanup_sysv_msgmsg(struct msg *msgptr);
292 void mac_cleanup_sysv_msgqueue(struct msqid_kernel *msqkptr);
293 void mac_cleanup_sysv_sema(struct semid_kernel *semakptr);
294 void mac_cleanup_sysv_shm(struct shmid_kernel *shmsegptr);
296 /* Access control checks. */
297 int mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
298 int mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
299 int mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
300 int mac_check_inpcb_deliver(struct inpcb *inp, struct mbuf *m);
301 int mac_check_sysv_msgmsq(struct ucred *cred, struct msg *msgptr,
302 struct msqid_kernel *msqkptr);
303 int mac_check_sysv_msgrcv(struct ucred *cred, struct msg *msgptr);
304 int mac_check_sysv_msgrmid(struct ucred *cred, struct msg *msgptr);
305 int mac_check_sysv_msqget(struct ucred *cred,
306 struct msqid_kernel *msqkptr);
307 int mac_check_sysv_msqsnd(struct ucred *cred,
308 struct msqid_kernel *msqkptr);
309 int mac_check_sysv_msqrcv(struct ucred *cred,
310 struct msqid_kernel *msqkptr);
311 int mac_check_sysv_msqctl(struct ucred *cred,
312 struct msqid_kernel *msqkptr, int cmd);
313 int mac_check_sysv_semctl(struct ucred *cred,
314 struct semid_kernel *semakptr, int cmd);
315 int mac_check_sysv_semget(struct ucred *cred,
316 struct semid_kernel *semakptr);
317 int mac_check_sysv_semop(struct ucred *cred,struct semid_kernel *semakptr,
319 int mac_check_sysv_shmat(struct ucred *cred,
320 struct shmid_kernel *shmsegptr, int shmflg);
321 int mac_check_sysv_shmctl(struct ucred *cred,
322 struct shmid_kernel *shmsegptr, int cmd);
323 int mac_check_sysv_shmdt(struct ucred *cred,
324 struct shmid_kernel *shmsegptr);
325 int mac_check_sysv_shmget(struct ucred *cred,
326 struct shmid_kernel *shmsegptr, int shmflg);
327 int mac_check_kenv_dump(struct ucred *cred);
328 int mac_check_kenv_get(struct ucred *cred, char *name);
329 int mac_check_kenv_set(struct ucred *cred, char *name, char *value);
330 int mac_check_kenv_unset(struct ucred *cred, char *name);
331 int mac_check_kld_load(struct ucred *cred, struct vnode *vp);
332 int mac_check_kld_stat(struct ucred *cred);
333 int mac_check_kld_unload(struct ucred *cred);
334 int mac_check_mount_stat(struct ucred *cred, struct mount *mp);
335 int mac_check_pipe_ioctl(struct ucred *cred, struct pipepair *pp,
336 unsigned long cmd, void *data);
337 int mac_check_pipe_poll(struct ucred *cred, struct pipepair *pp);
338 int mac_check_pipe_read(struct ucred *cred, struct pipepair *pp);
339 int mac_check_pipe_stat(struct ucred *cred, struct pipepair *pp);
340 int mac_check_pipe_write(struct ucred *cred, struct pipepair *pp);
341 int mac_check_posix_sem_destroy(struct ucred *cred, struct ksem *ksemptr);
342 int mac_check_posix_sem_getvalue(struct ucred *cred,struct ksem *ksemptr);
343 int mac_check_posix_sem_open(struct ucred *cred, struct ksem *ksemptr);
344 int mac_check_posix_sem_post(struct ucred *cred, struct ksem *ksemptr);
345 int mac_check_posix_sem_unlink(struct ucred *cred, struct ksem *ksemptr);
346 int mac_check_posix_sem_wait(struct ucred *cred, struct ksem *ksemptr);
347 int mac_check_proc_debug(struct ucred *cred, struct proc *proc);
348 int mac_check_proc_sched(struct ucred *cred, struct proc *proc);
349 int mac_check_proc_setuid(struct proc *proc, struct ucred *cred,
351 int mac_check_proc_seteuid(struct proc *proc, struct ucred *cred,
353 int mac_check_proc_setgid(struct proc *proc, struct ucred *cred,
355 int mac_check_proc_setegid(struct proc *proc, struct ucred *cred,
357 int mac_check_proc_setgroups(struct proc *proc, struct ucred *cred,
358 int ngroups, gid_t *gidset);
359 int mac_check_proc_setreuid(struct proc *proc, struct ucred *cred,
360 uid_t ruid, uid_t euid);
361 int mac_check_proc_setregid(struct proc *proc, struct ucred *cred,
362 gid_t rgid, gid_t egid);
363 int mac_check_proc_setresuid(struct proc *proc, struct ucred *cred,
364 uid_t ruid, uid_t euid, uid_t suid);
365 int mac_check_proc_setresgid(struct proc *proc, struct ucred *cred,
366 gid_t rgid, gid_t egid, gid_t sgid);
367 int mac_check_proc_signal(struct ucred *cred, struct proc *proc,
369 int mac_check_proc_wait(struct ucred *cred, struct proc *proc);
370 int mac_check_socket_accept(struct ucred *cred, struct socket *so);
371 int mac_check_socket_bind(struct ucred *cred, struct socket *so,
372 struct sockaddr *sockaddr);
373 int mac_check_socket_connect(struct ucred *cred, struct socket *so,
374 struct sockaddr *sockaddr);
375 int mac_check_socket_deliver(struct socket *so, struct mbuf *m);
376 int mac_check_socket_listen(struct ucred *cred, struct socket *so);
377 int mac_check_socket_poll(struct ucred *cred, struct socket *so);
378 int mac_check_socket_receive(struct ucred *cred, struct socket *so);
379 int mac_check_socket_send(struct ucred *cred, struct socket *so);
380 int mac_check_socket_stat(struct ucred *cred, struct socket *so);
381 int mac_check_socket_visible(struct ucred *cred, struct socket *so);
382 int mac_check_sysarch_ioperm(struct ucred *cred);
383 int mac_check_system_acct(struct ucred *cred, struct vnode *vp);
384 int mac_check_system_nfsd(struct ucred *cred);
385 int mac_check_system_reboot(struct ucred *cred, int howto);
386 int mac_check_system_settime(struct ucred *cred);
387 int mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
388 int mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
389 int mac_check_system_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
390 void *arg1, int arg2, struct sysctl_req *req);
391 int mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
393 int mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
394 int mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
395 int mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
396 struct componentname *cnp, struct vattr *vap);
397 int mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
398 struct vnode *vp, struct componentname *cnp);
399 int mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
401 int mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
402 int attrnamespace, const char *name);
403 int mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
404 struct image_params *imgp);
405 int mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
407 int mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
408 int attrnamespace, const char *name, struct uio *uio);
409 int mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
410 struct vnode *vp, struct componentname *cnp);
411 int mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
413 int mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
414 struct componentname *cnp);
415 int mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
416 int prot, int flags);
417 int mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
419 int mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
421 int mac_check_vnode_poll(struct ucred *active_cred,
422 struct ucred *file_cred, struct vnode *vp);
423 int mac_check_vnode_read(struct ucred *active_cred,
424 struct ucred *file_cred, struct vnode *vp);
425 int mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
426 int mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
427 int mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
428 struct vnode *vp, struct componentname *cnp);
429 int mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
430 struct vnode *vp, int samedir, struct componentname *cnp);
431 int mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
432 int mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
433 acl_type_t type, struct acl *acl);
434 int mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
435 int attrnamespace, const char *name, struct uio *uio);
436 int mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
438 int mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
440 int mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
441 uid_t uid, gid_t gid);
442 int mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
443 struct timespec atime, struct timespec mtime);
444 int mac_check_vnode_stat(struct ucred *active_cred,
445 struct ucred *file_cred, struct vnode *vp);
446 int mac_check_vnode_write(struct ucred *active_cred,
447 struct ucred *file_cred, struct vnode *vp);
448 int mac_getsockopt_label(struct ucred *cred, struct socket *so,
450 int mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
452 int mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
453 struct ifnet *ifnet);
454 int mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
455 struct ifnet *ifnet);
456 int mac_setsockopt_label(struct ucred *cred, struct socket *so,
458 int mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
459 struct label *label);
460 void mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
463 * Calls to help various file systems implement labeling functionality
464 * using their existing EA implementation.
466 int vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
468 #endif /* !_KERNEL */
470 #endif /* !_SYS_MAC_H_ */