sys/security/mac/mac_framework.h

   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 NAI Labs,
   9  * the Security Research Division of Network Associates, Inc. under
  10  * DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA
  11  * 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  * 3. The names of the authors may not be used to endorse or promote
  22  *    products derived from this software without specific prior written
  23  *    permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  * $FreeBSD$
  38  */
  39 /*
  40  * Userland/kernel interface for Mandatory Access Control.
  41  *
  42  * The POSIX.1e implementation page may be reached at:
  43  * http://www.trustedbsd.org/
  44  */
  45 #ifndef _SYS_MAC_H
  46 #define _SYS_MAC_H
  47
  48 #include <sys/_label.h>
  49
  50 #ifndef _POSIX_MAC
  51 #define _POSIX_MAC
  52 #endif
  53
  54 /*
  55  * XXXMAC: The single MAC extended attribute will be deprecated once
  56  * compound EA writes on a single target file can be performed cleanly
  57  * with UFS2.
  58  */
  59 #define FREEBSD_MAC_EXTATTR_NAME        "freebsd.mac"
  60 #define FREEBSD_MAC_EXTATTR_NAMESPACE   EXTATTR_NAMESPACE_SYSTEM
  61
  62 /*
  63  * MAC framework-related constants and limits.
  64  */
  65 #define MAC_MAX_POLICY_NAME             32
  66 #define MAC_MAX_LABEL_ELEMENT_NAME      32
  67 #define MAC_MAX_LABEL_ELEMENT_DATA      4096
  68 #define MAC_MAX_LABEL_BUF_LEN           8192
  69
  70 struct mac {
  71         size_t           m_buflen;
  72         char            *m_string;
  73 };
  74
  75 typedef struct mac      *mac_t;
  76
  77 #ifndef _KERNEL
  78
  79 /*
  80  * Location of the userland MAC framework configuration file.  mac.conf
  81  * binds policy names to shared libraries that understand those policies,
  82  * as well as setting defaults for MAC-aware applications.
  83  */
  84 #define MAC_CONFFILE    "/etc/mac.conf"
  85
  86 /*
  87  * Extended non-POSIX.1e interfaces that offer additional services
  88  * available from the userland and kernel MAC frameworks.
  89  */
  90 int              mac_free(mac_t _label);
  91 int              mac_from_text(mac_t *_label, const char *_text);
  92 int              mac_get_fd(int _fd, mac_t _label);
  93 int              mac_get_file(const char *_path, mac_t _label);
  94 int              mac_get_link(const char *_path, mac_t _label);
  95 int              mac_get_pid(pid_t _pid, mac_t _label);
  96 int              mac_get_proc(mac_t _label);
  97 int              mac_is_present(const char *_policyname);
  98 int              mac_prepare(mac_t *_label, char *_elements);
  99 int              mac_prepare_file_label(mac_t *_label);
 100 int              mac_prepare_ifnet_label(mac_t *_label);
 101 int              mac_prepare_process_label(mac_t *_label);
 102 int              mac_set_fd(int _fildes, const mac_t _label);
 103 int              mac_set_file(const char *_path, mac_t _label);
 104 int              mac_set_link(const char *_path, mac_t _label);
 105 int              mac_set_proc(const mac_t _label);
 106 int              mac_syscall(const char *_policyname, int _call, void *_arg);
 107 int              mac_to_text(mac_t mac, char **_text);
 108
 109 #endif /* !_KERNEL */
 110
 111 /*
 112  * XXXMAC: For compatibility until the labels on disk are changed.  We
 113  * will enable the definitions in various policy include files once
 114  * these can be disabled.
 115  */
 116
 117 #define MAC_BIBA_MAX_COMPARTMENTS       256
 118
 119 struct mac_biba_element {
 120         u_short mbe_type;
 121         u_short mbe_grade;
 122         u_char  mbe_compartments[MAC_BIBA_MAX_COMPARTMENTS >> 3];
 123 };
 124
 125 struct mac_biba {
 126         int                     mb_flags;
 127         struct mac_biba_element mb_single;
 128         struct mac_biba_element mb_rangelow, mb_rangehigh;
 129 };
 130
 131 #define MAC_MLS_MAX_COMPARTMENTS        256
 132
 133 struct mac_mls_element {
 134         u_short mme_type;
 135         u_short mme_level;
 136         u_char  mme_compartments[MAC_MLS_MAX_COMPARTMENTS >> 3];
 137 };
 138
 139 struct mac_mls {
 140         int                     mm_flags;
 141         struct mac_mls_element  mm_single;
 142         struct mac_mls_element  mm_rangelow, mm_rangehigh;
 143 };
 144
 145 struct mac_sebsd {
 146         uint32_t        ms_psid;
 147 };
 148
 149 struct oldmac {
 150         int                     m_macflags;
 151         struct mac_biba         m_biba;
 152         struct mac_mls          m_mls;
 153         struct mac_sebsd        m_sebsd;
 154 };
 155
 156 #ifdef _KERNEL
 157
 158 /*
 159  * Kernel functions to manage and evaluate labels.
 160  */
 161 struct bpf_d;
 162 struct componentname;
 163 struct devfs_dirent;
 164 struct ifnet;
 165 struct ifreq;
 166 struct ipq;
 167 struct mbuf;
 168 struct mount;
 169 struct proc;
 170 struct sockaddr;
 171 struct socket;
 172 struct pipe;
 173 struct thread;
 174 struct timespec;
 175 struct ucred;
 176 struct uio;
 177 struct vattr;
 178 struct vnode;
 179
 180 #include <sys/acl.h>                    /* XXX acl_type_t */
 181
 182 struct vop_refreshlabel_args;
 183 struct vop_setlabel_args;
 184
 185 /*
 186  * Label operations.
 187  */
 188 void    mac_init_bpfdesc(struct bpf_d *);
 189 void    mac_init_cred(struct ucred *);
 190 void    mac_init_devfsdirent(struct devfs_dirent *);
 191 void    mac_init_ifnet(struct ifnet *);
 192 void    mac_init_ipq(struct ipq *);
 193 int     mac_init_socket(struct socket *, int flag);
 194 void    mac_init_pipe(struct pipe *);
 195 int     mac_init_mbuf(struct mbuf *m, int flag);
 196 void    mac_init_mount(struct mount *);
 197 void    mac_init_vnode(struct vnode *);
 198 void    mac_init_vnode_label(struct label *);
 199 void    mac_copy_vnode_label(struct label *, struct label *label);
 200 void    mac_destroy_bpfdesc(struct bpf_d *);
 201 void    mac_destroy_cred(struct ucred *);
 202 void    mac_destroy_devfsdirent(struct devfs_dirent *);
 203 void    mac_destroy_ifnet(struct ifnet *);
 204 void    mac_destroy_ipq(struct ipq *);
 205 void    mac_destroy_socket(struct socket *);
 206 void    mac_destroy_pipe(struct pipe *);
 207 void    mac_destroy_mbuf(struct mbuf *);
 208 void    mac_destroy_mount(struct mount *);
 209 void    mac_destroy_vnode(struct vnode *);
 210 void    mac_destroy_vnode_label(struct label *);
 211
 212 /*
 213  * Labeling event operations: file system objects, and things that
 214  * look a lot like file system objects.
 215  */
 216 void    mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de,
 217             struct vnode *vp);
 218 int     mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp);
 219 void    mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp);
 220 void    mac_create_devfs_device(dev_t dev, struct devfs_dirent *de);
 221 void    mac_create_devfs_directory(char *dirname, int dirnamelen,
 222             struct devfs_dirent *de);
 223 void    mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd,
 224             struct devfs_dirent *de);
 225 void    mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp);
 226 int     mac_create_vnode_extattr(struct ucred *cred, struct mount *mp,
 227             struct vnode *dvp, struct vnode *vp, struct componentname *cnp);
 228 void    mac_create_mount(struct ucred *cred, struct mount *mp);
 229 void    mac_create_root_mount(struct ucred *cred, struct mount *mp);
 230 void    mac_relabel_vnode(struct ucred *cred, struct vnode *vp,
 231             struct label *newlabel);
 232 void    mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp);
 233
 234 /*
 235  * Labeling event operations: IPC objects.
 236  */
 237 void    mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m);
 238 void    mac_create_socket(struct ucred *cred, struct socket *socket);
 239 void    mac_create_socket_from_socket(struct socket *oldsocket,
 240             struct socket *newsocket);
 241 void    mac_set_socket_peer_from_mbuf(struct mbuf *mbuf,
 242             struct socket *socket);
 243 void    mac_set_socket_peer_from_socket(struct socket *oldsocket,
 244             struct socket *newsocket);
 245 void    mac_create_pipe(struct ucred *cred, struct pipe *pipe);
 246
 247 /*
 248  * Labeling event operations: network objects.
 249  */
 250 void    mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d);
 251 void    mac_create_ifnet(struct ifnet *ifp);
 252 void    mac_create_ipq(struct mbuf *fragment, struct ipq *ipq);
 253 void    mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram);
 254 void    mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment);
 255 void    mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf);
 256 void    mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m);
 257 void    mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m);
 258 void    mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m);
 259 void    mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf,
 260             struct ifnet *ifnet, struct mbuf *newmbuf);
 261 void    mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf);
 262 int     mac_fragment_match(struct mbuf *fragment, struct ipq *ipq);
 263 void    mac_update_ipq(struct mbuf *fragment, struct ipq *ipq);
 264
 265 /*
 266  * Labeling event operations: processes.
 267  */
 268 void    mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child);
 269 void    mac_execve_transition(struct ucred *old, struct ucred *new,
 270             struct vnode *vp);
 271 int     mac_execve_will_transition(struct ucred *old, struct vnode *vp);
 272 void    mac_create_proc0(struct ucred *cred);
 273 void    mac_create_proc1(struct ucred *cred);
 274 void    mac_thread_userret(struct thread *td);
 275
 276 /* Access control checks. */
 277 int     mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet);
 278 int     mac_check_cred_visible(struct ucred *u1, struct ucred *u2);
 279 int     mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m);
 280 int     mac_check_mount_stat(struct ucred *cred, struct mount *mp);
 281 int     mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe,
 282             unsigned long cmd, void *data);
 283 int     mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe);
 284 int     mac_check_pipe_read(struct ucred *cred, struct pipe *pipe);
 285 int     mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe);
 286 int     mac_check_pipe_write(struct ucred *cred, struct pipe *pipe);
 287 int     mac_check_proc_debug(struct ucred *cred, struct proc *proc);
 288 int     mac_check_proc_sched(struct ucred *cred, struct proc *proc);
 289 int     mac_check_proc_signal(struct ucred *cred, struct proc *proc,
 290             int signum);
 291 int     mac_check_socket_bind(struct ucred *cred, struct socket *so,
 292             struct sockaddr *sockaddr);
 293 int     mac_check_socket_connect(struct ucred *cred, struct socket *so,
 294             struct sockaddr *sockaddr);
 295 int     mac_check_socket_deliver(struct socket *so, struct mbuf *m);
 296 int     mac_check_socket_listen(struct ucred *cred, struct socket *so);
 297 int     mac_check_socket_receive(struct ucred *cred, struct socket *so);
 298 int     mac_check_socket_send(struct ucred *cred, struct socket *so);
 299 int     mac_check_socket_visible(struct ucred *cred, struct socket *so);
 300 int     mac_check_vnode_access(struct ucred *cred, struct vnode *vp,
 301             int flags);
 302 int     mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp);
 303 int     mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp);
 304 int     mac_check_vnode_create(struct ucred *cred, struct vnode *dvp,
 305             struct componentname *cnp, struct vattr *vap);
 306 int     mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp,
 307             struct vnode *vp, struct componentname *cnp);
 308 int     mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp,
 309             acl_type_t type);
 310 int     mac_check_vnode_exec(struct ucred *cred, struct vnode *vp);
 311 int     mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp,
 312             acl_type_t type);
 313 int     mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp,
 314             int attrnamespace, const char *name, struct uio *uio);
 315 int     mac_check_vnode_link(struct ucred *cred, struct vnode *dvp,
 316             struct vnode *vp, struct componentname *cnp);
 317 int     mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp,
 318             struct componentname *cnp);
 319 int     mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp,
 320             int prot);
 321 int     mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp,
 322             int prot);
 323 int     mac_check_vnode_open(struct ucred *cred, struct vnode *vp,
 324             mode_t acc_mode);
 325 int     mac_check_vnode_poll(struct ucred *active_cred,
 326             struct ucred *file_cred, struct vnode *vp);
 327 int     mac_check_vnode_read(struct ucred *active_cred,
 328             struct ucred *file_cred, struct vnode *vp);
 329 int     mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp);
 330 int     mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp);
 331 int     mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp,
 332             struct vnode *vp, struct componentname *cnp);
 333 int     mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp,
 334             struct vnode *vp, int samedir, struct componentname *cnp);
 335 int     mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp);
 336 int     mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp,
 337             acl_type_t type, struct acl *acl);
 338 int     mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp,
 339             int attrnamespace, const char *name, struct uio *uio);
 340 int     mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp,
 341             u_long flags);
 342 int     mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp,
 343             mode_t mode);
 344 int     mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp,
 345             uid_t uid, gid_t gid);
 346 int     mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp,
 347             struct timespec atime, struct timespec mtime);
 348 int     mac_check_vnode_stat(struct ucred *active_cred,
 349             struct ucred *file_cred, struct vnode *vp);
 350 int     mac_check_vnode_swapon(struct ucred *cred, struct vnode *vp);
 351 int     mac_check_vnode_write(struct ucred *active_cred,
 352             struct ucred *file_cred, struct vnode *vp);
 353 int     mac_getsockopt_label_get(struct ucred *cred, struct socket *so,
 354             struct mac *extmac);
 355 int     mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so,
 356             struct mac *extmac);
 357 int     mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr,
 358             struct ifnet *ifnet);
 359 int     mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr,
 360             struct ifnet *ifnet);
 361 int     mac_setsockopt_label_set(struct ucred *cred, struct socket *so,
 362             struct mac *extmac);
 363 int     mac_pipe_label_set(struct ucred *cred, struct pipe *pipe,
 364             struct label *label);
 365
 366 /*
 367  * Calls to help various file systems implement labeling functionality
 368  * using their existing EA implementation.
 369  */
 370 int     vop_stdsetlabel_ea(struct vop_setlabel_args *ap);
 371
 372 #endif /* _KERNEL */
 373
 374 #endif /* !_SYS_MAC_H */