xref: /freebsd/sys/security/mac/mac_framework.h (revision e5e820fd1f9a5d788798072f1d2a60f7cc798f70)
1 /*-
2  * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
3  * Copyright (c) 2001, 2002 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  * XXXMAC: The single MAC extended attribute will be deprecated once
53  * compound EA writes on a single target file can be performed cleanly
54  * with UFS2.
55  */
56 #define	FREEBSD_MAC_EXTATTR_NAME	"freebsd.mac"
57 #define	FREEBSD_MAC_EXTATTR_NAMESPACE	EXTATTR_NAMESPACE_SYSTEM
58 
59 /*
60  * MAC framework-related constants and limits.
61  */
62 #define	MAC_MAX_POLICY_NAME		32
63 #define	MAC_MAX_LABEL_ELEMENT_NAME	32
64 #define	MAC_MAX_LABEL_ELEMENT_DATA	4096
65 #define	MAC_MAX_LABEL_BUF_LEN		8192
66 
67 struct mac {
68 	size_t		 m_buflen;
69 	char		*m_string;
70 };
71 
72 typedef struct mac	*mac_t;
73 
74 #ifndef _KERNEL
75 
76 /*
77  * Location of the userland MAC framework configuration file.  mac.conf
78  * binds policy names to shared libraries that understand those policies,
79  * as well as setting defaults for MAC-aware applications.
80  */
81 #define	MAC_CONFFILE	"/etc/mac.conf"
82 
83 /*
84  * Extended non-POSIX.1e interfaces that offer additional services
85  * available from the userland and kernel MAC frameworks.
86  */
87 int		 mac_free(mac_t _label);
88 int		 mac_from_text(mac_t *_label, const char *_text);
89 int		 mac_get_fd(int _fd, mac_t _label);
90 int		 mac_get_file(const char *_path, mac_t _label);
91 int		 mac_get_link(const char *_path, mac_t _label);
92 int		 mac_get_pid(pid_t _pid, mac_t _label);
93 int		 mac_get_proc(mac_t _label);
94 int		 mac_is_present(const char *_policyname);
95 int		 mac_prepare(mac_t *_label, char *_elements);
96 int		 mac_prepare_file_label(mac_t *_label);
97 int		 mac_prepare_ifnet_label(mac_t *_label);
98 int		 mac_prepare_process_label(mac_t *_label);
99 int		 mac_set_fd(int _fildes, const mac_t _label);
100 int		 mac_set_file(const char *_path, mac_t _label);
101 int		 mac_set_link(const char *_path, mac_t _label);
102 int		 mac_set_proc(const mac_t _label);
103 int		 mac_syscall(const char *_policyname, int _call, void *_arg);
104 int		 mac_to_text(mac_t mac, char **_text);
105 
106 #else /* _KERNEL */
107 
108 /*
109  * Kernel functions to manage and evaluate labels.
110  */
111 struct bpf_d;
112 struct componentname;
113 struct devfs_dirent;
114 struct ifnet;
115 struct ifreq;
116 struct ipq;
117 struct mbuf;
118 struct mount;
119 struct proc;
120 struct sockaddr;
121 struct socket;
122 struct pipe;
123 struct thread;
124 struct timespec;
125 struct ucred;
126 struct uio;
127 struct vattr;
128 struct vnode;
129 
130 #include <sys/acl.h>			/* XXX acl_type_t */
131 
132 struct vop_refreshlabel_args;
133 struct vop_setlabel_args;
134 
135 /*
136  * Label operations.
137  */
138 void	mac_init_bpfdesc(struct bpf_d *);
139 void	mac_init_cred(struct ucred *);
140 void	mac_init_devfsdirent(struct devfs_dirent *);
141 void	mac_init_ifnet(struct ifnet *);
142 void	mac_init_ipq(struct ipq *);
143 int	mac_init_socket(struct socket *, int flag);
144 void	mac_init_pipe(struct pipe *);
145 int	mac_init_mbuf(struct mbuf *m, int flag);
146 void	mac_init_mount(struct mount *);
147 void	mac_init_vnode(struct vnode *);
148 void	mac_init_vnode_label(struct label *);
149 void	mac_copy_vnode_label(struct label *, struct label *label);
150 void	mac_destroy_bpfdesc(struct bpf_d *);
151 void	mac_destroy_cred(struct ucred *);
152 void	mac_destroy_devfsdirent(struct devfs_dirent *);
153 void	mac_destroy_ifnet(struct ifnet *);
154 void	mac_destroy_ipq(struct ipq *);
155 void	mac_destroy_socket(struct socket *);
156 void	mac_destroy_pipe(struct pipe *);
157 void	mac_destroy_mbuf(struct mbuf *);
158 void	mac_destroy_mount(struct mount *);
159 void	mac_destroy_vnode(struct vnode *);
160 void	mac_destroy_vnode_label(struct label *);
161 
162 /*
163  * Labeling event operations: file system objects, and things that
164  * look a lot like file system objects.
165  */
166 void	mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
167 	    struct vnode *vp);
168 int	mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
169 void	mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
170 void	mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
171 void	mac_create_devfs_directory(char *dirname, int dirnamelen,
172 	    struct devfs_dirent *de);
173 void	mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
174 	    struct devfs_dirent *de);
175 void	mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
176 int	mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
177 	    struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
178 void	mac_create_mount(struct ucred *cred, struct mount *mp);
179 void	mac_create_root_mount(struct ucred *cred, struct mount *mp);
180 void	mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
181 	    struct label *newlabel);
182 void	mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
183 
184 /*
185  * Labeling event operations: IPC objects.
186  */
187 void	mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
188 void	mac_create_socket(struct ucred *cred, struct socket *socket);
189 void	mac_create_socket_from_socket(struct socket *oldsocket,
190 	    struct socket *newsocket);
191 void	mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
192 	    struct socket *socket);
193 void	mac_set_socket_peer_from_socket(struct socket *oldsocket,
194 	    struct socket *newsocket);
195 void	mac_create_pipe(struct ucred *cred, struct pipe *pipe);
196 
197 /*
198  * Labeling event operations: network objects.
199  */
200 void	mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
201 void	mac_create_ifnet(struct ifnet *ifp);
202 void	mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
203 void	mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
204 void	mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
205 void	mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
206 void	mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
207 void	mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
208 void	mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
209 void	mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
210 	    struct ifnet *ifnet, struct mbuf *newmbuf);
211 void	mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
212 int	mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
213 void	mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
214 
215 /*
216  * Labeling event operations: processes.
217  */
218 void	mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
219 void	mac_execve_transition(struct ucred *old, struct ucred *new,
220 	    struct vnode *vp);
221 int	mac_execve_will_transition(struct ucred *old, struct vnode *vp);
222 void	mac_create_proc0(struct ucred *cred);
223 void	mac_create_proc1(struct ucred *cred);
224 void	mac_thread_userret(struct thread *td);
225 
226 /* Access control checks. */
227 int	mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
228 int	mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
229 int	mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
230 int	mac_check_kenv_dump(struct ucred *cred);
231 int	mac_check_kenv_get(struct ucred *cred, char *name);
232 int	mac_check_kenv_set(struct ucred *cred, char *name, char *value);
233 int	mac_check_kenv_unset(struct ucred *cred, char *name);
234 int	mac_check_mount_stat(struct ucred *cred, struct mount *mp);
235 int	mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
236 	    unsigned long cmd, void *data);
237 int	mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
238 int	mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
239 int	mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
240 int	mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
241 int	mac_check_proc_debug(struct ucred *cred, struct proc *proc);
242 int	mac_check_proc_sched(struct ucred *cred, struct proc *proc);
243 int	mac_check_proc_signal(struct ucred *cred, struct proc *proc,
244 	    int signum);
245 int	mac_check_socket_bind(struct ucred *cred, struct socket *so,
246 	    struct sockaddr *sockaddr);
247 int	mac_check_socket_connect(struct ucred *cred, struct socket *so,
248 	    struct sockaddr *sockaddr);
249 int	mac_check_socket_deliver(struct socket *so, struct mbuf *m);
250 int	mac_check_socket_listen(struct ucred *cred, struct socket *so);
251 int	mac_check_socket_receive(struct ucred *cred, struct socket *so);
252 int	mac_check_socket_send(struct ucred *cred, struct socket *so);
253 int	mac_check_socket_visible(struct ucred *cred, struct socket *so);
254 int	mac_check_system_acct(struct ucred *cred, struct vnode *vp);
255 int	mac_check_system_nfsd(struct ucred *cred);
256 int	mac_check_system_reboot(struct ucred *cred, int howto);
257 int	mac_check_system_settime(struct ucred *cred);
258 int	mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
259 int	mac_check_system_sysctl(struct ucred *cred, int *name,
260 	    u_int namelen, void *old, size_t *oldlenp, int inkernel,
261 	    void *new, size_t newlen);
262 int	mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
263 	    int acc_mode);
264 int	mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
265 int	mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
266 int	mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
267 	    struct componentname *cnp, struct vattr *vap);
268 int	mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
269 	    struct vnode *vp, struct componentname *cnp);
270 int	mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
271 	    acl_type_t type);
272 int	mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
273 int	mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
274 	    acl_type_t type);
275 int	mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
276 	    int attrnamespace, const char *name, struct uio *uio);
277 int	mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
278 	    struct vnode *vp, struct componentname *cnp);
279 int	mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
280  	    struct componentname *cnp);
281 int	mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
282 	    int prot);
283 int	mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
284 	    int prot);
285 int	mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
286 	    int acc_mode);
287 int	mac_check_vnode_poll(struct ucred *active_cred,
288 	    struct ucred *file_cred, struct vnode *vp);
289 int	mac_check_vnode_read(struct ucred *active_cred,
290 	    struct ucred *file_cred, struct vnode *vp);
291 int	mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
292 int	mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
293 int	mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
294 	    struct vnode *vp, struct componentname *cnp);
295 int	mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
296 	    struct vnode *vp, int samedir, struct componentname *cnp);
297 int	mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
298 int	mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
299 	    acl_type_t type, struct acl *acl);
300 int	mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
301 	    int attrnamespace, const char *name, struct uio *uio);
302 int	mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
303 	    u_long flags);
304 int	mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
305 	    mode_t mode);
306 int	mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
307 	    uid_t uid, gid_t gid);
308 int	mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
309 	    struct timespec atime, struct timespec mtime);
310 int	mac_check_vnode_stat(struct ucred *active_cred,
311 	    struct ucred *file_cred, struct vnode *vp);
312 int	mac_check_vnode_write(struct ucred *active_cred,
313 	    struct ucred *file_cred, struct vnode *vp);
314 int	mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
315 	    struct mac *extmac);
316 int	mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
317 	    struct mac *extmac);
318 int	mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
319 	    struct ifnet *ifnet);
320 int	mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
321 	    struct ifnet *ifnet);
322 int	mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
323 	    struct mac *extmac);
324 int	mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
325 	    struct label *label);
326 
327 /*
328  * Calls to help various file systems implement labeling functionality
329  * using their existing EA implementation.
330  */
331 int	vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
332 
333 #endif /* !_KERNEL */
334 
335 #endif /* !_SYS_MAC_H */
336