1/*-
2 * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
3 * Copyright (c) 2001, 2002 Networks Associates Technology, Inc.
4 * All rights reserved.
5 *
6 * This software was developed by Robert Watson for the TrustedBSD Project.
7 *
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.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
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
23 * permission.
24 *
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
35 * SUCH DAMAGE.
36 *
37 * $FreeBSD: head/sys/security/mac/mac_framework.h 105643 2002-10-21 18:42:01Z rwatson $
38 */
39/*
40 * Userland/kernel interface for Mandatory Access Control.
41 *
42 * The POSIX.1e implementation page may be reached at:
43 * http://www.trustedbsd.org/
44 */
45#ifndef _SYS_MAC_H
46#define _SYS_MAC_H
47
48#include <sys/_label.h>
49
50#ifndef _POSIX_MAC
51#define _POSIX_MAC
52#endif
53
54/*
55 * XXXMAC: The single MAC extended attribute will be deprecated once
56 * compound EA writes on a single target file can be performed cleanly
57 * with UFS2.
58 */
59#define FREEBSD_MAC_EXTATTR_NAME "freebsd.mac"
60#define FREEBSD_MAC_EXTATTR_NAMESPACE EXTATTR_NAMESPACE_SYSTEM
61
62/*
63 * MAC framework-related constants and limits.
64 */
65#define MAC_MAX_POLICY_NAME 32
66
67/*
68 * XXXMAC: Per-policy structures will be moved from mac.h to per-policy
69 * include files once the revised user interface is available.
70 */
71
72/*
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.
78 */
79#define MAC_BIBA_MAX_COMPARTMENTS 256
80struct mac_biba_element {
81 u_short mbe_type;
82 u_short mbe_grade;
83 u_char mbe_compartments[MAC_BIBA_MAX_COMPARTMENTS >> 3];
84};
85
86/*
87 * Biba labels consist of two components: a single label, and a label
88 * range. Depending on the context, one or both may be used; the mb_flags
89 * field permits the provider to indicate what fields are intended for
90 * use.
91 */
92struct mac_biba {
93 int mb_flags;
94 struct mac_biba_element mb_single;
95 struct mac_biba_element mb_rangelow, mb_rangehigh;
96};
97
98/*
99 * Structures and constants associated with a Multi-Level Security policy.
100 * mac_mls represents an MLS label, with mm_type determining its properties,
101 * and mm_level represents the hierarchal sensitivity level if valid for the
102 * current mm_type. These structures will move to mac_mls.h once we have
103 * dynamic labels exposed to userland.
104 */
105#define MAC_MLS_MAX_COMPARTMENTS 256
106struct mac_mls_element {
107 u_short mme_type;
108 u_short mme_level;
109 u_char mme_compartments[MAC_MLS_MAX_COMPARTMENTS >> 3];
110};
111
112/*
113 * MLS labels consist of two components: a single label, and a label
114 * range. Depending on the context, one or both may be used; the mb_flags
115 * field permits the provider to indicate what fields are intended for
116 * use.
117 */
118struct mac_mls {
119 int mm_flags;
120 struct mac_mls_element mm_single;
121 struct mac_mls_element mm_rangelow, mm_rangehigh;
122};
123
124/*
125 * Structures and constants associated with a Type Enforcement policy.
126 * mac_te represents a Type Enforcement label.
127 */
128#define MAC_TE_TYPE_MAXLEN 32
129struct mac_te {
130 char mt_type[MAC_TE_TYPE_MAXLEN+1]; /* TE type */
131};
132
133struct mac_sebsd {
134 uint32_t ms_psid; /* persistent sid storage */
135};
136
137/*
138 * Composite structures and constants which combine the various policy
139 * elements into common structures to be associated with subjects and
140 * objects.
141 */
142struct mac {
143 int m_macflags;
144 struct mac_biba m_biba;
145 struct mac_mls m_mls;
146 struct mac_te m_te;
147 struct mac_sebsd m_sebsd;
148};
149typedef struct mac *mac_t;
150
151#define MAC_FLAG_INITIALIZED 0x00000001 /* Is initialized. */
152
153#ifndef _KERNEL
154
155/*
156 * POSIX.1e functions visible in the application namespace.
157 */
158int mac_dominate(const mac_t _labela, const mac_t _labelb);
159int mac_equal(const mac_t labela, const mac_t _labelb);
160int mac_free(void *_buf_p);
161mac_t mac_from_text(const char *_text_p);
162mac_t mac_get_fd(int _fildes);
163mac_t mac_get_file(const char *_path_p);
164mac_t mac_get_proc(void);
165mac_t mac_glb(const mac_t _labela, const mac_t _labelb);
166mac_t mac_lub(const mac_t _labela, const mac_t _labelb);
167int mac_set_fd(int _fildes, const mac_t _label);
168int mac_set_file(const char *_path_p, mac_t _label);
169int mac_set_proc(const mac_t _label);
170ssize_t mac_size(mac_t _label);
171char * mac_to_text(const mac_t _label, size_t *_len_p);
172int mac_valid(const mac_t _label);
173
174/*
175 * Extensions to POSIX.1e visible in the application namespace.
176 */
177int mac_is_present_np(const char *_policyname);
178int mac_syscall(const char *_policyname, int call, void *arg);
179
180/*
181 * System calls wrapped by some POSIX.1e functions.
182 */
183int __mac_get_fd(int _fd, struct mac *_mac_p);
184int __mac_get_file(const char *_path_p, struct mac *_mac_p);
185int __mac_get_proc(struct mac *_mac_p);
186int __mac_set_fd(int fd, struct mac *_mac_p);
187int __mac_set_file(const char *_path_p, struct mac *_mac_p);
188int __mac_set_proc(struct mac *_mac_p);
189
190#else /* _KERNEL */
191
192/*
193 * Kernel functions to manage and evaluate labels.
194 */
195struct bpf_d;
196struct componentname;
197struct devfs_dirent;
198struct ifnet;
199struct ifreq;
200struct ipq;
201struct mbuf;
202struct mount;
203struct proc;
204struct sockaddr;
205struct socket;
206struct pipe;
207struct thread;
208struct timespec;
209struct ucred;
210struct uio;
211struct vattr;
212struct vnode;
213
214#include <sys/acl.h> /* XXX acl_type_t */
215
216struct vop_refreshlabel_args;
217struct vop_setlabel_args;
218
219/*
220 * Label operations.
221 */
222void mac_init_bpfdesc(struct bpf_d *);
223void mac_init_cred(struct ucred *);
224void mac_init_devfsdirent(struct devfs_dirent *);
225void mac_init_ifnet(struct ifnet *);
226void mac_init_ipq(struct ipq *);
227int mac_init_socket(struct socket *, int flag);
228void mac_init_pipe(struct pipe *);
229int mac_init_mbuf(struct mbuf *m, int flag);
230void mac_init_mount(struct mount *);
231void mac_init_vnode(struct vnode *);
232void mac_destroy_bpfdesc(struct bpf_d *);
233void mac_destroy_cred(struct ucred *);
234void mac_destroy_devfsdirent(struct devfs_dirent *);
235void mac_destroy_ifnet(struct ifnet *);
236void mac_destroy_ipq(struct ipq *);
237void mac_destroy_socket(struct socket *);
238void mac_destroy_pipe(struct pipe *);
239void mac_destroy_mbuf(struct mbuf *);
240void mac_destroy_mount(struct mount *);
241void mac_destroy_vnode(struct vnode *);
242
243/*
244 * Labeling event operations: file system objects, and things that
245 * look a lot like file system objects.
246 */
247void mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
248void mac_create_devfs_directory(char *dirname, int dirnamelen,
249 struct devfs_dirent *de);
250void mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
251void mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
252 struct devfs_dirent *de);
253void mac_create_vnode(struct ucred *cred, struct vnode *parent,
254 struct vnode *child);
255void mac_create_mount(struct ucred *cred, struct mount *mp);
256void mac_create_root_mount(struct ucred *cred, struct mount *mp);
257void mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
258 struct label *newlabel);
259void mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
260void mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
261void mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
262
263/*
264 * Labeling event operations: IPC objects.
265 */
266void mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
267void mac_create_socket(struct ucred *cred, struct socket *socket);
268void mac_create_socket_from_socket(struct socket *oldsocket,
269 struct socket *newsocket);
270void mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
271 struct socket *socket);
272void mac_set_socket_peer_from_socket(struct socket *oldsocket,
273 struct socket *newsocket);
274void mac_create_pipe(struct ucred *cred, struct pipe *pipe);
275
276/*
277 * Labeling event operations: network objects.
278 */
279void mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
280void mac_create_ifnet(struct ifnet *ifp);
281void mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
282void mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
283void mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
284void mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
285void mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
286void mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
287void mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
288void mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
289 struct ifnet *ifnet, struct mbuf *newmbuf);
290void mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
291int mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
292void mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
293
294/*
295 * Labeling event operations: processes.
296 */
297void mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
298void mac_execve_transition(struct ucred *old, struct ucred *new,
299 struct vnode *vp);
300int mac_execve_will_transition(struct ucred *old, struct vnode *vp);
301void mac_create_proc0(struct ucred *cred);
302void mac_create_proc1(struct ucred *cred);
303void mac_thread_userret(struct thread *td);
304
305/* Access control checks. */
306int mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
307int mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
308int mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
309int mac_check_mount_stat(struct ucred *cred, struct mount *mp);
310int mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
311 unsigned long cmd, void *data);
312int mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
313int mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
314int mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
315int mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
316int mac_check_proc_debug(struct ucred *cred, struct proc *proc);
317int mac_check_proc_sched(struct ucred *cred, struct proc *proc);
318int mac_check_proc_signal(struct ucred *cred, struct proc *proc,
319 int signum);
320int mac_check_socket_bind(struct ucred *cred, struct socket *so,
321 struct sockaddr *sockaddr);
322int mac_check_socket_connect(struct ucred *cred, struct socket *so,
323 struct sockaddr *sockaddr);
324int mac_check_socket_deliver(struct socket *so, struct mbuf *m);
325int mac_check_socket_listen(struct ucred *cred, struct socket *so);
326int mac_check_socket_receive(struct ucred *cred, struct socket *so);
327int mac_check_socket_send(struct ucred *cred, struct socket *so);
328int mac_check_socket_visible(struct ucred *cred, struct socket *so);
329int mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
330 int flags);
331int mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
332int mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
333int mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
334 struct componentname *cnp, struct vattr *vap);
335int mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
336 struct vnode *vp, struct componentname *cnp);
337int mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
338 acl_type_t type);
339int mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
340int mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
341 acl_type_t type);
342int mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
343 int attrnamespace, const char *name, struct uio *uio);
344int mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
345 struct vnode *vp, struct componentname *cnp);
346int mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
347 struct componentname *cnp);
348int mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
349 int prot);
350int mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
351 int prot);
352int mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
353 mode_t acc_mode);
354int mac_check_vnode_poll(struct ucred *active_cred,
355 struct ucred *file_cred, struct vnode *vp);
356int mac_check_vnode_read(struct ucred *active_cred,
357 struct ucred *file_cred, struct vnode *vp);
358int mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
359int mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
360int mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
361 struct vnode *vp, struct componentname *cnp);
362int mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
363 struct vnode *vp, int samedir, struct componentname *cnp);
364int mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
365int mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
366 acl_type_t type, struct acl *acl);
367int mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
368 int attrnamespace, const char *name, struct uio *uio);
369int mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
370 u_long flags);
371int mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
372 mode_t mode);
373int mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
374 uid_t uid, gid_t gid);
375int mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
376 struct timespec atime, struct timespec mtime);
377int mac_check_vnode_stat(struct ucred *active_cred,
378 struct ucred *file_cred, struct vnode *vp);
379int mac_check_vnode_write(struct ucred *active_cred,
380 struct ucred *file_cred, struct vnode *vp);
381int mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
382 struct mac *extmac);
383int mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
384 struct mac *extmac);
385int mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
386 struct ifnet *ifnet);
387int mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
388 struct ifnet *ifnet);
389int mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
390 struct mac *extmac);
391int mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
392 struct label *label);
393
394/*
395 * Calls to help various file systems implement labeling functionality
396 * using their existing EA implementation.
397 */
398int vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
399 struct ucred *cred);
400int vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
401int vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
402
403#endif /* _KERNEL */
404
405#endif /* !_SYS_MAC_H */