mac_framework.h revision 123173
1/*-
2 * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
3 * Copyright (c) 2001, 2002, 2003 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 Network
9 * Associates Laboratories, the Security Research Division of Network
10 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
11 * as part of the DARPA 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 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $FreeBSD: head/sys/security/mac/mac_framework.h 123173 2003-12-06 21:48:03Z rwatson $
35 */
36/*
37 * Userland/kernel interface for Mandatory Access Control.
38 *
39 * The POSIX.1e implementation page may be reached at:
40 * http://www.trustedbsd.org/
41 */
42#ifndef _SYS_MAC_H
43#define	_SYS_MAC_H
44
45#include <sys/_label.h>
46
47#ifndef _POSIX_MAC
48#define	_POSIX_MAC
49#endif
50
51/*
52 * MAC framework-related constants and limits.
53 */
54#define	MAC_MAX_POLICY_NAME		32
55#define	MAC_MAX_LABEL_ELEMENT_NAME	32
56#define	MAC_MAX_LABEL_ELEMENT_DATA	4096
57#define	MAC_MAX_LABEL_BUF_LEN		8192
58
59struct mac {
60	size_t		 m_buflen;
61	char		*m_string;
62};
63
64typedef struct mac	*mac_t;
65
66#ifndef _KERNEL
67
68/*
69 * Location of the userland MAC framework configuration file.  mac.conf
70 * binds policy names to shared libraries that understand those policies,
71 * as well as setting defaults for MAC-aware applications.
72 */
73#define	MAC_CONFFILE	"/etc/mac.conf"
74
75/*
76 * Extended non-POSIX.1e interfaces that offer additional services
77 * available from the userland and kernel MAC frameworks.
78 */
79__BEGIN_DECLS
80int	 mac_execve(char *fname, char **argv, char **envv, mac_t _label);
81int	 mac_free(mac_t _label);
82int	 mac_from_text(mac_t *_label, const char *_text);
83int	 mac_get_fd(int _fd, mac_t _label);
84int	 mac_get_file(const char *_path, mac_t _label);
85int	 mac_get_link(const char *_path, mac_t _label);
86int	 mac_get_peer(int _fd, mac_t _label);
87int	 mac_get_pid(pid_t _pid, mac_t _label);
88int	 mac_get_proc(mac_t _label);
89int	 mac_is_present(const char *_policyname);
90int	 mac_prepare(mac_t *_label, const char *_elements);
91int	 mac_prepare_file_label(mac_t *_label);
92int	 mac_prepare_ifnet_label(mac_t *_label);
93int	 mac_prepare_process_label(mac_t *_label);
94int	 mac_prepare_type(mac_t *_label, const char *_type);
95int	 mac_set_fd(int _fildes, const mac_t _label);
96int	 mac_set_file(const char *_path, mac_t _label);
97int	 mac_set_link(const char *_path, mac_t _label);
98int	 mac_set_proc(const mac_t _label);
99int	 mac_syscall(const char *_policyname, int _call, void *_arg);
100int	 mac_to_text(mac_t mac, char **_text);
101__END_DECLS
102
103#else /* _KERNEL */
104
105/*
106 * Kernel functions to manage and evaluate labels.
107 */
108struct bpf_d;
109struct componentname;
110struct devfs_dirent;
111struct ifnet;
112struct ifreq;
113struct inpcb;
114struct image_params;
115struct inpcb;
116struct ipq;
117struct m_tag;
118struct mbuf;
119struct mount;
120struct proc;
121struct sockaddr;
122struct socket;
123struct pipe;
124struct thread;
125struct timespec;
126struct ucred;
127struct uio;
128struct vattr;
129struct vnode;
130
131#include <sys/acl.h>			/* XXX acl_type_t */
132
133struct vop_setlabel_args;
134
135/*
136 * Label operations.
137 */
138void	mac_init_bpfdesc(struct bpf_d *);
139void	mac_init_cred(struct ucred *);
140void	mac_init_devfsdirent(struct devfs_dirent *);
141void	mac_init_ifnet(struct ifnet *);
142int	mac_init_inpcb(struct inpcb *, int flag);
143int	mac_init_ipq(struct ipq *, int flag);
144int	mac_init_socket(struct socket *, int flag);
145void	mac_init_pipe(struct pipe *);
146int	mac_init_mbuf(struct mbuf *mbuf, int flag);
147int	mac_init_mbuf_tag(struct m_tag *, int flag);
148void	mac_init_mount(struct mount *);
149void	mac_init_proc(struct proc *);
150void	mac_init_vnode(struct vnode *);
151void	mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
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_inpcb(struct inpcb *);
158void	mac_destroy_ipq(struct ipq *);
159void	mac_destroy_socket(struct socket *);
160void	mac_destroy_pipe(struct pipe *);
161void	mac_destroy_proc(struct proc *);
162void	mac_destroy_mbuf_tag(struct m_tag *);
163void	mac_destroy_mount(struct mount *);
164void	mac_destroy_vnode(struct vnode *);
165
166struct label	*mac_cred_label_alloc(void);
167void		 mac_cred_label_free(struct label *label);
168struct label	*mac_vnode_label_alloc(void);
169void		 mac_vnode_label_free(struct label *label);
170
171/*
172 * Labeling event operations: file system objects, and things that
173 * look a lot like file system objects.
174 */
175void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
176	    struct vnode *vp);
177int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
178void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
179void	mac_create_devfs_device(struct mount *mp, dev_t dev,
180	    struct devfs_dirent *de);
181void	mac_create_devfs_directory(struct mount *mp, char *dirname,
182	    int dirnamelen, struct devfs_dirent *de);
183void	mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
184	    struct devfs_dirent *dd, struct devfs_dirent *de);
185int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
186	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
187void	mac_create_mount(struct ucred *cred, struct mount *mp);
188void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
189void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
190	    struct label *newlabel);
191void	mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
192	    struct vnode *vp);
193
194/*
195 * Labeling event operations: IPC objects.
196 */
197void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
198void	mac_create_socket(struct ucred *cred, struct socket *socket);
199void	mac_create_socket_from_socket(struct socket *oldsocket,
200	    struct socket *newsocket);
201void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
202	    struct socket *socket);
203void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
204	    struct socket *newsocket);
205void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
206
207/*
208 * Labeling event operations: network objects.
209 */
210void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
211void	mac_create_ifnet(struct ifnet *ifp);
212void	mac_create_inpcb_from_socket(struct socket *so, struct inpcb *inp);
213void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
214void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
215void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
216void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
217void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
218void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
219void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
220void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
221	    struct ifnet *ifnet, struct mbuf *newmbuf);
222void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
223int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
224void	mac_reflect_mbuf_icmp(struct mbuf *m);
225void	mac_reflect_mbuf_tcp(struct mbuf *m);
226void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
227void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
228
229/*
230 * Labeling event operations: processes.
231 */
232void	mac_copy_cred(struct ucred *cr1, struct ucred *cr2);
233int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
234void	mac_execve_exit(struct image_params *imgp);
235void	mac_execve_transition(struct ucred *old, struct ucred *new,
236	    struct vnode *vp, struct label *interpvnodelabel,
237	    struct image_params *imgp);
238int	mac_execve_will_transition(struct ucred *old, struct vnode *vp,
239	    struct label *interpvnodelabel, struct image_params *imgp);
240void	mac_create_proc0(struct ucred *cred);
241void	mac_create_proc1(struct ucred *cred);
242void	mac_thread_userret(struct thread *td);
243
244/* Access control checks. */
245int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
246int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
247int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
248int	mac_check_inpcb_deliver(struct inpcb *inp, struct mbuf *m);
249int	mac_check_kenv_dump(struct ucred *cred);
250int	mac_check_kenv_get(struct ucred *cred, char *name);
251int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
252int	mac_check_kenv_unset(struct ucred *cred, char *name);
253int	mac_check_kld_load(struct ucred *cred, struct vnode *vp);
254int	mac_check_kld_stat(struct ucred *cred);
255int	mac_check_kld_unload(struct ucred *cred);
256int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
257int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
258	    unsigned long cmd, void *data);
259int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
260int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
261int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
262int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
263int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
264int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
265int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
266	    int signum);
267int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
268	    struct sockaddr *sockaddr);
269int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
270	    struct sockaddr *sockaddr);
271int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
272int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
273int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
274int	mac_check_socket_send(struct ucred *cred, struct socket *so);
275int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
276int	mac_check_sysarch_ioperm(struct ucred *cred);
277int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
278int	mac_check_system_nfsd(struct ucred *cred);
279int	mac_check_system_reboot(struct ucred *cred, int howto);
280int	mac_check_system_settime(struct ucred *cred);
281int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
282int	mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
283int	mac_check_system_sysctl(struct ucred *cred, int *name,
284	    u_int namelen, void *old, size_t *oldlenp, int inkernel,
285	    void *new, size_t newlen);
286int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
287	    int acc_mode);
288int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
289int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
290int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
291	    struct componentname *cnp, struct vattr *vap);
292int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
293	    struct vnode *vp, struct componentname *cnp);
294int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
295	    acl_type_t type);
296int	mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
297	    int attrnamespace, const char *name);
298int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
299	    struct image_params *imgp);
300int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
301	    acl_type_t type);
302int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
303	    int attrnamespace, const char *name, struct uio *uio);
304int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
305	    struct vnode *vp, struct componentname *cnp);
306int	mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
307	    int attrnamespace);
308int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
309 	    struct componentname *cnp);
310int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
311	    int prot);
312int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
313	    int prot);
314int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
315	    int acc_mode);
316int	mac_check_vnode_poll(struct ucred *active_cred,
317	    struct ucred *file_cred, struct vnode *vp);
318int	mac_check_vnode_read(struct ucred *active_cred,
319	    struct ucred *file_cred, struct vnode *vp);
320int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
321int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
322int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
323	    struct vnode *vp, struct componentname *cnp);
324int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
325	    struct vnode *vp, int samedir, struct componentname *cnp);
326int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
327int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
328	    acl_type_t type, struct acl *acl);
329int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
330	    int attrnamespace, const char *name, struct uio *uio);
331int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
332	    u_long flags);
333int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
334	    mode_t mode);
335int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
336	    uid_t uid, gid_t gid);
337int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
338	    struct timespec atime, struct timespec mtime);
339int	mac_check_vnode_stat(struct ucred *active_cred,
340	    struct ucred *file_cred, struct vnode *vp);
341int	mac_check_vnode_write(struct ucred *active_cred,
342	    struct ucred *file_cred, struct vnode *vp);
343int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
344	    struct mac *extmac);
345int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
346	    struct mac *extmac);
347int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
348	    struct ifnet *ifnet);
349int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
350	    struct ifnet *ifnet);
351int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
352	    struct mac *extmac);
353int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
354	    struct label *label);
355void	mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
356
357/*
358 * Calls to help various file systems implement labeling functionality
359 * using their existing EA implementation.
360 */
361int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
362
363#endif /* !_KERNEL */
364
365#endif /* !_SYS_MAC_H */
366