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