mac_framework.h revision 106308
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 106308 2002-11-01 20:46:53Z 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#else /* _KERNEL */
110
111/*
112 * Kernel functions to manage and evaluate labels.
113 */
114struct bpf_d;
115struct componentname;
116struct devfs_dirent;
117struct ifnet;
118struct ifreq;
119struct ipq;
120struct mbuf;
121struct mount;
122struct proc;
123struct sockaddr;
124struct socket;
125struct pipe;
126struct thread;
127struct timespec;
128struct ucred;
129struct uio;
130struct vattr;
131struct vnode;
132
133#include <sys/acl.h>			/* XXX acl_type_t */
134
135struct vop_refreshlabel_args;
136struct vop_setlabel_args;
137
138/*
139 * Label operations.
140 */
141void	mac_init_bpfdesc(struct bpf_d *);
142void	mac_init_cred(struct ucred *);
143void	mac_init_devfsdirent(struct devfs_dirent *);
144void	mac_init_ifnet(struct ifnet *);
145void	mac_init_ipq(struct ipq *);
146int	mac_init_socket(struct socket *, int flag);
147void	mac_init_pipe(struct pipe *);
148int	mac_init_mbuf(struct mbuf *m, int flag);
149void	mac_init_mount(struct mount *);
150void	mac_init_vnode(struct vnode *);
151void	mac_init_vnode_label(struct label *);
152void	mac_copy_vnode_label(struct label *, struct label *label);
153void	mac_destroy_bpfdesc(struct bpf_d *);
154void	mac_destroy_cred(struct ucred *);
155void	mac_destroy_devfsdirent(struct devfs_dirent *);
156void	mac_destroy_ifnet(struct ifnet *);
157void	mac_destroy_ipq(struct ipq *);
158void	mac_destroy_socket(struct socket *);
159void	mac_destroy_pipe(struct pipe *);
160void	mac_destroy_mbuf(struct mbuf *);
161void	mac_destroy_mount(struct mount *);
162void	mac_destroy_vnode(struct vnode *);
163void	mac_destroy_vnode_label(struct label *);
164
165/*
166 * Labeling event operations: file system objects, and things that
167 * look a lot like file system objects.
168 */
169void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
170	    struct vnode *vp);
171int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
172void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
173void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
174void	mac_create_devfs_directory(char *dirname, int dirnamelen,
175	    struct devfs_dirent *de);
176void	mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
177	    struct devfs_dirent *de);
178void	mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
179int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
180	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
181void	mac_create_mount(struct ucred *cred, struct mount *mp);
182void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
183void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
184	    struct label *newlabel);
185void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
186
187/*
188 * Labeling event operations: IPC objects.
189 */
190void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
191void	mac_create_socket(struct ucred *cred, struct socket *socket);
192void	mac_create_socket_from_socket(struct socket *oldsocket,
193	    struct socket *newsocket);
194void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
195	    struct socket *socket);
196void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
197	    struct socket *newsocket);
198void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
199
200/*
201 * Labeling event operations: network objects.
202 */
203void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
204void	mac_create_ifnet(struct ifnet *ifp);
205void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
206void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
207void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
208void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
209void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
210void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
211void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
212void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
213	    struct ifnet *ifnet, struct mbuf *newmbuf);
214void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
215int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
216void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
217
218/*
219 * Labeling event operations: processes.
220 */
221void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
222void	mac_execve_transition(struct ucred *old, struct ucred *new,
223	    struct vnode *vp);
224int	mac_execve_will_transition(struct ucred *old, struct vnode *vp);
225void	mac_create_proc0(struct ucred *cred);
226void	mac_create_proc1(struct ucred *cred);
227void	mac_thread_userret(struct thread *td);
228
229/* Access control checks. */
230int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
231int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
232int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
233int	mac_check_kenv_dump(struct ucred *cred);
234int	mac_check_kenv_get(struct ucred *cred, char *name);
235int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
236int	mac_check_kenv_unset(struct ucred *cred, char *name);
237int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
238int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
239	    unsigned long cmd, void *data);
240int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
241int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
242int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
243int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
244int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
245int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
246int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
247	    int signum);
248int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
249	    struct sockaddr *sockaddr);
250int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
251	    struct sockaddr *sockaddr);
252int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
253int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
254int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
255int	mac_check_socket_send(struct ucred *cred, struct socket *so);
256int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
257int	mac_check_system_reboot(struct ucred *cred, int howto);
258int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
259int	mac_check_system_sysctl(struct ucred *cred, int *name,
260	    u_int namelen, void *old, size_t *oldlenp, int inkernel,
261	    void *new, size_t newlen);
262int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
263	    int acc_mode);
264int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
265int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
266int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
267	    struct componentname *cnp, struct vattr *vap);
268int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
269	    struct vnode *vp, struct componentname *cnp);
270int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
271	    acl_type_t type);
272int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
273int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
274	    acl_type_t type);
275int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
276	    int attrnamespace, const char *name, struct uio *uio);
277int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
278	    struct vnode *vp, struct componentname *cnp);
279int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
280 	    struct componentname *cnp);
281int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
282	    int prot);
283int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
284	    int prot);
285int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
286	    int acc_mode);
287int	mac_check_vnode_poll(struct ucred *active_cred,
288	    struct ucred *file_cred, struct vnode *vp);
289int	mac_check_vnode_read(struct ucred *active_cred,
290	    struct ucred *file_cred, struct vnode *vp);
291int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
292int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
293int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
294	    struct vnode *vp, struct componentname *cnp);
295int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
296	    struct vnode *vp, int samedir, struct componentname *cnp);
297int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
298int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
299	    acl_type_t type, struct acl *acl);
300int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
301	    int attrnamespace, const char *name, struct uio *uio);
302int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
303	    u_long flags);
304int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
305	    mode_t mode);
306int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
307	    uid_t uid, gid_t gid);
308int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
309	    struct timespec atime, struct timespec mtime);
310int	mac_check_vnode_stat(struct ucred *active_cred,
311	    struct ucred *file_cred, struct vnode *vp);
312int	mac_check_vnode_write(struct ucred *active_cred,
313	    struct ucred *file_cred, struct vnode *vp);
314int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
315	    struct mac *extmac);
316int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
317	    struct mac *extmac);
318int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
319	    struct ifnet *ifnet);
320int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
321	    struct ifnet *ifnet);
322int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
323	    struct mac *extmac);
324int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
325	    struct label *label);
326
327/*
328 * Calls to help various file systems implement labeling functionality
329 * using their existing EA implementation.
330 */
331int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
332
333#endif /* !_KERNEL */
334
335#endif /* !_SYS_MAC_H */
336