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