xref: /freebsd/sys/security/mac/mac_framework.h (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
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$
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 
59 struct mac {
60 	size_t		 m_buflen;
61 	char		*m_string;
62 };
63 
64 typedef 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
80 int	 mac_execve(char *fname, char **argv, char **envv, mac_t _label);
81 int	 mac_free(mac_t _label);
82 int	 mac_from_text(mac_t *_label, const char *_text);
83 int	 mac_get_fd(int _fd, mac_t _label);
84 int	 mac_get_file(const char *_path, mac_t _label);
85 int	 mac_get_link(const char *_path, mac_t _label);
86 int	 mac_get_peer(int _fd, mac_t _label);
87 int	 mac_get_pid(pid_t _pid, mac_t _label);
88 int	 mac_get_proc(mac_t _label);
89 int	 mac_is_present(const char *_policyname);
90 int	 mac_prepare(mac_t *_label, const char *_elements);
91 int	 mac_prepare_file_label(mac_t *_label);
92 int	 mac_prepare_ifnet_label(mac_t *_label);
93 int	 mac_prepare_process_label(mac_t *_label);
94 int	 mac_prepare_type(mac_t *_label, const char *_type);
95 int	 mac_set_fd(int _fildes, const mac_t _label);
96 int	 mac_set_file(const char *_path, mac_t _label);
97 int	 mac_set_link(const char *_path, mac_t _label);
98 int	 mac_set_proc(const mac_t _label);
99 int	 mac_syscall(const char *_policyname, int _call, void *_arg);
100 int	 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  */
108 struct bpf_d;
109 struct cdev;
110 struct componentname;
111 struct devfs_dirent;
112 struct ifnet;
113 struct ifreq;
114 struct inpcb;
115 struct image_params;
116 struct inpcb;
117 struct ipq;
118 struct m_tag;
119 struct mbuf;
120 struct mount;
121 struct msg;
122 struct msqid_kernel;
123 struct proc;
124 struct semid_kernel;
125 struct shmid_kernel;
126 struct sockaddr;
127 struct socket;
128 struct sysctl_oid;
129 struct sysctl_req;
130 struct pipepair;
131 struct thread;
132 struct timespec;
133 struct ucred;
134 struct uio;
135 struct vattr;
136 struct vnode;
137 
138 #include <sys/acl.h>			/* XXX acl_type_t */
139 
140 struct vop_setlabel_args;
141 
142 /*
143  * Label operations.
144  */
145 void	mac_init_bpfdesc(struct bpf_d *);
146 void	mac_init_cred(struct ucred *);
147 void	mac_init_devfsdirent(struct devfs_dirent *);
148 void	mac_init_ifnet(struct ifnet *);
149 int	mac_init_inpcb(struct inpcb *, int flag);
150 void	mac_init_sysv_msgmsg(struct msg *);
151 void	mac_init_sysv_msgqueue(struct msqid_kernel*);
152 void	mac_init_sysv_sema(struct semid_kernel*);
153 void	mac_init_sysv_shm(struct shmid_kernel*);
154 int	mac_init_ipq(struct ipq *, int flag);
155 int	mac_init_socket(struct socket *, int flag);
156 void	mac_init_pipe(struct pipepair *);
157 int	mac_init_mbuf(struct mbuf *mbuf, int flag);
158 int	mac_init_mbuf_tag(struct m_tag *, int flag);
159 void	mac_init_mount(struct mount *);
160 void	mac_init_proc(struct proc *);
161 void	mac_init_vnode(struct vnode *);
162 void	mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
163 void	mac_copy_vnode_label(struct label *, struct label *label);
164 void	mac_destroy_bpfdesc(struct bpf_d *);
165 void	mac_destroy_cred(struct ucred *);
166 void	mac_destroy_devfsdirent(struct devfs_dirent *);
167 void	mac_destroy_ifnet(struct ifnet *);
168 void	mac_destroy_inpcb(struct inpcb *);
169 void	mac_destroy_sysv_msgmsg(struct msg *);
170 void	mac_destroy_sysv_msgqueue(struct msqid_kernel *);
171 void	mac_destroy_sysv_sema(struct semid_kernel *);
172 void	mac_destroy_sysv_shm(struct shmid_kernel *);
173 void	mac_destroy_ipq(struct ipq *);
174 void	mac_destroy_socket(struct socket *);
175 void	mac_destroy_pipe(struct pipepair *);
176 void	mac_destroy_proc(struct proc *);
177 void	mac_destroy_mbuf_tag(struct m_tag *);
178 void	mac_destroy_mount(struct mount *);
179 void	mac_destroy_vnode(struct vnode *);
180 
181 struct label	*mac_cred_label_alloc(void);
182 void		 mac_cred_label_free(struct label *label);
183 struct label	*mac_vnode_label_alloc(void);
184 void		 mac_vnode_label_free(struct label *label);
185 
186 /*
187  * Labeling event operations: file system objects, and things that
188  * look a lot like file system objects.
189  */
190 void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
191 	    struct vnode *vp);
192 int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
193 void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
194 void	mac_create_devfs_device(struct mount *mp, struct cdev *dev,
195 	    struct devfs_dirent *de);
196 void	mac_create_devfs_directory(struct mount *mp, char *dirname,
197 	    int dirnamelen, struct devfs_dirent *de);
198 void	mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
199 	    struct devfs_dirent *dd, struct devfs_dirent *de);
200 int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
201 	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
202 void	mac_create_mount(struct ucred *cred, struct mount *mp);
203 void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
204 void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
205 	    struct label *newlabel);
206 void	mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
207 	    struct vnode *vp);
208 
209 /*
210  * Labeling event operations: IPC objects.
211  */
212 void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
213 void	mac_create_socket(struct ucred *cred, struct socket *socket);
214 void	mac_create_socket_from_socket(struct socket *oldsocket,
215 	    struct socket *newsocket);
216 void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
217 	    struct socket *socket);
218 void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
219 	    struct socket *newsocket);
220 void	mac_create_pipe(struct ucred *cred, struct pipepair *pp);
221 
222 /*
223  * Labeling event operations: System V IPC primitives
224  */
225 void	mac_create_sysv_msgmsg(struct ucred *cred,
226 	    struct msqid_kernel *msqkptr, struct msg *msgptr);
227 void	mac_create_sysv_msgqueue(struct ucred *cred,
228 	    struct msqid_kernel *msqkptr);
229 void	mac_create_sysv_sema(struct ucred *cred,
230 	    struct semid_kernel *semakptr);
231 void	mac_create_sysv_shm(struct ucred *cred,
232 	    struct shmid_kernel *shmsegptr);
233 
234 /*
235  * Labeling event operations: network objects.
236  */
237 void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
238 void	mac_create_ifnet(struct ifnet *ifp);
239 void	mac_create_inpcb_from_socket(struct socket *so, struct inpcb *inp);
240 void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
241 void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
242 void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
243 void	mac_create_mbuf_from_inpcb(struct inpcb *inp, struct mbuf *m);
244 void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
245 void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
246 void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
247 void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
248 void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
249 	    struct ifnet *ifnet, struct mbuf *newmbuf);
250 void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
251 int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
252 void	mac_reflect_mbuf_icmp(struct mbuf *m);
253 void	mac_reflect_mbuf_tcp(struct mbuf *m);
254 void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
255 void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
256 
257 /*
258  * Labeling event operations: processes.
259  */
260 void	mac_copy_cred(struct ucred *cr1, struct ucred *cr2);
261 int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
262 void	mac_execve_exit(struct image_params *imgp);
263 void	mac_execve_transition(struct ucred *old, struct ucred *new,
264 	    struct vnode *vp, struct label *interpvnodelabel,
265 	    struct image_params *imgp);
266 int	mac_execve_will_transition(struct ucred *old, struct vnode *vp,
267 	    struct label *interpvnodelabel, struct image_params *imgp);
268 void	mac_create_proc0(struct ucred *cred);
269 void	mac_create_proc1(struct ucred *cred);
270 void	mac_thread_userret(struct thread *td);
271 
272 /*
273  * Label cleanup operation: This is the inverse complement for the
274  * mac_create and associate type of hooks. This hook lets the policy
275  * module(s) perform a cleanup/flushing operation on the label
276  * associated with the objects, without freeing up the space allocated.
277  * This hook is useful in cases where it is desirable to remove any
278  * labeling reference when recycling any object to a pool. This hook
279  * does not replace the mac_destroy hooks.
280  */
281 void	mac_cleanup_sysv_msgmsg(struct msg *msgptr);
282 void	mac_cleanup_sysv_msgqueue(struct msqid_kernel *msqkptr);
283 void	mac_cleanup_sysv_sema(struct semid_kernel *semakptr);
284 void	mac_cleanup_sysv_shm(struct shmid_kernel *shmsegptr);
285 
286 /* Access control checks. */
287 int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
288 int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
289 int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
290 int	mac_check_inpcb_deliver(struct inpcb *inp, struct mbuf *m);
291 int	mac_check_sysv_msgmsq(struct ucred *cred, struct msg *msgptr,
292 	    struct msqid_kernel *msqkptr);
293 int	mac_check_sysv_msgrcv(struct ucred *cred, struct msg *msgptr);
294 int	mac_check_sysv_msgrmid(struct ucred *cred, struct msg *msgptr);
295 int	mac_check_sysv_msqget(struct ucred *cred,
296 	    struct msqid_kernel *msqkptr);
297 int	mac_check_sysv_msqsnd(struct ucred *cred,
298 	    struct msqid_kernel *msqkptr);
299 int	mac_check_sysv_msqrcv(struct ucred *cred,
300 	    struct msqid_kernel *msqkptr);
301 int	mac_check_sysv_msqctl(struct ucred *cred,
302 	    struct msqid_kernel *msqkptr, int cmd);
303 int	mac_check_sysv_semctl(struct ucred *cred,
304 	    struct semid_kernel *semakptr, int cmd);
305 int	mac_check_sysv_semget(struct ucred *cred,
306 	   struct semid_kernel *semakptr);
307 int	mac_check_sysv_semop(struct ucred *cred,struct semid_kernel *semakptr,
308 	    size_t accesstype);
309 int	mac_check_sysv_shmat(struct ucred *cred,
310 	    struct shmid_kernel *shmsegptr, int shmflg);
311 int	mac_check_sysv_shmctl(struct ucred *cred,
312 	    struct shmid_kernel *shmsegptr, int cmd);
313 int	mac_check_sysv_shmdt(struct ucred *cred,
314 	    struct shmid_kernel *shmsegptr);
315 int	mac_check_sysv_shmget(struct ucred *cred,
316 	    struct shmid_kernel *shmsegptr, int shmflg);
317 int	mac_check_kenv_dump(struct ucred *cred);
318 int	mac_check_kenv_get(struct ucred *cred, char *name);
319 int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
320 int	mac_check_kenv_unset(struct ucred *cred, char *name);
321 int	mac_check_kld_load(struct ucred *cred, struct vnode *vp);
322 int	mac_check_kld_stat(struct ucred *cred);
323 int	mac_check_kld_unload(struct ucred *cred);
324 int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
325 int	mac_check_pipe_ioctl(struct ucred *cred, struct pipepair *pp,
326 	    unsigned long cmd, void *data);
327 int	mac_check_pipe_poll(struct ucred *cred, struct pipepair *pp);
328 int	mac_check_pipe_read(struct ucred *cred, struct pipepair *pp);
329 int	mac_check_pipe_stat(struct ucred *cred, struct pipepair *pp);
330 int	mac_check_pipe_write(struct ucred *cred, struct pipepair *pp);
331 int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
332 int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
333 int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
334 	    int signum);
335 int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
336 	    struct sockaddr *sockaddr);
337 int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
338 	    struct sockaddr *sockaddr);
339 int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
340 int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
341 int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
342 int	mac_check_socket_send(struct ucred *cred, struct socket *so);
343 int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
344 int	mac_check_sysarch_ioperm(struct ucred *cred);
345 int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
346 int	mac_check_system_nfsd(struct ucred *cred);
347 int	mac_check_system_reboot(struct ucred *cred, int howto);
348 int	mac_check_system_settime(struct ucred *cred);
349 int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
350 int	mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
351 int	mac_check_system_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
352 	    void *arg1, int arg2, struct sysctl_req *req);
353 int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
354 	    int acc_mode);
355 int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
356 int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
357 int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
358 	    struct componentname *cnp, struct vattr *vap);
359 int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
360 	    struct vnode *vp, struct componentname *cnp);
361 int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
362 	    acl_type_t type);
363 int	mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
364 	    int attrnamespace, const char *name);
365 int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
366 	    struct image_params *imgp);
367 int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
368 	    acl_type_t type);
369 int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
370 	    int attrnamespace, const char *name, struct uio *uio);
371 int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
372 	    struct vnode *vp, struct componentname *cnp);
373 int	mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
374 	    int attrnamespace);
375 int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
376  	    struct componentname *cnp);
377 int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
378 	    int prot);
379 int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
380 	    int prot);
381 int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
382 	    int acc_mode);
383 int	mac_check_vnode_poll(struct ucred *active_cred,
384 	    struct ucred *file_cred, struct vnode *vp);
385 int	mac_check_vnode_read(struct ucred *active_cred,
386 	    struct ucred *file_cred, struct vnode *vp);
387 int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
388 int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
389 int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
390 	    struct vnode *vp, struct componentname *cnp);
391 int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
392 	    struct vnode *vp, int samedir, struct componentname *cnp);
393 int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
394 int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
395 	    acl_type_t type, struct acl *acl);
396 int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
397 	    int attrnamespace, const char *name, struct uio *uio);
398 int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
399 	    u_long flags);
400 int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
401 	    mode_t mode);
402 int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
403 	    uid_t uid, gid_t gid);
404 int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
405 	    struct timespec atime, struct timespec mtime);
406 int	mac_check_vnode_stat(struct ucred *active_cred,
407 	    struct ucred *file_cred, struct vnode *vp);
408 int	mac_check_vnode_write(struct ucred *active_cred,
409 	    struct ucred *file_cred, struct vnode *vp);
410 int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
411 	    struct mac *extmac);
412 int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
413 	    struct mac *extmac);
414 int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
415 	    struct ifnet *ifnet);
416 int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
417 	    struct ifnet *ifnet);
418 int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
419 	    struct mac *extmac);
420 int	mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
421 	    struct label *label);
422 void	mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
423 
424 /*
425  * Calls to help various file systems implement labeling functionality
426  * using their existing EA implementation.
427  */
428 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
429 
430 #endif /* !_KERNEL */
431 
432 #endif /* !_SYS_MAC_H_ */
433