mac.h revision 107089
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/sys/mac.h 107089 2002-11-19 22:12:42Z 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 * XXXMAC: The single MAC extended attribute will be deprecated once
53 * compound EA writes on a single target file can be performed cleanly
54 * with UFS2.
55 */
56#define	FREEBSD_MAC_EXTATTR_NAME	"freebsd.mac"
57#define	FREEBSD_MAC_EXTATTR_NAMESPACE	EXTATTR_NAMESPACE_SYSTEM
58
59/*
60 * MAC framework-related constants and limits.
61 */
62#define	MAC_MAX_POLICY_NAME		32
63#define	MAC_MAX_LABEL_ELEMENT_NAME	32
64#define	MAC_MAX_LABEL_ELEMENT_DATA	4096
65#define	MAC_MAX_LABEL_BUF_LEN		8192
66
67struct mac {
68	size_t		 m_buflen;
69	char		*m_string;
70};
71
72typedef struct mac	*mac_t;
73
74#ifndef _KERNEL
75
76/*
77 * Location of the userland MAC framework configuration file.  mac.conf
78 * binds policy names to shared libraries that understand those policies,
79 * as well as setting defaults for MAC-aware applications.
80 */
81#define	MAC_CONFFILE	"/etc/mac.conf"
82
83/*
84 * Extended non-POSIX.1e interfaces that offer additional services
85 * available from the userland and kernel MAC frameworks.
86 */
87int		 mac_execve(char *fname, char **argv, char **envv,
88		    mac_t _label);
89int		 mac_free(mac_t _label);
90int		 mac_from_text(mac_t *_label, const char *_text);
91int		 mac_get_fd(int _fd, mac_t _label);
92int		 mac_get_file(const char *_path, mac_t _label);
93int		 mac_get_link(const char *_path, mac_t _label);
94int		 mac_get_pid(pid_t _pid, mac_t _label);
95int		 mac_get_proc(mac_t _label);
96int		 mac_is_present(const char *_policyname);
97int		 mac_prepare(mac_t *_label, char *_elements);
98int		 mac_prepare_file_label(mac_t *_label);
99int		 mac_prepare_ifnet_label(mac_t *_label);
100int		 mac_prepare_process_label(mac_t *_label);
101int		 mac_set_fd(int _fildes, const mac_t _label);
102int		 mac_set_file(const char *_path, mac_t _label);
103int		 mac_set_link(const char *_path, mac_t _label);
104int		 mac_set_proc(const mac_t _label);
105int		 mac_syscall(const char *_policyname, int _call, void *_arg);
106int		 mac_to_text(mac_t mac, char **_text);
107
108#else /* _KERNEL */
109
110/*
111 * Kernel functions to manage and evaluate labels.
112 */
113struct bpf_d;
114struct componentname;
115struct devfs_dirent;
116struct ifnet;
117struct ifreq;
118struct image_params;
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_setlabel_args;
136
137/*
138 * Label operations.
139 */
140void	mac_init_bpfdesc(struct bpf_d *);
141void	mac_init_cred(struct ucred *);
142void	mac_init_devfsdirent(struct devfs_dirent *);
143void	mac_init_ifnet(struct ifnet *);
144void	mac_init_ipq(struct ipq *);
145int	mac_init_socket(struct socket *, int flag);
146void	mac_init_pipe(struct pipe *);
147int	mac_init_mbuf(struct mbuf *m, int flag);
148void	mac_init_mount(struct mount *);
149void	mac_init_vnode(struct vnode *);
150void	mac_init_vnode_label(struct label *);
151void	mac_copy_vnode_label(struct label *, struct label *label);
152void	mac_destroy_bpfdesc(struct bpf_d *);
153void	mac_destroy_cred(struct ucred *);
154void	mac_destroy_devfsdirent(struct devfs_dirent *);
155void	mac_destroy_ifnet(struct ifnet *);
156void	mac_destroy_ipq(struct ipq *);
157void	mac_destroy_socket(struct socket *);
158void	mac_destroy_pipe(struct pipe *);
159void	mac_destroy_mbuf(struct mbuf *);
160void	mac_destroy_mount(struct mount *);
161void	mac_destroy_vnode(struct vnode *);
162void	mac_destroy_vnode_label(struct label *);
163
164/*
165 * Labeling event operations: file system objects, and things that
166 * look a lot like file system objects.
167 */
168void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
169	    struct vnode *vp);
170int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
171void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
172void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
173void	mac_create_devfs_directory(char *dirname, int dirnamelen,
174	    struct devfs_dirent *de);
175void	mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
176	    struct devfs_dirent *de);
177int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
178	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
179void	mac_create_mount(struct ucred *cred, struct mount *mp);
180void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
181void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
182	    struct label *newlabel);
183void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
184
185/*
186 * Labeling event operations: IPC objects.
187 */
188void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
189void	mac_create_socket(struct ucred *cred, struct socket *socket);
190void	mac_create_socket_from_socket(struct socket *oldsocket,
191	    struct socket *newsocket);
192void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
193	    struct socket *socket);
194void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
195	    struct socket *newsocket);
196void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
197
198/*
199 * Labeling event operations: network objects.
200 */
201void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
202void	mac_create_ifnet(struct ifnet *ifp);
203void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
204void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
205void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
206void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
207void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
208void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
209void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
210void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
211	    struct ifnet *ifnet, struct mbuf *newmbuf);
212void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
213int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
214void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
215
216/*
217 * Labeling event operations: processes.
218 */
219void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
220int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p,
221	    struct label *execlabel);
222void	mac_execve_exit(struct image_params *imgp);
223void	mac_execve_transition(struct ucred *old, struct ucred *new,
224	    struct vnode *vp, struct label *interpvnodelabel,
225	    struct image_params *imgp);
226int	mac_execve_will_transition(struct ucred *old, struct vnode *vp,
227	    struct label *interpvnodelabel, struct image_params *imgp);
228void	mac_create_proc0(struct ucred *cred);
229void	mac_create_proc1(struct ucred *cred);
230void	mac_thread_userret(struct thread *td);
231
232/* Access control checks. */
233int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
234int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
235int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
236int	mac_check_kenv_dump(struct ucred *cred);
237int	mac_check_kenv_get(struct ucred *cred, char *name);
238int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
239int	mac_check_kenv_unset(struct ucred *cred, char *name);
240int	mac_check_kld_load(struct ucred *cred, struct vnode *vp);
241int	mac_check_kld_stat(struct ucred *cred);
242int	mac_check_kld_unload(struct ucred *cred);
243int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
244int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
245	    unsigned long cmd, void *data);
246int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
247int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
248int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
249int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
250int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
251int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
252int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
253	    int signum);
254int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
255	    struct sockaddr *sockaddr);
256int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
257	    struct sockaddr *sockaddr);
258int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
259int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
260int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
261int	mac_check_socket_send(struct ucred *cred, struct socket *so);
262int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
263int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
264int	mac_check_system_nfsd(struct ucred *cred);
265int	mac_check_system_reboot(struct ucred *cred, int howto);
266int	mac_check_system_settime(struct ucred *cred);
267int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
268int	mac_check_system_sysctl(struct ucred *cred, int *name,
269	    u_int namelen, void *old, size_t *oldlenp, int inkernel,
270	    void *new, size_t newlen);
271int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
272	    int acc_mode);
273int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
274int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
275int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
276	    struct componentname *cnp, struct vattr *vap);
277int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
278	    struct vnode *vp, struct componentname *cnp);
279int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
280	    acl_type_t type);
281int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
282	    struct image_params *imgp);
283int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
284	    acl_type_t type);
285int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
286	    int attrnamespace, const char *name, struct uio *uio);
287int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
288	    struct vnode *vp, struct componentname *cnp);
289int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
290 	    struct componentname *cnp);
291int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
292	    int prot);
293int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
294	    int prot);
295int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
296	    int acc_mode);
297int	mac_check_vnode_poll(struct ucred *active_cred,
298	    struct ucred *file_cred, struct vnode *vp);
299int	mac_check_vnode_read(struct ucred *active_cred,
300	    struct ucred *file_cred, struct vnode *vp);
301int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
302int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
303int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
304	    struct vnode *vp, struct componentname *cnp);
305int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
306	    struct vnode *vp, int samedir, struct componentname *cnp);
307int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
308int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
309	    acl_type_t type, struct acl *acl);
310int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
311	    int attrnamespace, const char *name, struct uio *uio);
312int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
313	    u_long flags);
314int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
315	    mode_t mode);
316int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
317	    uid_t uid, gid_t gid);
318int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
319	    struct timespec atime, struct timespec mtime);
320int	mac_check_vnode_stat(struct ucred *active_cred,
321	    struct ucred *file_cred, struct vnode *vp);
322int	mac_check_vnode_write(struct ucred *active_cred,
323	    struct ucred *file_cred, struct vnode *vp);
324int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
325	    struct mac *extmac);
326int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
327	    struct mac *extmac);
328int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
329	    struct ifnet *ifnet);
330int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
331	    struct ifnet *ifnet);
332int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
333	    struct mac *extmac);
334int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
335	    struct label *label);
336
337/*
338 * Calls to help various file systems implement labeling functionality
339 * using their existing EA implementation.
340 */
341int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
342
343#endif /* !_KERNEL */
344
345#endif /* !_SYS_MAC_H */
346