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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
/* Copyright (C) 2018 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file
*
* \addtogroup keystore
*
* \brief Private key store access.
*
* The module provides abstraction for private key store. Basically, PKCS #8
* and PKCS #11 interfaces are supported.
*
* PKCS #8 uses unencrypted PEM, and allows implementation of custom stores.
*
* PKCS #11 provides access Hardware Security Modules.
*
* Example of using default PKCS #8 and to generate an RSA key:
*
* ~~~~~ {.c}
*
* int result;
* dnssec_keystore_t *store = NULL;
*
* // create key store access context
* dnssec_keystore_init_pkcs8_dir(&store);
*
* // open the key store
* result = dnssec_keystore_open(&store, "/path/to/keydb");
* if (result != DNSSEC_EOK) {
* return result;
* }
*
* // generate new private key in the key store
* int algorithm = DNSSEC_KEY_ALGORITHM_RSA_SHA256;
* unsigned bits = 2048;
* char *id = NULL;
* int dnssec_keystore_generate_key(store, algorithm, bits, &key_id);
* if (result != DNSSEC_EOK) {
* dnssec_keystore_close(store);
* return result;
* }
* printf("ID of the new key: %s\n", key_id);
*
* // create new signing key
* dnssec_key_t *key = NULL;
* result = dnssec_key_new(&key);
* if (result != DNSSEC_EOK) {
* free(key_id);
* dnssec_keystore_close(store);
* return result;
* }
*
* // import the key from the key store
* result = dnssec_key_import_keystore(key, store, key_id, algorithm);
* if (result != DNSSEC_EOK) {
* free(key_id);
* dnssec_key_free(key);
* dnssec_keystore_close(store);
* return result;
* }
*
* // use the key for signing ...
*
* // cleanup
* free(key_id);
* dnssec_key_free(key);
* dnssec_keystore_close(store);
* dnssec_keystore_deinit(store);
*
* ~~~~~
* @{
*/
#pragma once
#include <libdnssec/binary.h>
#include <libdnssec/key.h>
#include <libdnssec/list.h>
struct dnssec_keystore;
/*!
* DNSSEC private keys store.
*/
typedef struct dnssec_keystore dnssec_keystore_t;
/*!
* PKCS #8 key store callback functions for custom providers.
*/
typedef struct dnssec_keystore_pkcs8_functions {
/*!
* Callback to allocate key store handle.
*
* \param[out] handle_ptr Allocated key store handle.
*/
int (*handle_new)(void **handle_ptr);
/*!
* Callback to deallocate key store handle.
*
* \param handle Key store handle.
*/
int (*handle_free)(void *handle);
/*!
* Callback to initialize the key store.
*
* \param handle Key store handle.
* \param config Configuration string.
*/
int (*init)(void *handle, const char *config);
/*!
* Callback to open the key store.
*
* \param[out] handle Key store handle.
* \param[in] config Configuration string.
*/
int (*open)(void *handle, const char *config);
/*!
* Callback to close the key store.
*
* \param handle Key store handle.
*/
int (*close)(void *handle);
/*!
* Callback to read a PEM key.
*
* \param[in] handle Key store handle.
* \param[in] id Key ID of the key to be retrieved (ASCII form).
* \param[out] pem Key material in uncencrypted PEM format.
*/
int (*read)(void *handle, const char *id, dnssec_binary_t *pem);
/*!
* Callback to write a PEM key.
*
* \param handle Key store handle.
* \param id Key ID of the key to be saved (ASCII form).
* \param pem Key material in unencrypted PEM format.
*/
int (*write)(void *handle, const char *id, const dnssec_binary_t *pem);
/*!
* Callback to get a list of all PEM key IDs.
*
* \param[in] handle Key store handle.
* \param[out] list Allocated list of key IDs.
*/
int (*list)(void *handle, dnssec_list_t **list);
/*!
* Callback to remove a PEM key.
*
* \param handle Key store handle.
* \param id Key ID of the key to be removed (ASCII form).
*/
int (*remove)(void *handle, const char *id);
} dnssec_keystore_pkcs8_functions_t;
/*!
* Create default PKCS #8 private key store context.
*
* The default store maintains the private keys in one directory on the file
* system. The private keys are stored in unencrypted PEM format, named
* key-id.pem. The configuration string is a path to the directory.
*
* \param[out] store Opened key store.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_init_pkcs8_dir(dnssec_keystore_t **store);
/*!
* Create custom PKCS #8 private key store context.
*
* \param[out] store Opened key store.
* \param[in] impl Implementation of the key store provider.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_init_pkcs8_custom(dnssec_keystore_t **store,
const dnssec_keystore_pkcs8_functions_t *impl);
/*!
* Crate new PKCS #11 private key store context.
*
* \param[out] store Opened key store.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_init_pkcs11(dnssec_keystore_t **store);
/*!
* Deinitialize private key store context.
*
* \param store Key store to be deinitialized.
*/
int dnssec_keystore_deinit(dnssec_keystore_t *store);
/*!
* Initialize new private key store.
*/
int dnssec_keystore_init(dnssec_keystore_t *store, const char *config);
/*!
* Open private key store.
*/
int dnssec_keystore_open(dnssec_keystore_t *store, const char *config);
/*!
* Close private key store.
*
* \param store Key store to be closed.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_close(dnssec_keystore_t *store);
/*!
* Get a list of key IDs stored in the key store.
*
* \todo Not implemented.
*
* \param[in] store Key store.
* \param[out] list Resulting list of key IDs.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_list_keys(dnssec_keystore_t *store, dnssec_list_t **list);
/*!
* Generate a new key in the key store.
*
* \param[in] store Key store.
* \param[in] algorithm Algorithm.
* \param[in] bits Bit length of the key to be generated.
* \param[out] id_ptr ID of the generated key. Must be freed by the caller.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_generate_key(dnssec_keystore_t *store,
dnssec_key_algorithm_t algorithm,
unsigned bits, char **id_ptr);
/*!
* Import an existing key into the key store.
*
* \param[in] store Key store.
* \param[in] pem Private key material in PEM format.
* \param[out] id_ptr ID of the imported key. Must be freed by the caller.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_import(dnssec_keystore_t *store, const dnssec_binary_t *pem,
char **id_ptr);
/*!
* Remove a private key from the key store.
*
* \param store Key store.
* \param id ID of the private key to be deleted.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_remove_key(dnssec_keystore_t *store, const char *id);
/*!
* Import public and/or private key from the key store into a DNSSEC key.
*
* The key algorithm has to be set before calling this function.
*
* \param key DNSSEC key to be initialized.
* \param keystore Private key store.
* \param id ID of the key.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_key_import_keystore(dnssec_key_t *key, dnssec_keystore_t *keystore,
const char *id);
/*! @} */
|
