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 101826 2002-08-13 15:54:28Z 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 * XXXMAC: Per-policy structures will be moved from mac.h to per-policy
64 * include files once the revised user interface is available.
65 */
66
67/*
68 * Structures and constants associated with a Biba Integrity policy.
69 * mac_biba represents a Biba label, with mb_type determining its properties,
70 * and mb_grade represents the hierarchal grade if valid for the current
71 * mb_type. These structures will move to mac_biba.h once we have dymamic
72 * labels exposed to userland.
73 */
74struct mac_biba_element {
75 u_short mbe_type;
76 u_short mbe_grade;
77};
78
79/*
80 * Biba labels consist of two components: a single label, and a label
81 * range. Depending on the context, one or both may be used; the mb_flags
82 * field permits the provider to indicate what fields are intended for
83 * use.
84 */
85struct mac_biba {
86 int mb_flags;
87 struct mac_biba_element mb_single;
88 struct mac_biba_element mb_rangelow, mb_rangehigh;
89};
90
91/*
92 * Structures and constants associated with a Multi-Level Security policy.
93 * mac_mls represents an MLS label, with mm_type determining its properties,
94 * and mm_level represents the hierarchal sensitivity level if valid for the
95 * current mm_type. These structures will move to mac_mls.h once we have
96 * dynamic labels exposed to userland.
97 */
98struct mac_mls_element {
99 u_short mme_type;
100 u_short mme_level;
101};
102
103/*
104 * MLS labels consist of two components: a single label, and a label
105 * range. Depending on the context, one or both may be used; the mb_flags
106 * field permits the provider to indicate what fields are intended for
107 * use.
108 */
109struct mac_mls {
110 int mm_flags;
111 struct mac_mls_element mm_single;
112 struct mac_mls_element mm_rangelow, mm_rangehigh;
113};
114
115/*
116 * Structures and constants associated with a Type Enforcement policy.
117 * mac_te represents a Type Enforcement label.
118 */
119#define MAC_TE_TYPE_MAXLEN 32
120struct mac_te {
121 char mt_type[MAC_TE_TYPE_MAXLEN+1]; /* TE type */
122};
123
124struct mac_sebsd {
125 uint32_t ms_psid; /* persistent sid storage */
126};
127
128/*
129 * Composite structures and constants which combine the various policy
130 * elements into common structures to be associated with subjects and
131 * objects.
132 */
133struct mac {
134 int m_macflags;
135 struct mac_biba m_biba;
136 struct mac_mls m_mls;
137 struct mac_te m_te;
138 struct mac_sebsd m_sebsd;
139};
140typedef struct mac *mac_t;
141
142#define MAC_FLAG_INITIALIZED 0x00000001 /* Is initialized. */
143
144#ifndef _KERNEL
145
146/*
147 * POSIX.1e functions visible in the application namespace.
148 */
149int mac_dominate(const mac_t _labela, const mac_t _labelb);
150int mac_equal(const mac_t labela, const mac_t _labelb);
151int mac_free(void *_buf_p);
152mac_t mac_from_text(const char *_text_p);
153mac_t mac_get_fd(int _fildes);
154mac_t mac_get_file(const char *_path_p);
155mac_t mac_get_proc(void);
156mac_t mac_glb(const mac_t _labela, const mac_t _labelb);
157mac_t mac_lub(const mac_t _labela, const mac_t _labelb);
158int mac_set_fd(int _fildes, const mac_t _label);
159int mac_set_file(const char *_path_p, mac_t _label);
160int mac_set_proc(const mac_t _label);
161ssize_t mac_size(mac_t _label);
162char * mac_to_text(const mac_t _label, size_t *_len_p);
163int mac_valid(const mac_t _label);
164
165/*
166 * Extensions to POSIX.1e visible in the application namespace.
167 */
168int mac_is_present_np(const char *_policyname);
169int mac_policy(const char *_policyname, int call, void *arg);
170
171/*
172 * System calls wrapped by some POSIX.1e functions.
173 */
174int __mac_get_fd(int _fd, struct mac *_mac_p);
175int __mac_get_file(const char *_path_p, struct mac *_mac_p);
176int __mac_get_proc(struct mac *_mac_p);
177int __mac_set_fd(int fd, struct mac *_mac_p);
178int __mac_set_file(const char *_path_p, struct mac *_mac_p);
179int __mac_set_proc(struct mac *_mac_p);
180
181#else /* _KERNEL */
182
183/*
184 * MAC entry point operations
185 */
186enum mac_ep_ops {
187 MAC_OP_VNODE_READ,
188 MAC_OP_VNODE_WRITE,
189 MAC_OP_VNODE_POLL,
190 MAC_OP_PIPE_READ,
191 MAC_OP_PIPE_WRITE,
192 MAC_OP_PIPE_STAT,
193 MAC_OP_PIPE_POLL
194};
195
196/*
197 * Kernel functions to manage and evaluate labels.
198 */
199struct bpf_d;
200struct componentname;
201struct devfs_dirent;
202struct ifnet;
203struct ifreq;
204struct ipq;
205struct mbuf;
206struct mount;
207struct proc;
208struct sockaddr;
209struct socket;
210struct pipe;
211struct timespec;
212struct ucred;
213struct uio;
214struct vattr;
215struct vnode;
216
217#include <sys/acl.h> /* XXX acl_type_t */
218
219struct vop_refreshlabel_args;
220struct vop_setlabel_args;
221
222/*
223 * Label operations.
224 */
225void mac_init_bpfdesc(struct bpf_d *);
226void mac_init_cred(struct ucred *);
227void mac_init_devfsdirent(struct devfs_dirent *);
228void mac_init_ifnet(struct ifnet *);
229void mac_init_ipq(struct ipq *);
230void mac_init_socket(struct socket *);
231void mac_init_pipe(struct pipe *);
232int mac_init_mbuf(struct mbuf *m, int how);
233void mac_init_mount(struct mount *);
234void mac_init_vnode(struct vnode *);
235void mac_destroy_bpfdesc(struct bpf_d *);
236void mac_destroy_cred(struct ucred *);
237void mac_destroy_devfsdirent(struct devfs_dirent *);
238void mac_destroy_ifnet(struct ifnet *);
239void mac_destroy_ipq(struct ipq *);
240void mac_destroy_socket(struct socket *);
241void mac_destroy_pipe(struct pipe *);
242void mac_destroy_mbuf(struct mbuf *);
243void mac_destroy_mount(struct mount *);
244void mac_destroy_vnode(struct vnode *);
245
246/*
247 * Labeling event operations: file system objects, and things that
248 * look a lot like file system objects.
249 */
250void mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
251void mac_create_devfs_directory(char *dirname, int dirnamelen,
252 struct devfs_dirent *de);
253void mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
254void mac_create_vnode(struct ucred *cred, struct vnode *parent,
255 struct vnode *child);
256void mac_create_mount(struct ucred *cred, struct mount *mp);
257void mac_create_root_mount(struct ucred *cred, struct mount *mp);
258void mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
259 struct label *newlabel);
260void mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
261void mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
262void mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
263
264/*
265 * Labeling event operations: IPC objects.
266 */
267void mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
268void mac_create_socket(struct ucred *cred, struct socket *socket);
269void mac_create_socket_from_socket(struct socket *oldsocket,
270 struct socket *newsocket);
271void mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
272 struct socket *socket);
273void mac_set_socket_peer_from_socket(struct socket *oldsocket,
274 struct socket *newsocket);
275void mac_create_pipe(struct ucred *cred, struct pipe *pipe);
276
277/*
278 * Labeling event operations: network objects.
279 */
280void mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
281void mac_create_ifnet(struct ifnet *ifp);
282void mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
283void mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
284void mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
285void mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
286void mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
287void mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
288void mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
289void mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
290 struct ifnet *ifnet, struct mbuf *newmbuf);
291void mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
292int mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
293void mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
294
295/*
296 * Labeling event operations: processes.
297 */
298void mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
299void mac_execve_transition(struct ucred *old, struct ucred *new,
300 struct vnode *vp);
301int mac_execve_will_transition(struct ucred *old, struct vnode *vp);
302void mac_create_proc0(struct ucred *cred);
303void mac_create_proc1(struct ucred *cred);
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_op(struct ucred *cred, struct pipe *pipe, int op);
311int mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
312 unsigned long cmd, void *data);
313int mac_check_proc_debug(struct ucred *cred, struct proc *proc);
314int mac_check_proc_sched(struct ucred *cred, struct proc *proc);
315int mac_check_proc_signal(struct ucred *cred, struct proc *proc,
316 int signum);
317int mac_check_socket_bind(struct ucred *cred, struct socket *so,
318 struct sockaddr *sockaddr);
319int mac_check_socket_connect(struct ucred *cred, struct socket *so,
320 struct sockaddr *sockaddr);
321int mac_check_socket_listen(struct ucred *cred, struct socket *so);
322int mac_check_socket_receive(struct socket *so, struct mbuf *m);
323int mac_check_socket_visible(struct ucred *cred, struct socket *so);
324int mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
325 int flags);
326int mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
327int mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
328int mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
329 struct componentname *cnp, struct vattr *vap);
330int mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
331 struct vnode *vp, struct componentname *cnp);
332int mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
333 acl_type_t type);
334int mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
335int mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
336 acl_type_t type);
337int mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
338 int attrnamespace, const char *name, struct uio *uio);
339int mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
340 struct componentname *cnp);
341/* XXX This u_char should be vm_prot_t! */
342u_char mac_check_vnode_mmap_prot(struct ucred *cred, struct vnode *vp,
343 int newmapping);
344int mac_check_vnode_op(struct ucred *cred, struct vnode *vp, int op);
345int mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
346 mode_t acc_mode);
347int mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
348int mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
349int mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
350 struct vnode *vp, struct componentname *cnp);
351int mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
352 struct vnode *vp, int samedir, struct componentname *cnp);
353int mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
354int mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
355 acl_type_t type, struct acl *acl);
356int mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
357 int attrnamespace, const char *name, struct uio *uio);
358int mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
359 u_long flags);
360int mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
361 mode_t mode);
362int mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
363 uid_t uid, gid_t gid);
364int mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
365 struct timespec atime, struct timespec mtime);
366int mac_check_vnode_stat(struct ucred *cred, struct vnode *vp);
367int mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
368 struct mac *extmac);
369int mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
370 struct mac *extmac);
371int mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
372 struct ifnet *ifnet);
373int mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
374 struct ifnet *ifnet);
375int mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
376 struct mac *extmac);
377int mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
378 struct label *label);
379
380/*
381 * Calls to help various file systems implement labeling functionality
382 * using their existing EA implementation.
383 */
384int vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
385 struct ucred *cred);
386int vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
387int vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
388
389#endif /* _KERNEL */
390
391#endif /* !_SYS_MAC_H */