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