xref: /freebsd/sys/security/mac/mac_framework.h (revision c024c3eeb1d56f6424c2790f805a9038b214eeaf)
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  * 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  */
74 struct 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  */
85 struct 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  */
98 struct 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  */
109 struct 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
120 struct mac_te {
121 	char	mt_type[MAC_TE_TYPE_MAXLEN+1];	/* TE type */
122 };
123 
124 struct 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  */
133 struct 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 };
140 typedef 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  */
149 int	mac_dominate(const mac_t _labela, const mac_t _labelb);
150 int	mac_equal(const mac_t labela, const mac_t _labelb);
151 int	mac_free(void *_buf_p);
152 mac_t	mac_from_text(const char *_text_p);
153 mac_t	mac_get_fd(int _fildes);
154 mac_t	mac_get_file(const char *_path_p);
155 mac_t	mac_get_proc(void);
156 mac_t	mac_glb(const mac_t _labela, const mac_t _labelb);
157 mac_t	mac_lub(const mac_t _labela, const mac_t _labelb);
158 int	mac_set_fd(int _fildes, const mac_t _label);
159 int	mac_set_file(const char *_path_p, mac_t _label);
160 int	mac_set_proc(const mac_t _label);
161 ssize_t	mac_size(mac_t _label);
162 char *	mac_to_text(const mac_t _label, size_t *_len_p);
163 int	mac_valid(const mac_t _label);
164 
165 /*
166  * Extensions to POSIX.1e visible in the application namespace.
167  */
168 int	mac_is_present_np(const char *_policyname);
169 int	mac_policy(const char *_policyname, int call, void *arg);
170 
171 /*
172  * System calls wrapped by some POSIX.1e functions.
173  */
174 int	__mac_get_fd(int _fd, struct mac *_mac_p);
175 int	__mac_get_file(const char *_path_p, struct mac *_mac_p);
176 int	__mac_get_proc(struct mac *_mac_p);
177 int	__mac_set_fd(int fd, struct mac *_mac_p);
178 int	__mac_set_file(const char *_path_p, struct mac *_mac_p);
179 int	__mac_set_proc(struct mac *_mac_p);
180 
181 #else /* _KERNEL */
182 
183 /*
184  * Kernel functions to manage and evaluate labels.
185  */
186 struct bpf_d;
187 struct componentname;
188 struct devfs_dirent;
189 struct ifnet;
190 struct ifreq;
191 struct ipq;
192 struct mbuf;
193 struct mount;
194 struct proc;
195 struct sockaddr;
196 struct socket;
197 struct pipe;
198 struct timespec;
199 struct ucred;
200 struct uio;
201 struct vattr;
202 struct vnode;
203 
204 #include <sys/acl.h>			/* XXX acl_type_t */
205 
206 struct vop_refreshlabel_args;
207 struct vop_setlabel_args;
208 
209 /*
210  * Label operations.
211  */
212 void	mac_init_bpfdesc(struct bpf_d *);
213 void	mac_init_cred(struct ucred *);
214 void	mac_init_devfsdirent(struct devfs_dirent *);
215 void	mac_init_ifnet(struct ifnet *);
216 void	mac_init_ipq(struct ipq *);
217 void	mac_init_socket(struct socket *);
218 void	mac_init_pipe(struct pipe *);
219 int	mac_init_mbuf(struct mbuf *m, int how);
220 void	mac_init_mount(struct mount *);
221 void	mac_init_vnode(struct vnode *);
222 void	mac_destroy_bpfdesc(struct bpf_d *);
223 void	mac_destroy_cred(struct ucred *);
224 void	mac_destroy_devfsdirent(struct devfs_dirent *);
225 void	mac_destroy_ifnet(struct ifnet *);
226 void	mac_destroy_ipq(struct ipq *);
227 void	mac_destroy_socket(struct socket *);
228 void	mac_destroy_pipe(struct pipe *);
229 void	mac_destroy_mbuf(struct mbuf *);
230 void	mac_destroy_mount(struct mount *);
231 void	mac_destroy_vnode(struct vnode *);
232 
233 /*
234  * Labeling event operations: file system objects, and things that
235  * look a lot like file system objects.
236  */
237 void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
238 void	mac_create_devfs_directory(char *dirname, int dirnamelen,
239 	    struct devfs_dirent *de);
240 void	mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
241 void	mac_create_vnode(struct ucred *cred, struct vnode *parent,
242 	    struct vnode *child);
243 void	mac_create_mount(struct ucred *cred, struct mount *mp);
244 void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
245 void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
246 	    struct label *newlabel);
247 void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
248 void	mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
249 void	mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
250 
251 /*
252  * Labeling event operations: IPC objects.
253  */
254 void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
255 void	mac_create_socket(struct ucred *cred, struct socket *socket);
256 void	mac_create_socket_from_socket(struct socket *oldsocket,
257 	    struct socket *newsocket);
258 void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
259 	    struct socket *socket);
260 void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
261 	    struct socket *newsocket);
262 void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
263 
264 /*
265  * Labeling event operations: network objects.
266  */
267 void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
268 void	mac_create_ifnet(struct ifnet *ifp);
269 void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
270 void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
271 void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
272 void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
273 void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
274 void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
275 void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
276 void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
277 	    struct ifnet *ifnet, struct mbuf *newmbuf);
278 void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
279 int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
280 void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
281 
282 /*
283  * Labeling event operations: processes.
284  */
285 void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
286 void	mac_execve_transition(struct ucred *old, struct ucred *new,
287 	    struct vnode *vp);
288 int	mac_execve_will_transition(struct ucred *old, struct vnode *vp);
289 void	mac_create_proc0(struct ucred *cred);
290 void	mac_create_proc1(struct ucred *cred);
291 
292 /* Access control checks. */
293 int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
294 int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
295 int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
296 int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
297 int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
298 	    unsigned long cmd, void *data);
299 int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
300 int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
301 int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
302 int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
303 int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
304 int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
305 int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
306 	    int signum);
307 int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
308 	    struct sockaddr *sockaddr);
309 int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
310 	    struct sockaddr *sockaddr);
311 int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
312 int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
313 int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
314 int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
315 	    int flags);
316 int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
317 int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
318 int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
319 	    struct componentname *cnp, struct vattr *vap);
320 int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
321 	    struct vnode *vp, struct componentname *cnp);
322 int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
323 	    acl_type_t type);
324 int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
325 int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
326 	    acl_type_t type);
327 int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
328 	    int attrnamespace, const char *name, struct uio *uio);
329 int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
330  	    struct componentname *cnp);
331 /* XXX This u_char should be vm_prot_t! */
332 u_char	mac_check_vnode_mmap_prot(struct ucred *cred, struct vnode *vp,
333 	    int newmapping);
334 int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
335 	    mode_t acc_mode);
336 int	mac_check_vnode_poll(struct ucred *cred, struct vnode *vp);
337 int	mac_check_vnode_read(struct ucred *cred, struct vnode *vp);
338 int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
339 int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
340 int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
341 	    struct vnode *vp, struct componentname *cnp);
342 int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
343 	    struct vnode *vp, int samedir, struct componentname *cnp);
344 int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
345 int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
346 	    acl_type_t type, struct acl *acl);
347 int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
348 	    int attrnamespace, const char *name, struct uio *uio);
349 int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
350 	    u_long flags);
351 int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
352 	    mode_t mode);
353 int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
354 	    uid_t uid, gid_t gid);
355 int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
356 	    struct timespec atime, struct timespec mtime);
357 int	mac_check_vnode_stat(struct ucred *cred, struct vnode *vp);
358 int	mac_check_vnode_write(struct ucred *cred, struct vnode *vp);
359 int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
360 	    struct mac *extmac);
361 int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
362 	    struct mac *extmac);
363 int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
364 	    struct ifnet *ifnet);
365 int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
366 	    struct ifnet *ifnet);
367 int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
368 	    struct mac *extmac);
369 int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
370 	    struct label *label);
371 
372 /*
373  * Calls to help various file systems implement labeling functionality
374  * using their existing EA implementation.
375  */
376 int	vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
377 	    struct ucred *cred);
378 int	vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
379 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
380 
381 #endif /* _KERNEL */
382 
383 #endif /* !_SYS_MAC_H */
384