1/* 2 * Copyright (c) 2004-2010 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* 29 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce 30 * support for mandatory and extensible security protections. This notice 31 * is included in support of clause 2.2 (b) of the Apple Public License, 32 * Version 2.0. 33 */ 34 35#ifndef _SYS_KAUTH_H 36#define _SYS_KAUTH_H 37 38#include <sys/appleapiopts.h> 39#include <sys/cdefs.h> 40#include <mach/boolean.h> 41#include <sys/_types.h> /* __offsetof() */ 42 43#ifdef __APPLE_API_EVOLVING 44 45/* 46 * Identities. 47 */ 48 49#define KAUTH_UID_NONE (~(uid_t)0 - 100) /* not a valid UID */ 50#define KAUTH_GID_NONE (~(gid_t)0 - 100) /* not a valid GID */ 51 52#ifndef _KAUTH_GUID 53#define _KAUTH_GUID 54/* Apple-style globally unique identifier */ 55typedef struct { 56#define KAUTH_GUID_SIZE 16 /* 128-bit identifier */ 57 unsigned char g_guid[KAUTH_GUID_SIZE]; 58} guid_t; 59#define _GUID_T 60#endif /* _KAUTH_GUID */ 61 62/* NT Security Identifier, structure as defined by Microsoft */ 63#pragma pack(1) /* push packing of 1 byte */ 64typedef struct { 65 u_int8_t sid_kind; 66 u_int8_t sid_authcount; 67 u_int8_t sid_authority[6]; 68#define KAUTH_NTSID_MAX_AUTHORITIES 16 69 u_int32_t sid_authorities[KAUTH_NTSID_MAX_AUTHORITIES]; 70} ntsid_t; 71#pragma pack() /* pop packing to previous packing level */ 72#define _NTSID_T 73 74/* valid byte count inside a SID structure */ 75#define KAUTH_NTSID_HDRSIZE (8) 76#define KAUTH_NTSID_SIZE(_s) (KAUTH_NTSID_HDRSIZE + ((_s)->sid_authcount * sizeof(u_int32_t))) 77 78/* 79 * External lookup message payload; this structure is shared between the 80 * kernel group membership resolver, and the user space group membership 81 * resolver daemon, and is use to communicate resolution requests from the 82 * kernel to user space, and the result of that request from user space to 83 * the kernel. 84 */ 85struct kauth_identity_extlookup { 86 u_int32_t el_seqno; /* request sequence number */ 87 u_int32_t el_result; /* lookup result */ 88#define KAUTH_EXTLOOKUP_SUCCESS 0 /* results here are good */ 89#define KAUTH_EXTLOOKUP_BADRQ 1 /* request badly formatted */ 90#define KAUTH_EXTLOOKUP_FAILURE 2 /* transient failure during lookup */ 91#define KAUTH_EXTLOOKUP_FATAL 3 /* permanent failure during lookup */ 92#define KAUTH_EXTLOOKUP_INPROG 100 /* request in progress */ 93 u_int32_t el_flags; 94#define KAUTH_EXTLOOKUP_VALID_UID (1<<0) 95#define KAUTH_EXTLOOKUP_VALID_UGUID (1<<1) 96#define KAUTH_EXTLOOKUP_VALID_USID (1<<2) 97#define KAUTH_EXTLOOKUP_VALID_GID (1<<3) 98#define KAUTH_EXTLOOKUP_VALID_GGUID (1<<4) 99#define KAUTH_EXTLOOKUP_VALID_GSID (1<<5) 100#define KAUTH_EXTLOOKUP_WANT_UID (1<<6) 101#define KAUTH_EXTLOOKUP_WANT_UGUID (1<<7) 102#define KAUTH_EXTLOOKUP_WANT_USID (1<<8) 103#define KAUTH_EXTLOOKUP_WANT_GID (1<<9) 104#define KAUTH_EXTLOOKUP_WANT_GGUID (1<<10) 105#define KAUTH_EXTLOOKUP_WANT_GSID (1<<11) 106#define KAUTH_EXTLOOKUP_WANT_MEMBERSHIP (1<<12) 107#define KAUTH_EXTLOOKUP_VALID_MEMBERSHIP (1<<13) 108#define KAUTH_EXTLOOKUP_ISMEMBER (1<<14) 109#define KAUTH_EXTLOOKUP_VALID_PWNAM (1<<15) 110#define KAUTH_EXTLOOKUP_WANT_PWNAM (1<<16) 111#define KAUTH_EXTLOOKUP_VALID_GRNAM (1<<17) 112#define KAUTH_EXTLOOKUP_WANT_GRNAM (1<<18) 113 114 __darwin_pid_t el_info_pid; /* request on behalf of PID */ 115 u_int64_t el_extend; /* extension field */ 116 u_int32_t el_info_reserved_1; /* reserved (APPLE) */ 117 118 uid_t el_uid; /* user ID */ 119 guid_t el_uguid; /* user GUID */ 120 u_int32_t el_uguid_valid; /* TTL on translation result (seconds) */ 121 ntsid_t el_usid; /* user NT SID */ 122 u_int32_t el_usid_valid; /* TTL on translation result (seconds) */ 123 gid_t el_gid; /* group ID */ 124 guid_t el_gguid; /* group GUID */ 125 u_int32_t el_gguid_valid; /* TTL on translation result (seconds) */ 126 ntsid_t el_gsid; /* group SID */ 127 u_int32_t el_gsid_valid; /* TTL on translation result (seconds) */ 128 u_int32_t el_member_valid; /* TTL on group lookup result */ 129}; 130 131struct kauth_cache_sizes { 132 u_int32_t kcs_group_size; 133 u_int32_t kcs_id_size; 134}; 135 136#define KAUTH_EXTLOOKUP_REGISTER (0) 137#define KAUTH_EXTLOOKUP_RESULT (1<<0) 138#define KAUTH_EXTLOOKUP_WORKER (1<<1) 139#define KAUTH_EXTLOOKUP_DEREGISTER (1<<2) 140#define KAUTH_GET_CACHE_SIZES (1<<3) 141#define KAUTH_SET_CACHE_SIZES (1<<4) 142#define KAUTH_CLEAR_CACHES (1<<5) 143 144 145#ifdef KERNEL 146/* 147 * Credentials. 148 */ 149 150#if 0 151/* 152 * Supplemental credential data. 153 * 154 * This interface allows us to associate arbitrary data with a credential. 155 * As with the credential, the data is considered immutable. 156 */ 157struct kauth_cred_supplement { 158 TAILQ_ENTRY(kauth_cred_supplement) kcs_link; 159 160 int kcs_ref; /* reference count */ 161 int kcs_id; /* vended identifier */ 162 size_t kcs_size; /* size of data field */ 163 char kcs_data[0]; 164}; 165 166typedef struct kauth_cred_supplement *kauth_cred_supplement_t; 167 168struct kauth_cred { 169 TAILQ_ENTRY(kauth_cred) kc_link; 170 171 int kc_ref; /* reference count */ 172 uid_t kc_uid; /* effective user id */ 173 uid_t kc_ruid; /* real user id */ 174 uid_t kc_svuid; /* saved user id */ 175 gid_t kc_gid; /* effective group id */ 176 gid_t kc_rgid; /* real group id */ 177 gid_t kc_svgid; /* saved group id */ 178 179 int kc_flags; 180#define KAUTH_CRED_GRPOVERRIDE (1<<0) /* private group list is authoritative */ 181 182 int kc_npvtgroups; /* private group list, advisory or authoritative */ 183 gid_t kc_pvtgroups[NGROUPS]; /* based on KAUTH_CRED_GRPOVERRIDE flag */ 184 185 int kc_nsuppgroups; /* supplementary group list */ 186 gid_t *kc_suppgroups; 187 188 int kc_nwhtgroups; /* whiteout group list */ 189 gid_t *kc_whtgroups; 190 191 struct au_session cr_audit; /* user auditing data */ 192 193 int kc_nsupplement; /* entry count in supplemental data pointer array */ 194 kauth_cred_supplement_t *kc_supplement; 195}; 196#else 197 198/* XXX just for now */ 199#include <sys/ucred.h> 200// typedef struct ucred *kauth_cred_t; 201#endif 202 203/* Kernel SPI for now */ 204__BEGIN_DECLS 205/* 206 * Routines specific to credentials with POSIX credential labels attached 207 * 208 * XXX Should be in policy_posix.h, with struct posix_cred 209 */ 210extern kauth_cred_t posix_cred_create(posix_cred_t pcred); 211extern posix_cred_t posix_cred_get(kauth_cred_t cred); 212extern void posix_cred_label(kauth_cred_t cred, posix_cred_t pcred); 213extern int posix_cred_access(kauth_cred_t cred, id_t object_uid, id_t object_gid, mode_t object_mode, mode_t mode_req); 214 215extern uid_t kauth_getuid(void); 216extern uid_t kauth_getruid(void); 217extern gid_t kauth_getgid(void); 218extern kauth_cred_t kauth_cred_get(void); 219extern kauth_cred_t kauth_cred_get_with_ref(void); 220extern kauth_cred_t kauth_cred_proc_ref(proc_t procp); 221extern kauth_cred_t kauth_cred_create(kauth_cred_t cred); 222extern void kauth_cred_ref(kauth_cred_t _cred); 223#ifndef __LP64__ 224/* Use kauth_cred_unref(), not kauth_cred_rele() */ 225extern void kauth_cred_rele(kauth_cred_t _cred) __deprecated; 226#endif 227extern void kauth_cred_unref(kauth_cred_t *_cred); 228 229#if CONFIG_MACF 230struct label; 231extern kauth_cred_t kauth_cred_label_update(kauth_cred_t cred, struct label *label); 232extern int kauth_proc_label_update(struct proc *p, struct label *label); 233#else 234/* this is a temp hack to cover us when MAC is not built in a kernel configuration. 235 * Since we cannot build our export list based on the kernel configuration we need 236 * to define a stub. 237 */ 238extern kauth_cred_t kauth_cred_label_update(kauth_cred_t cred, void *label); 239extern int kauth_proc_label_update(struct proc *p, void *label); 240#endif 241 242extern kauth_cred_t kauth_cred_find(kauth_cred_t cred); 243extern uid_t kauth_cred_getuid(kauth_cred_t _cred); 244extern uid_t kauth_cred_getruid(kauth_cred_t _cred); 245extern uid_t kauth_cred_getsvuid(kauth_cred_t _cred); 246extern gid_t kauth_cred_getgid(kauth_cred_t _cred); 247extern gid_t kauth_cred_getrgid(kauth_cred_t _cred); 248extern gid_t kauth_cred_getsvgid(kauth_cred_t _cred); 249extern int kauth_cred_pwnam2guid(char *pwnam, guid_t *guidp); 250extern int kauth_cred_grnam2guid(char *grnam, guid_t *guidp); 251extern int kauth_cred_guid2pwnam(guid_t *guidp, char *pwnam); 252extern int kauth_cred_guid2grnam(guid_t *guidp, char *grnam); 253extern int kauth_cred_guid2uid(guid_t *_guid, uid_t *_uidp); 254extern int kauth_cred_guid2gid(guid_t *_guid, gid_t *_gidp); 255extern int kauth_cred_ntsid2uid(ntsid_t *_sid, uid_t *_uidp); 256extern int kauth_cred_ntsid2gid(ntsid_t *_sid, gid_t *_gidp); 257extern int kauth_cred_ntsid2guid(ntsid_t *_sid, guid_t *_guidp); 258extern int kauth_cred_uid2guid(uid_t _uid, guid_t *_guidp); 259extern int kauth_cred_getguid(kauth_cred_t _cred, guid_t *_guidp); 260extern int kauth_cred_gid2guid(gid_t _gid, guid_t *_guidp); 261extern int kauth_cred_uid2ntsid(uid_t _uid, ntsid_t *_sidp); 262extern int kauth_cred_getntsid(kauth_cred_t _cred, ntsid_t *_sidp); 263extern int kauth_cred_gid2ntsid(gid_t _gid, ntsid_t *_sidp); 264extern int kauth_cred_guid2ntsid(guid_t *_guid, ntsid_t *_sidp); 265extern int kauth_cred_ismember_gid(kauth_cred_t _cred, gid_t _gid, int *_resultp); 266extern int kauth_cred_ismember_guid(kauth_cred_t _cred, guid_t *_guidp, int *_resultp); 267 268extern int groupmember(gid_t gid, kauth_cred_t cred); 269 270/* currently only exported in unsupported for use by seatbelt */ 271extern int kauth_cred_issuser(kauth_cred_t _cred); 272 273 274/* GUID, NTSID helpers */ 275extern guid_t kauth_null_guid; 276extern int kauth_guid_equal(guid_t *_guid1, guid_t *_guid2); 277#ifdef XNU_KERNEL_PRIVATE 278extern int kauth_ntsid_equal(ntsid_t *_sid1, ntsid_t *_sid2); 279#endif /* XNU_KERNEL_PRIVATE */ 280 281#ifdef XNU_KERNEL_PRIVATE 282extern int kauth_wellknown_guid(guid_t *_guid); 283#define KAUTH_WKG_NOT 0 /* not a well-known GUID */ 284#define KAUTH_WKG_OWNER 1 285#define KAUTH_WKG_GROUP 2 286#define KAUTH_WKG_NOBODY 3 287#define KAUTH_WKG_EVERYBODY 4 288 289extern kauth_cred_t kauth_cred_dup(kauth_cred_t cred); 290extern gid_t kauth_getrgid(void); 291extern kauth_cred_t kauth_cred_alloc(void); 292extern int cantrace(proc_t cur_procp, kauth_cred_t creds, proc_t traced_procp, int *errp); 293extern kauth_cred_t kauth_cred_copy_real(kauth_cred_t cred); 294extern kauth_cred_t kauth_cred_setresuid(kauth_cred_t cred, uid_t ruid, uid_t euid, uid_t svuid, uid_t gmuid); 295extern kauth_cred_t kauth_cred_setresgid(kauth_cred_t cred, gid_t rgid, gid_t egid, gid_t svgid); 296extern kauth_cred_t kauth_cred_setuidgid(kauth_cred_t cred, uid_t uid, gid_t gid); 297extern kauth_cred_t kauth_cred_setsvuidgid(kauth_cred_t cred, uid_t uid, gid_t gid); 298extern kauth_cred_t kauth_cred_setgroups(kauth_cred_t cred, gid_t *groups, int groupcount, uid_t gmuid); 299struct uthread; 300extern void kauth_cred_uthread_update(struct uthread *, proc_t); 301#ifdef CONFIG_MACF 302extern int kauth_proc_label_update_execve(struct proc *p, struct vfs_context *ctx, struct vnode *vp, struct label *scriptlabel, struct label *execlabel); 303#endif 304extern int kauth_cred_getgroups(kauth_cred_t _cred, gid_t *_groups, int *_groupcount); 305extern int kauth_cred_assume(uid_t _uid); 306extern int kauth_cred_gid_subset(kauth_cred_t _cred1, kauth_cred_t _cred2, int *_resultp); 307struct auditinfo_addr; 308extern kauth_cred_t kauth_cred_setauditinfo(kauth_cred_t, au_session_t *); 309extern int kauth_cred_supplementary_register(const char *name, int *ident); 310extern int kauth_cred_supplementary_add(kauth_cred_t cred, int ident, const void *data, size_t datasize); 311extern int kauth_cred_supplementary_remove(kauth_cred_t cred, int ident); 312 313#endif /* XNU_KERNEL_PRIVATE */ 314__END_DECLS 315 316#endif /* KERNEL */ 317 318/* 319 * Generic Access Control Lists. 320 */ 321#if defined(KERNEL) || defined (_SYS_ACL_H) 322 323typedef u_int32_t kauth_ace_rights_t; 324 325/* Access Control List Entry (ACE) */ 326struct kauth_ace { 327 guid_t ace_applicable; 328 u_int32_t ace_flags; 329#define KAUTH_ACE_KINDMASK 0xf 330#define KAUTH_ACE_PERMIT 1 331#define KAUTH_ACE_DENY 2 332#define KAUTH_ACE_AUDIT 3 /* not implemented */ 333#define KAUTH_ACE_ALARM 4 /* not implemented */ 334#define KAUTH_ACE_INHERITED (1<<4) 335#define KAUTH_ACE_FILE_INHERIT (1<<5) 336#define KAUTH_ACE_DIRECTORY_INHERIT (1<<6) 337#define KAUTH_ACE_LIMIT_INHERIT (1<<7) 338#define KAUTH_ACE_ONLY_INHERIT (1<<8) 339#define KAUTH_ACE_SUCCESS (1<<9) /* not implemented (AUDIT/ALARM) */ 340#define KAUTH_ACE_FAILURE (1<<10) /* not implemented (AUDIT/ALARM) */ 341/* All flag bits controlling ACE inheritance */ 342#define KAUTH_ACE_INHERIT_CONTROL_FLAGS \ 343 (KAUTH_ACE_FILE_INHERIT | \ 344 KAUTH_ACE_DIRECTORY_INHERIT | \ 345 KAUTH_ACE_LIMIT_INHERIT | \ 346 KAUTH_ACE_ONLY_INHERIT) 347 kauth_ace_rights_t ace_rights; /* scope specific */ 348 /* These rights are never tested, but may be present in an ACL */ 349#define KAUTH_ACE_GENERIC_ALL (1<<21) 350#define KAUTH_ACE_GENERIC_EXECUTE (1<<22) 351#define KAUTH_ACE_GENERIC_WRITE (1<<23) 352#define KAUTH_ACE_GENERIC_READ (1<<24) 353 354}; 355 356#ifndef _KAUTH_ACE 357#define _KAUTH_ACE 358typedef struct kauth_ace *kauth_ace_t; 359#endif 360 361 362/* Access Control List */ 363struct kauth_acl { 364 u_int32_t acl_entrycount; 365 u_int32_t acl_flags; 366 367 struct kauth_ace acl_ace[1]; 368}; 369 370/* 371 * XXX this value needs to be raised - 3893388 372 */ 373#define KAUTH_ACL_MAX_ENTRIES 128 374 375/* 376 * The low 16 bits of the flags field are reserved for filesystem 377 * internal use and must be preserved by all APIs. This includes 378 * round-tripping flags through user-space interfaces. 379 */ 380#define KAUTH_ACL_FLAGS_PRIVATE (0xffff) 381 382/* 383 * The high 16 bits of the flags are used to store attributes and 384 * to request specific handling of the ACL. 385 */ 386 387/* inheritance will be deferred until the first rename operation */ 388#define KAUTH_ACL_DEFER_INHERIT (1<<16) 389/* this ACL must not be overwritten as part of an inheritance operation */ 390#define KAUTH_ACL_NO_INHERIT (1<<17) 391 392/* acl_entrycount that tells us the ACL is not valid */ 393#define KAUTH_FILESEC_NOACL ((u_int32_t)(-1)) 394 395/* 396 * If the acl_entrycount field is KAUTH_FILESEC_NOACL, then the size is the 397 * same as a kauth_acl structure; the intent is to put an actual entrycount of 398 * KAUTH_FILESEC_NOACL on disk to distinguish a kauth_filesec_t with an empty 399 * entry (Windows treats this as "deny all") from one that merely indicates a 400 * file group and/or owner guid values. 401 */ 402#define KAUTH_ACL_SIZE(c) (__offsetof(struct kauth_acl, acl_ace) + ((u_int32_t)(c) != KAUTH_FILESEC_NOACL ? ((c) * sizeof(struct kauth_ace)) : 0)) 403#define KAUTH_ACL_COPYSIZE(p) KAUTH_ACL_SIZE((p)->acl_entrycount) 404 405 406#ifndef _KAUTH_ACL 407#define _KAUTH_ACL 408typedef struct kauth_acl *kauth_acl_t; 409#endif 410 411#ifdef KERNEL 412__BEGIN_DECLS 413kauth_acl_t kauth_acl_alloc(int size); 414void kauth_acl_free(kauth_acl_t fsp); 415__END_DECLS 416#endif 417 418 419/* 420 * Extended File Security. 421 */ 422 423/* File Security information */ 424struct kauth_filesec { 425 u_int32_t fsec_magic; 426#define KAUTH_FILESEC_MAGIC 0x012cc16d 427 guid_t fsec_owner; 428 guid_t fsec_group; 429 430 struct kauth_acl fsec_acl; 431}; 432 433/* backwards compatibility */ 434#define fsec_entrycount fsec_acl.acl_entrycount 435#define fsec_flags fsec_acl.acl_flags 436#define fsec_ace fsec_acl.acl_ace 437#define KAUTH_FILESEC_FLAGS_PRIVATE KAUTH_ACL_FLAGS_PRIVATE 438#define KAUTH_FILESEC_DEFER_INHERIT KAUTH_ACL_DEFER_INHERIT 439#define KAUTH_FILESEC_NO_INHERIT KAUTH_ACL_NO_INHERIT 440#define KAUTH_FILESEC_NONE ((kauth_filesec_t)0) 441#define KAUTH_FILESEC_WANTED ((kauth_filesec_t)1) 442 443#ifndef _KAUTH_FILESEC 444#define _KAUTH_FILESEC 445typedef struct kauth_filesec *kauth_filesec_t; 446#endif 447 448#define KAUTH_FILESEC_SIZE(c) (__offsetof(struct kauth_filesec, fsec_acl) + __offsetof(struct kauth_acl, acl_ace) + (c) * sizeof(struct kauth_ace)) 449#define KAUTH_FILESEC_COPYSIZE(p) KAUTH_FILESEC_SIZE(((p)->fsec_entrycount == KAUTH_FILESEC_NOACL) ? 0 : (p)->fsec_entrycount) 450#define KAUTH_FILESEC_COUNT(s) (((s) - KAUTH_FILESEC_SIZE(0)) / sizeof(struct kauth_ace)) 451#define KAUTH_FILESEC_VALID(s) ((s) >= KAUTH_FILESEC_SIZE(0) && (((s) - KAUTH_FILESEC_SIZE(0)) % sizeof(struct kauth_ace)) == 0) 452 453#define KAUTH_FILESEC_XATTR "com.apple.system.Security" 454 455/* Allowable first arguments to kauth_filesec_acl_setendian() */ 456#define KAUTH_ENDIAN_HOST 0x00000001 /* set host endianness */ 457#define KAUTH_ENDIAN_DISK 0x00000002 /* set disk endianness */ 458 459#endif /* KERNEL || <sys/acl.h> */ 460 461 462#ifdef KERNEL 463 464 465/* 466 * Scope management. 467 */ 468struct kauth_scope; 469typedef struct kauth_scope *kauth_scope_t; 470struct kauth_listener; 471typedef struct kauth_listener *kauth_listener_t; 472#ifndef _KAUTH_ACTION_T 473typedef int kauth_action_t; 474# define _KAUTH_ACTION_T 475#endif 476 477typedef int (* kauth_scope_callback_t)(kauth_cred_t _credential, 478 void *_idata, 479 kauth_action_t _action, 480 uintptr_t _arg0, 481 uintptr_t _arg1, 482 uintptr_t _arg2, 483 uintptr_t _arg3); 484 485#define KAUTH_RESULT_ALLOW (1) 486#define KAUTH_RESULT_DENY (2) 487#define KAUTH_RESULT_DEFER (3) 488 489struct kauth_acl_eval { 490 kauth_ace_t ae_acl; 491 int ae_count; 492 kauth_ace_rights_t ae_requested; 493 kauth_ace_rights_t ae_residual; 494 int ae_result; 495 boolean_t ae_found_deny; 496 int ae_options; 497#define KAUTH_AEVAL_IS_OWNER (1<<0) /* authorizing operation for owner */ 498#define KAUTH_AEVAL_IN_GROUP (1<<1) /* authorizing operation for groupmember */ 499#define KAUTH_AEVAL_IN_GROUP_UNKNOWN (1<<2) /* authorizing operation for unknown group membership */ 500 /* expansions for 'generic' rights bits */ 501 kauth_ace_rights_t ae_exp_gall; 502 kauth_ace_rights_t ae_exp_gread; 503 kauth_ace_rights_t ae_exp_gwrite; 504 kauth_ace_rights_t ae_exp_gexec; 505}; 506 507typedef struct kauth_acl_eval *kauth_acl_eval_t; 508 509__BEGIN_DECLS 510kauth_filesec_t kauth_filesec_alloc(int size); 511void kauth_filesec_free(kauth_filesec_t fsp); 512extern kauth_scope_t kauth_register_scope(const char *_identifier, kauth_scope_callback_t _callback, void *_idata); 513extern void kauth_deregister_scope(kauth_scope_t _scope); 514extern kauth_listener_t kauth_listen_scope(const char *_identifier, kauth_scope_callback_t _callback, void *_idata); 515extern void kauth_unlisten_scope(kauth_listener_t _scope); 516extern int kauth_authorize_action(kauth_scope_t _scope, kauth_cred_t _credential, kauth_action_t _action, 517 uintptr_t _arg0, uintptr_t _arg1, uintptr_t _arg2, uintptr_t _arg3); 518 519/* default scope handlers */ 520extern int kauth_authorize_allow(kauth_cred_t _credential, void *_idata, kauth_action_t _action, 521 uintptr_t _arg0, uintptr_t _arg1, uintptr_t _arg2, uintptr_t _arg3); 522 523 524#ifdef XNU_KERNEL_PRIVATE 525void kauth_filesec_acl_setendian(int, kauth_filesec_t, kauth_acl_t); 526int kauth_copyinfilesec(user_addr_t xsecurity, kauth_filesec_t *xsecdestpp); 527extern int kauth_acl_evaluate(kauth_cred_t _credential, kauth_acl_eval_t _eval); 528extern int kauth_acl_inherit(vnode_t _dvp, kauth_acl_t _initial, kauth_acl_t *_product, int _isdir, vfs_context_t _ctx); 529 530#endif /* XNU_KERNEL_PRIVATE */ 531 532 533__END_DECLS 534 535/* 536 * Generic scope. 537 */ 538#define KAUTH_SCOPE_GENERIC "com.apple.kauth.generic" 539 540/* Actions */ 541#define KAUTH_GENERIC_ISSUSER 1 542 543#ifdef XNU_KERNEL_PRIVATE 544__BEGIN_DECLS 545extern int kauth_authorize_generic(kauth_cred_t credential, kauth_action_t action); 546__END_DECLS 547#endif /* XNU_KERNEL_PRIVATE */ 548 549/* 550 * Process/task scope. 551 */ 552#define KAUTH_SCOPE_PROCESS "com.apple.kauth.process" 553 554/* Actions */ 555#define KAUTH_PROCESS_CANSIGNAL 1 556#define KAUTH_PROCESS_CANTRACE 2 557 558__BEGIN_DECLS 559extern int kauth_authorize_process(kauth_cred_t _credential, kauth_action_t _action, 560 struct proc *_process, uintptr_t _arg1, uintptr_t _arg2, uintptr_t _arg3); 561__END_DECLS 562 563/* 564 * Vnode operation scope. 565 * 566 * Prototype for vnode_authorize is in vnode.h 567 */ 568#define KAUTH_SCOPE_VNODE "com.apple.kauth.vnode" 569 570/* 571 * File system operation scope. 572 * 573 */ 574#define KAUTH_SCOPE_FILEOP "com.apple.kauth.fileop" 575 576/* Actions */ 577#define KAUTH_FILEOP_OPEN 1 578#define KAUTH_FILEOP_CLOSE 2 579#define KAUTH_FILEOP_RENAME 3 580#define KAUTH_FILEOP_EXCHANGE 4 581#define KAUTH_FILEOP_LINK 5 582#define KAUTH_FILEOP_EXEC 6 583#define KAUTH_FILEOP_DELETE 7 584 585/* 586 * arguments passed to KAUTH_FILEOP_OPEN listeners 587 * arg0 is pointer to vnode (vnode *) for given user path. 588 * arg1 is pointer to path (char *) passed in to open. 589 * arguments passed to KAUTH_FILEOP_CLOSE listeners 590 * arg0 is pointer to vnode (vnode *) for file to be closed. 591 * arg1 is pointer to path (char *) of file to be closed. 592 * arg2 is close flags. 593 * arguments passed to KAUTH_FILEOP_RENAME listeners 594 * arg0 is pointer to "from" path (char *). 595 * arg1 is pointer to "to" path (char *). 596 * arguments passed to KAUTH_FILEOP_EXCHANGE listeners 597 * arg0 is pointer to file 1 path (char *). 598 * arg1 is pointer to file 2 path (char *). 599 * arguments passed to KAUTH_FILEOP_LINK listeners 600 * arg0 is pointer to path to file we are linking to (char *). 601 * arg1 is pointer to path to the new link file (char *). 602 * arguments passed to KAUTH_FILEOP_EXEC listeners 603 * arg0 is pointer to vnode (vnode *) for executable. 604 * arg1 is pointer to path (char *) to executable. 605 * arguments passed to KAUTH_FILEOP_DELETE listeners 606 * arg0 is pointer to vnode (vnode *) of file/dir that was deleted. 607 * arg1 is pointer to path (char *) of file/dir that was deleted. 608 */ 609 610/* Flag values returned to close listeners. */ 611#define KAUTH_FILEOP_CLOSE_MODIFIED (1<<1) 612 613__BEGIN_DECLS 614#ifdef XNU_KERNEL_PRIVATE 615extern int kauth_authorize_fileop_has_listeners(void); 616#endif /* XNU_KERNEL_PRIVATE */ 617extern int kauth_authorize_fileop(kauth_cred_t _credential, kauth_action_t _action, 618 uintptr_t _arg0, uintptr_t _arg1); 619__END_DECLS 620 621#endif /* KERNEL */ 622 623/* Actions, also rights bits in an ACE */ 624 625#if defined(KERNEL) || defined (_SYS_ACL_H) 626#define KAUTH_VNODE_READ_DATA (1<<1) 627#define KAUTH_VNODE_LIST_DIRECTORY KAUTH_VNODE_READ_DATA 628#define KAUTH_VNODE_WRITE_DATA (1<<2) 629#define KAUTH_VNODE_ADD_FILE KAUTH_VNODE_WRITE_DATA 630#define KAUTH_VNODE_EXECUTE (1<<3) 631#define KAUTH_VNODE_SEARCH KAUTH_VNODE_EXECUTE 632#define KAUTH_VNODE_DELETE (1<<4) 633#define KAUTH_VNODE_APPEND_DATA (1<<5) 634#define KAUTH_VNODE_ADD_SUBDIRECTORY KAUTH_VNODE_APPEND_DATA 635#define KAUTH_VNODE_DELETE_CHILD (1<<6) 636#define KAUTH_VNODE_READ_ATTRIBUTES (1<<7) 637#define KAUTH_VNODE_WRITE_ATTRIBUTES (1<<8) 638#define KAUTH_VNODE_READ_EXTATTRIBUTES (1<<9) 639#define KAUTH_VNODE_WRITE_EXTATTRIBUTES (1<<10) 640#define KAUTH_VNODE_READ_SECURITY (1<<11) 641#define KAUTH_VNODE_WRITE_SECURITY (1<<12) 642#define KAUTH_VNODE_TAKE_OWNERSHIP (1<<13) 643 644/* backwards compatibility only */ 645#define KAUTH_VNODE_CHANGE_OWNER KAUTH_VNODE_TAKE_OWNERSHIP 646 647/* For Windows interoperability only */ 648#define KAUTH_VNODE_SYNCHRONIZE (1<<20) 649 650/* (1<<21) - (1<<24) are reserved for generic rights bits */ 651 652/* Actions not expressed as rights bits */ 653/* 654 * Authorizes the vnode as the target of a hard link. 655 */ 656#define KAUTH_VNODE_LINKTARGET (1<<25) 657 658/* 659 * Indicates that other steps have been taken to authorise the action, 660 * but authorisation should be denied for immutable objects. 661 */ 662#define KAUTH_VNODE_CHECKIMMUTABLE (1<<26) 663 664/* Action modifiers */ 665/* 666 * The KAUTH_VNODE_ACCESS bit is passed to the callback if the authorisation 667 * request in progress is advisory, rather than authoritative. Listeners 668 * performing consequential work (i.e. not strictly checking authorisation) 669 * may test this flag to avoid performing unnecessary work. 670 * 671 * This bit will never be present in an ACE. 672 */ 673#define KAUTH_VNODE_ACCESS (1<<31) 674 675/* 676 * The KAUTH_VNODE_NOIMMUTABLE bit is passed to the callback along with the 677 * KAUTH_VNODE_WRITE_SECURITY bit (and no others) to indicate that the 678 * caller wishes to change one or more of the immutable flags, and the 679 * state of these flags should not be considered when authorizing the request. 680 * The system immutable flags are only ignored when the system securelevel 681 * is low enough to allow their removal. 682 */ 683#define KAUTH_VNODE_NOIMMUTABLE (1<<30) 684 685 686/* 687 * fake right that is composed by the following... 688 * vnode must have search for owner, group and world allowed 689 * plus there must be no deny modes present for SEARCH... this fake 690 * right is used by the fast lookup path to avoid checking 691 * for an exact match on the last credential to lookup 692 * the component being acted on 693 */ 694#define KAUTH_VNODE_SEARCHBYANYONE (1<<29) 695 696 697/* 698 * when passed as an 'action' to "vnode_uncache_authorized_actions" 699 * it indicates that all of the cached authorizations for that 700 * vnode should be invalidated 701 */ 702#define KAUTH_INVALIDATE_CACHED_RIGHTS ((kauth_action_t)~0) 703 704 705 706/* The expansions of the GENERIC bits at evaluation time */ 707#define KAUTH_VNODE_GENERIC_READ_BITS (KAUTH_VNODE_READ_DATA | \ 708 KAUTH_VNODE_READ_ATTRIBUTES | \ 709 KAUTH_VNODE_READ_EXTATTRIBUTES | \ 710 KAUTH_VNODE_READ_SECURITY) 711 712#define KAUTH_VNODE_GENERIC_WRITE_BITS (KAUTH_VNODE_WRITE_DATA | \ 713 KAUTH_VNODE_APPEND_DATA | \ 714 KAUTH_VNODE_DELETE | \ 715 KAUTH_VNODE_DELETE_CHILD | \ 716 KAUTH_VNODE_WRITE_ATTRIBUTES | \ 717 KAUTH_VNODE_WRITE_EXTATTRIBUTES | \ 718 KAUTH_VNODE_WRITE_SECURITY) 719 720#define KAUTH_VNODE_GENERIC_EXECUTE_BITS (KAUTH_VNODE_EXECUTE) 721 722#define KAUTH_VNODE_GENERIC_ALL_BITS (KAUTH_VNODE_GENERIC_READ_BITS | \ 723 KAUTH_VNODE_GENERIC_WRITE_BITS | \ 724 KAUTH_VNODE_GENERIC_EXECUTE_BITS) 725 726/* 727 * Some sets of bits, defined here for convenience. 728 */ 729#define KAUTH_VNODE_WRITE_RIGHTS (KAUTH_VNODE_ADD_FILE | \ 730 KAUTH_VNODE_ADD_SUBDIRECTORY | \ 731 KAUTH_VNODE_DELETE_CHILD | \ 732 KAUTH_VNODE_WRITE_DATA | \ 733 KAUTH_VNODE_APPEND_DATA | \ 734 KAUTH_VNODE_DELETE | \ 735 KAUTH_VNODE_WRITE_ATTRIBUTES | \ 736 KAUTH_VNODE_WRITE_EXTATTRIBUTES | \ 737 KAUTH_VNODE_WRITE_SECURITY | \ 738 KAUTH_VNODE_TAKE_OWNERSHIP | \ 739 KAUTH_VNODE_LINKTARGET | \ 740 KAUTH_VNODE_CHECKIMMUTABLE) 741 742 743#endif /* KERNEL || <sys/acl.h> */ 744 745#ifdef KERNEL 746#include <sys/lock.h> /* lck_grp_t */ 747 748/* 749 * Debugging 750 * 751 * XXX this wouldn't be necessary if we had a *real* debug-logging system. 752 */ 753#if 0 754# ifndef _FN_KPRINTF 755# define _FN_KPRINTF 756void kprintf(const char *fmt, ...); 757# endif /* !_FN_KPRINTF */ 758# define KAUTH_DEBUG_ENABLE 759# define K_UUID_FMT "%08x:%08x:%08x:%08x" 760# define K_UUID_ARG(_u) *(int *)&_u.g_guid[0],*(int *)&_u.g_guid[4],*(int *)&_u.g_guid[8],*(int *)&_u.g_guid[12] 761# define KAUTH_DEBUG(fmt, args...) do { kprintf("%s:%d: " fmt "\n", __PRETTY_FUNCTION__, __LINE__ , ##args); } while (0) 762# define KAUTH_DEBUG_CTX(_c) KAUTH_DEBUG("p = %p c = %p", _c->vc_proc, _c->vc_ucred) 763# define VFS_DEBUG(_ctx, _vp, fmt, args...) \ 764 do { \ 765 kprintf("%p '%s' %s:%d " fmt "\n", \ 766 _ctx, \ 767 (_vp != NULL && _vp->v_name != NULL) ? _vp->v_name : "????", \ 768 __PRETTY_FUNCTION__, __LINE__ , \ 769 ##args); \ 770 } while(0) 771#else /* !0 */ 772# define KAUTH_DEBUG(fmt, args...) do { } while (0) 773# define VFS_DEBUG(ctx, vp, fmt, args...) do { } while(0) 774#endif /* !0 */ 775 776/* 777 * Initialisation. 778 */ 779extern lck_grp_t *kauth_lck_grp; 780#ifdef XNU_KERNEL_PRIVATE 781__BEGIN_DECLS 782extern void kauth_init(void) __attribute__((section("__TEXT, initcode"))); 783extern void kauth_cred_init(void) __attribute__((section("__TEXT, initcode"))); 784#if CONFIG_EXT_RESOLVER 785extern void kauth_identity_init(void) __attribute__((section("__TEXT, initcode"))); 786extern void kauth_groups_init(void) __attribute__((section("__TEXT, initcode"))); 787extern void kauth_resolver_init(void) __attribute__((section("__TEXT, initcode"))); 788#endif 789__END_DECLS 790#endif /* XNU_KERNEL_PRIVATE */ 791 792#endif /* KERNEL */ 793 794#endif /* __APPLE_API_EVOLVING */ 795#endif /* _SYS_KAUTH_H */ 796