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
|
/*
* Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
*/
/* crypto/engine/hw_pk11.h */
/*
* This product includes software developed by the OpenSSL Project for
* use in the OpenSSL Toolkit (http://www.openssl.org/).
*
* This project also referenced hw_pkcs11-0.9.7b.patch written by
* Afchine Madjlessi.
*/
/*
* ====================================================================
* Copyright (c) 2000-2001 The OpenSSL Project. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. All advertising materials mentioning features or use of this
* software must display the following acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
*
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please contact
* licensing@OpenSSL.org.
*
* 5. Products derived from this software may not be called "OpenSSL"
* nor may "OpenSSL" appear in their names without prior written
* permission of the OpenSSL Project.
*
* 6. Redistributions of any form whatsoever must retain the following
* acknowledgment:
* "This product includes software developed by the OpenSSL Project
* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
*
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This product includes cryptographic software written by Eric Young
* (eay@cryptsoft.com). This product includes software written by Tim
* Hudson (tjh@cryptsoft.com).
*
*/
#ifndef HW_PK11_H
#define HW_PK11_H
#include "hw_pk11_err.h"
#ifdef __cplusplus
extern "C" {
#endif
/* max byte length of a symmetric key we support */
#define PK11_KEY_LEN_MAX 32
/*
* This structure encapsulates all reusable information for a PKCS#11
* session. A list of these objects is created on behalf of the
* calling application using an on-demand method. Each operation
* type (see PK11_OPTYPE below) has its own per-process list.
* Each of the lists is basically a cache for faster PKCS#11 object
* access to avoid expensive C_Find{,Init,Final}Object() calls.
*
* When a new request comes in, an object will be taken from the list
* (if there is one) or a new one is created to handle the request
* (if the list is empty). See pk11_get_session() on how it is done.
*/
typedef struct PK11_st_SESSION
{
struct PK11_st_SESSION *next;
CK_SESSION_HANDLE session; /* PK11 session handle */
pid_t pid; /* Current process ID */
CK_BBOOL persistent; /* is that a keystore object? */
union
{
#ifndef OPENSSL_NO_RSA
struct
{
CK_OBJECT_HANDLE rsa_pub_key; /* pub handle */
CK_OBJECT_HANDLE rsa_priv_key; /* priv handle */
RSA *rsa_pub; /* pub key addr */
BIGNUM *rsa_n_num; /* pub modulus */
BIGNUM *rsa_e_num; /* pub exponent */
RSA *rsa_priv; /* priv key addr */
BIGNUM *rsa_d_num; /* priv exponent */
} u_RSA;
#endif /* OPENSSL_NO_RSA */
#ifndef OPENSSL_NO_DSA
struct
{
CK_OBJECT_HANDLE dsa_pub_key; /* pub handle */
CK_OBJECT_HANDLE dsa_priv_key; /* priv handle */
DSA *dsa_pub; /* pub key addr */
BIGNUM *dsa_pub_num; /* pub key */
DSA *dsa_priv; /* priv key addr */
BIGNUM *dsa_priv_num; /* priv key */
} u_DSA;
#endif /* OPENSSL_NO_DSA */
#ifndef OPENSSL_NO_DH
struct
{
CK_OBJECT_HANDLE dh_key; /* key handle */
DH *dh; /* dh key addr */
BIGNUM *dh_priv_num; /* priv dh key */
} u_DH;
#endif /* OPENSSL_NO_DH */
struct
{
CK_OBJECT_HANDLE cipher_key; /* key handle */
unsigned char key[PK11_KEY_LEN_MAX];
int key_len; /* priv key len */
int encrypt; /* 1/0 enc/decr */
} u_cipher;
} opdata_u;
} PK11_SESSION;
#define opdata_rsa_pub_key opdata_u.u_RSA.rsa_pub_key
#define opdata_rsa_priv_key opdata_u.u_RSA.rsa_priv_key
#define opdata_rsa_pub opdata_u.u_RSA.rsa_pub
#define opdata_rsa_priv opdata_u.u_RSA.rsa_priv
#define opdata_rsa_n_num opdata_u.u_RSA.rsa_n_num
#define opdata_rsa_e_num opdata_u.u_RSA.rsa_e_num
#define opdata_rsa_d_num opdata_u.u_RSA.rsa_d_num
#define opdata_dsa_pub_key opdata_u.u_DSA.dsa_pub_key
#define opdata_dsa_priv_key opdata_u.u_DSA.dsa_priv_key
#define opdata_dsa_pub opdata_u.u_DSA.dsa_pub
#define opdata_dsa_pub_num opdata_u.u_DSA.dsa_pub_num
#define opdata_dsa_priv opdata_u.u_DSA.dsa_priv
#define opdata_dsa_priv_num opdata_u.u_DSA.dsa_priv_num
#define opdata_dh_key opdata_u.u_DH.dh_key
#define opdata_dh opdata_u.u_DH.dh
#define opdata_dh_priv_num opdata_u.u_DH.dh_priv_num
#define opdata_cipher_key opdata_u.u_cipher.cipher_key
#define opdata_key opdata_u.u_cipher.key
#define opdata_key_len opdata_u.u_cipher.key_len
#define opdata_encrypt opdata_u.u_cipher.encrypt
/*
* We have 3 different groups of operation types:
* 1) asymmetric operations
* 2) random operations
* 3) symmetric and digest operations
*
* This division into groups stems from the fact that it's common that hardware
* providers may support operations from one group only. For example, hardware
* providers on UltraSPARC T2, n2rng(7d), ncp(7d), and n2cp(7d), each support
* only a single group of operations.
*
* For every group a different slot can be chosen. That means that we must have
* at least 3 different lists of cached PKCS#11 sessions since sessions from
* different groups may be initialized in different slots.
*
* To provide locking granularity in multithreaded environment, the groups are
* further split into types with each type having a separate session cache.
*/
typedef enum PK11_OPTYPE_ENUM
{
OP_RAND,
OP_RSA,
OP_DSA,
OP_DH,
OP_CIPHER,
OP_DIGEST,
OP_MAX
} PK11_OPTYPE;
/*
* This structure contains the heads of the lists forming the object caches
* and locks associated with the lists.
*/
typedef struct PK11_st_CACHE
{
PK11_SESSION *head;
pthread_mutex_t *lock;
} PK11_CACHE;
/* structure for tracking handles of asymmetric key objects */
typedef struct PK11_active_st
{
CK_OBJECT_HANDLE h;
unsigned int refcnt;
struct PK11_active_st *prev;
struct PK11_active_st *next;
} PK11_active;
extern pthread_mutex_t *find_lock[];
extern PK11_active *active_list[];
/*
* These variables are specific for the RSA keys by reference code. See
* hw_pk11_pub.c for explanation.
*/
extern char *passphrasedialog;
extern CK_FLAGS pubkey_token_flags;
#define LOCK_OBJSTORE(alg_type) \
(void) pthread_mutex_lock(find_lock[alg_type])
#define UNLOCK_OBJSTORE(alg_type) \
(void) pthread_mutex_unlock(find_lock[alg_type])
extern PK11_SESSION *pk11_get_session(PK11_OPTYPE optype);
extern void pk11_return_session(PK11_SESSION *sp, PK11_OPTYPE optype);
#ifndef OPENSSL_NO_RSA
extern int pk11_destroy_rsa_key_objects(PK11_SESSION *session);
extern int pk11_destroy_rsa_object_pub(PK11_SESSION *sp, CK_BBOOL uselock);
extern int pk11_destroy_rsa_object_priv(PK11_SESSION *sp, CK_BBOOL uselock);
extern EVP_PKEY *pk11_load_privkey(ENGINE *e, const char *pubkey_file,
UI_METHOD *ui_method, void *callback_data);
extern EVP_PKEY *pk11_load_pubkey(ENGINE *e, const char *pubkey_file,
UI_METHOD *ui_method, void *callback_data);
extern RSA_METHOD *PK11_RSA(void);
#endif /* OPENSSL_NO_RSA */
#ifndef OPENSSL_NO_DSA
extern int pk11_destroy_dsa_key_objects(PK11_SESSION *session);
extern int pk11_destroy_dsa_object_pub(PK11_SESSION *sp, CK_BBOOL uselock);
extern int pk11_destroy_dsa_object_priv(PK11_SESSION *sp, CK_BBOOL uselock);
extern DSA_METHOD *PK11_DSA(void);
#endif /* OPENSSL_NO_DSA */
#ifndef OPENSSL_NO_DH
extern int pk11_destroy_dh_key_objects(PK11_SESSION *session);
extern int pk11_destroy_dh_object(PK11_SESSION *sp, CK_BBOOL uselock);
extern DH_METHOD *PK11_DH(void);
#endif /* OPENSSL_NO_DH */
extern int pk11_engine_pkey_methods(ENGINE *e, EVP_PKEY_METHOD **pmeth,
const int **nids, int nid);
extern CK_FUNCTION_LIST_PTR pFuncList;
#ifdef __cplusplus
}
#endif
#endif /* HW_PK11_H */
|
