[apple/xnu.git] / bsd / sys / cprotect.h

/*
 * Copyright (c) 2009 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef _SYS_CPROTECT_H_
#define	_SYS_CPROTECT_H_

#ifdef __cplusplus
extern "C" {
#endif

#if KERNEL_PRIVATE

#include <sys/cdefs.h>
#include <sys/kernel_types.h>

#define PROTECTION_CLASS_A 1
#define PROTECTION_CLASS_B 2
#define PROTECTION_CLASS_C 3
#define PROTECTION_CLASS_D 4
#define PROTECTION_CLASS_E 5

#define KEYSIZE 8				/* 8x4 = 32, 32x8 = 256 */
#define INTEGRITYSIZE 2			/* 2x4 = 8, 8x8 = 64 */

#define LOCKED_STATE 0
#define UNLOCKED_STATE 1

#define LOCKED_KEYCHAIN 0
#define UNLOCKED_KEYCHAIN 1

#define CONTENT_PROTECTION_XATTR_NAME	"com.apple.system.cprotect"

#define kEMBCKeyHandleSpecial	~1

/* SLIST_HEAD(cp_list, cp_entry) cp_head = LIST_HEAD_INITIALIZER(cp_head); */
/* struct cp_list *cprotect_list_headp;                 /\* List head *\/ */

typedef struct cprotect *cprotect_t;
typedef struct cp_wrap_func *cp_wrap_func_t;
typedef struct cp_global_state *cp_global_state_t;
typedef struct cp_xattr *cp_xattr_t;


typedef int wrapper_t(uint32_t properties, void *key_bytes, size_t key_length, void **wrapped_data, uint32_t *wrapped_length);
typedef	int unwrapper_t(uint32_t properties, void *wrapped_data, size_t wrapped_data_length, void **key_bytes, uint32_t *key_length);

struct cprotect {
	uint32_t cache_key[KEYSIZE];
	uint32_t special_data;
	uint32_t pclass;
	uint8_t cache_key_flushed;
	uint8_t lock_state;			/* lock_state: 0 means unlocked. 1 means locked */
};

struct cp_entry {
    SLIST_ENTRY(cp_entry) cp_list;
	struct cprotect *protected_entry;
};

struct cp_wrap_func {
	wrapper_t *wrapper;
	unwrapper_t *unwrapper;
};

struct cp_global_state {
	uint8_t lock_state;
	uint8_t wrap_functions_set;
};

struct cp_xattr {
	uint32_t persistent_class;
	uint8_t persistent_key[32];
	uint8_t persistent_integrity[8];
	uint8_t xattr_version;
};

int cp_create_init(vnode_t, vfs_context_t);
int cp_key_store_action(int);
int cp_register_wraps(cp_wrap_func_t);
struct cprotect *cp_vnode_entry_alloc(void);
void cp_vnode_entry_init(vnode_t);
int cp_vnode_entry_init_needed(vnode_t);
struct cp_xattr * cp_vn_getxattr(vnode_t, vfs_context_t);
int cp_vn_setxattr(vnode_t, uint32_t, vfs_context_t);

#endif	/* KERNEL_PRIVATE */

#ifdef __cplusplus
};
#endif

#endif /* !_SYS_CPROTECT_H_ */
Commit	Line	Data
d1ecb069 A	1	/*
	2	* Copyright (c) 2009 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	#ifndef _SYS_CPROTECT_H_
	30	#define _SYS_CPROTECT_H_
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	#if KERNEL_PRIVATE
	37
	38	#include <sys/cdefs.h>
	39	#include <sys/kernel_types.h>
	40
	41	#define PROTECTION_CLASS_A 1
	42	#define PROTECTION_CLASS_B 2
	43	#define PROTECTION_CLASS_C 3
	44	#define PROTECTION_CLASS_D 4
	45	#define PROTECTION_CLASS_E 5
	46
	47	#define KEYSIZE 8 /* 8x4 = 32, 32x8 = 256 */
	48	#define INTEGRITYSIZE 2 /* 2x4 = 8, 8x8 = 64 */
	49
	50	#define LOCKED_STATE 0
	51	#define UNLOCKED_STATE 1
	52
	53	#define LOCKED_KEYCHAIN 0
	54	#define UNLOCKED_KEYCHAIN 1
	55
	56	#define CONTENT_PROTECTION_XATTR_NAME "com.apple.system.cprotect"
	57
	58	#define kEMBCKeyHandleSpecial ~1
	59
	60	/* SLIST_HEAD(cp_list, cp_entry) cp_head = LIST_HEAD_INITIALIZER(cp_head); */
	61	/* struct cp_list cprotect_list_headp; /\ List head \/ /
	62
	63	typedef struct cprotect *cprotect_t;
	64	typedef struct cp_wrap_func *cp_wrap_func_t;
65	typedef struct cp_global_state *cp_global_state_t;
66	typedef struct cp_xattr *cp_xattr_t;
67
68
69	typedef int wrapper_t(uint32_t properties, void key_bytes, size_t key_length, void wrapped_data, uint32_t wrapped_length);
70	typedef int unwrapper_t(uint32_t properties, void wrapped_data, size_t wrapped_data_length, void key_bytes, uint32_t key_length);
71
72	struct cprotect {
73	uint32_t cache_key[KEYSIZE];
74	uint32_t special_data;
75	uint32_t pclass;
76	uint8_t cache_key_flushed;
77	uint8_t lock_state; /* lock_state: 0 means unlocked. 1 means locked */
78	};
79
80	struct cp_entry {
81	SLIST_ENTRY(cp_entry) cp_list;
82	struct cprotect *protected_entry;
83	};
84
85	struct cp_wrap_func {
86	wrapper_t *wrapper;
87	unwrapper_t *unwrapper;
88	};
89
90	struct cp_global_state {
91	uint8_t lock_state;
92	uint8_t wrap_functions_set;
93	};
94
95	struct cp_xattr {
96	uint32_t persistent_class;
97	uint8_t persistent_key[32];
98	uint8_t persistent_integrity[8];
99	uint8_t xattr_version;
100	};
101
102	int cp_create_init(vnode_t, vfs_context_t);
103	int cp_key_store_action(int);
104	int cp_register_wraps(cp_wrap_func_t);
105	struct cprotect *cp_vnode_entry_alloc(void);
106	void cp_vnode_entry_init(vnode_t);
107	int cp_vnode_entry_init_needed(vnode_t);
108	struct cp_xattr * cp_vn_getxattr(vnode_t, vfs_context_t);
109	int cp_vn_setxattr(vnode_t, uint32_t, vfs_context_t);
110
111	#endif /* KERNEL_PRIVATE */
112
113	#ifdef __cplusplus
114	};
115	#endif
116
117	#endif /* !_SYS_CPROTECT_H_ */