2 * Written by Corinne Dive-Reclus(cdive@baltimore.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * 3. All advertising materials mentioning features or use of this
18 * software must display the following acknowledgment:
19 * "This product includes software developed by the OpenSSL Project
20 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 * endorse or promote products derived from this software without
24 * prior written permission. For written permission, please contact
25 * licensing@OpenSSL.org.
27 * 5. Products derived from this software may not be called "OpenSSL"
28 * nor may "OpenSSL" appear in their names without prior written
29 * permission of the OpenSSL Project.
31 * 6. Redistributions of any form whatsoever must retain the following
33 * "This product includes software developed by the OpenSSL Project
34 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
36 * Written by Corinne Dive-Reclus(cdive@baltimore.com)
38 * Copyright@2001 Baltimore Technologies Ltd.
41 * THIS FILE IS PROVIDED BY BALTIMORE TECHNOLOGIES ``AS IS'' AND *
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE *
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE *
44 * ARE DISCLAIMED. IN NO EVENT SHALL BALTIMORE TECHNOLOGIES BE LIABLE *
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL *
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS *
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) *
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT *
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY *
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF *
52 ====================================================================*/
56 #include <openssl/crypto.h>
57 #include <openssl/pem.h>
58 #include <openssl/dso.h>
59 #include <openssl/engine.h>
60 #include <openssl/rand.h>
61 #ifndef OPENSSL_NO_RSA
62 #include <openssl/rsa.h>
64 #ifndef OPENSSL_NO_DSA
65 #include <openssl/dsa.h>
68 #include <openssl/dh.h>
70 #include <openssl/bn.h>
73 #ifndef OPENSSL_NO_HW_SUREWARE
78 #include "vendor_defns/sureware.h"
81 #define SUREWARE_LIB_NAME "sureware engine"
82 #include "e_sureware_err.c"
84 static int surewarehk_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
)(void));
85 static int surewarehk_destroy(ENGINE
*e
);
86 static int surewarehk_init(ENGINE
*e
);
87 static int surewarehk_finish(ENGINE
*e
);
88 static int surewarehk_modexp(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
89 const BIGNUM
*m
, BN_CTX
*ctx
);
92 #ifndef OPENSSL_NO_RSA
93 static int surewarehk_rsa_priv_dec(int flen
,const unsigned char *from
,unsigned char *to
,
94 RSA
*rsa
,int padding
);
95 static int surewarehk_rsa_sign(int flen
,const unsigned char *from
,unsigned char *to
,
96 RSA
*rsa
,int padding
);
100 static int surewarehk_rand_bytes(unsigned char *buf
, int num
);
101 static void surewarehk_rand_seed(const void *buf
, int num
);
102 static void surewarehk_rand_add(const void *buf
, int num
, double entropy
);
105 static EVP_PKEY
*surewarehk_load_privkey(ENGINE
*e
, const char *key_id
,
106 UI_METHOD
*ui_method
, void *callback_data
);
107 static EVP_PKEY
*surewarehk_load_pubkey(ENGINE
*e
, const char *key_id
,
108 UI_METHOD
*ui_method
, void *callback_data
);
109 static void surewarehk_ex_free(void *obj
, void *item
, CRYPTO_EX_DATA
*ad
,
110 int idx
,long argl
, void *argp
);
112 static void surewarehk_dh_ex_free(void *obj
, void *item
, CRYPTO_EX_DATA
*ad
,
113 int idx
,long argl
, void *argp
);
116 #ifndef OPENSSL_NO_RSA
117 /* This function is aliased to mod_exp (with the mont stuff dropped). */
118 static int surewarehk_mod_exp_mont(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
119 const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
121 return surewarehk_modexp(r
, a
, p
, m
, ctx
);
124 /* Our internal RSA_METHOD that we provide pointers to */
125 static RSA_METHOD surewarehk_rsa
=
127 "SureWare RSA method",
130 surewarehk_rsa_sign
, /* our rsa_sign is OpenSSL priv_enc*/
131 surewarehk_rsa_priv_dec
, /* priv_dec*/
133 surewarehk_mod_exp_mont
, /*mod_exp_mongomery*/
138 NULL
, /* OpenSSL sign*/
139 NULL
, /* OpenSSL verify*/
144 #ifndef OPENSSL_NO_DH
145 /* Our internal DH_METHOD that we provide pointers to */
146 /* This function is aliased to mod_exp (with the dh and mont dropped). */
147 static int surewarehk_modexp_dh(const DH
*dh
, BIGNUM
*r
, const BIGNUM
*a
,
148 const BIGNUM
*p
, const BIGNUM
*m
, BN_CTX
*ctx
, BN_MONT_CTX
*m_ctx
)
150 return surewarehk_modexp(r
, a
, p
, m
, ctx
);
153 static DH_METHOD surewarehk_dh
=
155 "SureWare DH method",
158 surewarehk_modexp_dh
, /*dh mod exp*/
167 static RAND_METHOD surewarehk_rand
=
169 /* "SureWare RAND method", */
170 surewarehk_rand_seed
,
171 surewarehk_rand_bytes
,
174 surewarehk_rand_bytes
,
178 #ifndef OPENSSL_NO_DSA
180 static DSA_SIG
* surewarehk_dsa_do_sign(const unsigned char *dgst
, int dlen
, DSA
*dsa
);
181 static int surewarehk_dsa_mod_exp(DSA
*dsa
, BIGNUM
*rr
, BIGNUM
*a1
,
182 BIGNUM
*p1
, BIGNUM
*a2
, BIGNUM
*p2
, BIGNUM
*m
,
183 BN_CTX
*ctx
, BN_MONT_CTX
*in_mont
)
188 /* let rr = a1 ^ p1 mod m */
189 if (!surewarehk_modexp(rr
,a1
,p1
,m
,ctx
)) goto end
;
190 /* let t = a2 ^ p2 mod m */
191 if (!surewarehk_modexp(&t
,a2
,p2
,m
,ctx
)) goto end
;
192 /* let rr = rr * t mod m */
193 if (!BN_mod_mul(rr
,rr
,&t
,m
,ctx
)) goto end
;
200 static DSA_METHOD surewarehk_dsa
=
202 "SureWare DSA method",
203 surewarehk_dsa_do_sign
,
206 surewarehk_dsa_mod_exp
,/*mod exp*/
217 static const char *engine_sureware_id
= "sureware";
218 static const char *engine_sureware_name
= "SureWare hardware engine support";
220 /* Now, to our own code */
222 /* As this is only ever called once, there's no need for locking
223 * (indeed - the lock will already be held by our caller!!!) */
224 static int bind_sureware(ENGINE
*e
)
226 #ifndef OPENSSL_NO_RSA
227 const RSA_METHOD
*meth1
;
229 #ifndef OPENSSL_NO_DSA
230 const DSA_METHOD
*meth2
;
232 #ifndef OPENSSL_NO_DH
233 const DH_METHOD
*meth3
;
236 if(!ENGINE_set_id(e
, engine_sureware_id
) ||
237 !ENGINE_set_name(e
, engine_sureware_name
) ||
238 #ifndef OPENSSL_NO_RSA
239 !ENGINE_set_RSA(e
, &surewarehk_rsa
) ||
241 #ifndef OPENSSL_NO_DSA
242 !ENGINE_set_DSA(e
, &surewarehk_dsa
) ||
244 #ifndef OPENSSL_NO_DH
245 !ENGINE_set_DH(e
, &surewarehk_dh
) ||
247 !ENGINE_set_RAND(e
, &surewarehk_rand
) ||
248 !ENGINE_set_destroy_function(e
, surewarehk_destroy
) ||
249 !ENGINE_set_init_function(e
, surewarehk_init
) ||
250 !ENGINE_set_finish_function(e
, surewarehk_finish
) ||
251 !ENGINE_set_ctrl_function(e
, surewarehk_ctrl
) ||
252 !ENGINE_set_load_privkey_function(e
, surewarehk_load_privkey
) ||
253 !ENGINE_set_load_pubkey_function(e
, surewarehk_load_pubkey
))
256 #ifndef OPENSSL_NO_RSA
257 /* We know that the "PKCS1_SSLeay()" functions hook properly
258 * to the cswift-specific mod_exp and mod_exp_crt so we use
259 * those functions. NB: We don't use ENGINE_openssl() or
260 * anything "more generic" because something like the RSAref
261 * code may not hook properly, and if you own one of these
262 * cards then you have the right to do RSA operations on it
264 meth1
= RSA_PKCS1_SSLeay();
267 surewarehk_rsa
.rsa_pub_enc
= meth1
->rsa_pub_enc
;
268 surewarehk_rsa
.rsa_pub_dec
= meth1
->rsa_pub_dec
;
272 #ifndef OPENSSL_NO_DSA
273 /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
275 meth2
= DSA_OpenSSL();
278 surewarehk_dsa
.dsa_do_verify
= meth2
->dsa_do_verify
;
282 #ifndef OPENSSL_NO_DH
283 /* Much the same for Diffie-Hellman */
284 meth3
= DH_OpenSSL();
287 surewarehk_dh
.generate_key
= meth3
->generate_key
;
288 surewarehk_dh
.compute_key
= meth3
->compute_key
;
292 /* Ensure the sureware error handling is set up */
293 ERR_load_SUREWARE_strings();
297 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
298 static int bind_helper(ENGINE
*e
, const char *id
)
300 if(id
&& (strcmp(id
, engine_sureware_id
) != 0))
302 if(!bind_sureware(e
))
306 IMPLEMENT_DYNAMIC_CHECK_FN()
307 IMPLEMENT_DYNAMIC_BIND_FN(bind_helper
)
309 static ENGINE
*engine_sureware(void)
311 ENGINE
*ret
= ENGINE_new();
314 if(!bind_sureware(ret
))
322 void ENGINE_load_sureware(void)
324 /* Copied from eng_[openssl|dyn].c */
325 ENGINE
*toadd
= engine_sureware();
333 /* This is a process-global DSO handle used for loading and unloading
334 * the SureWareHook library. NB: This is only set (or unset) during an
335 * init() or finish() call (reference counts permitting) and they're
336 * operating with global locks, so this should be thread-safe
338 static DSO
*surewarehk_dso
= NULL
;
339 #ifndef OPENSSL_NO_RSA
340 static int rsaHndidx
= -1; /* Index for KM handle. Not really used yet. */
342 #ifndef OPENSSL_NO_DSA
343 static int dsaHndidx
= -1; /* Index for KM handle. Not really used yet. */
346 /* These are the function pointers that are (un)set when the library has
347 * successfully (un)loaded. */
348 static SureWareHook_Init_t
*p_surewarehk_Init
= NULL
;
349 static SureWareHook_Finish_t
*p_surewarehk_Finish
= NULL
;
350 static SureWareHook_Rand_Bytes_t
*p_surewarehk_Rand_Bytes
= NULL
;
351 static SureWareHook_Rand_Seed_t
*p_surewarehk_Rand_Seed
= NULL
;
352 static SureWareHook_Load_Privkey_t
*p_surewarehk_Load_Privkey
= NULL
;
353 static SureWareHook_Info_Pubkey_t
*p_surewarehk_Info_Pubkey
= NULL
;
354 static SureWareHook_Load_Rsa_Pubkey_t
*p_surewarehk_Load_Rsa_Pubkey
= NULL
;
355 static SureWareHook_Load_Dsa_Pubkey_t
*p_surewarehk_Load_Dsa_Pubkey
= NULL
;
356 static SureWareHook_Free_t
*p_surewarehk_Free
=NULL
;
357 static SureWareHook_Rsa_Priv_Dec_t
*p_surewarehk_Rsa_Priv_Dec
=NULL
;
358 static SureWareHook_Rsa_Sign_t
*p_surewarehk_Rsa_Sign
=NULL
;
359 static SureWareHook_Dsa_Sign_t
*p_surewarehk_Dsa_Sign
=NULL
;
360 static SureWareHook_Mod_Exp_t
*p_surewarehk_Mod_Exp
=NULL
;
362 /* Used in the DSO operations. */
363 static const char *surewarehk_LIBNAME
= "SureWareHook";
364 static const char *n_surewarehk_Init
= "SureWareHook_Init";
365 static const char *n_surewarehk_Finish
= "SureWareHook_Finish";
366 static const char *n_surewarehk_Rand_Bytes
="SureWareHook_Rand_Bytes";
367 static const char *n_surewarehk_Rand_Seed
="SureWareHook_Rand_Seed";
368 static const char *n_surewarehk_Load_Privkey
="SureWareHook_Load_Privkey";
369 static const char *n_surewarehk_Info_Pubkey
="SureWareHook_Info_Pubkey";
370 static const char *n_surewarehk_Load_Rsa_Pubkey
="SureWareHook_Load_Rsa_Pubkey";
371 static const char *n_surewarehk_Load_Dsa_Pubkey
="SureWareHook_Load_Dsa_Pubkey";
372 static const char *n_surewarehk_Free
="SureWareHook_Free";
373 static const char *n_surewarehk_Rsa_Priv_Dec
="SureWareHook_Rsa_Priv_Dec";
374 static const char *n_surewarehk_Rsa_Sign
="SureWareHook_Rsa_Sign";
375 static const char *n_surewarehk_Dsa_Sign
="SureWareHook_Dsa_Sign";
376 static const char *n_surewarehk_Mod_Exp
="SureWareHook_Mod_Exp";
377 static BIO
*logstream
= NULL
;
379 /* SureWareHook library functions and mechanics - these are used by the
380 * higher-level functions further down. NB: As and where there's no
381 * error checking, take a look lower down where these functions are
382 * called, the checking and error handling is probably down there.
384 static int threadsafe
=1;
385 static int surewarehk_ctrl(ENGINE
*e
, int cmd
, long i
, void *p
, void (*f
)(void))
391 case ENGINE_CTRL_SET_LOGSTREAM
:
394 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
400 if (CRYPTO_add(&bio
->references
,1,CRYPTO_LOCK_BIO
) > 1)
403 SUREWAREerr(SUREWARE_F_SUREWAREHK_CTRL
,SUREWARE_R_BIO_WAS_FREED
);
405 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
407 /* This will prevent the initialisation function from "installing"
408 * the mutex-handling callbacks, even if they are available from
409 * within the library (or were provided to the library from the
410 * calling application). This is to remove any baggage for
411 * applications not using multithreading. */
412 case ENGINE_CTRL_CHIL_NO_LOCKING
:
413 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE
);
415 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE
);
418 /* The command isn't understood by this engine */
420 SUREWAREerr(SUREWARE_F_SUREWAREHK_CTRL
,
421 ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED
);
429 /* Destructor (complements the "ENGINE_surewarehk()" constructor) */
430 static int surewarehk_destroy(ENGINE
*e
)
432 ERR_unload_SUREWARE_strings();
436 /* (de)initialisation functions. */
437 static int surewarehk_init(ENGINE
*e
)
439 char msg
[64]="ENGINE_init";
440 SureWareHook_Init_t
*p1
=NULL
;
441 SureWareHook_Finish_t
*p2
=NULL
;
442 SureWareHook_Rand_Bytes_t
*p3
=NULL
;
443 SureWareHook_Rand_Seed_t
*p4
=NULL
;
444 SureWareHook_Load_Privkey_t
*p5
=NULL
;
445 SureWareHook_Load_Rsa_Pubkey_t
*p6
=NULL
;
446 SureWareHook_Free_t
*p7
=NULL
;
447 SureWareHook_Rsa_Priv_Dec_t
*p8
=NULL
;
448 SureWareHook_Rsa_Sign_t
*p9
=NULL
;
449 SureWareHook_Dsa_Sign_t
*p12
=NULL
;
450 SureWareHook_Info_Pubkey_t
*p13
=NULL
;
451 SureWareHook_Load_Dsa_Pubkey_t
*p14
=NULL
;
452 SureWareHook_Mod_Exp_t
*p15
=NULL
;
454 if(surewarehk_dso
!= NULL
)
456 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT
,ENGINE_R_ALREADY_LOADED
);
459 /* Attempt to load libsurewarehk.so/surewarehk.dll/whatever. */
460 surewarehk_dso
= DSO_load(NULL
, surewarehk_LIBNAME
, NULL
, 0);
461 if(surewarehk_dso
== NULL
)
463 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT
,ENGINE_R_DSO_FAILURE
);
466 if(!(p1
=(SureWareHook_Init_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Init
)) ||
467 !(p2
=(SureWareHook_Finish_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Finish
)) ||
468 !(p3
=(SureWareHook_Rand_Bytes_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Rand_Bytes
)) ||
469 !(p4
=(SureWareHook_Rand_Seed_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Rand_Seed
)) ||
470 !(p5
=(SureWareHook_Load_Privkey_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Load_Privkey
)) ||
471 !(p6
=(SureWareHook_Load_Rsa_Pubkey_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Load_Rsa_Pubkey
)) ||
472 !(p7
=(SureWareHook_Free_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Free
)) ||
473 !(p8
=(SureWareHook_Rsa_Priv_Dec_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Rsa_Priv_Dec
)) ||
474 !(p9
=(SureWareHook_Rsa_Sign_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Rsa_Sign
)) ||
475 !(p12
=(SureWareHook_Dsa_Sign_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Dsa_Sign
)) ||
476 !(p13
=(SureWareHook_Info_Pubkey_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Info_Pubkey
)) ||
477 !(p14
=(SureWareHook_Load_Dsa_Pubkey_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Load_Dsa_Pubkey
)) ||
478 !(p15
=(SureWareHook_Mod_Exp_t
*)DSO_bind_func(surewarehk_dso
, n_surewarehk_Mod_Exp
)))
480 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT
,ENGINE_R_DSO_FAILURE
);
483 /* Copy the pointers */
484 p_surewarehk_Init
= p1
;
485 p_surewarehk_Finish
= p2
;
486 p_surewarehk_Rand_Bytes
= p3
;
487 p_surewarehk_Rand_Seed
= p4
;
488 p_surewarehk_Load_Privkey
= p5
;
489 p_surewarehk_Load_Rsa_Pubkey
= p6
;
490 p_surewarehk_Free
= p7
;
491 p_surewarehk_Rsa_Priv_Dec
= p8
;
492 p_surewarehk_Rsa_Sign
= p9
;
493 p_surewarehk_Dsa_Sign
= p12
;
494 p_surewarehk_Info_Pubkey
= p13
;
495 p_surewarehk_Load_Dsa_Pubkey
= p14
;
496 p_surewarehk_Mod_Exp
= p15
;
497 /* Contact the hardware and initialises it. */
498 if(p_surewarehk_Init(msg
,threadsafe
)==SUREWAREHOOK_ERROR_UNIT_FAILURE
)
500 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT
,SUREWARE_R_UNIT_FAILURE
);
503 if(p_surewarehk_Init(msg
,threadsafe
)==SUREWAREHOOK_ERROR_UNIT_FAILURE
)
505 SUREWAREerr(SUREWARE_F_SUREWAREHK_INIT
,SUREWARE_R_UNIT_FAILURE
);
508 /* try to load the default private key, if failed does not return a failure but
509 wait for an explicit ENGINE_load_privakey */
510 surewarehk_load_privkey(e
,NULL
,NULL
,NULL
);
512 /* Everything's fine. */
513 #ifndef OPENSSL_NO_RSA
515 rsaHndidx
= RSA_get_ex_new_index(0,
516 "SureWareHook RSA key handle",
517 NULL
, NULL
, surewarehk_ex_free
);
519 #ifndef OPENSSL_NO_DSA
521 dsaHndidx
= DSA_get_ex_new_index(0,
522 "SureWareHook DSA key handle",
523 NULL
, NULL
, surewarehk_ex_free
);
529 DSO_free(surewarehk_dso
);
530 surewarehk_dso
= NULL
;
531 p_surewarehk_Init
= NULL
;
532 p_surewarehk_Finish
= NULL
;
533 p_surewarehk_Rand_Bytes
= NULL
;
534 p_surewarehk_Rand_Seed
= NULL
;
535 p_surewarehk_Load_Privkey
= NULL
;
536 p_surewarehk_Load_Rsa_Pubkey
= NULL
;
537 p_surewarehk_Free
= NULL
;
538 p_surewarehk_Rsa_Priv_Dec
= NULL
;
539 p_surewarehk_Rsa_Sign
= NULL
;
540 p_surewarehk_Dsa_Sign
= NULL
;
541 p_surewarehk_Info_Pubkey
= NULL
;
542 p_surewarehk_Load_Dsa_Pubkey
= NULL
;
543 p_surewarehk_Mod_Exp
= NULL
;
547 static int surewarehk_finish(ENGINE
*e
)
550 if(surewarehk_dso
== NULL
)
552 SUREWAREerr(SUREWARE_F_SUREWAREHK_FINISH
,ENGINE_R_NOT_LOADED
);
556 p_surewarehk_Finish();
557 if(!DSO_free(surewarehk_dso
))
559 SUREWAREerr(SUREWARE_F_SUREWAREHK_FINISH
,ENGINE_R_DSO_FAILURE
);
566 surewarehk_dso
= NULL
;
567 p_surewarehk_Init
= NULL
;
568 p_surewarehk_Finish
= NULL
;
569 p_surewarehk_Rand_Bytes
= NULL
;
570 p_surewarehk_Rand_Seed
= NULL
;
571 p_surewarehk_Load_Privkey
= NULL
;
572 p_surewarehk_Load_Rsa_Pubkey
= NULL
;
573 p_surewarehk_Free
= NULL
;
574 p_surewarehk_Rsa_Priv_Dec
= NULL
;
575 p_surewarehk_Rsa_Sign
= NULL
;
576 p_surewarehk_Dsa_Sign
= NULL
;
577 p_surewarehk_Info_Pubkey
= NULL
;
578 p_surewarehk_Load_Dsa_Pubkey
= NULL
;
579 p_surewarehk_Mod_Exp
= NULL
;
583 static void surewarehk_error_handling(char *const msg
,int func
,int ret
)
587 case SUREWAREHOOK_ERROR_UNIT_FAILURE
:
588 ENGINEerr(func
,SUREWARE_R_UNIT_FAILURE
);
590 case SUREWAREHOOK_ERROR_FALLBACK
:
591 ENGINEerr(func
,SUREWARE_R_REQUEST_FALLBACK
);
593 case SUREWAREHOOK_ERROR_DATA_SIZE
:
594 ENGINEerr(func
,SUREWARE_R_SIZE_TOO_LARGE_OR_TOO_SMALL
);
596 case SUREWAREHOOK_ERROR_INVALID_PAD
:
597 ENGINEerr(func
,SUREWARE_R_PADDING_CHECK_FAILED
);
600 ENGINEerr(func
,SUREWARE_R_REQUEST_FAILED
);
607 ERR_add_error_data(1,msg
);
610 CRYPTO_w_lock(CRYPTO_LOCK_BIO
);
611 BIO_write(logstream
, msg
, strlen(msg
));
612 CRYPTO_w_unlock(CRYPTO_LOCK_BIO
);
617 static int surewarehk_rand_bytes(unsigned char *buf
, int num
)
620 char msg
[64]="ENGINE_rand_bytes";
621 if(!p_surewarehk_Rand_Bytes
)
623 SUREWAREerr(SUREWARE_F_SUREWAREHK_RAND_BYTES
,ENGINE_R_NOT_INITIALISED
);
627 ret
= p_surewarehk_Rand_Bytes(msg
,buf
, num
);
628 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_RAND_BYTES
,ret
);
630 return ret
==1 ? 1 : 0;
633 static void surewarehk_rand_seed(const void *buf
, int num
)
636 char msg
[64]="ENGINE_rand_seed";
637 if(!p_surewarehk_Rand_Seed
)
639 SUREWAREerr(SUREWARE_F_SUREWAREHK_RAND_SEED
,ENGINE_R_NOT_INITIALISED
);
643 ret
= p_surewarehk_Rand_Seed(msg
,buf
, num
);
644 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_RAND_SEED
,ret
);
648 static void surewarehk_rand_add(const void *buf
, int num
, double entropy
)
650 surewarehk_rand_seed(buf
,num
);
653 static EVP_PKEY
* sureware_load_public(ENGINE
*e
,const char *key_id
,char *hptr
,unsigned long el
,char keytype
)
655 EVP_PKEY
*res
= NULL
;
656 #ifndef OPENSSL_NO_RSA
659 #ifndef OPENSSL_NO_DSA
662 char msg
[64]="sureware_load_public";
664 if(!p_surewarehk_Load_Rsa_Pubkey
|| !p_surewarehk_Load_Dsa_Pubkey
)
666 SUREWAREerr(SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ENGINE_R_NOT_INITIALISED
);
671 #ifndef OPENSSL_NO_RSA
673 /* set private external reference */
674 rsatmp
= RSA_new_method(e
);
675 RSA_set_ex_data(rsatmp
,rsaHndidx
,hptr
);
676 rsatmp
->flags
|= RSA_FLAG_EXT_PKEY
;
678 /* set public big nums*/
679 rsatmp
->e
= BN_new();
680 rsatmp
->n
= BN_new();
681 bn_expand2(rsatmp
->e
, el
/sizeof(BN_ULONG
));
682 bn_expand2(rsatmp
->n
, el
/sizeof(BN_ULONG
));
683 if (!rsatmp
->e
|| rsatmp
->e
->dmax
!=(int)(el
/sizeof(BN_ULONG
))||
684 !rsatmp
->n
|| rsatmp
->n
->dmax
!=(int)(el
/sizeof(BN_ULONG
)))
686 ret
=p_surewarehk_Load_Rsa_Pubkey(msg
,key_id
,el
,
687 (unsigned long *)rsatmp
->n
->d
,
688 (unsigned long *)rsatmp
->e
->d
);
689 surewarehk_error_handling(msg
,SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ret
);
692 SUREWAREerr(SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ENGINE_R_FAILED_LOADING_PUBLIC_KEY
);
695 /* normalise pub e and pub n */
696 rsatmp
->e
->top
=el
/sizeof(BN_ULONG
);
697 bn_fix_top(rsatmp
->e
);
698 rsatmp
->n
->top
=el
/sizeof(BN_ULONG
);
699 bn_fix_top(rsatmp
->n
);
700 /* create an EVP object: engine + rsa key */
701 res
= EVP_PKEY_new();
702 EVP_PKEY_assign_RSA(res
, rsatmp
);
706 #ifndef OPENSSL_NO_DSA
708 /* set private/public external reference */
709 dsatmp
= DSA_new_method(e
);
710 DSA_set_ex_data(dsatmp
,dsaHndidx
,hptr
);
711 /*dsatmp->flags |= DSA_FLAG_EXT_PKEY;*/
714 dsatmp
->pub_key
= BN_new();
715 dsatmp
->p
= BN_new();
716 dsatmp
->q
= BN_new();
717 dsatmp
->g
= BN_new();
718 bn_expand2(dsatmp
->pub_key
, el
/sizeof(BN_ULONG
));
719 bn_expand2(dsatmp
->p
, el
/sizeof(BN_ULONG
));
720 bn_expand2(dsatmp
->q
, 20/sizeof(BN_ULONG
));
721 bn_expand2(dsatmp
->g
, el
/sizeof(BN_ULONG
));
722 if (!dsatmp
->pub_key
|| dsatmp
->pub_key
->dmax
!=(int)(el
/sizeof(BN_ULONG
))||
723 !dsatmp
->p
|| dsatmp
->p
->dmax
!=(int)(el
/sizeof(BN_ULONG
)) ||
724 !dsatmp
->q
|| dsatmp
->q
->dmax
!=20/sizeof(BN_ULONG
) ||
725 !dsatmp
->g
|| dsatmp
->g
->dmax
!=(int)(el
/sizeof(BN_ULONG
)))
728 ret
=p_surewarehk_Load_Dsa_Pubkey(msg
,key_id
,el
,
729 (unsigned long *)dsatmp
->pub_key
->d
,
730 (unsigned long *)dsatmp
->p
->d
,
731 (unsigned long *)dsatmp
->q
->d
,
732 (unsigned long *)dsatmp
->g
->d
);
733 surewarehk_error_handling(msg
,SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ret
);
736 SUREWAREerr(SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ENGINE_R_FAILED_LOADING_PUBLIC_KEY
);
740 /* normalise pubkey and parameters in case of */
741 dsatmp
->pub_key
->top
=el
/sizeof(BN_ULONG
);
742 bn_fix_top(dsatmp
->pub_key
);
743 dsatmp
->p
->top
=el
/sizeof(BN_ULONG
);
744 bn_fix_top(dsatmp
->p
);
745 dsatmp
->q
->top
=20/sizeof(BN_ULONG
);
746 bn_fix_top(dsatmp
->q
);
747 dsatmp
->g
->top
=el
/sizeof(BN_ULONG
);
748 bn_fix_top(dsatmp
->g
);
750 /* create an EVP object: engine + rsa key */
751 res
= EVP_PKEY_new();
752 EVP_PKEY_assign_DSA(res
, dsatmp
);
757 SUREWAREerr(SUREWARE_F_SUREWARE_LOAD_PUBLIC
,ENGINE_R_FAILED_LOADING_PRIVATE_KEY
);
764 #ifndef OPENSSL_NO_RSA
768 #ifndef OPENSSL_NO_DSA
775 static EVP_PKEY
*surewarehk_load_privkey(ENGINE
*e
, const char *key_id
,
776 UI_METHOD
*ui_method
, void *callback_data
)
778 EVP_PKEY
*res
= NULL
;
783 char msg
[64]="ENGINE_load_privkey";
785 if(!p_surewarehk_Load_Privkey
)
787 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVKEY
,ENGINE_R_NOT_INITIALISED
);
791 ret
=p_surewarehk_Load_Privkey(msg
,key_id
,&hptr
,&el
,&keytype
);
794 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PRIVKEY
,ENGINE_R_FAILED_LOADING_PRIVATE_KEY
);
795 ERR_add_error_data(1,msg
);
798 res
=sureware_load_public(e
,key_id
,hptr
,el
,keytype
);
803 static EVP_PKEY
*surewarehk_load_pubkey(ENGINE
*e
, const char *key_id
,
804 UI_METHOD
*ui_method
, void *callback_data
)
806 EVP_PKEY
*res
= NULL
;
811 char msg
[64]="ENGINE_load_pubkey";
813 if(!p_surewarehk_Info_Pubkey
)
815 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PUBKEY
,ENGINE_R_NOT_INITIALISED
);
819 /* call once to identify if DSA or RSA */
820 ret
=p_surewarehk_Info_Pubkey(msg
,key_id
,&el
,&keytype
);
823 SUREWAREerr(SUREWARE_F_SUREWAREHK_LOAD_PUBKEY
,ENGINE_R_FAILED_LOADING_PUBLIC_KEY
);
824 ERR_add_error_data(1,msg
);
827 res
=sureware_load_public(e
,key_id
,hptr
,el
,keytype
);
832 /* This cleans up an RSA/DSA KM key(do not destroy the key into the hardware)
833 , called when ex_data is freed */
834 static void surewarehk_ex_free(void *obj
, void *item
, CRYPTO_EX_DATA
*ad
,
835 int idx
,long argl
, void *argp
)
837 if(!p_surewarehk_Free
)
839 SUREWAREerr(SUREWARE_F_SUREWAREHK_EX_FREE
,ENGINE_R_NOT_INITIALISED
);
842 p_surewarehk_Free((char *)item
,0);
846 /* not currently used (bug?) */
847 /* This cleans up an DH KM key (destroys the key into hardware),
848 called when ex_data is freed */
849 static void surewarehk_dh_ex_free(void *obj
, void *item
, CRYPTO_EX_DATA
*ad
,
850 int idx
,long argl
, void *argp
)
852 if(!p_surewarehk_Free
)
854 SUREWAREerr(SUREWARE_F_SUREWAREHK_DH_EX_FREE
,ENGINE_R_NOT_INITIALISED
);
857 p_surewarehk_Free((char *)item
,1);
862 * return number of decrypted bytes
864 #ifndef OPENSSL_NO_RSA
865 static int surewarehk_rsa_priv_dec(int flen
,const unsigned char *from
,unsigned char *to
,
866 RSA
*rsa
,int padding
)
869 char *buf
=NULL
,*hptr
=NULL
;
870 char msg
[64]="ENGINE_rsa_priv_dec";
871 if (!p_surewarehk_Rsa_Priv_Dec
)
873 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,ENGINE_R_NOT_INITIALISED
);
875 /* extract ref to private key */
876 else if (!(hptr
=RSA_get_ex_data(rsa
, rsaHndidx
)))
878 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,SUREWARE_R_MISSING_KEY_COMPONENTS
);
881 /* analyse what padding we can do into the hardware */
882 if (padding
==RSA_PKCS1_PADDING
)
885 ret
=p_surewarehk_Rsa_Priv_Dec(msg
,flen
,(unsigned char *)from
,&tlen
,to
,hptr
,SUREWARE_PKCS1_PAD
);
886 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,ret
);
891 else /* do with no padding into hardware */
893 ret
=p_surewarehk_Rsa_Priv_Dec(msg
,flen
,(unsigned char *)from
,&tlen
,to
,hptr
,SUREWARE_NO_PAD
);
894 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,ret
);
897 /* intermediate buffer for padding */
898 if ((buf
=OPENSSL_malloc(tlen
)) == NULL
)
900 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,ERR_R_MALLOC_FAILURE
);
903 memcpy(buf
,to
,tlen
);/* transfert to into buf */
904 switch (padding
) /* check padding in software */
906 #ifndef OPENSSL_NO_SHA
907 case RSA_PKCS1_OAEP_PADDING
:
908 ret
=RSA_padding_check_PKCS1_OAEP(to
,tlen
,(unsigned char *)buf
,tlen
,tlen
,NULL
,0);
911 case RSA_SSLV23_PADDING
:
912 ret
=RSA_padding_check_SSLv23(to
,tlen
,(unsigned char *)buf
,flen
,tlen
);
915 ret
=RSA_padding_check_none(to
,tlen
,(unsigned char *)buf
,flen
,tlen
);
918 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,SUREWARE_R_UNKNOWN_PADDING_TYPE
);
922 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_PRIV_DEC
,SUREWARE_R_PADDING_CHECK_FAILED
);
927 OPENSSL_cleanse(buf
,tlen
);
934 * Does what OpenSSL rsa_priv_enc does.
936 static int surewarehk_rsa_sign(int flen
,const unsigned char *from
,unsigned char *to
,
937 RSA
*rsa
,int padding
)
941 char msg
[64]="ENGINE_rsa_sign";
942 if (!p_surewarehk_Rsa_Sign
)
944 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_SIGN
,ENGINE_R_NOT_INITIALISED
);
946 /* extract ref to private key */
947 else if (!(hptr
=RSA_get_ex_data(rsa
, rsaHndidx
)))
949 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_SIGN
,SUREWARE_R_MISSING_KEY_COMPONENTS
);
955 case RSA_PKCS1_PADDING
: /* do it in one shot */
956 ret
=p_surewarehk_Rsa_Sign(msg
,flen
,(unsigned char *)from
,&tlen
,to
,hptr
,SUREWARE_PKCS1_PAD
);
957 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_RSA_SIGN
,ret
);
961 SUREWAREerr(SUREWARE_F_SUREWAREHK_RSA_SIGN
,SUREWARE_R_UNKNOWN_PADDING_TYPE
);
964 return ret
==1 ? tlen
: ret
;
969 #ifndef OPENSSL_NO_DSA
970 /* DSA sign and verify */
971 static DSA_SIG
* surewarehk_dsa_do_sign(const unsigned char *from
, int flen
, DSA
*dsa
)
976 char msg
[64]="ENGINE_dsa_do_sign";
977 if (!p_surewarehk_Dsa_Sign
)
979 SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN
,ENGINE_R_NOT_INITIALISED
);
982 /* extract ref to private key */
983 else if (!(hptr
=DSA_get_ex_data(dsa
, dsaHndidx
)))
985 SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN
,SUREWARE_R_MISSING_KEY_COMPONENTS
);
990 if((psign
= DSA_SIG_new()) == NULL
)
992 SUREWAREerr(SUREWARE_F_SUREWAREHK_DSA_DO_SIGN
,ERR_R_MALLOC_FAILURE
);
997 bn_expand2(psign
->r
, 20/sizeof(BN_ULONG
));
998 bn_expand2(psign
->s
, 20/sizeof(BN_ULONG
));
999 if (!psign
->r
|| psign
->r
->dmax
!=20/sizeof(BN_ULONG
) ||
1000 !psign
->s
|| psign
->s
->dmax
!=20/sizeof(BN_ULONG
))
1002 ret
=p_surewarehk_Dsa_Sign(msg
,flen
,from
,
1003 (unsigned long *)psign
->r
->d
,
1004 (unsigned long *)psign
->s
->d
,
1006 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_DSA_DO_SIGN
,ret
);
1008 psign
->r
->top
=20/sizeof(BN_ULONG
);
1009 bn_fix_top(psign
->r
);
1010 psign
->s
->top
=20/sizeof(BN_ULONG
);
1011 bn_fix_top(psign
->s
);
1016 DSA_SIG_free(psign
);
1023 static int surewarehk_modexp(BIGNUM
*r
, const BIGNUM
*a
, const BIGNUM
*p
,
1024 const BIGNUM
*m
, BN_CTX
*ctx
)
1027 char msg
[64]="ENGINE_modexp";
1028 if (!p_surewarehk_Mod_Exp
)
1030 SUREWAREerr(SUREWARE_F_SUREWAREHK_MODEXP
,ENGINE_R_NOT_INITIALISED
);
1034 bn_expand2(r
,m
->top
);
1035 if (r
&& r
->dmax
==m
->top
)
1038 ret
=p_surewarehk_Mod_Exp(msg
,
1039 m
->top
*sizeof(BN_ULONG
),
1040 (unsigned long *)m
->d
,
1041 p
->top
*sizeof(BN_ULONG
),
1042 (unsigned long *)p
->d
,
1043 a
->top
*sizeof(BN_ULONG
),
1044 (unsigned long *)a
->d
,
1045 (unsigned long *)r
->d
);
1046 surewarehk_error_handling(msg
,SUREWARE_F_SUREWAREHK_MODEXP
,ret
);
1049 /* normalise result */
1057 #endif /* !OPENSSL_NO_HW_SureWare */
1058 #endif /* !OPENSSL_NO_HW */