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