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
|
#ifndef __GNUTLS_PKCS11_H
#define __GNUTLS_PKCS11_H
/**
* @addtogroup gnutls_pkcs11 GnuTLS PKCS#11 interface.
*
* @{
*/
/**
* @file gnutls-pkcs11.h
* @brief gnutls-pkcs11 interface.
* @author Alon Bar-Lev <alon.barlev@gmail.com>
* @see @ref gnutls_pkcs11
*/
#include <stdarg.h>
#include <gnutls/gnutls.h>
#include <gnutls/x509.h>
#define GNUTLS_PKCS11_MAX_PIN_LEN 32
/**
* @brief Token prompt callback.
* @param global_data Callback data.
* @param label Token label.
* @param retry Retry counter.
* @return none zero on success.
*/
typedef int (*gnutls_pkcs11_token_callback_t)(
void * const global_data,
const char * const label,
const unsigned retry
);
/* flags */
#define GNUTLS_PKCS11_PIN_FINAL_TRY 1
#define GNUTLS_PKCS11_PIN_COUNT_LOW 2
/* Callback for PKCS#11 PIN entry. The callback provides the PIN code
* to unlock the token with label 'token_label' in the slot described
* by 'slot_descr'.
*
* The PIN code, as a NUL-terminated ASCII string, should be copied
* into the 'pin' buffer (of fixed length NE_SSL_P11PINLEN), and
* return 0 to indicate success. Alternatively, the callback may
* return -1 to indicate failure and cancel PIN entry (in which case,
* the contents of the 'pin' parameter are ignored).
*
* When a PIN is required, the callback will be invoked repeatedly
* (and indefinitely) until either the returned PIN code is correct,
* the callback returns failure, or the token refuses login (e.g. when
* the token is locked due to too many incorrect PINs!). For the
* first such invocation, the 'attempt' counter will have value zero;
* it will increase by one for each subsequent attempt.
*
* The NE_SSL_P11PIN_COUNT_LOW and/or NE_SSL_P11PIN_FINAL_TRY hints
* may be set in the 'flags' argument, if these hints are made
* available by the token; not all tokens expose these hints. */
typedef int (*gnutls_pkcs11_pin_callback_t)(void *userdata, int attempt,
const char *slot_descr,
const char *token_label,
unsigned int flags,
char *pin, size_t pin_max);
/**
* @brief PKCS#11 certificate reference.
*/
struct gnutls_pkcs11_crt_st;
typedef struct gnutls_pkcs11_crt_st* gnutls_pkcs11_crt_t;
#define GNUTLS_PKCS11_FLAG_MANUAL 0 /* Manual loading of libraries */
#define GNUTLS_PKCS11_FLAG_AUTO 1 /* Automatically load libraries by reading /etc/gnutls/pkcs11.conf */
/* pkcs11.conf format:
* load = /lib/xxx-pkcs11.so
* load = /lib/yyy-pkcs11.so
*/
/**
* @brief Initialize gnutls-pkcs11.
* @param params Misc values to use.
* @return gnutls status.
* @note gnutls-pkcs11 must be uninitialize.
* @see gnutls_pkcs11_deinit()
* @todo params is not implemented yet.
*
* params is in the format of:
* name=value;name=value;
*/
int gnutls_pkcs11_init (unsigned int flags, const char* configfile);
/**
* @brief Deinitialize gnutls-pkcs11.
* @return gnutls status.
*/
void gnutls_pkcs11_deinit (void);
/**
* @brief Set token prompt callback.
* @param callback Callback to use.
* @param data Data to use when calling callback.
* @return gnutls status.
*/
//int gnutls_pkcs11_set_token_function (const gnutls_pkcs11_token_callback_t callback, void * const data);
/**
* @brief Set PIN prompt callback.
* @param callback Callback to use.
* @param data Data to use when calling callback.
* @return gnutls status.
*/
void gnutls_pkcs11_set_pin_function (gnutls_pkcs11_pin_callback_t callback, void * const data);
/**
* @brief Add PKCS#11 provider.
* @param name Library to load.
* @param params Misc provider parameters.
* @return gnutls status.
* @todo params is not implemented yet.
*
* params is in the format of:
* name=value;name=value;
*/
int gnutls_pkcs11_add_provider (const char * name, const char * params);
/**
* @brief Free certificate reference.
* @param certificate Certificate reference to free.
* @return gnutls stauts.
*/
int gnutls_pkcs11_crt_init ( gnutls_pkcs11_crt_t *certificate);
/**
* @brief Deserialize a certificate reference.
* @param serialized Serialized certificate.
* @param p_certificate Certificate reference.
* @return gnutls status.
*/
int gnutls_pkcs11_crt_import_url (gnutls_pkcs11_crt_t p_certificate, const char * url);
/**
* @brief Serialize a certificate reference.
* @param certificate Certificate reference to serialize.
* @param serialized Serialize result (string). Use gnutls_free() to free it.
* @return gnutls status.
*/
int gnutls_pkcs11_crt_export_url (gnutls_pkcs11_crt_t certificate, char** url);
/**
* @brief Free certificate reference.
* @param certificate Certificate reference to free.
* @return gnutls stauts.
*/
void gnutls_pkcs11_crt_deinit ( gnutls_pkcs11_crt_t certificate);
/**
* @brief Release array of certificate references.
* @param certificates Array to free.
* @param ncertificates Array size.
* @return gnutls status.
*/
int gnutls_pkcs11_crt_list_deinit (gnutls_pkcs11_crt_t * certificates, const unsigned int ncertificates);
typedef enum {
GNUTLS_PKCS11_CRT_ID_HEX=1,
GNUTLS_PKCS11_CRT_LABEL,
GNUTLS_PKCS11_CRT_TOKEN_LABEL,
GNUTLS_PKCS11_CRT_TOKEN_SERIAL,
GNUTLS_PKCS11_CRT_TOKEN_MANUFACTURER,
GNUTLS_PKCS11_CRT_TOKEN_MODEL,
} gnutls_pkcs11_cert_info_t;
int gnutls_pkcs11_crt_get_info(gnutls_pkcs11_crt_t crt, gnutls_pkcs11_cert_info_t itype, void* output, size_t* output_size);
typedef enum {
GNUTLS_PKCS11_CRT_ATTR_ALL=1,
GNUTLS_PKCS11_CRT_ATTR_TRUSTED, /* marked as trusted */
GNUTLS_PKCS11_CRT_ATTR_WITH_PK, /* with corresponding private key */
} gnutls_pkcs11_crt_attr_t;
/* token info */
typedef enum {
GNUTLS_PKCS11_TOKEN_LABEL,
GNUTLS_PKCS11_TOKEN_SERIAL,
GNUTLS_PKCS11_TOKEN_MANUFACTURER,
GNUTLS_PKCS11_TOKEN_MODEL,
} gnutls_pkcs11_token_info_t;
int gnutls_pkcs11_token_get_url (unsigned int seq, char** url);
int gnutls_pkcs11_token_get_info(const char* url, gnutls_pkcs11_token_info_t, void* output, size_t *output_size);
/**
* @brief Enumerate available certificates.
* @param p_list Location to store the list.
* @param n_list Location to store end list length.
* @param url Enumerate only certificates found in token(s) pointed by url
* @param attributes Only export certificates that match this attribute
* @return gnutls status.
* @note the p_list is should not be initialized.
*/
int gnutls_pkcs11_crt_list_import_url (gnutls_pkcs11_crt_t * p_list, unsigned int *const n_list, const char* url, gnutls_pkcs11_crt_attr_t flags);
int gnutls_x509_crt_import_pkcs11( gnutls_x509_crt_t crt, gnutls_pkcs11_crt_t pkcs11_crt);
int gnutls_x509_crt_import_pkcs11_url( gnutls_x509_crt_t crt, const char* url);
/**
* @brief Return the type of the certificate
* @param certificate Certificate reference.
* @return gnutls status.
*/
gnutls_certificate_type_t gnutls_pkcs11_crt_get_type (gnutls_pkcs11_crt_t certificate);
int gnutls_x509_crt_list_import_pkcs11 (gnutls_x509_crt_t * certs,
unsigned int cert_max,
gnutls_pkcs11_crt_t * const pkcs11_certs,
unsigned int flags);
/* XXX: private key functions...*/
/**
* @brief Setup session to be used with gnutls-pkcs11.
* @param session Session to setup.
* @param certificate Certificate to use in this session.
* @return gnutls status.
* @see gnutls_pkcs11_cleanup_session()
* @note Resources must be released using @ref gnutls_pkcs11_cleanup_session().
*/
//int gnutls_pkcs11_setup_session (gnutls_session session, gnutls_pkcs11_crt_t certificate);
/**
* @brief Cleanup session.
* @param session Session to cleanup.
* @return gnutls status.
*/
//int gnutls_pkcs11_cleanup_session (gnutls_session session);
/** @} */
#endif
|
