mac_framework.h revision 106308
1100978Srwatson/*- 2100978Srwatson * Copyright (c) 1999, 2000, 2001, 2002 Robert N. M. Watson 3100978Srwatson * Copyright (c) 2001, 2002 Networks Associates Technology, Inc. 4100978Srwatson * All rights reserved. 5100978Srwatson * 6100978Srwatson * This software was developed by Robert Watson for the TrustedBSD Project. 7100978Srwatson * 8100978Srwatson * This software was developed for the FreeBSD Project in part by NAI Labs, 9100978Srwatson * the Security Research Division of Network Associates, Inc. under 10100978Srwatson * DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA 11100978Srwatson * CHATS research program. 12100978Srwatson * 13100978Srwatson * Redistribution and use in source and binary forms, with or without 14100978Srwatson * modification, are permitted provided that the following conditions 15100978Srwatson * are met: 16100978Srwatson * 1. Redistributions of source code must retain the above copyright 17100978Srwatson * notice, this list of conditions and the following disclaimer. 18100978Srwatson * 2. Redistributions in binary form must reproduce the above copyright 19100978Srwatson * notice, this list of conditions and the following disclaimer in the 20100978Srwatson * documentation and/or other materials provided with the distribution. 21100978Srwatson * 3. The names of the authors may not be used to endorse or promote 22100978Srwatson * products derived from this software without specific prior written 23100978Srwatson * permission. 24100978Srwatson * 25100978Srwatson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26100978Srwatson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27100978Srwatson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28100978Srwatson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29100978Srwatson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30100978Srwatson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31100978Srwatson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32100978Srwatson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33100978Srwatson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34100978Srwatson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35100978Srwatson * SUCH DAMAGE. 36100978Srwatson * 37100978Srwatson * $FreeBSD: head/sys/security/mac/mac_framework.h 106308 2002-11-01 20:46:53Z rwatson $ 38100978Srwatson */ 39100978Srwatson/* 40100978Srwatson * Userland/kernel interface for Mandatory Access Control. 41100978Srwatson * 42100978Srwatson * The POSIX.1e implementation page may be reached at: 43100978Srwatson * http://www.trustedbsd.org/ 44100978Srwatson */ 45100978Srwatson#ifndef _SYS_MAC_H 46100978Srwatson#define _SYS_MAC_H 47100978Srwatson 48101826Srwatson#include <sys/_label.h> 49101826Srwatson 50100978Srwatson#ifndef _POSIX_MAC 51100978Srwatson#define _POSIX_MAC 52100978Srwatson#endif 53100978Srwatson 54100978Srwatson/* 55100978Srwatson * XXXMAC: The single MAC extended attribute will be deprecated once 56100978Srwatson * compound EA writes on a single target file can be performed cleanly 57100978Srwatson * with UFS2. 58100978Srwatson */ 59100978Srwatson#define FREEBSD_MAC_EXTATTR_NAME "freebsd.mac" 60100978Srwatson#define FREEBSD_MAC_EXTATTR_NAMESPACE EXTATTR_NAMESPACE_SYSTEM 61100978Srwatson 62100978Srwatson/* 63102123Srwatson * MAC framework-related constants and limits. 64102123Srwatson */ 65105693Srwatson#define MAC_MAX_POLICY_NAME 32 66105693Srwatson#define MAC_MAX_LABEL_ELEMENT_NAME 32 67105693Srwatson#define MAC_MAX_LABEL_ELEMENT_DATA 4096 68105693Srwatson#define MAC_MAX_LABEL_BUF_LEN 8192 69102123Srwatson 70105693Srwatsonstruct mac { 71105693Srwatson size_t m_buflen; 72105693Srwatson char *m_string; 73105693Srwatson}; 74105693Srwatson 75105693Srwatsontypedef struct mac *mac_t; 76105693Srwatson 77105693Srwatson#ifndef _KERNEL 78105693Srwatson 79102123Srwatson/* 80105693Srwatson * Location of the userland MAC framework configuration file. mac.conf 81105693Srwatson * binds policy names to shared libraries that understand those policies, 82105693Srwatson * as well as setting defaults for MAC-aware applications. 83100978Srwatson */ 84105693Srwatson#define MAC_CONFFILE "/etc/mac.conf" 85100978Srwatson 86100978Srwatson/* 87105693Srwatson * Extended non-POSIX.1e interfaces that offer additional services 88105693Srwatson * available from the userland and kernel MAC frameworks. 89100978Srwatson */ 90105693Srwatsonint mac_free(mac_t _label); 91105693Srwatsonint mac_from_text(mac_t *_label, const char *_text); 92105693Srwatsonint mac_get_fd(int _fd, mac_t _label); 93105693Srwatsonint mac_get_file(const char *_path, mac_t _label); 94105693Srwatsonint mac_get_link(const char *_path, mac_t _label); 95105693Srwatsonint mac_get_pid(pid_t _pid, mac_t _label); 96105693Srwatsonint mac_get_proc(mac_t _label); 97105693Srwatsonint mac_is_present(const char *_policyname); 98105693Srwatsonint mac_prepare(mac_t *_label, char *_elements); 99105693Srwatsonint mac_prepare_file_label(mac_t *_label); 100105693Srwatsonint mac_prepare_ifnet_label(mac_t *_label); 101105693Srwatsonint mac_prepare_process_label(mac_t *_label); 102105693Srwatsonint mac_set_fd(int _fildes, const mac_t _label); 103105693Srwatsonint mac_set_file(const char *_path, mac_t _label); 104105693Srwatsonint mac_set_link(const char *_path, mac_t _label); 105105693Srwatsonint mac_set_proc(const mac_t _label); 106105693Srwatsonint mac_syscall(const char *_policyname, int _call, void *_arg); 107105693Srwatsonint mac_to_text(mac_t mac, char **_text); 108105693Srwatson 109106093Srwatson#else /* _KERNEL */ 110105693Srwatson 111105693Srwatson/* 112100978Srwatson * Kernel functions to manage and evaluate labels. 113100978Srwatson */ 114100978Srwatsonstruct bpf_d; 115100978Srwatsonstruct componentname; 116100978Srwatsonstruct devfs_dirent; 117100978Srwatsonstruct ifnet; 118100978Srwatsonstruct ifreq; 119100978Srwatsonstruct ipq; 120100978Srwatsonstruct mbuf; 121100978Srwatsonstruct mount; 122100978Srwatsonstruct proc; 123100978Srwatsonstruct sockaddr; 124100978Srwatsonstruct socket; 125100978Srwatsonstruct pipe; 126104338Srwatsonstruct thread; 127100978Srwatsonstruct timespec; 128100978Srwatsonstruct ucred; 129100978Srwatsonstruct uio; 130100978Srwatsonstruct vattr; 131100978Srwatsonstruct vnode; 132100978Srwatson 133100978Srwatson#include <sys/acl.h> /* XXX acl_type_t */ 134100978Srwatson 135100978Srwatsonstruct vop_refreshlabel_args; 136100978Srwatsonstruct vop_setlabel_args; 137100978Srwatson 138100978Srwatson/* 139100978Srwatson * Label operations. 140100978Srwatson */ 141100978Srwatsonvoid mac_init_bpfdesc(struct bpf_d *); 142100978Srwatsonvoid mac_init_cred(struct ucred *); 143100978Srwatsonvoid mac_init_devfsdirent(struct devfs_dirent *); 144100978Srwatsonvoid mac_init_ifnet(struct ifnet *); 145100978Srwatsonvoid mac_init_ipq(struct ipq *); 146104541Srwatsonint mac_init_socket(struct socket *, int flag); 147100978Srwatsonvoid mac_init_pipe(struct pipe *); 148104541Srwatsonint mac_init_mbuf(struct mbuf *m, int flag); 149100978Srwatsonvoid mac_init_mount(struct mount *); 150100978Srwatsonvoid mac_init_vnode(struct vnode *); 151105988Srwatsonvoid mac_init_vnode_label(struct label *); 152105988Srwatsonvoid mac_copy_vnode_label(struct label *, struct label *label); 153100978Srwatsonvoid mac_destroy_bpfdesc(struct bpf_d *); 154100978Srwatsonvoid mac_destroy_cred(struct ucred *); 155100978Srwatsonvoid mac_destroy_devfsdirent(struct devfs_dirent *); 156100978Srwatsonvoid mac_destroy_ifnet(struct ifnet *); 157100978Srwatsonvoid mac_destroy_ipq(struct ipq *); 158100978Srwatsonvoid mac_destroy_socket(struct socket *); 159100978Srwatsonvoid mac_destroy_pipe(struct pipe *); 160100978Srwatsonvoid mac_destroy_mbuf(struct mbuf *); 161100978Srwatsonvoid mac_destroy_mount(struct mount *); 162100978Srwatsonvoid mac_destroy_vnode(struct vnode *); 163105988Srwatsonvoid mac_destroy_vnode_label(struct label *); 164100978Srwatson 165100978Srwatson/* 166100978Srwatson * Labeling event operations: file system objects, and things that 167100978Srwatson * look a lot like file system objects. 168100978Srwatson */ 169105988Srwatsonvoid mac_associate_vnode_devfs(struct mount *mp, struct devfs_dirent *de, 170105988Srwatson struct vnode *vp); 171105988Srwatsonint mac_associate_vnode_extattr(struct mount *mp, struct vnode *vp); 172105988Srwatsonvoid mac_associate_vnode_singlelabel(struct mount *mp, struct vnode *vp); 173100978Srwatsonvoid mac_create_devfs_device(dev_t dev, struct devfs_dirent *de); 174100978Srwatsonvoid mac_create_devfs_directory(char *dirname, int dirnamelen, 175100978Srwatson struct devfs_dirent *de); 176104533Srwatsonvoid mac_create_devfs_symlink(struct ucred *cred, struct devfs_dirent *dd, 177104533Srwatson struct devfs_dirent *de); 178105693Srwatsonvoid mac_create_devfs_vnode(struct devfs_dirent *de, struct vnode *vp); 179105988Srwatsonint mac_create_vnode_extattr(struct ucred *cred, struct mount *mp, 180105988Srwatson struct vnode *dvp, struct vnode *vp, struct componentname *cnp); 181100978Srwatsonvoid mac_create_mount(struct ucred *cred, struct mount *mp); 182100978Srwatsonvoid mac_create_root_mount(struct ucred *cred, struct mount *mp); 183100978Srwatsonvoid mac_relabel_vnode(struct ucred *cred, struct vnode *vp, 184100978Srwatson struct label *newlabel); 185100978Srwatsonvoid mac_update_devfsdirent(struct devfs_dirent *de, struct vnode *vp); 186100978Srwatson 187100978Srwatson/* 188100978Srwatson * Labeling event operations: IPC objects. 189100978Srwatson */ 190100978Srwatsonvoid mac_create_mbuf_from_socket(struct socket *so, struct mbuf *m); 191100978Srwatsonvoid mac_create_socket(struct ucred *cred, struct socket *socket); 192100978Srwatsonvoid mac_create_socket_from_socket(struct socket *oldsocket, 193100978Srwatson struct socket *newsocket); 194100978Srwatsonvoid mac_set_socket_peer_from_mbuf(struct mbuf *mbuf, 195100978Srwatson struct socket *socket); 196100978Srwatsonvoid mac_set_socket_peer_from_socket(struct socket *oldsocket, 197100978Srwatson struct socket *newsocket); 198100978Srwatsonvoid mac_create_pipe(struct ucred *cred, struct pipe *pipe); 199100978Srwatson 200100978Srwatson/* 201100978Srwatson * Labeling event operations: network objects. 202100978Srwatson */ 203100978Srwatsonvoid mac_create_bpfdesc(struct ucred *cred, struct bpf_d *bpf_d); 204100978Srwatsonvoid mac_create_ifnet(struct ifnet *ifp); 205100978Srwatsonvoid mac_create_ipq(struct mbuf *fragment, struct ipq *ipq); 206100978Srwatsonvoid mac_create_datagram_from_ipq(struct ipq *ipq, struct mbuf *datagram); 207100978Srwatsonvoid mac_create_fragment(struct mbuf *datagram, struct mbuf *fragment); 208100978Srwatsonvoid mac_create_mbuf_from_mbuf(struct mbuf *oldmbuf, struct mbuf *newmbuf); 209100978Srwatsonvoid mac_create_mbuf_linklayer(struct ifnet *ifnet, struct mbuf *m); 210100978Srwatsonvoid mac_create_mbuf_from_bpfdesc(struct bpf_d *bpf_d, struct mbuf *m); 211100978Srwatsonvoid mac_create_mbuf_from_ifnet(struct ifnet *ifnet, struct mbuf *m); 212100978Srwatsonvoid mac_create_mbuf_multicast_encap(struct mbuf *oldmbuf, 213100978Srwatson struct ifnet *ifnet, struct mbuf *newmbuf); 214100978Srwatsonvoid mac_create_mbuf_netlayer(struct mbuf *oldmbuf, struct mbuf *newmbuf); 215100978Srwatsonint mac_fragment_match(struct mbuf *fragment, struct ipq *ipq); 216100978Srwatsonvoid mac_update_ipq(struct mbuf *fragment, struct ipq *ipq); 217100978Srwatson 218100978Srwatson/* 219100978Srwatson * Labeling event operations: processes. 220100978Srwatson */ 221100978Srwatsonvoid mac_create_cred(struct ucred *cred_parent, struct ucred *cred_child); 222100978Srwatsonvoid mac_execve_transition(struct ucred *old, struct ucred *new, 223100978Srwatson struct vnode *vp); 224100978Srwatsonint mac_execve_will_transition(struct ucred *old, struct vnode *vp); 225100978Srwatsonvoid mac_create_proc0(struct ucred *cred); 226100978Srwatsonvoid mac_create_proc1(struct ucred *cred); 227104338Srwatsonvoid mac_thread_userret(struct thread *td); 228100978Srwatson 229100978Srwatson/* Access control checks. */ 230100978Srwatsonint mac_check_bpfdesc_receive(struct bpf_d *bpf_d, struct ifnet *ifnet); 231100978Srwatsonint mac_check_cred_visible(struct ucred *u1, struct ucred *u2); 232100978Srwatsonint mac_check_ifnet_transmit(struct ifnet *ifnet, struct mbuf *m); 233106308Srwatsonint mac_check_kenv_dump(struct ucred *cred); 234106308Srwatsonint mac_check_kenv_get(struct ucred *cred, char *name); 235106308Srwatsonint mac_check_kenv_set(struct ucred *cred, char *name, char *value); 236106308Srwatsonint mac_check_kenv_unset(struct ucred *cred, char *name); 237100978Srwatsonint mac_check_mount_stat(struct ucred *cred, struct mount *mp); 238100978Srwatsonint mac_check_pipe_ioctl(struct ucred *cred, struct pipe *pipe, 239100978Srwatson unsigned long cmd, void *data); 240102115Srwatsonint mac_check_pipe_poll(struct ucred *cred, struct pipe *pipe); 241102115Srwatsonint mac_check_pipe_read(struct ucred *cred, struct pipe *pipe); 242102115Srwatsonint mac_check_pipe_stat(struct ucred *cred, struct pipe *pipe); 243102115Srwatsonint mac_check_pipe_write(struct ucred *cred, struct pipe *pipe); 244100978Srwatsonint mac_check_proc_debug(struct ucred *cred, struct proc *proc); 245100978Srwatsonint mac_check_proc_sched(struct ucred *cred, struct proc *proc); 246100978Srwatsonint mac_check_proc_signal(struct ucred *cred, struct proc *proc, 247100978Srwatson int signum); 248100978Srwatsonint mac_check_socket_bind(struct ucred *cred, struct socket *so, 249100978Srwatson struct sockaddr *sockaddr); 250100978Srwatsonint mac_check_socket_connect(struct ucred *cred, struct socket *so, 251100978Srwatson struct sockaddr *sockaddr); 252101934Srwatsonint mac_check_socket_deliver(struct socket *so, struct mbuf *m); 253100978Srwatsonint mac_check_socket_listen(struct ucred *cred, struct socket *so); 254104571Srwatsonint mac_check_socket_receive(struct ucred *cred, struct socket *so); 255104571Srwatsonint mac_check_socket_send(struct ucred *cred, struct socket *so); 256100978Srwatsonint mac_check_socket_visible(struct ucred *cred, struct socket *so); 257106024Srwatsonint mac_check_system_reboot(struct ucred *cred, int howto); 258106023Srwatsonint mac_check_system_swapon(struct ucred *cred, struct vnode *vp); 259106025Srwatsonint mac_check_system_sysctl(struct ucred *cred, int *name, 260106025Srwatson u_int namelen, void *old, size_t *oldlenp, int inkernel, 261106025Srwatson void *new, size_t newlen); 262100978Srwatsonint mac_check_vnode_access(struct ucred *cred, struct vnode *vp, 263106212Srwatson int acc_mode); 264100978Srwatsonint mac_check_vnode_chdir(struct ucred *cred, struct vnode *dvp); 265100978Srwatsonint mac_check_vnode_chroot(struct ucred *cred, struct vnode *dvp); 266100978Srwatsonint mac_check_vnode_create(struct ucred *cred, struct vnode *dvp, 267100978Srwatson struct componentname *cnp, struct vattr *vap); 268100978Srwatsonint mac_check_vnode_delete(struct ucred *cred, struct vnode *dvp, 269100978Srwatson struct vnode *vp, struct componentname *cnp); 270100978Srwatsonint mac_check_vnode_deleteacl(struct ucred *cred, struct vnode *vp, 271100978Srwatson acl_type_t type); 272100978Srwatsonint mac_check_vnode_exec(struct ucred *cred, struct vnode *vp); 273100978Srwatsonint mac_check_vnode_getacl(struct ucred *cred, struct vnode *vp, 274100978Srwatson acl_type_t type); 275100978Srwatsonint mac_check_vnode_getextattr(struct ucred *cred, struct vnode *vp, 276100978Srwatson int attrnamespace, const char *name, struct uio *uio); 277104529Srwatsonint mac_check_vnode_link(struct ucred *cred, struct vnode *dvp, 278104529Srwatson struct vnode *vp, struct componentname *cnp); 279100978Srwatsonint mac_check_vnode_lookup(struct ucred *cred, struct vnode *dvp, 280100978Srwatson struct componentname *cnp); 281104546Srwatsonint mac_check_vnode_mmap(struct ucred *cred, struct vnode *vp, 282104546Srwatson int prot); 283104546Srwatsonint mac_check_vnode_mprotect(struct ucred *cred, struct vnode *vp, 284104546Srwatson int prot); 285100978Srwatsonint mac_check_vnode_open(struct ucred *cred, struct vnode *vp, 286106212Srwatson int acc_mode); 287102129Srwatsonint mac_check_vnode_poll(struct ucred *active_cred, 288102129Srwatson struct ucred *file_cred, struct vnode *vp); 289102129Srwatsonint mac_check_vnode_read(struct ucred *active_cred, 290102129Srwatson struct ucred *file_cred, struct vnode *vp); 291100978Srwatsonint mac_check_vnode_readdir(struct ucred *cred, struct vnode *vp); 292100978Srwatsonint mac_check_vnode_readlink(struct ucred *cred, struct vnode *vp); 293100978Srwatsonint mac_check_vnode_rename_from(struct ucred *cred, struct vnode *dvp, 294100978Srwatson struct vnode *vp, struct componentname *cnp); 295100978Srwatsonint mac_check_vnode_rename_to(struct ucred *cred, struct vnode *dvp, 296100978Srwatson struct vnode *vp, int samedir, struct componentname *cnp); 297100978Srwatsonint mac_check_vnode_revoke(struct ucred *cred, struct vnode *vp); 298100978Srwatsonint mac_check_vnode_setacl(struct ucred *cred, struct vnode *vp, 299100978Srwatson acl_type_t type, struct acl *acl); 300100978Srwatsonint mac_check_vnode_setextattr(struct ucred *cred, struct vnode *vp, 301100978Srwatson int attrnamespace, const char *name, struct uio *uio); 302100978Srwatsonint mac_check_vnode_setflags(struct ucred *cred, struct vnode *vp, 303100978Srwatson u_long flags); 304100978Srwatsonint mac_check_vnode_setmode(struct ucred *cred, struct vnode *vp, 305100978Srwatson mode_t mode); 306100978Srwatsonint mac_check_vnode_setowner(struct ucred *cred, struct vnode *vp, 307100978Srwatson uid_t uid, gid_t gid); 308100978Srwatsonint mac_check_vnode_setutimes(struct ucred *cred, struct vnode *vp, 309100978Srwatson struct timespec atime, struct timespec mtime); 310102129Srwatsonint mac_check_vnode_stat(struct ucred *active_cred, 311102129Srwatson struct ucred *file_cred, struct vnode *vp); 312102129Srwatsonint mac_check_vnode_write(struct ucred *active_cred, 313102129Srwatson struct ucred *file_cred, struct vnode *vp); 314100978Srwatsonint mac_getsockopt_label_get(struct ucred *cred, struct socket *so, 315100978Srwatson struct mac *extmac); 316100978Srwatsonint mac_getsockopt_peerlabel_get(struct ucred *cred, struct socket *so, 317100978Srwatson struct mac *extmac); 318100978Srwatsonint mac_ioctl_ifnet_get(struct ucred *cred, struct ifreq *ifr, 319100978Srwatson struct ifnet *ifnet); 320100978Srwatsonint mac_ioctl_ifnet_set(struct ucred *cred, struct ifreq *ifr, 321100978Srwatson struct ifnet *ifnet); 322100978Srwatsonint mac_setsockopt_label_set(struct ucred *cred, struct socket *so, 323100978Srwatson struct mac *extmac); 324100978Srwatsonint mac_pipe_label_set(struct ucred *cred, struct pipe *pipe, 325100978Srwatson struct label *label); 326100978Srwatson 327100978Srwatson/* 328100978Srwatson * Calls to help various file systems implement labeling functionality 329100978Srwatson * using their existing EA implementation. 330100978Srwatson */ 331100978Srwatsonint vop_stdsetlabel_ea(struct vop_setlabel_args *ap); 332100978Srwatson 333106093Srwatson#endif /* !_KERNEL */ 334100978Srwatson 335100978Srwatson#endif /* !_SYS_MAC_H */ 336