xref: /freebsd/sys/security/mac/mac_framework.h (revision 8640764682960c128ab9edd1e534589d98fce43b)
1 /*-
2  * Copyright (c) 1999-2002 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  * Kernel functions to manage and evaluate labels.
92  */
93 int	mac_bpfdesc_check_receive(struct bpf_d *d, struct ifnet *ifp);
94 void	mac_bpfdesc_create(struct ucred *cred, struct bpf_d *d);
95 void	mac_bpfdesc_create_mbuf(struct bpf_d *d, struct mbuf *m);
96 void	mac_bpfdesc_destroy(struct bpf_d *);
97 void	mac_bpfdesc_init(struct bpf_d *);
98 
99 int	mac_cred_check_visible(struct ucred *cr1, struct ucred *cr2);
100 void	mac_cred_copy(struct ucred *cr1, struct ucred *cr2);
101 void	mac_cred_destroy(struct ucred *);
102 void	mac_cred_init(struct ucred *);
103 
104 void	mac_devfs_create_device(struct ucred *cred, struct mount *mp,
105 	    struct cdev *dev, struct devfs_dirent *de);
106 void	mac_devfs_create_directory(struct mount *mp, char *dirname,
107 	    int dirnamelen, struct devfs_dirent *de);
108 void	mac_devfs_create_symlink(struct ucred *cred, struct mount *mp,
109 	    struct devfs_dirent *dd, struct devfs_dirent *de);
110 void	mac_devfs_destroy(struct devfs_dirent *);
111 void	mac_devfs_init(struct devfs_dirent *);
112 void	mac_devfs_update(struct mount *mp, struct devfs_dirent *de,
113 	    struct vnode *vp);
114 void	mac_devfs_vnode_associate(struct mount *mp, struct devfs_dirent *de,
115 	    struct vnode *vp);
116 
117 int	mac_ifnet_check_transmit(struct ifnet *ifp, struct mbuf *m);
118 void	mac_ifnet_create(struct ifnet *ifp);
119 void	mac_ifnet_create_mbuf(struct ifnet *ifp, struct mbuf *m);
120 void	mac_ifnet_destroy(struct ifnet *);
121 void	mac_ifnet_init(struct ifnet *);
122 int	mac_ifnet_ioctl_get(struct ucred *cred, struct ifreq *ifr,
123 	    struct ifnet *ifp);
124 int	mac_ifnet_ioctl_set(struct ucred *cred, struct ifreq *ifr,
125 	    struct ifnet *ifp);
126 
127 int	mac_inpcb_check_deliver(struct inpcb *inp, struct mbuf *m);
128 void	mac_inpcb_create(struct socket *so, struct inpcb *inp);
129 void	mac_inpcb_create_mbuf(struct inpcb *inp, struct mbuf *m);
130 void	mac_inpcb_destroy(struct inpcb *);
131 int	mac_inpcb_init(struct inpcb *, int);
132 void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
133 
134 void	mac_ipq_create(struct mbuf *m, struct ipq *ipq);
135 void	mac_ipq_destroy(struct ipq *);
136 int	mac_ipq_init(struct ipq *, int);
137 int	mac_ipq_match(struct mbuf *m, struct ipq *ipq);
138 void	mac_ipq_reassemble(struct ipq *ipq, struct mbuf *m);
139 void	mac_ipq_update(struct mbuf *m, struct ipq *ipq);
140 
141 int	mac_kenv_check_dump(struct ucred *cred);
142 int	mac_kenv_check_get(struct ucred *cred, char *name);
143 int	mac_kenv_check_set(struct ucred *cred, char *name, char *value);
144 int	mac_kenv_check_unset(struct ucred *cred, char *name);
145 
146 int	mac_kld_check_load(struct ucred *cred, struct vnode *vp);
147 int	mac_kld_check_stat(struct ucred *cred);
148 
149 void	mac_mbuf_copy(struct mbuf *, struct mbuf *);
150 void	mac_mbuf_create_linklayer(struct ifnet *ifp, struct mbuf *m);
151 void	mac_mbuf_create_multicast_encap(struct mbuf *m, struct ifnet *ifp,
152 	    struct mbuf *mnew);
153 void	mac_mbuf_create_netlayer(struct mbuf *m, struct mbuf *mnew);
154 int	mac_mbuf_init(struct mbuf *, int);
155 
156 void	mac_mbuf_tag_copy(struct m_tag *, struct m_tag *);
157 void	mac_mbuf_tag_destroy(struct m_tag *);
158 int	mac_mbuf_tag_init(struct m_tag *, int);
159 
160 int	mac_mount_check_stat(struct ucred *cred, struct mount *mp);
161 void	mac_mount_create(struct ucred *cred, struct mount *mp);
162 void	mac_mount_destroy(struct mount *);
163 void	mac_mount_init(struct mount *);
164 
165 void	mac_netinet_firewall_send(struct mbuf *m);
166 void	mac_netinet_fragment(struct mbuf *m, struct mbuf *frag);
167 void	mac_netinet_icmp_reply(struct mbuf *m);
168 void	mac_netinet_tcp_reply(struct mbuf *m);
169 
170 int	mac_pipe_check_ioctl(struct ucred *cred, struct pipepair *pp,
171 	    unsigned long cmd, void *data);
172 int	mac_pipe_check_poll(struct ucred *cred, struct pipepair *pp);
173 int	mac_pipe_check_read(struct ucred *cred, struct pipepair *pp);
174 int	mac_pipe_check_stat(struct ucred *cred, struct pipepair *pp);
175 int	mac_pipe_check_write(struct ucred *cred, struct pipepair *pp);
176 void	mac_pipe_create(struct ucred *cred, struct pipepair *pp);
177 void	mac_pipe_destroy(struct pipepair *);
178 void	mac_pipe_init(struct pipepair *);
179 int	mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
180 	    struct label *label);
181 
182 int	mac_posixsem_check_destroy(struct ucred *cred, struct ksem *ks);
183 int	mac_posixsem_check_getvalue(struct ucred *cred,struct ksem *ks);
184 int	mac_posixsem_check_open(struct ucred *cred, struct ksem *ks);
185 int	mac_posixsem_check_post(struct ucred *cred, struct ksem *ks);
186 int	mac_posixsem_check_unlink(struct ucred *cred, struct ksem *ks);
187 int	mac_posixsem_check_wait(struct ucred *cred, struct ksem *ks);
188 void 	mac_posixsem_create(struct ucred *cred, struct ksem *ks);
189 void	mac_posixsem_destroy(struct ksem *);
190 void	mac_posixsem_init(struct ksem *);
191 
192 int	mac_priv_check(struct ucred *cred, int priv);
193 int	mac_priv_grant(struct ucred *cred, int priv);
194 
195 void	mac_proc_associate_nfsd(struct ucred *cred);
196 int	mac_proc_check_debug(struct ucred *cred, struct proc *p);
197 int	mac_proc_check_sched(struct ucred *cred, struct proc *p);
198 int	mac_proc_check_setaudit(struct ucred *cred, struct auditinfo *ai);
199 int	mac_proc_check_setaudit_addr(struct ucred *cred,
200 	    struct auditinfo_addr *aia);
201 int	mac_proc_check_setauid(struct ucred *cred, uid_t auid);
202 int	mac_proc_check_setegid(struct proc *p, struct ucred *cred,
203 	    gid_t egid);
204 int	mac_proc_check_seteuid(struct proc *p, struct ucred *cred,
205 	    uid_t euid);
206 int	mac_proc_check_setgid(struct proc *p, struct ucred *cred,
207 	    gid_t gid);
208 int	mac_proc_check_setgroups(struct proc *p, struct ucred *cred,
209 	    int ngroups, gid_t *gidset);
210 int	mac_proc_check_setregid(struct proc *p, struct ucred *cred,
211 	    gid_t rgid, gid_t egid);
212 int	mac_proc_check_setresgid(struct proc *p, struct ucred *cred,
213 	    gid_t rgid, gid_t egid, gid_t sgid);
214 int	mac_proc_check_setresuid(struct proc *p, struct ucred *cred,
215 	    uid_t ruid, uid_t euid, uid_t suid);
216 int	mac_proc_check_setreuid(struct proc *p, struct ucred *cred,
217 	    uid_t ruid, uid_t euid);
218 int	mac_proc_check_setuid(struct proc *p,  struct ucred *cred,
219 	    uid_t uid);
220 int	mac_proc_check_signal(struct ucred *cred, struct proc *p,
221 	    int signum);
222 int	mac_proc_check_wait(struct ucred *cred, struct proc *p);
223 void	mac_proc_create_init(struct ucred *cred);
224 void	mac_proc_create_swapper(struct ucred *cred);
225 void	mac_proc_destroy(struct proc *);
226 int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
227 void	mac_execve_exit(struct image_params *imgp);
228 void	mac_proc_init(struct proc *);
229 
230 int	mac_socket_check_accept(struct ucred *cred, struct socket *so);
231 int	mac_socket_check_bind(struct ucred *cred, struct socket *so,
232 	    struct sockaddr *sa);
233 int	mac_socket_check_connect(struct ucred *cred, struct socket *so,
234 	    struct sockaddr *sa);
235 int	mac_socket_check_create(struct ucred *cred, int domain, int type,
236 	    int proto);
237 int	mac_socket_check_deliver(struct socket *so, struct mbuf *m);
238 int	mac_socket_check_listen(struct ucred *cred, struct socket *so);
239 int	mac_socket_check_poll(struct ucred *cred, struct socket *so);
240 int	mac_socket_check_receive(struct ucred *cred, struct socket *so);
241 int	mac_socket_check_send(struct ucred *cred, struct socket *so);
242 int	mac_socket_check_stat(struct ucred *cred, struct socket *so);
243 int	mac_socket_check_visible(struct ucred *cred, struct socket *so);
244 void	mac_socket_create_mbuf(struct socket *so, struct mbuf *m);
245 void	mac_socket_create(struct ucred *cred, struct socket *so);
246 void	mac_socket_destroy(struct socket *);
247 int	mac_socket_init(struct socket *, int);
248 void	mac_socket_newconn(struct socket *oldso, struct socket *newso);
249 int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
250 	    struct mac *extmac);
251 int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
252 	    struct mac *extmac);
253 int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
254 	    struct mac *extmac);
255 
256 void	mac_socketpeer_set_from_mbuf(struct mbuf *m, struct socket *so);
257 void	mac_socketpeer_set_from_socket(struct socket *oldso,
258 	    struct socket *newso);
259 
260 void	mac_syncache_create(struct label *l, struct inpcb *inp);
261 void	mac_syncache_create_mbuf(struct label *l, struct mbuf *m);
262 void	mac_syncache_destroy(struct label **l);
263 int	mac_syncache_init(struct label **l);
264 
265 int	mac_system_check_acct(struct ucred *cred, struct vnode *vp);
266 int	mac_system_check_audit(struct ucred *cred, void *record, int length);
267 int	mac_system_check_auditctl(struct ucred *cred, struct vnode *vp);
268 int	mac_system_check_auditon(struct ucred *cred, int cmd);
269 int	mac_system_check_reboot(struct ucred *cred, int howto);
270 int	mac_system_check_swapon(struct ucred *cred, struct vnode *vp);
271 int	mac_system_check_swapoff(struct ucred *cred, struct vnode *vp);
272 int	mac_system_check_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
273 	    void *arg1, int arg2, struct sysctl_req *req);
274 
275 void	mac_sysvmsg_cleanup(struct msg *msgptr);
276 void	mac_sysvmsg_create(struct ucred *cred, struct msqid_kernel *msqkptr,
277 	    struct msg *msgptr);
278 void	mac_sysvmsg_destroy(struct msg *);
279 void	mac_sysvmsg_init(struct msg *);
280 
281 int	mac_sysvmsq_check_msgmsq(struct ucred *cred, struct msg *msgptr,
282 	    struct msqid_kernel *msqkptr);
283 int	mac_sysvmsq_check_msgrcv(struct ucred *cred, struct msg *msgptr);
284 int	mac_sysvmsq_check_msgrmid(struct ucred *cred, struct msg *msgptr);
285 int	mac_sysvmsq_check_msqctl(struct ucred *cred,
286 	    struct msqid_kernel *msqkptr, int cmd);
287 int	mac_sysvmsq_check_msqget(struct ucred *cred,
288 	    struct msqid_kernel *msqkptr);
289 int	mac_sysvmsq_check_msqrcv(struct ucred *cred,
290 	    struct msqid_kernel *msqkptr);
291 int	mac_sysvmsq_check_msqsnd(struct ucred *cred,
292 	    struct msqid_kernel *msqkptr);
293 void	mac_sysvmsq_cleanup(struct msqid_kernel *msqkptr);
294 void	mac_sysvmsq_create(struct ucred *cred, struct msqid_kernel *msqkptr);
295 void	mac_sysvmsq_destroy(struct msqid_kernel *);
296 void	mac_sysvmsq_init(struct msqid_kernel *);
297 
298 int	mac_sysvsem_check_semctl(struct ucred *cred,
299 	    struct semid_kernel *semakptr, int cmd);
300 int	mac_sysvsem_check_semget(struct ucred *cred,
301 	   struct semid_kernel *semakptr);
302 int	mac_sysvsem_check_semop(struct ucred *cred,
303 	    struct semid_kernel *semakptr, size_t accesstype);
304 void	mac_sysvsem_cleanup(struct semid_kernel *semakptr);
305 void	mac_sysvsem_create(struct ucred *cred,
306 	    struct semid_kernel *semakptr);
307 void	mac_sysvsem_destroy(struct semid_kernel *);
308 void	mac_sysvsem_init(struct semid_kernel *);
309 
310 int	mac_sysvshm_check_shmat(struct ucred *cred,
311 	    struct shmid_kernel *shmsegptr, int shmflg);
312 int	mac_sysvshm_check_shmctl(struct ucred *cred,
313 	    struct shmid_kernel *shmsegptr, int cmd);
314 int	mac_sysvshm_check_shmdt(struct ucred *cred,
315 	    struct shmid_kernel *shmsegptr);
316 int	mac_sysvshm_check_shmget(struct ucred *cred,
317 	    struct shmid_kernel *shmsegptr, int shmflg);
318 void	mac_sysvshm_cleanup(struct shmid_kernel *shmsegptr);
319 void	mac_sysvshm_create(struct ucred *cred,
320 	    struct shmid_kernel *shmsegptr);
321 void	mac_sysvshm_destroy(struct shmid_kernel *);
322 void	mac_sysvshm_init(struct shmid_kernel *);
323 
324 void	mac_thread_userret(struct thread *td);
325 
326 int	mac_vnode_associate_extattr(struct mount *mp, struct vnode *vp);
327 void	mac_vnode_associate_singlelabel(struct mount *mp, struct vnode *vp);
328 int	mac_vnode_check_access(struct ucred *cred, struct vnode *vp,
329 	    int acc_mode);
330 int	mac_vnode_check_chdir(struct ucred *cred, struct vnode *dvp);
331 int	mac_vnode_check_chroot(struct ucred *cred, struct vnode *dvp);
332 int	mac_vnode_check_create(struct ucred *cred, struct vnode *dvp,
333 	    struct componentname *cnp, struct vattr *vap);
334 int	mac_vnode_check_deleteacl(struct ucred *cred, struct vnode *vp,
335 	    acl_type_t type);
336 int	mac_vnode_check_deleteextattr(struct ucred *cred, struct vnode *vp,
337 	    int attrnamespace, const char *name);
338 int	mac_vnode_check_exec(struct ucred *cred, struct vnode *vp,
339 	    struct image_params *imgp);
340 int	mac_vnode_check_getacl(struct ucred *cred, struct vnode *vp,
341 	    acl_type_t type);
342 int	mac_vnode_check_getextattr(struct ucred *cred, struct vnode *vp,
343 	    int attrnamespace, const char *name, struct uio *uio);
344 int	mac_vnode_check_link(struct ucred *cred, struct vnode *dvp,
345 	    struct vnode *vp, struct componentname *cnp);
346 int	mac_vnode_check_listextattr(struct ucred *cred, struct vnode *vp,
347 	    int attrnamespace);
348 int	mac_vnode_check_lookup(struct ucred *cred, struct vnode *dvp,
349  	    struct componentname *cnp);
350 int	mac_vnode_check_mmap(struct ucred *cred, struct vnode *vp, int prot,
351 	    int flags);
352 int	mac_vnode_check_mprotect(struct ucred *cred, struct vnode *vp,
353 	    int prot);
354 int	mac_vnode_check_open(struct ucred *cred, struct vnode *vp,
355 	    int acc_mode);
356 int	mac_vnode_check_poll(struct ucred *active_cred,
357 	    struct ucred *file_cred, struct vnode *vp);
358 int	mac_vnode_check_read(struct ucred *active_cred,
359 	    struct ucred *file_cred, struct vnode *vp);
360 int	mac_vnode_check_readdir(struct ucred *cred, struct vnode *vp);
361 int	mac_vnode_check_readlink(struct ucred *cred, struct vnode *vp);
362 int	mac_vnode_check_rename_from(struct ucred *cred, struct vnode *dvp,
363 	    struct vnode *vp, struct componentname *cnp);
364 int	mac_vnode_check_rename_to(struct ucred *cred, struct vnode *dvp,
365 	    struct vnode *vp, int samedir, struct componentname *cnp);
366 int	mac_vnode_check_revoke(struct ucred *cred, struct vnode *vp);
367 int	mac_vnode_check_setacl(struct ucred *cred, struct vnode *vp,
368 	    acl_type_t type, struct acl *acl);
369 int	mac_vnode_check_setextattr(struct ucred *cred, struct vnode *vp,
370 	    int attrnamespace, const char *name, struct uio *uio);
371 int	mac_vnode_check_setflags(struct ucred *cred, struct vnode *vp,
372 	    u_long flags);
373 int	mac_vnode_check_setmode(struct ucred *cred, struct vnode *vp,
374 	    mode_t mode);
375 int	mac_vnode_check_setowner(struct ucred *cred, struct vnode *vp,
376 	    uid_t uid, gid_t gid);
377 int	mac_vnode_check_setutimes(struct ucred *cred, struct vnode *vp,
378 	    struct timespec atime, struct timespec mtime);
379 int	mac_vnode_check_stat(struct ucred *active_cred,
380 	    struct ucred *file_cred, struct vnode *vp);
381 int	mac_vnode_check_unlink(struct ucred *cred, struct vnode *dvp,
382 	    struct vnode *vp, struct componentname *cnp);
383 int	mac_vnode_check_write(struct ucred *active_cred,
384 	    struct ucred *file_cred, struct vnode *vp);
385 void	mac_vnode_copy_label(struct label *, struct label *);
386 void	mac_vnode_init(struct vnode *);
387 int	mac_vnode_create_extattr(struct ucred *cred, struct mount *mp,
388 	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
389 void	mac_vnode_destroy(struct vnode *);
390 void	mac_vnode_execve_transition(struct ucred *oldcred,
391 	    struct ucred *newcred, struct vnode *vp,
392 	    struct label *interpvplabel, struct image_params *imgp);
393 int	mac_vnode_execve_will_transition(struct ucred *cred,
394 	    struct vnode *vp, struct label *interpvplabel,
395 	    struct image_params *imgp);
396 void	mac_vnode_relabel(struct ucred *cred, struct vnode *vp,
397 	    struct label *newlabel);
398 
399 struct label	*mac_cred_label_alloc(void);
400 void		 mac_cred_label_free(struct label *);
401 struct label	*mac_vnode_label_alloc(void);
402 void		 mac_vnode_label_free(struct label *);
403 
404 void	mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
405 
406 /*
407  * Calls to help various file systems implement labeling functionality using
408  * their existing EA implementation.
409  */
410 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
411 
412 #endif /* !_SYS_SECURITY_MAC_MAC_FRAMEWORK_H_ */
413