1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* Copyright (c) 2010 Apple Inc. All Rights Reserved.
*
* @APPLE_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. 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_LICENSE_HEADER_END@
*/
#ifndef _CC_SYMKEYWRAP_H_
#define _CC_SYMKEYWRAP_H_
#include <sys/types.h>
#include <stdint.h>
#include <string.h>
#include <limits.h>
#include <stdlib.h>
#if defined(_MSC_VER)
#include <availability.h>
#else
#include <os/availability.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
enum {
kCCWRAPAES = 1,
};
extern const uint8_t * const CCrfc3394_iv API_AVAILABLE(macos(10.7), ios(5.0));
extern const size_t CCrfc3394_ivLen API_AVAILABLE(macos(10.7), ios(5.0));
typedef uint32_t CCWrappingAlgorithm;
/*!
@function CCSymmetricKeyWrap
@abstract Wrap a symmetric key with a Key Encryption Key (KEK).
@param algorithm Currently only AES Keywrapping (rfc3394) is available
via kCCWRAPAES
@param iv The initialization value to be used. CCrfc3394_iv is
available as a constant for the standard IV to use.
@param ivLen The length of the initialization value to be used.
CCrfc3394_ivLen is available as a constant for the
standard IV to use.
@param kek The Key Encryption Key to be used to wrap the raw key.
@param kekLen The length of the KEK in bytes.
@param rawKey The raw key bytes to be wrapped.
@param rawKeyLen The length of the key in bytes.
@param wrappedKey The resulting wrapped key produced by the function.
The space for this must be provided by the caller.
@param wrappedKeyLen The length of the wrapped key in bytes.
@discussion The algorithm chosen is determined by the algorithm parameter
and the size of the key being wrapped (ie aes128 for 128 bit
keys).
@result kCCBufferTooSmall indicates insufficent space in the wrappedKey
buffer.
kCCParamError can result from bad values for the kek, rawKey, and
wrappedKey key pointers.
*/
int
CCSymmetricKeyWrap(CCWrappingAlgorithm algorithm,
const uint8_t *iv, const size_t ivLen,
const uint8_t *kek, size_t kekLen,
const uint8_t *rawKey, size_t rawKeyLen,
uint8_t *wrappedKey, size_t *wrappedKeyLen)
API_AVAILABLE(macos(10.7), ios(5.0));
/*!
@function CCSymmetricKeyUnwrap
@abstract Unwrap a symmetric key with a Key Encryption Key (KEK).
@param algorithm Currently only AES Keywrapping (rfc3394) is available
via kCCWRAPAES
@param iv The initialization value to be used. CCrfc3394_iv is
available as a constant for the standard IV to use.
@param ivLen The length of the initialization value to be used.
CCrfc3394_ivLen is available as a constant for the
standard IV to use.
@param kek The Key Encryption Key to be used to unwrap the raw key.
@param kekLen The length of the KEK in bytes.
@param wrappedKey The wrapped key bytes.
@param wrappedKeyLen The length of the wrapped key in bytes.
@param rawKey The resulting raw key bytes. The space for this must
be provided by the caller.
@param rawKeyLen The length of the raw key in bytes.
@discussion The algorithm chosen is determined by the algorithm parameter
and the size of the key being wrapped (ie aes128 for 128 bit
keys).
@result kCCBufferTooSmall indicates insufficent space in the rawKey buffer.
kCCParamError can result from bad values for the kek, rawKey, and
wrappedKey key pointers.
*/
int
CCSymmetricKeyUnwrap(CCWrappingAlgorithm algorithm,
const uint8_t *iv, const size_t ivLen,
const uint8_t *kek, size_t kekLen,
const uint8_t *wrappedKey, size_t wrappedKeyLen,
uint8_t *rawKey, size_t *rawKeyLen)
API_AVAILABLE(macos(10.7), ios(5.0));
/*!
@function CCSymmetricWrappedSize
@abstract Determine the buffer size required to hold a key wrapped with
CCAESKeyWrap().
@param algorithm Currently only AES Keywrapping (rfc3394) is
available via kCCWRAPAES
@param rawKeyLen The length of the key in bytes.
@result The length of the resulting wrapped key.
*/
size_t
CCSymmetricWrappedSize(CCWrappingAlgorithm algorithm, size_t rawKeyLen)
API_AVAILABLE(macos(10.7), ios(5.0));
/*!
@function CCSymmetricUnwrappedSize
@abstract Determine the buffer size required to hold a key unwrapped with
CCAESKeyUnwrap().
@param algorithm Currently only AES Keywrapping (rfc3394) is
available via kCCWRAPAES
@param wrappedKeyLen The length of the wrapped key in bytes.
@result The length of the resulting raw key.
*/
size_t
CCSymmetricUnwrappedSize(CCWrappingAlgorithm algorithm, size_t wrappedKeyLen)
API_AVAILABLE(macos(10.7), ios(5.0));
#ifdef __cplusplus
}
#endif
#endif /* _CC_SYMKEYWRAP_H_ */
|
