1 | /* Copyright (c) (2010-2012,2014-2022) Apple Inc. All rights reserved. |
2 | * |
3 | * corecrypto is licensed under Apple Inc.’s Internal Use License Agreement (which |
4 | * is contained in the License.txt file distributed with corecrypto) and only to |
5 | * people who accept that license. IMPORTANT: Any license rights granted to you by |
6 | * Apple Inc. (if any) are limited to internal use within your organization only on |
7 | * devices and computers you own or control, for the sole purpose of verifying the |
8 | * security characteristics and correct functioning of the Apple Software. You may |
9 | * not, directly or indirectly, redistribute the Apple Software or any portions thereof. |
10 | */ |
11 | |
12 | #ifndef _CORECRYPTO_CCDIGEST_H_ |
13 | #define _CORECRYPTO_CCDIGEST_H_ |
14 | |
15 | #include <corecrypto/cc.h> |
16 | #include <corecrypto/ccn.h> |
17 | |
18 | /* To malloc a digest context for a given di, use malloc(ccdigest_di_size(di)) |
19 | and assign the result to a pointer to a struct ccdigest_ctx. */ |
20 | struct ccdigest_ctx { |
21 | uint8_t state[1]; |
22 | } CC_ALIGNED(8); |
23 | |
24 | typedef struct ccdigest_ctx *ccdigest_ctx_t; |
25 | |
26 | struct ccdigest_state { |
27 | uint8_t state[1]; |
28 | } CC_ALIGNED(8); |
29 | |
30 | typedef struct ccdigest_state *ccdigest_state_t; |
31 | |
32 | struct ccdigest_info { |
33 | size_t output_size; |
34 | size_t state_size; |
35 | size_t block_size; |
36 | size_t oid_size; |
37 | const unsigned char *oid; |
38 | const void *initial_state; |
39 | void(* CC_SPTR(ccdigest_info, compress))(ccdigest_state_t state, size_t nblocks, |
40 | const void *data); |
41 | void(* CC_SPTR(ccdigest_info, final))(const struct ccdigest_info *di, ccdigest_ctx_t ctx, |
42 | unsigned char *digest); |
43 | cc_impl_t impl; |
44 | }; |
45 | |
46 | /* Return sizeof a ccdigest_ctx for a given size_t _state_size_ and |
47 | size_t _block_size_. */ |
48 | #define ccdigest_ctx_size(_state_size_, _block_size_) ((_state_size_) + sizeof(uint64_t) + (_block_size_) + sizeof(unsigned int)) |
49 | /* Return sizeof a ccdigest_ctx for a given struct ccdigest_info *_di_. */ |
50 | #define ccdigest_di_size(_di_) (ccdigest_ctx_size((_di_)->state_size, (_di_)->block_size)) |
51 | |
52 | /* Declare a ccdigest_ctx for a given size_t _state_size_ and |
53 | size_t _block_size_, named _name_. Can be used in structs or on the |
54 | stack. */ |
55 | #define ccdigest_ctx_decl(_state_size_, _block_size_, _name_) cc_ctx_decl(struct ccdigest_ctx, ccdigest_ctx_size(_state_size_, _block_size_), _name_) |
56 | #define ccdigest_ctx_clear(_state_size_, _block_size_, _name_) cc_clear(ccdigest_ctx_size(_state_size_, _block_size_), _name_) |
57 | /* Declare a ccdigest_ctx for a given size_t _state_size_ and |
58 | size_t _block_size_, named _name_. Can be used on the stack. */ |
59 | #define ccdigest_di_decl(_di_, _name_) cc_ctx_decl_vla(struct ccdigest_ctx, ccdigest_di_size(_di_), _name_) |
60 | #define ccdigest_di_clear(_di_, _name_) cc_clear(ccdigest_di_size(_di_), _name_) |
61 | |
62 | /* Digest context field accessors. Consider the implementation private. */ |
63 | #define ccdigest_state_u8(_di_, _ctx_) ccdigest_u8(ccdigest_state((_di_), (_ctx_))) |
64 | #define ccdigest_state_u32(_di_, _ctx_) ccdigest_u32(ccdigest_state((_di_), (_ctx_))) |
65 | #define ccdigest_state_u64(_di_, _ctx_) ccdigest_u64(ccdigest_state((_di_), (_ctx_))) |
66 | #define ccdigest_state_ccn(_di_, _ctx_) ccdigest_ccn(ccdigest_state((_di_), (_ctx_))) |
67 | |
68 | #define ccdigest_nbits(_di_, _ctx_) (*((uint64_t *)((ccdigest_ctx_t)(_ctx_))->state)) |
69 | #define ccdigest_state(_di_, _ctx_) ((ccdigest_state_t)(((ccdigest_ctx_t)(_ctx_))->state + sizeof(uint64_t))) |
70 | #define ccdigest_data(_di_, _ctx_) (((ccdigest_ctx_t)(_ctx_))->state + (_di_)->state_size + sizeof(uint64_t)) |
71 | #define ccdigest_num(_di_, _ctx_) (*((unsigned int *)(((ccdigest_ctx_t)(_ctx_))->state + (_di_)->state_size + sizeof(uint64_t) + (_di_)->block_size))) |
72 | |
73 | /* Digest state field accessors. Consider the implementation private. */ |
74 | #define ccdigest_u8(_state_) ((uint8_t *)((ccdigest_state_t)(_state_))) |
75 | #define ccdigest_u32(_state_) ((uint32_t *)((ccdigest_state_t)(_state_))) |
76 | #define ccdigest_u64(_state_) ((uint64_t *)((ccdigest_state_t)(_state_))) |
77 | #define ccdigest_ccn(_state_) ((cc_unit *)((ccdigest_state_t)(_state_))) |
78 | |
79 | void ccdigest_init(const struct ccdigest_info *di, ccdigest_ctx_t ctx); |
80 | void ccdigest_update(const struct ccdigest_info *di, ccdigest_ctx_t ctx, |
81 | size_t len, const void *data); |
82 | |
83 | CC_INLINE |
84 | void ccdigest_final(const struct ccdigest_info *di, ccdigest_ctx_t ctx, unsigned char *digest) |
85 | { |
86 | di->final(di,ctx,digest); |
87 | } |
88 | |
89 | void ccdigest(const struct ccdigest_info *di, size_t len, |
90 | const void *data, void *digest); |
91 | |
92 | #define OID_DEF(_VALUE_) ((const unsigned char *)_VALUE_) |
93 | |
94 | // https://csrc.nist.gov/projects/computer-security-objects-register/algorithm-registration#Hash |
95 | #define CC_DIGEST_OID_MD2 OID_DEF("\x06\x08\x2A\x86\x48\x86\xF7\x0D\x02\x02") |
96 | #define CC_DIGEST_OID_MD4 OID_DEF("\x06\x08\x2A\x86\x48\x86\xF7\x0D\x02\x04") |
97 | #define CC_DIGEST_OID_MD5 OID_DEF("\x06\x08\x2A\x86\x48\x86\xF7\x0D\x02\x05") |
98 | #define CC_DIGEST_OID_SHA1 OID_DEF("\x06\x05\x2b\x0e\x03\x02\x1a") |
99 | #define CC_DIGEST_OID_SHA224 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x04") |
100 | #define CC_DIGEST_OID_SHA256 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x01") |
101 | #define CC_DIGEST_OID_SHA384 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x02") |
102 | #define CC_DIGEST_OID_SHA512 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x03") |
103 | #define CC_DIGEST_OID_SHA512_256 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x06") |
104 | #define CC_DIGEST_OID_RMD160 OID_DEF("\x06\x05\x2B\x24\x03\x02\x01") |
105 | #define CC_DIGEST_OID_SHA3_224 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x07") |
106 | #define CC_DIGEST_OID_SHA3_256 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x08") |
107 | #define CC_DIGEST_OID_SHA3_384 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x09") |
108 | #define CC_DIGEST_OID_SHA3_512 OID_DEF("\x06\x09\x60\x86\x48\x01\x65\x03\x04\x02\x0A") |
109 | |
110 | // Provide current maximum sizes for block and state in order to prevent the |
111 | // need for dynamic allocation of context or many macro accessor functions. |
112 | #define MAX_DIGEST_BLOCK_SIZE 144 // Maximum block size is that of SHA3-224 |
113 | #define MAX_DIGEST_STATE_SIZE 200 // SHA-3 state is 1600 bits |
114 | #define MAX_DIGEST_OUTPUT_SIZE 64 |
115 | |
116 | #endif /* _CORECRYPTO_CCDIGEST_H_ */ |
117 | |