mac_framework.h revision 105717
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 105717 2002-10-22 15:53:43Z 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#define	MAC_MAX_LABEL_ELEMENT_NAME	32
67#define	MAC_MAX_LABEL_ELEMENT_DATA	4096
68#define	MAC_MAX_LABEL_BUF_LEN		8192
69
70struct mac {
71	size_t		 m_buflen;
72	char		*m_string;
73};
74
75typedef struct mac	*mac_t;
76
77#ifndef _KERNEL
78
79/*
80 * Location of the userland MAC framework configuration file.  mac.conf
81 * binds policy names to shared libraries that understand those policies,
82 * as well as setting defaults for MAC-aware applications.
83 */
84#define	MAC_CONFFILE	"/etc/mac.conf"
85
86/*
87 * Extended non-POSIX.1e interfaces that offer additional services
88 * available from the userland and kernel MAC frameworks.
89 */
90int		 mac_free(mac_t _label);
91int		 mac_from_text(mac_t *_label, const char *_text);
92int		 mac_get_fd(int _fd, mac_t _label);
93int		 mac_get_file(const char *_path, mac_t _label);
94int		 mac_get_link(const char *_path, mac_t _label);
95int		 mac_get_pid(pid_t _pid, mac_t _label);
96int		 mac_get_proc(mac_t _label);
97int		 mac_is_present(const char *_policyname);
98int		 mac_prepare(mac_t *_label, char *_elements);
99int		 mac_prepare_file_label(mac_t *_label);
100int		 mac_prepare_ifnet_label(mac_t *_label);
101int		 mac_prepare_process_label(mac_t *_label);
102int		 mac_set_fd(int _fildes, const mac_t _label);
103int		 mac_set_file(const char *_path, mac_t _label);
104int		 mac_set_link(const char *_path, mac_t _label);
105int		 mac_set_proc(const mac_t _label);
106int		 mac_syscall(const char *_policyname, int _call, void *_arg);
107int		 mac_to_text(mac_t mac, char **_text);
108
109#endif /* !_KERNEL */
110
111/*
112 * XXXMAC: For compatibility until the labels on disk are changed.  We
113 * will enable the definitions in various policy include files once
114 * these can be disabled.
115 */
116
117#define	MAC_BIBA_MAX_COMPARTMENTS	256
118
119struct mac_biba_element {
120	u_short	mbe_type;
121	u_short	mbe_grade;
122	u_char	mbe_compartments[MAC_BIBA_MAX_COMPARTMENTS >> 3];
123};
124
125struct mac_biba {
126	int			mb_flags;
127	struct mac_biba_element	mb_single;
128	struct mac_biba_element	mb_rangelow, mb_rangehigh;
129};
130
131#define	MAC_MLS_MAX_COMPARTMENTS	256
132
133struct mac_mls_element {
134	u_short	mme_type;
135	u_short	mme_level;
136	u_char	mme_compartments[MAC_MLS_MAX_COMPARTMENTS >> 3];
137};
138
139struct mac_mls {
140	int			mm_flags;
141	struct mac_mls_element	mm_single;
142	struct mac_mls_element	mm_rangelow, mm_rangehigh;
143};
144
145#define	MAC_TE_TYPE_MAXLEN	32
146struct mac_te {
147	char	mt_type[MAC_TE_TYPE_MAXLEN];
148};
149
150struct mac_sebsd {
151	uint32_t	ms_psid;
152};
153
154struct oldmac {
155	int			m_macflags;
156	struct mac_biba		m_biba;
157	struct mac_mls		m_mls;
158	struct mac_te		m_te;
159	struct mac_sebsd	m_sebsd;
160};
161
162#ifdef _KERNEL
163
164/*
165 * Kernel functions to manage and evaluate labels.
166 */
167struct bpf_d;
168struct componentname;
169struct devfs_dirent;
170struct ifnet;
171struct ifreq;
172struct ipq;
173struct mbuf;
174struct mount;
175struct proc;
176struct sockaddr;
177struct socket;
178struct pipe;
179struct thread;
180struct timespec;
181struct ucred;
182struct uio;
183struct vattr;
184struct vnode;
185
186#include <sys/acl.h>			/* XXX acl_type_t */
187
188struct vop_refreshlabel_args;
189struct vop_setlabel_args;
190
191/*
192 * Label operations.
193 */
194void	mac_init_bpfdesc(struct bpf_d *);
195void	mac_init_cred(struct ucred *);
196void	mac_init_devfsdirent(struct devfs_dirent *);
197void	mac_init_ifnet(struct ifnet *);
198void	mac_init_ipq(struct ipq *);
199int	mac_init_socket(struct socket *, int flag);
200void	mac_init_pipe(struct pipe *);
201int	mac_init_mbuf(struct mbuf *m, int flag);
202void	mac_init_mount(struct mount *);
203void	mac_init_vnode(struct vnode *);
204void	mac_destroy_bpfdesc(struct bpf_d *);
205void	mac_destroy_cred(struct ucred *);
206void	mac_destroy_devfsdirent(struct devfs_dirent *);
207void	mac_destroy_ifnet(struct ifnet *);
208void	mac_destroy_ipq(struct ipq *);
209void	mac_destroy_socket(struct socket *);
210void	mac_destroy_pipe(struct pipe *);
211void	mac_destroy_mbuf(struct mbuf *);
212void	mac_destroy_mount(struct mount *);
213void	mac_destroy_vnode(struct vnode *);
214
215/*
216 * Labeling event operations: file system objects, and things that
217 * look a lot like file system objects.
218 */
219void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
220void	mac_create_devfs_directory(char *dirname, int dirnamelen,
221	    struct devfs_dirent *de);
222void	mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
223	    struct devfs_dirent *de);
224void	mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
225void	mac_create_vnode(struct ucred *cred, struct vnode *parent,
226	    struct vnode *child);
227void	mac_create_mount(struct ucred *cred, struct mount *mp);
228void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
229void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
230	    struct label *newlabel);
231void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
232void	mac_update_procfsvnode(struct vnode *vp, struct ucred *cred);
233void	mac_update_vnode_from_mount(struct vnode *vp, struct mount *mp);
234
235/*
236 * Labeling event operations: IPC objects.
237 */
238void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
239void	mac_create_socket(struct ucred *cred, struct socket *socket);
240void	mac_create_socket_from_socket(struct socket *oldsocket,
241	    struct socket *newsocket);
242void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
243	    struct socket *socket);
244void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
245	    struct socket *newsocket);
246void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
247
248/*
249 * Labeling event operations: network objects.
250 */
251void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
252void	mac_create_ifnet(struct ifnet *ifp);
253void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
254void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
255void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
256void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
257void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
258void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
259void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
260void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
261	    struct ifnet *ifnet, struct mbuf *newmbuf);
262void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
263int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
264void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
265
266/*
267 * Labeling event operations: processes.
268 */
269void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
270void	mac_execve_transition(struct ucred *old, struct ucred *new,
271	    struct vnode *vp);
272int	mac_execve_will_transition(struct ucred *old, struct vnode *vp);
273void	mac_create_proc0(struct ucred *cred);
274void	mac_create_proc1(struct ucred *cred);
275void	mac_thread_userret(struct thread *td);
276
277/* Access control checks. */
278int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
279int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
280int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
281int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
282int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
283	    unsigned long cmd, void *data);
284int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
285int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
286int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
287int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
288int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
289int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
290int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
291	    int signum);
292int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
293	    struct sockaddr *sockaddr);
294int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
295	    struct sockaddr *sockaddr);
296int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
297int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
298int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
299int	mac_check_socket_send(struct ucred *cred, struct socket *so);
300int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
301int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
302	    int flags);
303int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
304int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
305int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
306	    struct componentname *cnp, struct vattr *vap);
307int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
308	    struct vnode *vp, struct componentname *cnp);
309int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
310	    acl_type_t type);
311int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
312int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
313	    acl_type_t type);
314int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
315	    int attrnamespace, const char *name, struct uio *uio);
316int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
317	    struct vnode *vp, struct componentname *cnp);
318int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
319 	    struct componentname *cnp);
320int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
321	    int prot);
322int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
323	    int prot);
324int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
325	    mode_t acc_mode);
326int	mac_check_vnode_poll(struct ucred *active_cred,
327	    struct ucred *file_cred, struct vnode *vp);
328int	mac_check_vnode_read(struct ucred *active_cred,
329	    struct ucred *file_cred, struct vnode *vp);
330int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
331int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
332int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
333	    struct vnode *vp, struct componentname *cnp);
334int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
335	    struct vnode *vp, int samedir, struct componentname *cnp);
336int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
337int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
338	    acl_type_t type, struct acl *acl);
339int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
340	    int attrnamespace, const char *name, struct uio *uio);
341int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
342	    u_long flags);
343int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
344	    mode_t mode);
345int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
346	    uid_t uid, gid_t gid);
347int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
348	    struct timespec atime, struct timespec mtime);
349int	mac_check_vnode_stat(struct ucred *active_cred,
350	    struct ucred *file_cred, struct vnode *vp);
351int	mac_check_vnode_swapon(struct ucred *cred, struct vnode *vp);
352int	mac_check_vnode_write(struct ucred *active_cred,
353	    struct ucred *file_cred, struct vnode *vp);
354int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
355	    struct mac *extmac);
356int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
357	    struct mac *extmac);
358int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
359	    struct ifnet *ifnet);
360int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
361	    struct ifnet *ifnet);
362int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
363	    struct mac *extmac);
364int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
365	    struct label *label);
366
367/*
368 * Calls to help various file systems implement labeling functionality
369 * using their existing EA implementation.
370 */
371int	vop_stdcreatevnode_ea(struct vnode *dvp, struct vnode *tvp,
372	    struct ucred *cred);
373int	vop_stdrefreshlabel_ea(struct vop_refreshlabel_args *ap);
374int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
375
376#endif /* _KERNEL */
377
378#endif /* !_SYS_MAC_H */
379