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
68 * XXXMAC: Per-policy structures will be moved from mac.h to per-policy
69 * include files once the revised user interface is available.
73 * Structures and constants associated with a Biba Integrity policy.
74 * mac_biba represents a Biba label, with mb_type determining its properties,
75 * and mb_grade represents the hierarchal grade if valid for the current
76 * mb_type. These structures will move to mac_biba.h once we have dymamic
77 * labels exposed to userland.
79 struct mac_biba_element {
85 * Biba labels consist of two components: a single label, and a label
86 * range. Depending on the context, one or both may be used; the mb_flags
87 * field permits the provider to indicate what fields are intended for
92 struct mac_biba_element mb_single;
93 struct mac_biba_element mb_rangelow, mb_rangehigh;
97 * Structures and constants associated with a Multi-Level Security policy.
98 * mac_mls represents an MLS label, with mm_type determining its properties,
99 * and mm_level represents the hierarchal sensitivity level if valid for the
100 * current mm_type. These structures will move to mac_mls.h once we have
101 * dynamic labels exposed to userland.
103 struct mac_mls_element {
109 * MLS labels consist of two components: a single label, and a label
110 * range. Depending on the context, one or both may be used; the mb_flags
111 * field permits the provider to indicate what fields are intended for
116 struct mac_mls_element mm_single;
117 struct mac_mls_element mm_rangelow, mm_rangehigh;
121 * Structures and constants associated with a Type Enforcement policy.
122 * mac_te represents a Type Enforcement label.
124 #define MAC_TE_TYPE_MAXLEN 32
126 char mt_type[MAC_TE_TYPE_MAXLEN+1]; /* TE type */
130 uint32_t ms_psid; /* persistent sid storage */
134 * Composite structures and constants which combine the various policy
135 * elements into common structures to be associated with subjects and
140 struct mac_biba m_biba;
141 struct mac_mls m_mls;
143 struct mac_sebsd m_sebsd;
145 typedef struct mac *mac_t;
147 #define MAC_FLAG_INITIALIZED 0x00000001 /* Is initialized. */
152 * POSIX.1e functions visible in the application namespace.
154 int mac_dominate(const mac_t _labela, const mac_t _labelb);
155 int mac_equal(const mac_t labela, const mac_t _labelb);
156 int mac_free(void *_buf_p);
157 mac_t mac_from_text(const char *_text_p);
158 mac_t mac_get_fd(int _fildes);
159 mac_t mac_get_file(const char *_path_p);
160 mac_t mac_get_proc(void);
161 mac_t mac_glb(const mac_t _labela, const mac_t _labelb);
162 mac_t mac_lub(const mac_t _labela, const mac_t _labelb);
163 int mac_set_fd(int _fildes, const mac_t _label);
164 int mac_set_file(const char *_path_p, mac_t _label);
165 int mac_set_proc(const mac_t _label);
166 ssize_t mac_size(mac_t _label);
167 char * mac_to_text(const mac_t _label, size_t *_len_p);
168 int mac_valid(const mac_t _label);
171 * Extensions to POSIX.1e visible in the application namespace.
173 int mac_is_present_np(const char *_policyname);
174 int mac_syscall(const char *_policyname, int call, void *arg);
177 * System calls wrapped by some POSIX.1e functions.
179 int __mac_get_fd(int _fd, struct mac *_mac_p);
180 int __mac_get_file(const char *_path_p, struct mac *_mac_p);
181 int __mac_get_proc(struct mac *_mac_p);
182 int __mac_set_fd(int fd, struct mac *_mac_p);
183 int __mac_set_file(const char *_path_p, struct mac *_mac_p);
184 int __mac_set_proc(struct mac *_mac_p);
189 * Kernel functions to manage and evaluate labels.
192 struct componentname;
210 #include <sys/acl.h> /* XXX acl_type_t */
212 struct vop_refreshlabel_args;
213 struct vop_setlabel_args;
218 void mac_init_bpfdesc(struct bpf_d *);
219 void mac_init_cred(struct ucred *);
220 void mac_init_devfsdirent(struct devfs_dirent *);
221 void mac_init_ifnet(struct ifnet *);
222 void mac_init_ipq(struct ipq *);
223 void mac_init_socket(struct socket *);
224 void mac_init_pipe(struct pipe *);
225 int mac_init_mbuf(struct mbuf *m, int how);
226 void mac_init_mount(struct mount *);
227 void mac_init_vnode(struct vnode *);
228 void mac_destroy_bpfdesc(struct bpf_d *);
229 void mac_destroy_cred(struct ucred *);
230 void mac_destroy_devfsdirent(struct devfs_dirent *);
231 void mac_destroy_ifnet(struct ifnet *);
232 void mac_destroy_ipq(struct ipq *);
233 void mac_destroy_socket(struct socket *);
234 void mac_destroy_pipe(struct pipe *);
235 void mac_destroy_mbuf(struct mbuf *);
236 void mac_destroy_mount(struct mount *);
237 void mac_destroy_vnode(struct vnode *);
240 * Labeling event operations: file system objects, and things that
241 * look a lot like file system objects.
243 void mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
244 void mac_create_devfs_directory(char *dirname, int dirnamelen,
245 struct devfs_dirent *de);
246 void mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
247 void mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
248 struct devfs_dirent *de);
249 void mac_create_vnode(struct ucred *cred, struct vnode *parent,
250 struct vnode *child);
251 void mac_create_mount(struct ucred *cred, struct mount *mp);
252 void mac_create_root_mount(struct ucred *cred, struct mount *mp);
253 void mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
254 struct label *newlabel);
255 void mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
256 void mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
257 void mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
260 * Labeling event operations: IPC objects.
262 void mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
263 void mac_create_socket(struct ucred *cred, struct socket *socket);
264 void mac_create_socket_from_socket(struct socket *oldsocket,
265 struct socket *newsocket);
266 void mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
267 struct socket *socket);
268 void mac_set_socket_peer_from_socket(struct socket *oldsocket,
269 struct socket *newsocket);
270 void mac_create_pipe(struct ucred *cred, struct pipe *pipe);
273 * Labeling event operations: network objects.
275 void mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
276 void mac_create_ifnet(struct ifnet *ifp);
277 void mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
278 void mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
279 void mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
280 void mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
281 void mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
282 void mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
283 void mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
284 void mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
285 struct ifnet *ifnet, struct mbuf *newmbuf);
286 void mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
287 int mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
288 void mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
291 * Labeling event operations: processes.
293 void mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
294 void mac_execve_transition(struct ucred *old, struct ucred *new,
296 int mac_execve_will_transition(struct ucred *old, struct vnode *vp);
297 void mac_create_proc0(struct ucred *cred);
298 void mac_create_proc1(struct ucred *cred);
299 void mac_thread_userret(struct thread *td);
301 /* Access control checks. */
302 int mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
303 int mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
304 int mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
305 int mac_check_mount_stat(struct ucred *cred, struct mount *mp);
306 int mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
307 unsigned long cmd, void *data);
308 int mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
309 int mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
310 int mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
311 int mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
312 int mac_check_proc_debug(struct ucred *cred, struct proc *proc);
313 int mac_check_proc_sched(struct ucred *cred, struct proc *proc);
314 int mac_check_proc_signal(struct ucred *cred, struct proc *proc,
316 int mac_check_socket_bind(struct ucred *cred, struct socket *so,
317 struct sockaddr *sockaddr);
318 int mac_check_socket_connect(struct ucred *cred, struct socket *so,
319 struct sockaddr *sockaddr);
320 int mac_check_socket_deliver(struct socket *so, struct mbuf *m);
321 int mac_check_socket_listen(struct ucred *cred, struct socket *so);
322 int mac_check_socket_visible(struct ucred *cred, struct socket *so);
323 int mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
325 int mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
326 int mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
327 int mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
328 struct componentname *cnp, struct vattr *vap);
329 int mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
330 struct vnode *vp, struct componentname *cnp);
331 int mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
333 int mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
334 int mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
336 int mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
337 int attrnamespace, const char *name, struct uio *uio);
338 int mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
339 struct vnode *vp, struct componentname *cnp);
340 int mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
341 struct componentname *cnp);
342 /* XXX This u_char should be vm_prot_t! */
343 u_char mac_check_vnode_mmap_prot(struct ucred *cred, struct vnode *vp,
345 int mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
347 int mac_check_vnode_poll(struct ucred *active_cred,
348 struct ucred *file_cred, struct vnode *vp);
349 int mac_check_vnode_read(struct ucred *active_cred,
350 struct ucred *file_cred, struct vnode *vp);
351 int mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
352 int mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
353 int mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
354 struct vnode *vp, struct componentname *cnp);
355 int mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
356 struct vnode *vp, int samedir, struct componentname *cnp);
357 int mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
358 int mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
359 acl_type_t type, struct acl *acl);
360 int mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
361 int attrnamespace, const char *name, struct uio *uio);
362 int mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
364 int mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
366 int mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
367 uid_t uid, gid_t gid);
368 int mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
369 struct timespec atime, struct timespec mtime);
370 int mac_check_vnode_stat(struct ucred *active_cred,
371 struct ucred *file_cred, struct vnode *vp);
372 int mac_check_vnode_write(struct ucred *active_cred,
373 struct ucred *file_cred, struct vnode *vp);
374 int mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
376 int mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
378 int mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
379 struct ifnet *ifnet);
380 int mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
381 struct ifnet *ifnet);
382 int mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
384 int mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
385 struct label *label);
388 * Calls to help various file systems implement labeling functionality
389 * using their existing EA implementation.
391 int vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
393 int vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
394 int vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
398 #endif /* !_SYS_MAC_H */