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