xref: /freebsd/sys/security/mac/mac_framework.h (revision b9b0dac33ba72ade7976c47a2ce3d500fcfd27f5)
1 /*-
2  * Copyright (c) 1999-2002, 2007 Robert N. M. Watson
3  * Copyright (c) 2001-2005 Networks Associates Technology, Inc.
4  * Copyright (c) 2005-2006 SPARTA, Inc.
5  * All rights reserved.
6  *
7  * This software was developed by Robert Watson for the TrustedBSD Project.
8  *
9  * This software was developed for the FreeBSD Project in part by Network
10  * Associates Laboratories, the Security Research Division of Network
11  * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
12  * as part of the DARPA CHATS research program.
13  *
14  * This software was enhanced by SPARTA ISSO under SPAWAR contract
15  * N66001-04-C-6019 ("SEFOS").
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions
19  * are met:
20  * 1. Redistributions of source code must retain the above copyright
21  *    notice, this list of conditions and the following disclaimer.
22  * 2. Redistributions in binary form must reproduce the above copyright
23  *    notice, this list of conditions and the following disclaimer in the
24  *    documentation and/or other materials provided with the distribution.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  * $FreeBSD$
39  */
40 
41 /*
42  * Kernel interface for Mandatory Access Control -- how kernel services
43  * interact with the TrustedBSD MAC Framework.
44  */
45 
46 #ifndef _SYS_SECURITY_MAC_MAC_FRAMEWORK_H_
47 #define	_SYS_SECURITY_MAC_MAC_FRAMEWORK_H_
48 
49 #ifndef _KERNEL
50 #error "no user-serviceable parts inside"
51 #endif
52 
53 struct auditinfo;
54 struct auditinfo_addr;
55 struct bpf_d;
56 struct cdev;
57 struct componentname;
58 struct devfs_dirent;
59 struct ifnet;
60 struct ifreq;
61 struct image_params;
62 struct inpcb;
63 struct ipq;
64 struct ksem;
65 struct label;
66 struct m_tag;
67 struct mac;
68 struct mbuf;
69 struct mount;
70 struct msg;
71 struct msqid_kernel;
72 struct proc;
73 struct semid_kernel;
74 struct shmid_kernel;
75 struct sockaddr;
76 struct socket;
77 struct sysctl_oid;
78 struct sysctl_req;
79 struct pipepair;
80 struct thread;
81 struct timespec;
82 struct ucred;
83 struct uio;
84 struct vattr;
85 struct vnode;
86 struct vop_setlabel_args;
87 
88 #include <sys/acl.h>			/* XXX acl_type_t */
89 
90 /*
91  * Entry points to the TrustedBSD MAC Framework from the remainder of the
92  * kernel: entry points are named based on a principle object type and an
93  * action relating to it.  They are sorted alphabetically first by object
94  * type and then action.  In some situations, the principle object type is
95  * obvious, and in other cases, less so as multiple objects may be inolved
96  * in the operation.
97  */
98 int	mac_bpfdesc_check_receive(struct bpf_d *d, struct ifnet *ifp);
99 void	mac_bpfdesc_create(struct ucred *cred, struct bpf_d *d);
100 void	mac_bpfdesc_create_mbuf(struct bpf_d *d, struct mbuf *m);
101 void	mac_bpfdesc_destroy(struct bpf_d *);
102 void	mac_bpfdesc_init(struct bpf_d *);
103 
104 int	mac_cred_check_visible(struct ucred *cr1, struct ucred *cr2);
105 void	mac_cred_copy(struct ucred *cr1, struct ucred *cr2);
106 void	mac_cred_destroy(struct ucred *);
107 void	mac_cred_init(struct ucred *);
108 
109 void	mac_devfs_create_device(struct ucred *cred, struct mount *mp,
110 	    struct cdev *dev, struct devfs_dirent *de);
111 void	mac_devfs_create_directory(struct mount *mp, char *dirname,
112 	    int dirnamelen, struct devfs_dirent *de);
113 void	mac_devfs_create_symlink(struct ucred *cred, struct mount *mp,
114 	    struct devfs_dirent *dd, struct devfs_dirent *de);
115 void	mac_devfs_destroy(struct devfs_dirent *);
116 void	mac_devfs_init(struct devfs_dirent *);
117 void	mac_devfs_update(struct mount *mp, struct devfs_dirent *de,
118 	    struct vnode *vp);
119 void	mac_devfs_vnode_associate(struct mount *mp, struct devfs_dirent *de,
120 	    struct vnode *vp);
121 
122 int	mac_ifnet_check_transmit(struct ifnet *ifp, struct mbuf *m);
123 void	mac_ifnet_create(struct ifnet *ifp);
124 void	mac_ifnet_create_mbuf(struct ifnet *ifp, struct mbuf *m);
125 void	mac_ifnet_destroy(struct ifnet *);
126 void	mac_ifnet_init(struct ifnet *);
127 int	mac_ifnet_ioctl_get(struct ucred *cred, struct ifreq *ifr,
128 	    struct ifnet *ifp);
129 int	mac_ifnet_ioctl_set(struct ucred *cred, struct ifreq *ifr,
130 	    struct ifnet *ifp);
131 
132 int	mac_inpcb_check_deliver(struct inpcb *inp, struct mbuf *m);
133 void	mac_inpcb_create(struct socket *so, struct inpcb *inp);
134 void	mac_inpcb_create_mbuf(struct inpcb *inp, struct mbuf *m);
135 void	mac_inpcb_destroy(struct inpcb *);
136 int	mac_inpcb_init(struct inpcb *, int);
137 void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
138 
139 void	mac_ipq_create(struct mbuf *m, struct ipq *ipq);
140 void	mac_ipq_destroy(struct ipq *);
141 int	mac_ipq_init(struct ipq *, int);
142 int	mac_ipq_match(struct mbuf *m, struct ipq *ipq);
143 void	mac_ipq_reassemble(struct ipq *ipq, struct mbuf *m);
144 void	mac_ipq_update(struct mbuf *m, struct ipq *ipq);
145 
146 int	mac_kenv_check_dump(struct ucred *cred);
147 int	mac_kenv_check_get(struct ucred *cred, char *name);
148 int	mac_kenv_check_set(struct ucred *cred, char *name, char *value);
149 int	mac_kenv_check_unset(struct ucred *cred, char *name);
150 
151 int	mac_kld_check_load(struct ucred *cred, struct vnode *vp);
152 int	mac_kld_check_stat(struct ucred *cred);
153 
154 void	mac_mbuf_copy(struct mbuf *, struct mbuf *);
155 void	mac_mbuf_create_multicast_encap(struct mbuf *m, struct ifnet *ifp,
156 	    struct mbuf *mnew);
157 void	mac_mbuf_create_netlayer(struct mbuf *m, struct mbuf *mnew);
158 int	mac_mbuf_init(struct mbuf *, int);
159 
160 void	mac_mbuf_tag_copy(struct m_tag *, struct m_tag *);
161 void	mac_mbuf_tag_destroy(struct m_tag *);
162 int	mac_mbuf_tag_init(struct m_tag *, int);
163 
164 int	mac_mount_check_stat(struct ucred *cred, struct mount *mp);
165 void	mac_mount_create(struct ucred *cred, struct mount *mp);
166 void	mac_mount_destroy(struct mount *);
167 void	mac_mount_init(struct mount *);
168 
169 void	mac_netatalk_aarp_send(struct ifnet *ifp, struct mbuf *m);
170 
171 void	mac_netinet_arp_send(struct ifnet *ifp, struct mbuf *m);
172 void	mac_netinet_firewall_send(struct mbuf *m);
173 void	mac_netinet_fragment(struct mbuf *m, struct mbuf *frag);
174 void	mac_netinet_icmp_reply(struct mbuf *m);
175 void	mac_netinet_igmp_send(struct ifnet *ifp, struct mbuf *m);
176 void	mac_netinet_tcp_reply(struct mbuf *m);
177 
178 void	mac_netinet6_nd6_send(struct ifnet *ifp, struct mbuf *m);
179 
180 int	mac_pipe_check_ioctl(struct ucred *cred, struct pipepair *pp,
181 	    unsigned long cmd, void *data);
182 int	mac_pipe_check_poll(struct ucred *cred, struct pipepair *pp);
183 int	mac_pipe_check_read(struct ucred *cred, struct pipepair *pp);
184 int	mac_pipe_check_stat(struct ucred *cred, struct pipepair *pp);
185 int	mac_pipe_check_write(struct ucred *cred, struct pipepair *pp);
186 void	mac_pipe_create(struct ucred *cred, struct pipepair *pp);
187 void	mac_pipe_destroy(struct pipepair *);
188 void	mac_pipe_init(struct pipepair *);
189 int	mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
190 	    struct label *label);
191 
192 int	mac_posixsem_check_destroy(struct ucred *cred, struct ksem *ks);
193 int	mac_posixsem_check_getvalue(struct ucred *cred,struct ksem *ks);
194 int	mac_posixsem_check_open(struct ucred *cred, struct ksem *ks);
195 int	mac_posixsem_check_post(struct ucred *cred, struct ksem *ks);
196 int	mac_posixsem_check_unlink(struct ucred *cred, struct ksem *ks);
197 int	mac_posixsem_check_wait(struct ucred *cred, struct ksem *ks);
198 void 	mac_posixsem_create(struct ucred *cred, struct ksem *ks);
199 void	mac_posixsem_destroy(struct ksem *);
200 void	mac_posixsem_init(struct ksem *);
201 
202 int	mac_priv_check(struct ucred *cred, int priv);
203 int	mac_priv_grant(struct ucred *cred, int priv);
204 
205 void	mac_proc_associate_nfsd(struct ucred *cred);
206 int	mac_proc_check_debug(struct ucred *cred, struct proc *p);
207 int	mac_proc_check_sched(struct ucred *cred, struct proc *p);
208 int	mac_proc_check_setaudit(struct ucred *cred, struct auditinfo *ai);
209 int	mac_proc_check_setaudit_addr(struct ucred *cred,
210 	    struct auditinfo_addr *aia);
211 int	mac_proc_check_setauid(struct ucred *cred, uid_t auid);
212 int	mac_proc_check_setegid(struct proc *p, struct ucred *cred,
213 	    gid_t egid);
214 int	mac_proc_check_seteuid(struct proc *p, struct ucred *cred,
215 	    uid_t euid);
216 int	mac_proc_check_setgid(struct proc *p, struct ucred *cred,
217 	    gid_t gid);
218 int	mac_proc_check_setgroups(struct proc *p, struct ucred *cred,
219 	    int ngroups, gid_t *gidset);
220 int	mac_proc_check_setregid(struct proc *p, struct ucred *cred,
221 	    gid_t rgid, gid_t egid);
222 int	mac_proc_check_setresgid(struct proc *p, struct ucred *cred,
223 	    gid_t rgid, gid_t egid, gid_t sgid);
224 int	mac_proc_check_setresuid(struct proc *p, struct ucred *cred,
225 	    uid_t ruid, uid_t euid, uid_t suid);
226 int	mac_proc_check_setreuid(struct proc *p, struct ucred *cred,
227 	    uid_t ruid, uid_t euid);
228 int	mac_proc_check_setuid(struct proc *p,  struct ucred *cred,
229 	    uid_t uid);
230 int	mac_proc_check_signal(struct ucred *cred, struct proc *p,
231 	    int signum);
232 int	mac_proc_check_wait(struct ucred *cred, struct proc *p);
233 void	mac_proc_create_init(struct ucred *cred);
234 void	mac_proc_create_swapper(struct ucred *cred);
235 void	mac_proc_destroy(struct proc *);
236 int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
237 void	mac_execve_exit(struct image_params *imgp);
238 void	mac_proc_init(struct proc *);
239 
240 int	mac_socket_check_accept(struct ucred *cred, struct socket *so);
241 int	mac_socket_check_bind(struct ucred *cred, struct socket *so,
242 	    struct sockaddr *sa);
243 int	mac_socket_check_connect(struct ucred *cred, struct socket *so,
244 	    struct sockaddr *sa);
245 int	mac_socket_check_create(struct ucred *cred, int domain, int type,
246 	    int proto);
247 int	mac_socket_check_deliver(struct socket *so, struct mbuf *m);
248 int	mac_socket_check_listen(struct ucred *cred, struct socket *so);
249 int	mac_socket_check_poll(struct ucred *cred, struct socket *so);
250 int	mac_socket_check_receive(struct ucred *cred, struct socket *so);
251 int	mac_socket_check_send(struct ucred *cred, struct socket *so);
252 int	mac_socket_check_stat(struct ucred *cred, struct socket *so);
253 int	mac_socket_check_visible(struct ucred *cred, struct socket *so);
254 void	mac_socket_create_mbuf(struct socket *so, struct mbuf *m);
255 void	mac_socket_create(struct ucred *cred, struct socket *so);
256 void	mac_socket_destroy(struct socket *);
257 int	mac_socket_init(struct socket *, int);
258 void	mac_socket_newconn(struct socket *oldso, struct socket *newso);
259 int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
260 	    struct mac *extmac);
261 int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
262 	    struct mac *extmac);
263 int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
264 	    struct mac *extmac);
265 
266 void	mac_socketpeer_set_from_mbuf(struct mbuf *m, struct socket *so);
267 void	mac_socketpeer_set_from_socket(struct socket *oldso,
268 	    struct socket *newso);
269 
270 void	mac_syncache_create(struct label *l, struct inpcb *inp);
271 void	mac_syncache_create_mbuf(struct label *l, struct mbuf *m);
272 void	mac_syncache_destroy(struct label **l);
273 int	mac_syncache_init(struct label **l);
274 
275 int	mac_system_check_acct(struct ucred *cred, struct vnode *vp);
276 int	mac_system_check_audit(struct ucred *cred, void *record, int length);
277 int	mac_system_check_auditctl(struct ucred *cred, struct vnode *vp);
278 int	mac_system_check_auditon(struct ucred *cred, int cmd);
279 int	mac_system_check_reboot(struct ucred *cred, int howto);
280 int	mac_system_check_swapon(struct ucred *cred, struct vnode *vp);
281 int	mac_system_check_swapoff(struct ucred *cred, struct vnode *vp);
282 int	mac_system_check_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
283 	    void *arg1, int arg2, struct sysctl_req *req);
284 
285 void	mac_sysvmsg_cleanup(struct msg *msgptr);
286 void	mac_sysvmsg_create(struct ucred *cred, struct msqid_kernel *msqkptr,
287 	    struct msg *msgptr);
288 void	mac_sysvmsg_destroy(struct msg *);
289 void	mac_sysvmsg_init(struct msg *);
290 
291 int	mac_sysvmsq_check_msgmsq(struct ucred *cred, struct msg *msgptr,
292 	    struct msqid_kernel *msqkptr);
293 int	mac_sysvmsq_check_msgrcv(struct ucred *cred, struct msg *msgptr);
294 int	mac_sysvmsq_check_msgrmid(struct ucred *cred, struct msg *msgptr);
295 int	mac_sysvmsq_check_msqctl(struct ucred *cred,
296 	    struct msqid_kernel *msqkptr, int cmd);
297 int	mac_sysvmsq_check_msqget(struct ucred *cred,
298 	    struct msqid_kernel *msqkptr);
299 int	mac_sysvmsq_check_msqrcv(struct ucred *cred,
300 	    struct msqid_kernel *msqkptr);
301 int	mac_sysvmsq_check_msqsnd(struct ucred *cred,
302 	    struct msqid_kernel *msqkptr);
303 void	mac_sysvmsq_cleanup(struct msqid_kernel *msqkptr);
304 void	mac_sysvmsq_create(struct ucred *cred, struct msqid_kernel *msqkptr);
305 void	mac_sysvmsq_destroy(struct msqid_kernel *);
306 void	mac_sysvmsq_init(struct msqid_kernel *);
307 
308 int	mac_sysvsem_check_semctl(struct ucred *cred,
309 	    struct semid_kernel *semakptr, int cmd);
310 int	mac_sysvsem_check_semget(struct ucred *cred,
311 	   struct semid_kernel *semakptr);
312 int	mac_sysvsem_check_semop(struct ucred *cred,
313 	    struct semid_kernel *semakptr, size_t accesstype);
314 void	mac_sysvsem_cleanup(struct semid_kernel *semakptr);
315 void	mac_sysvsem_create(struct ucred *cred,
316 	    struct semid_kernel *semakptr);
317 void	mac_sysvsem_destroy(struct semid_kernel *);
318 void	mac_sysvsem_init(struct semid_kernel *);
319 
320 int	mac_sysvshm_check_shmat(struct ucred *cred,
321 	    struct shmid_kernel *shmsegptr, int shmflg);
322 int	mac_sysvshm_check_shmctl(struct ucred *cred,
323 	    struct shmid_kernel *shmsegptr, int cmd);
324 int	mac_sysvshm_check_shmdt(struct ucred *cred,
325 	    struct shmid_kernel *shmsegptr);
326 int	mac_sysvshm_check_shmget(struct ucred *cred,
327 	    struct shmid_kernel *shmsegptr, int shmflg);
328 void	mac_sysvshm_cleanup(struct shmid_kernel *shmsegptr);
329 void	mac_sysvshm_create(struct ucred *cred,
330 	    struct shmid_kernel *shmsegptr);
331 void	mac_sysvshm_destroy(struct shmid_kernel *);
332 void	mac_sysvshm_init(struct shmid_kernel *);
333 
334 void	mac_thread_userret(struct thread *td);
335 
336 int	mac_vnode_associate_extattr(struct mount *mp, struct vnode *vp);
337 void	mac_vnode_associate_singlelabel(struct mount *mp, struct vnode *vp);
338 int	mac_vnode_check_access(struct ucred *cred, struct vnode *vp,
339 	    int acc_mode);
340 int	mac_vnode_check_chdir(struct ucred *cred, struct vnode *dvp);
341 int	mac_vnode_check_chroot(struct ucred *cred, struct vnode *dvp);
342 int	mac_vnode_check_create(struct ucred *cred, struct vnode *dvp,
343 	    struct componentname *cnp, struct vattr *vap);
344 int	mac_vnode_check_deleteacl(struct ucred *cred, struct vnode *vp,
345 	    acl_type_t type);
346 int	mac_vnode_check_deleteextattr(struct ucred *cred, struct vnode *vp,
347 	    int attrnamespace, const char *name);
348 int	mac_vnode_check_exec(struct ucred *cred, struct vnode *vp,
349 	    struct image_params *imgp);
350 int	mac_vnode_check_getacl(struct ucred *cred, struct vnode *vp,
351 	    acl_type_t type);
352 int	mac_vnode_check_getextattr(struct ucred *cred, struct vnode *vp,
353 	    int attrnamespace, const char *name, struct uio *uio);
354 int	mac_vnode_check_link(struct ucred *cred, struct vnode *dvp,
355 	    struct vnode *vp, struct componentname *cnp);
356 int	mac_vnode_check_listextattr(struct ucred *cred, struct vnode *vp,
357 	    int attrnamespace);
358 int	mac_vnode_check_lookup(struct ucred *cred, struct vnode *dvp,
359  	    struct componentname *cnp);
360 int	mac_vnode_check_mmap(struct ucred *cred, struct vnode *vp, int prot,
361 	    int flags);
362 int	mac_vnode_check_mprotect(struct ucred *cred, struct vnode *vp,
363 	    int prot);
364 int	mac_vnode_check_open(struct ucred *cred, struct vnode *vp,
365 	    int acc_mode);
366 int	mac_vnode_check_poll(struct ucred *active_cred,
367 	    struct ucred *file_cred, struct vnode *vp);
368 int	mac_vnode_check_read(struct ucred *active_cred,
369 	    struct ucred *file_cred, struct vnode *vp);
370 int	mac_vnode_check_readdir(struct ucred *cred, struct vnode *vp);
371 int	mac_vnode_check_readlink(struct ucred *cred, struct vnode *vp);
372 int	mac_vnode_check_rename_from(struct ucred *cred, struct vnode *dvp,
373 	    struct vnode *vp, struct componentname *cnp);
374 int	mac_vnode_check_rename_to(struct ucred *cred, struct vnode *dvp,
375 	    struct vnode *vp, int samedir, struct componentname *cnp);
376 int	mac_vnode_check_revoke(struct ucred *cred, struct vnode *vp);
377 int	mac_vnode_check_setacl(struct ucred *cred, struct vnode *vp,
378 	    acl_type_t type, struct acl *acl);
379 int	mac_vnode_check_setextattr(struct ucred *cred, struct vnode *vp,
380 	    int attrnamespace, const char *name, struct uio *uio);
381 int	mac_vnode_check_setflags(struct ucred *cred, struct vnode *vp,
382 	    u_long flags);
383 int	mac_vnode_check_setmode(struct ucred *cred, struct vnode *vp,
384 	    mode_t mode);
385 int	mac_vnode_check_setowner(struct ucred *cred, struct vnode *vp,
386 	    uid_t uid, gid_t gid);
387 int	mac_vnode_check_setutimes(struct ucred *cred, struct vnode *vp,
388 	    struct timespec atime, struct timespec mtime);
389 int	mac_vnode_check_stat(struct ucred *active_cred,
390 	    struct ucred *file_cred, struct vnode *vp);
391 int	mac_vnode_check_unlink(struct ucred *cred, struct vnode *dvp,
392 	    struct vnode *vp, struct componentname *cnp);
393 int	mac_vnode_check_write(struct ucred *active_cred,
394 	    struct ucred *file_cred, struct vnode *vp);
395 void	mac_vnode_copy_label(struct label *, struct label *);
396 void	mac_vnode_init(struct vnode *);
397 int	mac_vnode_create_extattr(struct ucred *cred, struct mount *mp,
398 	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
399 void	mac_vnode_destroy(struct vnode *);
400 void	mac_vnode_execve_transition(struct ucred *oldcred,
401 	    struct ucred *newcred, struct vnode *vp,
402 	    struct label *interpvplabel, struct image_params *imgp);
403 int	mac_vnode_execve_will_transition(struct ucred *cred,
404 	    struct vnode *vp, struct label *interpvplabel,
405 	    struct image_params *imgp);
406 void	mac_vnode_relabel(struct ucred *cred, struct vnode *vp,
407 	    struct label *newlabel);
408 
409 struct label	*mac_cred_label_alloc(void);
410 void		 mac_cred_label_free(struct label *);
411 struct label	*mac_vnode_label_alloc(void);
412 void		 mac_vnode_label_free(struct label *);
413 
414 void	mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
415 
416 /*
417  * Calls to help various file systems implement labeling functionality using
418  * their existing EA implementation.
419  */
420 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
421 
422 #endif /* !_SYS_SECURITY_MAC_MAC_FRAMEWORK_H_ */
423