xref: /xnu-10063.141.1/EXTERNAL_HEADERS/image4/cryptex1/nonce.h (revision d8b80295118ef25ac3a784134bcf95cd8e88109f)
1 /*
2  * Copyright © 2017-2024 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  * @header
30  * Definitions and interfaces for handling Cryptex1 nonces on Darwin platforms.
31  */
32 #ifndef __IMAGE4_DARWIN_CRYPTEX1_NONCE_H
33 #define __IMAGE4_DARWIN_CRYPTEX1_NONCE_H
34 
35 #include <os/base.h>
36 
37 __BEGIN_DECLS
38 OS_ASSUME_NONNULL_BEGIN
39 
40 /*!
41  * @typedef darwin_cryptex1_nonce_t
42  * A type describing nonce handle values for Cryptex1 nonce domains hosted on
43  * Darwin.
44  *
45  * @const DARWIN_CRYPTEX1_NONCE_BOOT
46  * The Cryptex1 boot nonce.
47  *
48  * @const DARWIN_CRYPTEX1_NONCE_ASSET_BRAIN
49  * The Cryptex1 MobileAsset brain nonce.
50  *
51  * @const DARWIN_CRYPTEX1_NONCE_GENERIC
52  * The Cryptex1 generic nonce.
53  *
54  * @const DARWIN_CRYPTEX1_NONCE_SIMULATOR_RUNTIME
55  * The Cryptex1 simulator runtime nonce.
56  *
57  * @const DARWIN_CRYPTEX1_NONCE_EPHEMERAL
58  * The Cryptex1 ephemeral nonce. This nonce is suitable for any ephemeral
59  * personalization.
60  */
61 OS_CLOSED_ENUM(darwin_cryptex1_nonce, uint32_t,
62 	DARWIN_CRYPTEX1_NONCE_BOOT = 1,
63 	DARWIN_CRYPTEX1_NONCE_ASSET_BRAIN = 2,
64 	DARWIN_CRYPTEX1_NONCE_GENERIC = 3,
65 	DARWIN_CRYPTEX1_NONCE_SIMULATOR_RUNTIME = 4,
66 	DARWIN_CRYPTEX1_NONCE_EPHEMERAL = 5,
67 	_DARWIN_CRYPTEX1_NONCE_CNT,
68 );
69 
70 OS_ASSUME_NONNULL_END
71 __END_DECLS
72 
73 #endif // __IMAGE4_DARWIN_CRYPTEX1_NONCE_H
74