2 * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
3 * Copyright (c) 2001, 2002 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 NAI Labs,
9 * the Security Research Division of Network Associates, Inc. under
10 * DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA
11 * 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.
21 * 3. The names of the authors may not be used to endorse or promote
22 * products derived from this software without specific prior written
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * Userland/kernel interface for Mandatory Access Control.
42 * The POSIX.1e implementation page may be reached at:
43 * http://www.trustedbsd.org/
48 #include <sys/_label.h>
55 * XXXMAC: The single MAC extended attribute will be deprecated once
56 * compound EA writes on a single target file can be performed cleanly
59 #define FREEBSD_MAC_EXTATTR_NAME "freebsd.mac"
60 #define FREEBSD_MAC_EXTATTR_NAMESPACE EXTATTR_NAMESPACE_SYSTEM
63 * MAC framework-related constants and limits.
65 #define MAC_MAX_POLICY_NAME 32
66 #define MAC_MAX_LABEL_ELEMENT_NAME 32
67 #define MAC_MAX_LABEL_ELEMENT_DATA 4096
68 #define MAC_MAX_LABEL_BUF_LEN 8192
75 typedef struct mac *mac_t;
80 * Location of the userland MAC framework configuration file. mac.conf
81 * binds policy names to shared libraries that understand those policies,
82 * as well as setting defaults for MAC-aware applications.
84 #define MAC_CONFFILE "/etc/mac.conf"
87 * Extended non-POSIX.1e interfaces that offer additional services
88 * available from the userland and kernel MAC frameworks.
90 int mac_free(mac_t _label);
91 int mac_from_text(mac_t *_label, const char *_text);
92 int mac_get_fd(int _fd, mac_t _label);
93 int mac_get_file(const char *_path, mac_t _label);
94 int mac_get_link(const char *_path, mac_t _label);
95 int mac_get_pid(pid_t _pid, mac_t _label);
96 int mac_get_proc(mac_t _label);
97 int mac_is_present(const char *_policyname);
98 int mac_prepare(mac_t *_label, char *_elements);
99 int mac_prepare_file_label(mac_t *_label);
100 int mac_prepare_ifnet_label(mac_t *_label);
101 int mac_prepare_process_label(mac_t *_label);
102 int mac_set_fd(int _fildes, const mac_t _label);
103 int mac_set_file(const char *_path, mac_t _label);
104 int mac_set_link(const char *_path, mac_t _label);
105 int mac_set_proc(const mac_t _label);
106 int mac_syscall(const char *_policyname, int _call, void *_arg);
107 int mac_to_text(mac_t mac, char **_text);
109 #endif /* !_KERNEL */
112 * XXXMAC: For compatibility until the labels on disk are changed. We
113 * will enable the definitions in various policy include files once
114 * these can be disabled.
117 #define MAC_BIBA_MAX_COMPARTMENTS 256
119 struct mac_biba_element {
122 u_char mbe_compartments[MAC_BIBA_MAX_COMPARTMENTS >> 3];
127 struct mac_biba_element mb_single;
128 struct mac_biba_element mb_rangelow, mb_rangehigh;
131 #define MAC_MLS_MAX_COMPARTMENTS 256
133 struct mac_mls_element {
136 u_char mme_compartments[MAC_MLS_MAX_COMPARTMENTS >> 3];
141 struct mac_mls_element mm_single;
142 struct mac_mls_element mm_rangelow, mm_rangehigh;
151 struct mac_biba m_biba;
152 struct mac_mls m_mls;
153 struct mac_sebsd m_sebsd;
159 * Kernel functions to manage and evaluate labels.
162 struct componentname;
180 #include <sys/acl.h> /* XXX acl_type_t */
182 struct vop_refreshlabel_args;
183 struct vop_setlabel_args;
188 void mac_init_bpfdesc(struct bpf_d *);
189 void mac_init_cred(struct ucred *);
190 void mac_init_devfsdirent(struct devfs_dirent *);
191 void mac_init_ifnet(struct ifnet *);
192 void mac_init_ipq(struct ipq *);
193 int mac_init_socket(struct socket *, int flag);
194 void mac_init_pipe(struct pipe *);
195 int mac_init_mbuf(struct mbuf *m, int flag);
196 void mac_init_mount(struct mount *);
197 void mac_init_vnode(struct vnode *);
198 void mac_destroy_bpfdesc(struct bpf_d *);
199 void mac_destroy_cred(struct ucred *);
200 void mac_destroy_devfsdirent(struct devfs_dirent *);
201 void mac_destroy_ifnet(struct ifnet *);
202 void mac_destroy_ipq(struct ipq *);
203 void mac_destroy_socket(struct socket *);
204 void mac_destroy_pipe(struct pipe *);
205 void mac_destroy_mbuf(struct mbuf *);
206 void mac_destroy_mount(struct mount *);
207 void mac_destroy_vnode(struct vnode *);
210 * Labeling event operations: file system objects, and things that
211 * look a lot like file system objects.
213 void mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
214 void mac_create_devfs_directory(char *dirname, int dirnamelen,
215 struct devfs_dirent *de);
216 void mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
217 struct devfs_dirent *de);
218 void mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
219 void mac_create_vnode(struct ucred *cred, struct vnode *parent,
220 struct vnode *child);
221 void mac_create_mount(struct ucred *cred, struct mount *mp);
222 void mac_create_root_mount(struct ucred *cred, struct mount *mp);
223 void mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
224 struct label *newlabel);
225 void mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
226 void mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
227 void mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
230 * Labeling event operations: IPC objects.
232 void mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
233 void mac_create_socket(struct ucred *cred, struct socket *socket);
234 void mac_create_socket_from_socket(struct socket *oldsocket,
235 struct socket *newsocket);
236 void mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
237 struct socket *socket);
238 void mac_set_socket_peer_from_socket(struct socket *oldsocket,
239 struct socket *newsocket);
240 void mac_create_pipe(struct ucred *cred, struct pipe *pipe);
243 * Labeling event operations: network objects.
245 void mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
246 void mac_create_ifnet(struct ifnet *ifp);
247 void mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
248 void mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
249 void mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
250 void mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
251 void mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
252 void mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
253 void mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
254 void mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
255 struct ifnet *ifnet, struct mbuf *newmbuf);
256 void mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
257 int mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
258 void mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
261 * Labeling event operations: processes.
263 void mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
264 void mac_execve_transition(struct ucred *old, struct ucred *new,
266 int mac_execve_will_transition(struct ucred *old, struct vnode *vp);
267 void mac_create_proc0(struct ucred *cred);
268 void mac_create_proc1(struct ucred *cred);
269 void mac_thread_userret(struct thread *td);
271 /* Access control checks. */
272 int mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
273 int mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
274 int mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
275 int mac_check_mount_stat(struct ucred *cred, struct mount *mp);
276 int mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
277 unsigned long cmd, void *data);
278 int mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
279 int mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
280 int mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
281 int mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
282 int mac_check_proc_debug(struct ucred *cred, struct proc *proc);
283 int mac_check_proc_sched(struct ucred *cred, struct proc *proc);
284 int mac_check_proc_signal(struct ucred *cred, struct proc *proc,
286 int mac_check_socket_bind(struct ucred *cred, struct socket *so,
287 struct sockaddr *sockaddr);
288 int mac_check_socket_connect(struct ucred *cred, struct socket *so,
289 struct sockaddr *sockaddr);
290 int mac_check_socket_deliver(struct socket *so, struct mbuf *m);
291 int mac_check_socket_listen(struct ucred *cred, struct socket *so);
292 int mac_check_socket_receive(struct ucred *cred, struct socket *so);
293 int mac_check_socket_send(struct ucred *cred, struct socket *so);
294 int mac_check_socket_visible(struct ucred *cred, struct socket *so);
295 int mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
297 int mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
298 int mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
299 int mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
300 struct componentname *cnp, struct vattr *vap);
301 int mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
302 struct vnode *vp, struct componentname *cnp);
303 int mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
305 int mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
306 int mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
308 int mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
309 int attrnamespace, const char *name, struct uio *uio);
310 int mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
311 struct vnode *vp, struct componentname *cnp);
312 int mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
313 struct componentname *cnp);
314 int mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
316 int mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
318 int mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
320 int mac_check_vnode_poll(struct ucred *active_cred,
321 struct ucred *file_cred, struct vnode *vp);
322 int mac_check_vnode_read(struct ucred *active_cred,
323 struct ucred *file_cred, struct vnode *vp);
324 int mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
325 int mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
326 int mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
327 struct vnode *vp, struct componentname *cnp);
328 int mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
329 struct vnode *vp, int samedir, struct componentname *cnp);
330 int mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
331 int mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
332 acl_type_t type, struct acl *acl);
333 int mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
334 int attrnamespace, const char *name, struct uio *uio);
335 int mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
337 int mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
339 int mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
340 uid_t uid, gid_t gid);
341 int mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
342 struct timespec atime, struct timespec mtime);
343 int mac_check_vnode_stat(struct ucred *active_cred,
344 struct ucred *file_cred, struct vnode *vp);
345 int mac_check_vnode_swapon(struct ucred *cred, struct vnode *vp);
346 int mac_check_vnode_write(struct ucred *active_cred,
347 struct ucred *file_cred, struct vnode *vp);
348 int mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
350 int mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
352 int mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
353 struct ifnet *ifnet);
354 int mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
355 struct ifnet *ifnet);
356 int mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
358 int mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
359 struct label *label);
362 * Calls to help various file systems implement labeling functionality
363 * using their existing EA implementation.
365 int vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
367 int vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
368 int vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
372 #endif /* !_SYS_MAC_H */