mac_framework.h revision 145076
1279377Simp/*-
2279377Simp * Copyright (c) 1999-2002 Robert N. M. Watson
3279377Simp * Copyright (c) 2001-2003 Networks Associates Technology, Inc.
4279377Simp * All rights reserved.
5279377Simp *
6279377Simp * This software was developed by Robert Watson for the TrustedBSD Project.
7279377Simp *
8279377Simp * This software was developed for the FreeBSD Project in part by Network
9279377Simp * Associates Laboratories, the Security Research Division of Network
10279377Simp * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
11279377Simp * as part of the DARPA CHATS research program.
12279377Simp *
13279377Simp * Redistribution and use in source and binary forms, with or without
14279377Simp * modification, are permitted provided that the following conditions
15279377Simp * are met:
16279377Simp * 1. Redistributions of source code must retain the above copyright
17279377Simp *    notice, this list of conditions and the following disclaimer.
18279377Simp * 2. Redistributions in binary form must reproduce the above copyright
19279377Simp *    notice, this list of conditions and the following disclaimer in the
20279377Simp *    documentation and/or other materials provided with the distribution.
21279377Simp *
22279377Simp * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23279377Simp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24279377Simp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25279377Simp * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26279377Simp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27279377Simp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28279377Simp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29279377Simp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30279377Simp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31279377Simp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32279377Simp * SUCH DAMAGE.
33279377Simp *
34279377Simp * $FreeBSD: head/sys/security/mac/mac_framework.h 145076 2005-04-14 16:03:30Z csjp $
35279377Simp */
36279377Simp/*
37279377Simp * Userland/kernel interface for Mandatory Access Control.
38279377Simp *
39279377Simp * The POSIX.1e implementation page may be reached at:
40279377Simp * http://www.trustedbsd.org/
41279377Simp */
42279377Simp#ifndef _SYS_MAC_H_
43279377Simp#define	_SYS_MAC_H_
44279377Simp
45279377Simp#include <sys/_label.h>
46279377Simp
47279377Simp#ifndef _POSIX_MAC
48279377Simp#define	_POSIX_MAC
49279377Simp#endif
50279377Simp
51279377Simp/*
52279377Simp * MAC framework-related constants and limits.
53279377Simp */
54279377Simp#define	MAC_MAX_POLICY_NAME		32
55279377Simp#define	MAC_MAX_LABEL_ELEMENT_NAME	32
56279377Simp#define	MAC_MAX_LABEL_ELEMENT_DATA	4096
57#define	MAC_MAX_LABEL_BUF_LEN		8192
58
59struct mac {
60	size_t		 m_buflen;
61	char		*m_string;
62};
63
64typedef 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
80int	 mac_execve(char *fname, char **argv, char **envv, mac_t _label);
81int	 mac_free(mac_t _label);
82int	 mac_from_text(mac_t *_label, const char *_text);
83int	 mac_get_fd(int _fd, mac_t _label);
84int	 mac_get_file(const char *_path, mac_t _label);
85int	 mac_get_link(const char *_path, mac_t _label);
86int	 mac_get_peer(int _fd, mac_t _label);
87int	 mac_get_pid(pid_t _pid, mac_t _label);
88int	 mac_get_proc(mac_t _label);
89int	 mac_is_present(const char *_policyname);
90int	 mac_prepare(mac_t *_label, const char *_elements);
91int	 mac_prepare_file_label(mac_t *_label);
92int	 mac_prepare_ifnet_label(mac_t *_label);
93int	 mac_prepare_process_label(mac_t *_label);
94int	 mac_prepare_type(mac_t *_label, const char *_type);
95int	 mac_set_fd(int _fildes, const mac_t _label);
96int	 mac_set_file(const char *_path, mac_t _label);
97int	 mac_set_link(const char *_path, mac_t _label);
98int	 mac_set_proc(const mac_t _label);
99int	 mac_syscall(const char *_policyname, int _call, void *_arg);
100int	 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 */
108struct bpf_d;
109struct cdev;
110struct componentname;
111struct devfs_dirent;
112struct ifnet;
113struct ifreq;
114struct inpcb;
115struct image_params;
116struct inpcb;
117struct ipq;
118struct m_tag;
119struct mbuf;
120struct mount;
121struct msg;
122struct msqid_kernel;
123struct proc;
124struct semid_kernel;
125struct shmid_kernel;
126struct sockaddr;
127struct socket;
128struct sysctl_oid;
129struct sysctl_req;
130struct pipepair;
131struct thread;
132struct timespec;
133struct ucred;
134struct uio;
135struct vattr;
136struct vnode;
137
138#include <sys/acl.h>			/* XXX acl_type_t */
139
140struct vop_setlabel_args;
141
142/*
143 * Label operations.
144 */
145void	mac_init_bpfdesc(struct bpf_d *);
146void	mac_init_cred(struct ucred *);
147void	mac_init_devfsdirent(struct devfs_dirent *);
148void	mac_init_ifnet(struct ifnet *);
149int	mac_init_inpcb(struct inpcb *, int flag);
150void	mac_init_sysv_msgmsg(struct msg *);
151void	mac_init_sysv_msgqueue(struct msqid_kernel*);
152void	mac_init_sysv_sema(struct semid_kernel*);
153void	mac_init_sysv_shm(struct shmid_kernel*);
154int	mac_init_ipq(struct ipq *, int flag);
155int	mac_init_socket(struct socket *, int flag);
156void	mac_init_pipe(struct pipepair *);
157int	mac_init_mbuf(struct mbuf *mbuf, int flag);
158int	mac_init_mbuf_tag(struct m_tag *, int flag);
159void	mac_init_mount(struct mount *);
160void	mac_init_proc(struct proc *);
161void	mac_init_vnode(struct vnode *);
162void	mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
163void	mac_copy_vnode_label(struct label *, struct label *label);
164void	mac_destroy_bpfdesc(struct bpf_d *);
165void	mac_destroy_cred(struct ucred *);
166void	mac_destroy_devfsdirent(struct devfs_dirent *);
167void	mac_destroy_ifnet(struct ifnet *);
168void	mac_destroy_inpcb(struct inpcb *);
169void	mac_destroy_sysv_msgmsg(struct msg *);
170void	mac_destroy_sysv_msgqueue(struct msqid_kernel *);
171void	mac_destroy_sysv_sema(struct semid_kernel *);
172void	mac_destroy_sysv_shm(struct shmid_kernel *);
173void	mac_destroy_ipq(struct ipq *);
174void	mac_destroy_socket(struct socket *);
175void	mac_destroy_pipe(struct pipepair *);
176void	mac_destroy_proc(struct proc *);
177void	mac_destroy_mbuf_tag(struct m_tag *);
178void	mac_destroy_mount(struct mount *);
179void	mac_destroy_vnode(struct vnode *);
180
181struct label	*mac_cred_label_alloc(void);
182void		 mac_cred_label_free(struct label *label);
183struct label	*mac_vnode_label_alloc(void);
184void		 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 */
190void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
191	    struct vnode *vp);
192int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
193void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
194void	mac_create_devfs_device(struct mount *mp, struct cdev *dev,
195	    struct devfs_dirent *de);
196void	mac_create_devfs_directory(struct mount *mp, char *dirname,
197	    int dirnamelen, struct devfs_dirent *de);
198void	mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
199	    struct devfs_dirent *dd, struct devfs_dirent *de);
200int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
201	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
202void	mac_create_mount(struct ucred *cred, struct mount *mp);
203void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
204void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
205	    struct label *newlabel);
206void	mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
207	    struct vnode *vp);
208
209/*
210 * Labeling event operations: IPC objects.
211 */
212void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
213void	mac_create_socket(struct ucred *cred, struct socket *socket);
214void	mac_create_socket_from_socket(struct socket *oldsocket,
215	    struct socket *newsocket);
216void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
217	    struct socket *socket);
218void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
219	    struct socket *newsocket);
220void	mac_create_pipe(struct ucred *cred, struct pipepair *pp);
221
222/*
223 * Labeling event operations: System V IPC primitives
224 */
225void	mac_create_sysv_msgmsg(struct ucred *cred,
226	    struct msqid_kernel *msqkptr, struct msg *msgptr);
227void	mac_create_sysv_msgqueue(struct ucred *cred,
228	    struct msqid_kernel *msqkptr);
229void	mac_create_sysv_sema(struct ucred *cred,
230	    struct semid_kernel *semakptr);
231void	mac_create_sysv_shm(struct ucred *cred,
232	    struct shmid_kernel *shmsegptr);
233
234/*
235 * Labeling event operations: network objects.
236 */
237void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
238void	mac_create_ifnet(struct ifnet *ifp);
239void	mac_create_inpcb_from_socket(struct socket *so, struct inpcb *inp);
240void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
241void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
242void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
243void	mac_create_mbuf_from_inpcb(struct inpcb *inp, struct mbuf *m);
244void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
245void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
246void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
247void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
248void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
249	    struct ifnet *ifnet, struct mbuf *newmbuf);
250void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
251int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
252void	mac_reflect_mbuf_icmp(struct mbuf *m);
253void	mac_reflect_mbuf_tcp(struct mbuf *m);
254void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
255void	mac_inpcb_sosetlabel(struct socket *so, struct inpcb *inp);
256
257/*
258 * Labeling event operations: processes.
259 */
260void	mac_copy_cred(struct ucred *cr1, struct ucred *cr2);
261int	mac_execve_enter(struct image_params *imgp, struct mac *mac_p);
262void	mac_execve_exit(struct image_params *imgp);
263void	mac_execve_transition(struct ucred *old, struct ucred *new,
264	    struct vnode *vp, struct label *interpvnodelabel,
265	    struct image_params *imgp);
266int	mac_execve_will_transition(struct ucred *old, struct vnode *vp,
267	    struct label *interpvnodelabel, struct image_params *imgp);
268void	mac_create_proc0(struct ucred *cred);
269void	mac_create_proc1(struct ucred *cred);
270void	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 */
281void	mac_cleanup_sysv_msgmsg(struct msg *msgptr);
282void	mac_cleanup_sysv_msgqueue(struct msqid_kernel *msqkptr);
283void	mac_cleanup_sysv_sema(struct semid_kernel *semakptr);
284void	mac_cleanup_sysv_shm(struct shmid_kernel *shmsegptr);
285
286/* Access control checks. */
287int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
288int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
289int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
290int	mac_check_inpcb_deliver(struct inpcb *inp, struct mbuf *m);
291int	mac_check_sysv_msgmsq(struct ucred *cred, struct msg *msgptr,
292	    struct msqid_kernel *msqkptr);
293int	mac_check_sysv_msgrcv(struct ucred *cred, struct msg *msgptr);
294int	mac_check_sysv_msgrmid(struct ucred *cred, struct msg *msgptr);
295int	mac_check_sysv_msqget(struct ucred *cred,
296	    struct msqid_kernel *msqkptr);
297int	mac_check_sysv_msqsnd(struct ucred *cred,
298	    struct msqid_kernel *msqkptr);
299int	mac_check_sysv_msqrcv(struct ucred *cred,
300	    struct msqid_kernel *msqkptr);
301int	mac_check_sysv_msqctl(struct ucred *cred,
302	    struct msqid_kernel *msqkptr, int cmd);
303int	mac_check_sysv_semctl(struct ucred *cred,
304	    struct semid_kernel *semakptr, int cmd);
305int	mac_check_sysv_semget(struct ucred *cred,
306	   struct semid_kernel *semakptr);
307int	mac_check_sysv_semop(struct ucred *cred,struct semid_kernel *semakptr,
308	    size_t accesstype);
309int	mac_check_sysv_shmat(struct ucred *cred,
310	    struct shmid_kernel *shmsegptr, int shmflg);
311int	mac_check_sysv_shmctl(struct ucred *cred,
312	    struct shmid_kernel *shmsegptr, int cmd);
313int	mac_check_sysv_shmdt(struct ucred *cred,
314	    struct shmid_kernel *shmsegptr);
315int	mac_check_sysv_shmget(struct ucred *cred,
316	    struct shmid_kernel *shmsegptr, int shmflg);
317int	mac_check_kenv_dump(struct ucred *cred);
318int	mac_check_kenv_get(struct ucred *cred, char *name);
319int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
320int	mac_check_kenv_unset(struct ucred *cred, char *name);
321int	mac_check_kld_load(struct ucred *cred, struct vnode *vp);
322int	mac_check_kld_stat(struct ucred *cred);
323int	mac_check_kld_unload(struct ucred *cred);
324int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
325int	mac_check_pipe_ioctl(struct ucred *cred, struct pipepair *pp,
326	    unsigned long cmd, void *data);
327int	mac_check_pipe_poll(struct ucred *cred, struct pipepair *pp);
328int	mac_check_pipe_read(struct ucred *cred, struct pipepair *pp);
329int	mac_check_pipe_stat(struct ucred *cred, struct pipepair *pp);
330int	mac_check_pipe_write(struct ucred *cred, struct pipepair *pp);
331int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
332int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
333int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
334	    int signum);
335int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
336	    struct sockaddr *sockaddr);
337int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
338	    struct sockaddr *sockaddr);
339int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
340int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
341int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
342int	mac_check_socket_send(struct ucred *cred, struct socket *so);
343int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
344int	mac_check_sysarch_ioperm(struct ucred *cred);
345int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
346int	mac_check_system_nfsd(struct ucred *cred);
347int	mac_check_system_reboot(struct ucred *cred, int howto);
348int	mac_check_system_settime(struct ucred *cred);
349int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
350int	mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
351int	mac_check_system_sysctl(struct ucred *cred, struct sysctl_oid *oidp,
352	    void *arg1, int arg2, struct sysctl_req *req);
353int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
354	    int acc_mode);
355int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
356int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
357int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
358	    struct componentname *cnp, struct vattr *vap);
359int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
360	    struct vnode *vp, struct componentname *cnp);
361int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
362	    acl_type_t type);
363int	mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
364	    int attrnamespace, const char *name);
365int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
366	    struct image_params *imgp);
367int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
368	    acl_type_t type);
369int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
370	    int attrnamespace, const char *name, struct uio *uio);
371int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
372	    struct vnode *vp, struct componentname *cnp);
373int	mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
374	    int attrnamespace);
375int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
376 	    struct componentname *cnp);
377int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
378	    int prot, int flags);
379int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
380	    int prot);
381int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
382	    int acc_mode);
383int	mac_check_vnode_poll(struct ucred *active_cred,
384	    struct ucred *file_cred, struct vnode *vp);
385int	mac_check_vnode_read(struct ucred *active_cred,
386	    struct ucred *file_cred, struct vnode *vp);
387int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
388int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
389int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
390	    struct vnode *vp, struct componentname *cnp);
391int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
392	    struct vnode *vp, int samedir, struct componentname *cnp);
393int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
394int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
395	    acl_type_t type, struct acl *acl);
396int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
397	    int attrnamespace, const char *name, struct uio *uio);
398int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
399	    u_long flags);
400int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
401	    mode_t mode);
402int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
403	    uid_t uid, gid_t gid);
404int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
405	    struct timespec atime, struct timespec mtime);
406int	mac_check_vnode_stat(struct ucred *active_cred,
407	    struct ucred *file_cred, struct vnode *vp);
408int	mac_check_vnode_write(struct ucred *active_cred,
409	    struct ucred *file_cred, struct vnode *vp);
410int	mac_getsockopt_label(struct ucred *cred, struct socket *so,
411	    struct mac *extmac);
412int	mac_getsockopt_peerlabel(struct ucred *cred, struct socket *so,
413	    struct mac *extmac);
414int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
415	    struct ifnet *ifnet);
416int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
417	    struct ifnet *ifnet);
418int	mac_setsockopt_label(struct ucred *cred, struct socket *so,
419	    struct mac *extmac);
420int	mac_pipe_label_set(struct ucred *cred, struct pipepair *pp,
421	    struct label *label);
422void	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 */
428int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
429
430#endif /* !_KERNEL */
431
432#endif /* !_SYS_MAC_H_ */
433