mac_framework.h revision 126121
1/*-
2 * Copyright (c) 1999-2002 Robert N. M. Watson
3 * Copyright (c) 2001-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 126121 2004-02-22 12:31:44Z pjd $
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 sysctl_oid;
124struct sysctl_req;
125struct pipepair;
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 *);
144int	mac_init_inpcb(struct inpcb *, int flag);
145int	mac_init_ipq(struct ipq *, int flag);
146int	mac_init_socket(struct socket *, int flag);
147void	mac_init_pipe(struct pipepair *);
148int	mac_init_mbuf(struct mbuf *mbuf, int flag);
149int	mac_init_mbuf_tag(struct m_tag *, int flag);
150void	mac_init_mount(struct mount *);
151void	mac_init_proc(struct proc *);
152void	mac_init_vnode(struct vnode *);
153void	mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
154void	mac_copy_vnode_label(struct label *, struct label *label);
155void	mac_destroy_bpfdesc(struct bpf_d *);
156void	mac_destroy_cred(struct ucred *);
157void	mac_destroy_devfsdirent(struct devfs_dirent *);
158void	mac_destroy_ifnet(struct ifnet *);
159void	mac_destroy_inpcb(struct inpcb *);
160void	mac_destroy_ipq(struct ipq *);
161void	mac_destroy_socket(struct socket *);
162void	mac_destroy_pipe(struct pipepair *);
163void	mac_destroy_proc(struct proc *);
164void	mac_destroy_mbuf_tag(struct m_tag *);
165void	mac_destroy_mount(struct mount *);
166void	mac_destroy_vnode(struct vnode *);
167
168struct label	*mac_cred_label_alloc(void);
169void		 mac_cred_label_free(struct label *label);
170struct label	*mac_vnode_label_alloc(void);
171void		 mac_vnode_label_free(struct label *label);
172
173/*
174 * Labeling event operations: file system objects, and things that
175 * look a lot like file system objects.
176 */
177void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
178	    struct vnode *vp);
179int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
180void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
181void	mac_create_devfs_device(struct mount *mp, dev_t dev,
182	    struct devfs_dirent *de);
183void	mac_create_devfs_directory(struct mount *mp, char *dirname,
184	    int dirnamelen, struct devfs_dirent *de);
185void	mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
186	    struct devfs_dirent *dd, struct devfs_dirent *de);
187int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
188	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
189void	mac_create_mount(struct ucred *cred, struct mount *mp);
190void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
191void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
192	    struct label *newlabel);
193void	mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
194	    struct vnode *vp);
195
196/*
197 * Labeling event operations: IPC objects.
198 */
199void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
200void	mac_create_socket(struct ucred *cred, struct socket *socket);
201void	mac_create_socket_from_socket(struct socket *oldsocket,
202	    struct socket *newsocket);
203void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
204	    struct socket *socket);
205void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
206	    struct socket *newsocket);
207void	mac_create_pipe(struct ucred *cred, struct pipepair *pp);
208
209/*
210 * Labeling event operations: network objects.
211 */
212void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
213void	mac_create_ifnet(struct ifnet *ifp);
214void	mac_create_inpcb_from_socket(struct socket *so, struct inpcb *inp);
215void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
216void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
217void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
218void	mac_create_mbuf_from_inpcb(struct inpcb *inp, struct mbuf *m);
219void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
220void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
221void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
222void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
223void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
224	    struct ifnet *ifnet, struct mbuf *newmbuf);
225void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
226int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
227void	mac_reflect_mbuf_icmp(struct mbuf *m);
228void	mac_reflect_mbuf_tcp(struct mbuf *m);
229void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
230void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
231
232/*
233 * Labeling event operations: processes.
234 */
235void	mac_copy_cred(struct ucred *cr1, struct ucred *cr2);
236int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
237void	mac_execve_exit(struct image_params *imgp);
238void	mac_execve_transition(struct ucred *old, struct ucred *new,
239	    struct vnode *vp, struct label *interpvnodelabel,
240	    struct image_params *imgp);
241int	mac_execve_will_transition(struct ucred *old, struct vnode *vp,
242	    struct label *interpvnodelabel, struct image_params *imgp);
243void	mac_create_proc0(struct ucred *cred);
244void	mac_create_proc1(struct ucred *cred);
245void	mac_thread_userret(struct thread *td);
246
247/* Access control checks. */
248int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
249int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
250int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
251int	mac_check_inpcb_deliver(struct inpcb *inp, struct mbuf *m);
252int	mac_check_kenv_dump(struct ucred *cred);
253int	mac_check_kenv_get(struct ucred *cred, char *name);
254int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
255int	mac_check_kenv_unset(struct ucred *cred, char *name);
256int	mac_check_kld_load(struct ucred *cred, struct vnode *vp);
257int	mac_check_kld_stat(struct ucred *cred);
258int	mac_check_kld_unload(struct ucred *cred);
259int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
260int	mac_check_pipe_ioctl(struct ucred *cred, struct pipepair *pp,
261	    unsigned long cmd, void *data);
262int	mac_check_pipe_poll(struct ucred *cred, struct pipepair *pp);
263int	mac_check_pipe_read(struct ucred *cred, struct pipepair *pp);
264int	mac_check_pipe_stat(struct ucred *cred, struct pipepair *pp);
265int	mac_check_pipe_write(struct ucred *cred, struct pipepair *pp);
266int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
267int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
268int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
269	    int signum);
270int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
271	    struct sockaddr *sockaddr);
272int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
273	    struct sockaddr *sockaddr);
274int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
275int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
276int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
277int	mac_check_socket_send(struct ucred *cred, struct socket *so);
278int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
279int	mac_check_sysarch_ioperm(struct ucred *cred);
280int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
281int	mac_check_system_nfsd(struct ucred *cred);
282int	mac_check_system_reboot(struct ucred *cred, int howto);
283int	mac_check_system_settime(struct ucred *cred);
284int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
285int	mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
286int	mac_check_system_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
287	    void *arg1, int arg2, struct sysctl_req *req);
288int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
289	    int acc_mode);
290int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
291int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
292int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
293	    struct componentname *cnp, struct vattr *vap);
294int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
295	    struct vnode *vp, struct componentname *cnp);
296int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
297	    acl_type_t type);
298int	mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
299	    int attrnamespace, const char *name);
300int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
301	    struct image_params *imgp);
302int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
303	    acl_type_t type);
304int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
305	    int attrnamespace, const char *name, struct uio *uio);
306int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
307	    struct vnode *vp, struct componentname *cnp);
308int	mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
309	    int attrnamespace);
310int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
311 	    struct componentname *cnp);
312int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
313	    int prot);
314int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
315	    int prot);
316int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
317	    int acc_mode);
318int	mac_check_vnode_poll(struct ucred *active_cred,
319	    struct ucred *file_cred, struct vnode *vp);
320int	mac_check_vnode_read(struct ucred *active_cred,
321	    struct ucred *file_cred, struct vnode *vp);
322int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
323int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
324int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
325	    struct vnode *vp, struct componentname *cnp);
326int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
327	    struct vnode *vp, int samedir, struct componentname *cnp);
328int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
329int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
330	    acl_type_t type, struct acl *acl);
331int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
332	    int attrnamespace, const char *name, struct uio *uio);
333int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
334	    u_long flags);
335int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
336	    mode_t mode);
337int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
338	    uid_t uid, gid_t gid);
339int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
340	    struct timespec atime, struct timespec mtime);
341int	mac_check_vnode_stat(struct ucred *active_cred,
342	    struct ucred *file_cred, struct vnode *vp);
343int	mac_check_vnode_write(struct ucred *active_cred,
344	    struct ucred *file_cred, struct vnode *vp);
345int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
346	    struct mac *extmac);
347int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
348	    struct mac *extmac);
349int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
350	    struct ifnet *ifnet);
351int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
352	    struct ifnet *ifnet);
353int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
354	    struct mac *extmac);
355int	mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
356	    struct label *label);
357void	mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
358
359/*
360 * Calls to help various file systems implement labeling functionality
361 * using their existing EA implementation.
362 */
363int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
364
365#endif /* !_KERNEL */
366
367#endif /* !_SYS_MAC_H */
368