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
|
/* Copyright (C) 2022 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 <https://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.
*
* PKCS #11 provides access Hardware Security Modules.
*
* @{
*/
#pragma once
#include <libdnssec/binary.h>
#include <libdnssec/key.h>
struct dnssec_keystore;
/*!
* DNSSEC private keys store.
*/
typedef struct dnssec_keystore dnssec_keystore_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(dnssec_keystore_t **store);
/*!
* 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);
/*!
* 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[in] label Optional key label for PKCS #11.
* \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(dnssec_keystore_t *store,
dnssec_key_algorithm_t algorithm,
unsigned bits, const char *label, 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(dnssec_keystore_t *store, const char *id);
/*!
* Export private key from the key store into a DNSSEC key.
*
* The key algorithm has to be set before calling this function.
*
* \param store Private key store.
* \param id ID of the key.
* \param key DNSSEC key to be initialized.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_get_private(dnssec_keystore_t *store, const char *id,
dnssec_key_t *key);
/*!
* Import a DNSSEC private key into key store.
*
* \param store Key store.
* \param key DNSSEC key with a private key.
*
* \return Error code, DNSSEC_EOK if successful.
*/
int dnssec_keystore_set_private(dnssec_keystore_t *store, dnssec_key_t *key);
/*! @} */
|
