xref: /freebsd/sys/security/mac/mac_framework.h (revision c4f6a2a9e1b1879b618c436ab4f56ff75c73a0f5)
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 #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 struct mac_biba_element {
80 	u_short	mbe_type;
81 	u_short	mbe_grade;
82 };
83 
84 /*
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
88  * use.
89  */
90 struct mac_biba {
91 	int			mb_flags;
92 	struct mac_biba_element	mb_single;
93 	struct mac_biba_element mb_rangelow, mb_rangehigh;
94 };
95 
96 /*
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.
102  */
103 struct mac_mls_element {
104 	u_short	mme_type;
105 	u_short	mme_level;
106 };
107 
108 /*
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
112  * use.
113  */
114 struct mac_mls {
115 	int			mm_flags;
116 	struct mac_mls_element	mm_single;
117 	struct mac_mls_element	mm_rangelow, mm_rangehigh;
118 };
119 
120 /*
121  * Structures and constants associated with a Type Enforcement policy.
122  * mac_te represents a Type Enforcement label.
123  */
124 #define	MAC_TE_TYPE_MAXLEN	32
125 struct mac_te {
126 	char	mt_type[MAC_TE_TYPE_MAXLEN+1];	/* TE type */
127 };
128 
129 struct mac_sebsd {
130 	uint32_t	ms_psid;	/* persistent sid storage */
131 };
132 
133 /*
134  * Composite structures and constants which combine the various policy
135  * elements into common structures to be associated with subjects and
136  * objects.
137  */
138 struct mac {
139 	int		m_macflags;
140 	struct mac_biba	m_biba;
141 	struct mac_mls	m_mls;
142 	struct mac_te	m_te;
143 	struct mac_sebsd m_sebsd;
144 };
145 typedef struct mac	*mac_t;
146 
147 #define	MAC_FLAG_INITIALIZED		0x00000001	/* Is initialized. */
148 
149 #ifndef _KERNEL
150 
151 /*
152  * POSIX.1e functions visible in the application namespace.
153  */
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);
169 
170 /*
171  * Extensions to POSIX.1e visible in the application namespace.
172  */
173 int	mac_is_present_np(const char *_policyname);
174 int	mac_syscall(const char *_policyname, int call, void *arg);
175 
176 /*
177  * System calls wrapped by some POSIX.1e functions.
178  */
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);
185 
186 #else /* _KERNEL */
187 
188 /*
189  * Kernel functions to manage and evaluate labels.
190  */
191 struct bpf_d;
192 struct componentname;
193 struct devfs_dirent;
194 struct ifnet;
195 struct ifreq;
196 struct ipq;
197 struct mbuf;
198 struct mount;
199 struct proc;
200 struct sockaddr;
201 struct socket;
202 struct pipe;
203 struct timespec;
204 struct ucred;
205 struct uio;
206 struct vattr;
207 struct vnode;
208 
209 #include <sys/acl.h>			/* XXX acl_type_t */
210 
211 struct vop_refreshlabel_args;
212 struct vop_setlabel_args;
213 
214 /*
215  * Label operations.
216  */
217 void	mac_init_bpfdesc(struct bpf_d *);
218 void	mac_init_cred(struct ucred *);
219 void	mac_init_devfsdirent(struct devfs_dirent *);
220 void	mac_init_ifnet(struct ifnet *);
221 void	mac_init_ipq(struct ipq *);
222 void	mac_init_socket(struct socket *);
223 void	mac_init_pipe(struct pipe *);
224 int	mac_init_mbuf(struct mbuf *m, int how);
225 void	mac_init_mount(struct mount *);
226 void	mac_init_vnode(struct vnode *);
227 void	mac_destroy_bpfdesc(struct bpf_d *);
228 void	mac_destroy_cred(struct ucred *);
229 void	mac_destroy_devfsdirent(struct devfs_dirent *);
230 void	mac_destroy_ifnet(struct ifnet *);
231 void	mac_destroy_ipq(struct ipq *);
232 void	mac_destroy_socket(struct socket *);
233 void	mac_destroy_pipe(struct pipe *);
234 void	mac_destroy_mbuf(struct mbuf *);
235 void	mac_destroy_mount(struct mount *);
236 void	mac_destroy_vnode(struct vnode *);
237 
238 /*
239  * Labeling event operations: file system objects, and things that
240  * look a lot like file system objects.
241  */
242 void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
243 void	mac_create_devfs_directory(char *dirname, int dirnamelen,
244 	    struct devfs_dirent *de);
245 void	mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
246 void	mac_create_vnode(struct ucred *cred, struct vnode *parent,
247 	    struct vnode *child);
248 void	mac_create_mount(struct ucred *cred, struct mount *mp);
249 void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
250 void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
251 	    struct label *newlabel);
252 void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
253 void	mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
254 void	mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
255 
256 /*
257  * Labeling event operations: IPC objects.
258  */
259 void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
260 void	mac_create_socket(struct ucred *cred, struct socket *socket);
261 void	mac_create_socket_from_socket(struct socket *oldsocket,
262 	    struct socket *newsocket);
263 void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
264 	    struct socket *socket);
265 void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
266 	    struct socket *newsocket);
267 void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
268 
269 /*
270  * Labeling event operations: network objects.
271  */
272 void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
273 void	mac_create_ifnet(struct ifnet *ifp);
274 void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
275 void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
276 void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
277 void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
278 void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
279 void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
280 void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
281 void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
282 	    struct ifnet *ifnet, struct mbuf *newmbuf);
283 void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
284 int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
285 void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
286 
287 /*
288  * Labeling event operations: processes.
289  */
290 void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
291 void	mac_execve_transition(struct ucred *old, struct ucred *new,
292 	    struct vnode *vp);
293 int	mac_execve_will_transition(struct ucred *old, struct vnode *vp);
294 void	mac_create_proc0(struct ucred *cred);
295 void	mac_create_proc1(struct ucred *cred);
296 
297 /* Access control checks. */
298 int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
299 int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
300 int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
301 int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
302 int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
303 	    unsigned long cmd, void *data);
304 int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
305 int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
306 int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
307 int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
308 int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
309 int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
310 int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
311 	    int signum);
312 int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
313 	    struct sockaddr *sockaddr);
314 int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
315 	    struct sockaddr *sockaddr);
316 int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
317 int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
318 int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
319 int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
320 	    int flags);
321 int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
322 int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
323 int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
324 	    struct componentname *cnp, struct vattr *vap);
325 int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
326 	    struct vnode *vp, struct componentname *cnp);
327 int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
328 	    acl_type_t type);
329 int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
330 int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
331 	    acl_type_t type);
332 int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
333 	    int attrnamespace, const char *name, struct uio *uio);
334 int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
335  	    struct componentname *cnp);
336 /* XXX This u_char should be vm_prot_t! */
337 u_char	mac_check_vnode_mmap_prot(struct ucred *cred, struct vnode *vp,
338 	    int newmapping);
339 int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
340 	    mode_t acc_mode);
341 int	mac_check_vnode_poll(struct ucred *active_cred,
342 	    struct ucred *file_cred, struct vnode *vp);
343 int	mac_check_vnode_read(struct ucred *active_cred,
344 	    struct ucred *file_cred, struct vnode *vp);
345 int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
346 int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
347 int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
348 	    struct vnode *vp, struct componentname *cnp);
349 int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
350 	    struct vnode *vp, int samedir, struct componentname *cnp);
351 int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
352 int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
353 	    acl_type_t type, struct acl *acl);
354 int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
355 	    int attrnamespace, const char *name, struct uio *uio);
356 int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
357 	    u_long flags);
358 int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
359 	    mode_t mode);
360 int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
361 	    uid_t uid, gid_t gid);
362 int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
363 	    struct timespec atime, struct timespec mtime);
364 int	mac_check_vnode_stat(struct ucred *active_cred,
365 	    struct ucred *file_cred, struct vnode *vp);
366 int	mac_check_vnode_write(struct ucred *active_cred,
367 	    struct ucred *file_cred, struct vnode *vp);
368 int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
369 	    struct mac *extmac);
370 int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
371 	    struct mac *extmac);
372 int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
373 	    struct ifnet *ifnet);
374 int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
375 	    struct ifnet *ifnet);
376 int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
377 	    struct mac *extmac);
378 int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
379 	    struct label *label);
380 
381 /*
382  * Calls to help various file systems implement labeling functionality
383  * using their existing EA implementation.
384  */
385 int	vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
386 	    struct ucred *cred);
387 int	vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
388 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
389 
390 #endif /* _KERNEL */
391 
392 #endif /* !_SYS_MAC_H */
393