sys/sys/mac.h

   1 /*-
   2  * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson
   3  * Copyright (c) 2001, 2002, 2003 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  * MAC framework-related constants and limits.
  53  */
  54 #define MAC_MAX_POLICY_NAME             32
  55 #define MAC_MAX_LABEL_ELEMENT_NAME      32
  56 #define MAC_MAX_LABEL_ELEMENT_DATA      4096
  57 #define MAC_MAX_LABEL_BUF_LEN           8192
  58
  59 struct mac {
  60         size_t           m_buflen;
  61         char            *m_string;
  62 };
  63
  64 typedef 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
  80 int      mac_execve(char *fname, char **argv, char **envv, mac_t _label);
  81 int      mac_free(mac_t _label);
  82 int      mac_from_text(mac_t *_label, const char *_text);
  83 int      mac_get_fd(int _fd, mac_t _label);
  84 int      mac_get_file(const char *_path, mac_t _label);
  85 int      mac_get_link(const char *_path, mac_t _label);
  86 int      mac_get_pid(pid_t _pid, mac_t _label);
  87 int      mac_get_proc(mac_t _label);
  88 int      mac_is_present(const char *_policyname);
  89 int      mac_prepare(mac_t *_label, const char *_elements);
  90 int      mac_prepare_file_label(mac_t *_label);
  91 int      mac_prepare_ifnet_label(mac_t *_label);
  92 int      mac_prepare_process_label(mac_t *_label);
  93 int      mac_prepare_type(mac_t *_label, const char *_type);
  94 int      mac_set_fd(int _fildes, const mac_t _label);
  95 int      mac_set_file(const char *_path, mac_t _label);
  96 int      mac_set_link(const char *_path, mac_t _label);
  97 int      mac_set_proc(const mac_t _label);
  98 int      mac_syscall(const char *_policyname, int _call, void *_arg);
  99 int      mac_to_text(mac_t mac, char **_text);
 100 __END_DECLS
 101
 102 #else /* _KERNEL */
 103
 104 /*
 105  * Kernel functions to manage and evaluate labels.
 106  */
 107 struct bpf_d;
 108 struct componentname;
 109 struct devfs_dirent;
 110 struct ifnet;
 111 struct ifreq;
 112 struct image_params;
 113 struct ipq;
 114 struct m_tag;
 115 struct mbuf;
 116 struct mount;
 117 struct proc;
 118 struct sockaddr;
 119 struct socket;
 120 struct pipe;
 121 struct thread;
 122 struct timespec;
 123 struct ucred;
 124 struct uio;
 125 struct vattr;
 126 struct vnode;
 127
 128 #include <sys/acl.h>                    /* XXX acl_type_t */
 129
 130 struct vop_setlabel_args;
 131
 132 /*
 133  * Label operations.
 134  */
 135 void    mac_init_bpfdesc(struct bpf_d *);
 136 void    mac_init_cred(struct ucred *);
 137 void    mac_init_devfsdirent(struct devfs_dirent *);
 138 void    mac_init_ifnet(struct ifnet *);
 139 int     mac_init_ipq(struct ipq *, int flag);
 140 int     mac_init_socket(struct socket *, int flag);
 141 void    mac_init_pipe(struct pipe *);
 142 int     mac_init_mbuf(struct mbuf *mbuf, int flag);
 143 int     mac_init_mbuf_tag(struct m_tag *, int flag);
 144 void    mac_init_mount(struct mount *);
 145 void    mac_init_proc(struct proc *);
 146 void    mac_init_vnode(struct vnode *);
 147 void    mac_init_vnode_label(struct label *);
 148 void    mac_copy_mbuf_tag(struct m_tag *, struct m_tag *);
 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_proc(struct proc *);
 158 void    mac_destroy_mbuf_tag(struct m_tag *);
 159 void    mac_destroy_mount(struct mount *);
 160 void    mac_destroy_vnode(struct vnode *);
 161 void    mac_destroy_vnode_label(struct label *);
 162
 163 /*
 164  * Labeling event operations: file system objects, and things that
 165  * look a lot like file system objects.
 166  */
 167 void    mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
 168             struct vnode *vp);
 169 int     mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
 170 void    mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
 171 void    mac_create_devfs_device(struct mount *mp, dev_t dev,
 172             struct devfs_dirent *de);
 173 void    mac_create_devfs_directory(struct mount *mp, char *dirname,
 174             int dirnamelen, struct devfs_dirent *de);
 175 void    mac_create_devfs_symlink(struct ucred *cred, struct mount *mp,
 176             struct devfs_dirent *dd, struct devfs_dirent *de);
 177 int     mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
 178             struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
 179 void    mac_create_mount(struct ucred *cred, struct mount *mp);
 180 void    mac_create_root_mount(struct ucred *cred, struct mount *mp);
 181 void    mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
 182             struct label *newlabel);
 183 void    mac_update_devfsdirent(struct mount *mp, struct devfs_dirent *de,
 184             struct vnode *vp);
 185
 186 /*
 187  * Labeling event operations: IPC objects.
 188  */
 189 void    mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
 190 void    mac_create_socket(struct ucred *cred, struct socket *socket);
 191 void    mac_create_socket_from_socket(struct socket *oldsocket,
 192             struct socket *newsocket);
 193 void    mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
 194             struct socket *socket);
 195 void    mac_set_socket_peer_from_socket(struct socket *oldsocket,
 196             struct socket *newsocket);
 197 void    mac_create_pipe(struct ucred *cred, struct pipe *pipe);
 198
 199 /*
 200  * Labeling event operations: network objects.
 201  */
 202 void    mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
 203 void    mac_create_ifnet(struct ifnet *ifp);
 204 void    mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
 205 void    mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
 206 void    mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
 207 void    mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
 208 void    mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
 209 void    mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
 210 void    mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
 211 void    mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
 212             struct ifnet *ifnet, struct mbuf *newmbuf);
 213 void    mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
 214 int     mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
 215 void    mac_reflect_mbuf_icmp(struct mbuf *m);
 216 void    mac_reflect_mbuf_tcp(struct mbuf *m);
 217 void    mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
 218
 219 /*
 220  * Labeling event operations: processes.
 221  */
 222 void    mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
 223 int     mac_execve_enter(struct image_params *imgp, struct mac *mac_p,
 224             struct label *execlabel);
 225 void    mac_execve_exit(struct image_params *imgp);
 226 void    mac_execve_transition(struct ucred *old, struct ucred *new,
 227             struct vnode *vp, struct label *interpvnodelabel,
 228             struct image_params *imgp);
 229 int     mac_execve_will_transition(struct ucred *old, struct vnode *vp,
 230             struct label *interpvnodelabel, struct image_params *imgp);
 231 void    mac_create_proc0(struct ucred *cred);
 232 void    mac_create_proc1(struct ucred *cred);
 233 void    mac_thread_userret(struct thread *td);
 234
 235 /* Access control checks. */
 236 int     mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
 237 int     mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
 238 int     mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
 239 int     mac_check_kenv_dump(struct ucred *cred);
 240 int     mac_check_kenv_get(struct ucred *cred, char *name);
 241 int     mac_check_kenv_set(struct ucred *cred, char *name, char *value);
 242 int     mac_check_kenv_unset(struct ucred *cred, char *name);
 243 int     mac_check_kld_load(struct ucred *cred, struct vnode *vp);
 244 int     mac_check_kld_stat(struct ucred *cred);
 245 int     mac_check_kld_unload(struct ucred *cred);
 246 int     mac_check_mount_stat(struct ucred *cred, struct mount *mp);
 247 int     mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
 248             unsigned long cmd, void *data);
 249 int     mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
 250 int     mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
 251 int     mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
 252 int     mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
 253 int     mac_check_proc_debug(struct ucred *cred, struct proc *proc);
 254 int     mac_check_proc_sched(struct ucred *cred, struct proc *proc);
 255 int     mac_check_proc_signal(struct ucred *cred, struct proc *proc,
 256             int signum);
 257 int     mac_check_socket_bind(struct ucred *cred, struct socket *so,
 258             struct sockaddr *sockaddr);
 259 int     mac_check_socket_connect(struct ucred *cred, struct socket *so,
 260             struct sockaddr *sockaddr);
 261 int     mac_check_socket_deliver(struct socket *so, struct mbuf *m);
 262 int     mac_check_socket_listen(struct ucred *cred, struct socket *so);
 263 int     mac_check_socket_receive(struct ucred *cred, struct socket *so);
 264 int     mac_check_socket_send(struct ucred *cred, struct socket *so);
 265 int     mac_check_socket_visible(struct ucred *cred, struct socket *so);
 266 int     mac_check_sysarch_ioperm(struct ucred *cred);
 267 int     mac_check_system_acct(struct ucred *cred, struct vnode *vp);
 268 int     mac_check_system_nfsd(struct ucred *cred);
 269 int     mac_check_system_reboot(struct ucred *cred, int howto);
 270 int     mac_check_system_settime(struct ucred *cred);
 271 int     mac_check_system_swapon(struct ucred *cred, struct vnode *vp);
 272 int     mac_check_system_swapoff(struct ucred *cred, struct vnode *vp);
 273 int     mac_check_system_sysctl(struct ucred *cred, int *name,
 274             u_int namelen, void *old, size_t *oldlenp, int inkernel,
 275             void *new, size_t newlen);
 276 int     mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
 277             int acc_mode);
 278 int     mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
 279 int     mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
 280 int     mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
 281             struct componentname *cnp, struct vattr *vap);
 282 int     mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
 283             struct vnode *vp, struct componentname *cnp);
 284 int     mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
 285             acl_type_t type);
 286 int     mac_check_vnode_deleteextattr(struct ucred *cred, struct vnode *vp,
 287             int attrnamespace, const char *name);
 288 int     mac_check_vnode_exec(struct ucred *cred, struct vnode *vp,
 289             struct image_params *imgp);
 290 int     mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
 291             acl_type_t type);
 292 int     mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
 293             int attrnamespace, const char *name, struct uio *uio);
 294 int     mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
 295             struct vnode *vp, struct componentname *cnp);
 296 int     mac_check_vnode_listextattr(struct ucred *cred, struct vnode *vp,
 297             int attrnamespace);
 298 int     mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
 299             struct componentname *cnp);
 300 int     mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
 301             int prot);
 302 int     mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
 303             int prot);
 304 int     mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
 305             int acc_mode);
 306 int     mac_check_vnode_poll(struct ucred *active_cred,
 307             struct ucred *file_cred, struct vnode *vp);
 308 int     mac_check_vnode_read(struct ucred *active_cred,
 309             struct ucred *file_cred, struct vnode *vp);
 310 int     mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
 311 int     mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
 312 int     mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
 313             struct vnode *vp, struct componentname *cnp);
 314 int     mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
 315             struct vnode *vp, int samedir, struct componentname *cnp);
 316 int     mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
 317 int     mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
 318             acl_type_t type, struct acl *acl);
 319 int     mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
 320             int attrnamespace, const char *name, struct uio *uio);
 321 int     mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
 322             u_long flags);
 323 int     mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
 324             mode_t mode);
 325 int     mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
 326             uid_t uid, gid_t gid);
 327 int     mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
 328             struct timespec atime, struct timespec mtime);
 329 int     mac_check_vnode_stat(struct ucred *active_cred,
 330             struct ucred *file_cred, struct vnode *vp);
 331 int     mac_check_vnode_write(struct ucred *active_cred,
 332             struct ucred *file_cred, struct vnode *vp);
 333 int     mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
 334             struct mac *extmac);
 335 int     mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
 336             struct mac *extmac);
 337 int     mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
 338             struct ifnet *ifnet);
 339 int     mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
 340             struct ifnet *ifnet);
 341 int     mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
 342             struct mac *extmac);
 343 int     mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
 344             struct label *label);
 345 void    mac_cred_mmapped_drop_perms(struct thread *td, struct ucred *cred);
 346
 347 /*
 348  * Calls to help various file systems implement labeling functionality
 349  * using their existing EA implementation.
 350  */
 351 int     vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
 352
 353 #endif /* !_KERNEL */
 354
 355 #endif /* !_SYS_MAC_H */