bsd/sys/kauth.h

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