X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/3e170ce000f1506b7b5d2c5c7faec85ceabb573d..HEAD:/bsd/sys/cprotect.h diff --git a/bsd/sys/cprotect.h b/bsd/sys/cprotect.h index 642858921..080dcc203 100644 --- a/bsd/sys/cprotect.h +++ b/bsd/sys/cprotect.h @@ -27,9 +27,9 @@ */ #ifndef _SYS_CPROTECT_H_ -#define _SYS_CPROTECT_H_ +#define _SYS_CPROTECT_H_ -#if KERNEL_PRIVATE +#ifdef KERNEL_PRIVATE #include #include @@ -37,25 +37,27 @@ #include #include #include +#include +#include __BEGIN_DECLS #define CP_CODE(code) FSDBG_CODE(DBG_CONTENT_PROT, code) -/* +/* * Class DBG_FSYSTEM == 0x03 * Subclass DBG_CONTENT_PROT == 0xCF * These debug codes are of the form 0x03CFzzzz */ enum { - CPDBG_OFFSET_IO = CP_CODE(0), /* 0x03CF0000 */ + CPDBG_OFFSET_IO = CP_CODE(0), /* 0x03CF0000 */ }; /* normally the debug events are no-ops */ -#define CP_DEBUG(x,a,b,c,d,e) do {} while (0); +#define CP_DEBUG(x, a, b, c, d, e) do {} while (0); /* dev kernels only! */ -#if !SECURE_KERNEL +#if !SECURE_KERNEL /* KDEBUG events used by content protection subsystem */ #if 0 @@ -65,19 +67,67 @@ enum { #endif -#define CP_MAX_WRAPPEDKEYSIZE 128 /* The size of the largest allowed key */ +#define CP_MAX_WRAPPEDKEYSIZE 128 /* The size of the largest allowed key */ +#define VFS_CP_MAX_CACHEBUFLEN 64 /* Maximum size of the cached key */ /* lock events from AppleKeyStore */ -#define CP_LOCKED_STATE 0 /* Device is locked */ -#define CP_UNLOCKED_STATE 1 /* Device is unlocked */ +enum { + CP_ACTION_LOCKED = 0, + CP_ACTION_UNLOCKED = 1, +}; +/* + * Ideally, cp_key_store_action_t would be an enum, but we cannot fix + * that until AppleKeyStore is updated. + */ +typedef int cp_key_store_action_t; -#define CP_MAX_STATE 1 /* uint8_t ; maximum # of states is 255 */ +/* + * It was once the case (and it may still be the case) where the lock + * state got conflated with the possible actions/events that + * AppleKeyStore can send. For that reason, the locked states below + * should numerically match their corresponding actions above. + */ +typedef unsigned char cp_lock_state_t; +enum { + CP_LOCKED_STATE = 0, + CP_UNLOCKED_STATE = 1, +}; + +typedef uint32_t cp_key_class_t; +typedef uint32_t cp_key_os_version_t; +typedef uint16_t cp_key_revision_t; +typedef uint64_t cp_crypto_id_t; typedef struct cprotect *cprotect_t; -typedef struct cp_wrap_func *cp_wrap_func_t; typedef struct cpx *cpx_t; -/* Structures passed between HFS and AKS kext */ +#ifdef BSD_KERNEL_PRIVATE +/* Not for consumption outside of XNU */ +typedef uint32_t cpx_flags_t; +/* + * This is a CPX structure with a fixed-length key buffer. We need this defined in a header + * so that we can use this structure to allocate the memory for the zone(s) properly. + */ +typedef struct fcpx { +#ifdef DEBUG + uint32_t cpx_magic1; +#endif // DEBUG + aes_encrypt_ctx *cpx_iv_aes_ctx_ptr;// Context used for generating the IV + cpx_flags_t cpx_flags; + uint16_t cpx_max_key_len; + uint16_t cpx_key_len; + uint8_t cpx_cached_key[VFS_CP_MAX_CACHEBUFLEN]; + //Fixed length all the way through +} fcpx_t; + +#endif // BSD_KERNEL_PRIVATE + +typedef struct cp_key { + uint8_t len; + void *key; +} cp_key_t; + +/* Interface to AKS kext */ typedef struct { void *key; unsigned key_len; @@ -91,99 +141,76 @@ typedef cp_raw_key_s* cp_raw_key_t; typedef struct { void *key; unsigned key_len; - uint32_t dp_class; + cp_key_class_t dp_class; } cp_wrapped_key_s; typedef cp_wrapped_key_s* cp_wrapped_key_t; -typedef uint16_t cp_key_revision_t; - typedef struct { - ino64_t inode; - uint32_t volume; - pid_t pid; - uid_t uid; - cp_key_revision_t key_revision; + union { + ino64_t inode; + cp_crypto_id_t crypto_id; + }; + uint32_t volume; + pid_t pid; + uid_t uid; + cp_key_revision_t key_revision; } cp_cred_s; typedef cp_cred_s* cp_cred_t; /* The wrappers are invoked on the AKS kext */ typedef int unwrapper_t(cp_cred_t access, const cp_wrapped_key_t wrapped_key_in, cp_raw_key_t key_out); -typedef int rewrapper_t(cp_cred_t access, uint32_t dp_class, const cp_wrapped_key_t wrapped_key_in, cp_wrapped_key_t wrapped_key_out); -typedef int new_key_t(cp_cred_t access, uint32_t dp_class, cp_raw_key_t key_out, cp_wrapped_key_t wrapped_key_out); +typedef int rewrapper_t(cp_cred_t access, cp_key_class_t dp_class, const cp_wrapped_key_t wrapped_key_in, cp_wrapped_key_t wrapped_key_out); +typedef int new_key_t(cp_cred_t access, cp_key_class_t dp_class, cp_raw_key_t key_out, cp_wrapped_key_t wrapped_key_out); typedef int invalidater_t(cp_cred_t access); /* invalidates keys */ typedef int backup_key_t(cp_cred_t access, const cp_wrapped_key_t wrapped_key_in, cp_wrapped_key_t wrapped_key_out); - -/* - * Flags for Interaction between AKS / Kernel +/* + * Flags for Interaction between AKS / Kernel * These are twiddled via the input/output structs in the above * wrapper/unwrapper functions. */ -#define CP_RAW_KEY_WRAPPEDKEY 0x00000001 +#define CP_RAW_KEY_WRAPPEDKEY 0x00000001 /* * Function prototypes for kexts to interface with our internal cprotect * fields; cpx provides opacity and allows us to modify behavior internally * without requiring kext changes. */ -cpx_t cpx_alloc(size_t key_size); +cpx_t cpx_alloc(size_t key_size, bool needs_ctx); +int cpx_alloc_ctx(cpx_t cpx); +void cpx_free_ctx(cpx_t cpx); +void cpx_init(cpx_t, size_t key_len); +void cpx_init_ctx_ptr(cpx_t cpx); void cpx_free(cpx_t); -__attribute__((const)) size_t cpx_size(size_t key_size); +void cpx_writeprotect(cpx_t cpx); +__attribute__((const)) size_t cpx_size(size_t key_len); __attribute__((pure)) bool cpx_is_sep_wrapped_key(const struct cpx *); void cpx_set_is_sep_wrapped_key(struct cpx *, bool); +__attribute__((pure)) bool cpx_is_composite_key(const struct cpx *); +void cpx_set_is_composite_key(struct cpx *, bool); __attribute__((pure)) bool cpx_use_offset_for_iv(const struct cpx *); void cpx_set_use_offset_for_iv(struct cpx *, bool); +__attribute__((pure)) bool cpx_synthetic_offset_for_iv(const struct cpx *); +void cpx_set_synthetic_offset_for_iv(struct cpx *, bool); __attribute__((pure)) uint16_t cpx_key_len(const struct cpx *); void cpx_set_key_len(struct cpx *, uint16_t key_len); __attribute__((pure)) void *cpx_key(const struct cpx *); aes_encrypt_ctx *cpx_iv_aes_ctx(struct cpx *); - -/* Structure to store pointers for AKS functions */ -struct cp_wrap_func { - new_key_t *new_key; - unwrapper_t *unwrapper; - rewrapper_t *rewrapper; - invalidater_t *invalidater; - backup_key_t *backup_key; -}; - -int cp_key_store_action(int); -int cp_register_wraps(cp_wrap_func_t); - -#ifdef BSD_KERNEL_PRIVATE - -/* - * Declarations that are not exported from the kernel but are used by - * VFS to call into the implementation (i.e. HFS) should be here. - */ - -/* Content Protection VNOP Operation flags */ -#define CP_READ_ACCESS 0x1 -#define CP_WRITE_ACCESS 0x2 - -/* - * Functions to check the status of a CP and to query - * the containing filesystem to see if it is supported. - */ -struct vnode; -struct hfsmount; - -int cp_vnode_getclass(struct vnode *, int *); -int cp_vnode_setclass(struct vnode *, uint32_t); -int cp_vnode_transcode(struct vnode * vp, void *key, unsigned *len); - -int cp_handle_vnop(struct vnode *, int, int); -int cp_handle_open(struct vnode *vp, int mode); -int cp_get_root_major_vers (struct vnode *vp, uint32_t *level); -int cp_get_default_level (struct vnode *vp, uint32_t *level); -int cp_is_valid_class (int isdir, int32_t protectionclass); -int cp_set_trimmed(struct hfsmount *hfsmp); -int cp_set_rewrapped(struct hfsmount *hfsmp); -int cp_flop_generation (struct hfsmount *hfsmp); - -#endif /* BSD_KERNEL_PRIVATE */ +void cpx_flush(cpx_t cpx); +bool cpx_can_copy(const struct cpx *src, const struct cpx *dst); +void cpx_copy(const struct cpx *src, cpx_t dst); +uint16_t cpx_max_key_len(const struct cpx *cpx); +bool cpx_has_key(const struct cpx *cpx); +size_t cpx_sizex(const struct cpx *cpx); +void cpx_set_aes_iv_key(struct cpx *cpx, void *iv_key); + +int cp_key_store_action(cp_key_store_action_t); +int cp_key_store_action_for_volume(uuid_t volume_uuid, cp_key_store_action_t action); +cp_key_os_version_t cp_os_version(void); +// Should be cp_key_class_t but HFS has a conflicting definition +int cp_is_valid_class(int isdir, int32_t protectionclass); __END_DECLS