Remove some obsolete/obscure internal define switches:
[openssl.git] / demos / engines / e_chil.c
1 /*
2  * Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include <string.h>
12 #include <openssl/crypto.h>
13 #include <openssl/pem.h>
14 #include "internal/dso.h"
15 #include <openssl/engine.h>
16 #include <openssl/ui.h>
17 #include <openssl/rand.h>
18 #ifndef OPENSSL_NO_RSA
19 # include <openssl/rsa.h>
20 #endif
21 #ifndef OPENSSL_NO_DH
22 # include <openssl/dh.h>
23 #endif
24 #include <openssl/bn.h>
25
26 #ifndef OPENSSL_NO_HW
27 # ifndef OPENSSL_NO_HW_CHIL
28
29 /*-
30  * Attribution notice: nCipher have said several times that it's OK for
31  * us to implement a general interface to their boxes, and recently declared
32  * their HWCryptoHook to be public, and therefore available for us to use.
33  * Thanks, nCipher.
34  *
35  * The hwcryptohook.h included here is from May 2000.
36  * [Richard Levitte]
37  */
38 # include "vendor_defns/hwcryptohook.h"
39
40 #  define HWCRHK_LIB_NAME "CHIL engine"
41 #  include "e_chil_err.c"
42
43 static CRYPTO_RWLOCK *chil_lock;
44
45 static int hwcrhk_destroy(ENGINE *e);
46 static int hwcrhk_init(ENGINE *e);
47 static int hwcrhk_finish(ENGINE *e);
48 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
49
50 /* Functions to handle mutexes */
51 static int hwcrhk_mutex_init(HWCryptoHook_Mutex *,
52                              HWCryptoHook_CallerContext *);
53 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex *);
54 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex *);
55 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex *);
56
57 /* BIGNUM stuff */
58 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
59                           const BIGNUM *m, BN_CTX *ctx);
60
61 #  ifndef OPENSSL_NO_RSA
62 /* RSA stuff */
63 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
64                               BN_CTX *ctx);
65 /* This function is aliased to mod_exp (with the mont stuff dropped). */
66 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
67                                const BIGNUM *m, BN_CTX *ctx,
68                                BN_MONT_CTX *m_ctx);
69 static int hwcrhk_rsa_finish(RSA *rsa);
70 #  endif
71
72 #  ifndef OPENSSL_NO_DH
73 /* DH stuff */
74 /* This function is alised to mod_exp (with the DH and mont dropped). */
75 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
76                              const BIGNUM *a, const BIGNUM *p,
77                              const BIGNUM *m, BN_CTX *ctx,
78                              BN_MONT_CTX *m_ctx);
79 #  endif
80
81 /* RAND stuff */
82 static int hwcrhk_rand_bytes(unsigned char *buf, int num);
83 static int hwcrhk_rand_status(void);
84
85 /* KM stuff */
86 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
87                                      UI_METHOD *ui_method,
88                                      void *callback_data);
89 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
90                                     UI_METHOD *ui_method,
91                                     void *callback_data);
92
93 /* Interaction stuff */
94 static int hwcrhk_insert_card(const char *prompt_info,
95                               const char *wrong_info,
96                               HWCryptoHook_PassphraseContext * ppctx,
97                               HWCryptoHook_CallerContext * cactx);
98 static int hwcrhk_get_pass(const char *prompt_info,
99                            int *len_io, char *buf,
100                            HWCryptoHook_PassphraseContext * ppctx,
101                            HWCryptoHook_CallerContext * cactx);
102 static void hwcrhk_log_message(void *logstr, const char *message);
103
104 /* The definitions for control commands specific to this engine */
105 #  define HWCRHK_CMD_SO_PATH              ENGINE_CMD_BASE
106 #  define HWCRHK_CMD_FORK_CHECK           (ENGINE_CMD_BASE + 1)
107 #  define HWCRHK_CMD_THREAD_LOCKING       (ENGINE_CMD_BASE + 2)
108 #  define HWCRHK_CMD_SET_USER_INTERFACE   (ENGINE_CMD_BASE + 3)
109 #  define HWCRHK_CMD_SET_CALLBACK_DATA    (ENGINE_CMD_BASE + 4)
110 static const ENGINE_CMD_DEFN hwcrhk_cmd_defns[] = {
111     {HWCRHK_CMD_SO_PATH,
112      "SO_PATH",
113      "Specifies the path to the 'hwcrhk' shared library",
114      ENGINE_CMD_FLAG_STRING},
115     {HWCRHK_CMD_FORK_CHECK,
116      "FORK_CHECK",
117      "Turns fork() checking on (non-zero) or off (zero)",
118      ENGINE_CMD_FLAG_NUMERIC},
119     {HWCRHK_CMD_THREAD_LOCKING,
120      "THREAD_LOCKING",
121      "Turns thread-safe locking on (zero) or off (non-zero)",
122      ENGINE_CMD_FLAG_NUMERIC},
123     {HWCRHK_CMD_SET_USER_INTERFACE,
124      "SET_USER_INTERFACE",
125      "Set the global user interface (internal)",
126      ENGINE_CMD_FLAG_INTERNAL},
127     {HWCRHK_CMD_SET_CALLBACK_DATA,
128      "SET_CALLBACK_DATA",
129      "Set the global user interface extra data (internal)",
130      ENGINE_CMD_FLAG_INTERNAL},
131     {0, NULL, NULL, 0}
132 };
133
134 #  ifndef OPENSSL_NO_RSA
135 /* Our internal RSA_METHOD that we provide pointers to */
136 static RSA_METHOD hwcrhk_rsa = {
137     "CHIL RSA method",
138     NULL,
139     NULL,
140     NULL,
141     NULL,
142     hwcrhk_rsa_mod_exp,
143     hwcrhk_mod_exp_mont,
144     NULL,
145     hwcrhk_rsa_finish,
146     0,
147     NULL,
148     NULL,
149     NULL,
150     NULL
151 };
152 #  endif
153
154 #  ifndef OPENSSL_NO_DH
155 /* Our internal DH_METHOD that we provide pointers to */
156 static DH_METHOD hwcrhk_dh = {
157     "CHIL DH method",
158     NULL,
159     NULL,
160     hwcrhk_mod_exp_dh,
161     NULL,
162     NULL,
163     0,
164     NULL,
165     NULL
166 };
167 #  endif
168
169 static RAND_METHOD hwcrhk_rand = {
170     /* "CHIL RAND method", */
171     NULL,
172     hwcrhk_rand_bytes,
173     NULL,
174     NULL,
175     hwcrhk_rand_bytes,
176     hwcrhk_rand_status,
177 };
178
179 /* Constants used when creating the ENGINE */
180 static const char *engine_hwcrhk_id = "chil";
181 static const char *engine_hwcrhk_name = "CHIL hardware engine support";
182 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
183 /* Compatibility hack, the dynamic library uses this form in the path */
184 static const char *engine_hwcrhk_id_alt = "ncipher";
185 #  endif
186
187 /* Internal stuff for HWCryptoHook */
188
189 /* Some structures needed for proper use of thread locks */
190 /*
191  * hwcryptohook.h has some typedefs that turn struct HWCryptoHook_MutexValue
192  * into HWCryptoHook_Mutex
193  */
194 struct HWCryptoHook_MutexValue {
195     CRYPTO_RWLOCK *lock;
196 };
197
198 /*
199  * hwcryptohook.h has some typedefs that turn struct
200  * HWCryptoHook_PassphraseContextValue into HWCryptoHook_PassphraseContext
201  */
202 struct HWCryptoHook_PassphraseContextValue {
203     UI_METHOD *ui_method;
204     void *callback_data;
205 };
206
207 /*
208  * hwcryptohook.h has some typedefs that turn struct
209  * HWCryptoHook_CallerContextValue into HWCryptoHook_CallerContext
210  */
211 struct HWCryptoHook_CallerContextValue {
212     pem_password_cb *password_callback; /* Deprecated! Only present for
213                                          * backward compatibility! */
214     UI_METHOD *ui_method;
215     void *callback_data;
216 };
217
218 /*
219  * The MPI structure in HWCryptoHook is pretty compatible with OpenSSL
220  * BIGNUM's, so lets define a couple of conversion macros
221  */
222 #  define BN2MPI(mp, bn) \
223     {mp.size = bn->top * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
224 #  define MPI2BN(bn, mp) \
225     {mp.size = bn->dmax * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
226
227 static BIO *logstream = NULL;
228 static int disable_mutex_callbacks = 0;
229
230 /*
231  * One might wonder why these are needed, since one can pass down at least a
232  * UI_METHOD and a pointer to callback data to the key-loading functions. The
233  * thing is that the ModExp and RSAImmed functions can load keys as well, if
234  * the data they get is in a special, nCipher-defined format (hint: if you
235  * look at the private exponent of the RSA data as a string, you'll see this
236  * string: "nCipher KM tool key id", followed by some bytes, followed a key
237  * identity string, followed by more bytes.  This happens when you use
238  * "embed" keys instead of "hwcrhk" keys).  Unfortunately, those functions do
239  * not take any passphrase or caller context, and our functions can't really
240  * take any callback data either.  Still, the "insert_card" and
241  * "get_passphrase" callbacks may be called down the line, and will need to
242  * know what user interface callbacks to call, and having callback data from
243  * the application may be a nice thing as well, so we need to keep track of
244  * that globally.
245  */
246 static HWCryptoHook_CallerContext password_context = { NULL, NULL, NULL };
247
248 /* Stuff to pass to the HWCryptoHook library */
249 static HWCryptoHook_InitInfo hwcrhk_globals = {
250     HWCryptoHook_InitFlags_SimpleForkCheck, /* Flags */
251     &logstream,                 /* logstream */
252     sizeof(BN_ULONG),           /* limbsize */
253     0,                          /* mslimb first: false for BNs */
254     -1,                         /* msbyte first: use native */
255     0,                          /* Max mutexes, 0 = no small limit */
256     0,                          /* Max simultaneous, 0 = default */
257
258     /*
259      * The next few are mutex stuff: we write wrapper functions around the OS
260      * mutex functions.  We initialise them to 0 here, and change that to
261      * actual function pointers in hwcrhk_init() if dynamic locks are
262      * supported (that is, if the application programmer has made sure of
263      * setting up callbacks bafore starting this engine) *and* if
264      * disable_mutex_callbacks hasn't been set by a call to
265      * ENGINE_ctrl(ENGINE_CTRL_CHIL_NO_LOCKING).
266      */
267     sizeof(HWCryptoHook_Mutex),
268     0,
269     0,
270     0,
271     0,
272
273     /*
274      * The next few are condvar stuff: we write wrapper functions round the
275      * OS functions.  Currently not implemented and not and absolute
276      * necessity even in threaded programs, therefore 0'ed.  Will hopefully
277      * be implemented some day, since it enhances the efficiency of
278      * HWCryptoHook.
279      */
280     0,                          /* sizeof(HWCryptoHook_CondVar), */
281     0,                          /* hwcrhk_cv_init, */
282     0,                          /* hwcrhk_cv_wait, */
283     0,                          /* hwcrhk_cv_signal, */
284     0,                          /* hwcrhk_cv_broadcast, */
285     0,                          /* hwcrhk_cv_destroy, */
286
287     hwcrhk_get_pass,            /* pass phrase */
288     hwcrhk_insert_card,         /* insert a card */
289     hwcrhk_log_message          /* Log message */
290 };
291
292 /* Now, to our own code */
293
294 /*
295  * This internal function is used by ENGINE_chil() and possibly by the
296  * "dynamic" ENGINE support too
297  */
298 static int bind_helper(ENGINE *e)
299 {
300 #  ifndef OPENSSL_NO_RSA
301     const RSA_METHOD *meth1;
302 #  endif
303 #  ifndef OPENSSL_NO_DH
304     const DH_METHOD *meth2;
305 #  endif
306
307     chil_lock = CRYPTO_THREAD_lock_new();
308     if (chil_lock == NULL) {
309         HWCRHKerr(HWCRHK_F_BIND_HELPER, ERR_R_MALLOC_FAILURE);
310         return 0;
311     }
312
313     if (!ENGINE_set_id(e, engine_hwcrhk_id) ||
314         !ENGINE_set_name(e, engine_hwcrhk_name) ||
315 #  ifndef OPENSSL_NO_RSA
316         !ENGINE_set_RSA(e, &hwcrhk_rsa) ||
317 #  endif
318 #  ifndef OPENSSL_NO_DH
319         !ENGINE_set_DH(e, &hwcrhk_dh) ||
320 #  endif
321         !ENGINE_set_RAND(e, &hwcrhk_rand) ||
322         !ENGINE_set_destroy_function(e, hwcrhk_destroy) ||
323         !ENGINE_set_init_function(e, hwcrhk_init) ||
324         !ENGINE_set_finish_function(e, hwcrhk_finish) ||
325         !ENGINE_set_ctrl_function(e, hwcrhk_ctrl) ||
326         !ENGINE_set_load_privkey_function(e, hwcrhk_load_privkey) ||
327         !ENGINE_set_load_pubkey_function(e, hwcrhk_load_pubkey) ||
328         !ENGINE_set_cmd_defns(e, hwcrhk_cmd_defns))
329         return 0;
330
331 #  ifndef OPENSSL_NO_RSA
332     /*
333      * We know that the "PKCS1_OpenSSL()" functions hook properly to the
334      * cswift-specific mod_exp and mod_exp_crt so we use those functions. NB:
335      * We don't use ENGINE_openssl() or anything "more generic" because
336      * something like the RSAref code may not hook properly, and if you own
337      * one of these cards then you have the right to do RSA operations on it
338      * anyway!
339      */
340     meth1 = RSA_PKCS1_OpenSSL();
341     hwcrhk_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
342     hwcrhk_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
343     hwcrhk_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
344     hwcrhk_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
345 #  endif
346
347 #  ifndef OPENSSL_NO_DH
348     /* Much the same for Diffie-Hellman */
349     meth2 = DH_OpenSSL();
350     hwcrhk_dh.generate_key = meth2->generate_key;
351     hwcrhk_dh.compute_key = meth2->compute_key;
352 #  endif
353
354     /* Ensure the hwcrhk error handling is set up */
355     ERR_load_HWCRHK_strings();
356
357     return 1;
358 }
359
360 #  ifdef OPENSSL_NO_DYNAMIC_ENGINE
361 static ENGINE *engine_chil(void)
362 {
363     ENGINE *ret = ENGINE_new();
364     if (ret == NULL)
365         return NULL;
366     if (!bind_helper(ret)) {
367         ENGINE_free(ret);
368         return NULL;
369     }
370     return ret;
371 }
372
373 void ENGINE_load_chil(void)
374 {
375     /* Copied from eng_[openssl|dyn].c */
376     ENGINE *toadd = engine_chil();
377     if (!toadd)
378         return;
379     ENGINE_add(toadd);
380     ENGINE_free(toadd);
381     ERR_clear_error();
382 }
383 #  endif
384
385 /*
386  * This is a process-global DSO handle used for loading and unloading the
387  * HWCryptoHook library. NB: This is only set (or unset) during an init() or
388  * finish() call (reference counts permitting) and they're operating with
389  * global locks, so this should be thread-safe implicitly.
390  */
391 static DSO *hwcrhk_dso = NULL;
392 static HWCryptoHook_ContextHandle hwcrhk_context = 0;
393 #  ifndef OPENSSL_NO_RSA
394 /* Index for KM handle.  Not really used yet. */
395 static int hndidx_rsa = -1;
396 #  endif
397
398 /*
399  * These are the function pointers that are (un)set when the library has
400  * successfully (un)loaded.
401  */
402 static HWCryptoHook_Init_t *p_hwcrhk_Init = NULL;
403 static HWCryptoHook_Finish_t *p_hwcrhk_Finish = NULL;
404 static HWCryptoHook_ModExp_t *p_hwcrhk_ModExp = NULL;
405 #  ifndef OPENSSL_NO_RSA
406 static HWCryptoHook_RSA_t *p_hwcrhk_RSA = NULL;
407 #  endif
408 static HWCryptoHook_RandomBytes_t *p_hwcrhk_RandomBytes = NULL;
409 #  ifndef OPENSSL_NO_RSA
410 static HWCryptoHook_RSALoadKey_t *p_hwcrhk_RSALoadKey = NULL;
411 static HWCryptoHook_RSAGetPublicKey_t *p_hwcrhk_RSAGetPublicKey = NULL;
412 static HWCryptoHook_RSAUnloadKey_t *p_hwcrhk_RSAUnloadKey = NULL;
413 #  endif
414 static HWCryptoHook_ModExpCRT_t *p_hwcrhk_ModExpCRT = NULL;
415
416 /* Used in the DSO operations. */
417 static const char *HWCRHK_LIBNAME = NULL;
418 static void free_HWCRHK_LIBNAME(void)
419 {
420     OPENSSL_free(HWCRHK_LIBNAME);
421     HWCRHK_LIBNAME = NULL;
422 }
423
424 static const char *get_HWCRHK_LIBNAME(void)
425 {
426     if (HWCRHK_LIBNAME)
427         return HWCRHK_LIBNAME;
428     return "nfhwcrhk";
429 }
430
431 static long set_HWCRHK_LIBNAME(const char *name)
432 {
433     free_HWCRHK_LIBNAME();
434     return (((HWCRHK_LIBNAME = OPENSSL_strdup(name)) != NULL) ? 1 : 0);
435 }
436
437 static const char *n_hwcrhk_Init = "HWCryptoHook_Init";
438 static const char *n_hwcrhk_Finish = "HWCryptoHook_Finish";
439 static const char *n_hwcrhk_ModExp = "HWCryptoHook_ModExp";
440 #  ifndef OPENSSL_NO_RSA
441 static const char *n_hwcrhk_RSA = "HWCryptoHook_RSA";
442 #  endif
443 static const char *n_hwcrhk_RandomBytes = "HWCryptoHook_RandomBytes";
444 #  ifndef OPENSSL_NO_RSA
445 static const char *n_hwcrhk_RSALoadKey = "HWCryptoHook_RSALoadKey";
446 static const char *n_hwcrhk_RSAGetPublicKey = "HWCryptoHook_RSAGetPublicKey";
447 static const char *n_hwcrhk_RSAUnloadKey = "HWCryptoHook_RSAUnloadKey";
448 #  endif
449 static const char *n_hwcrhk_ModExpCRT = "HWCryptoHook_ModExpCRT";
450
451 /*
452  * HWCryptoHook library functions and mechanics - these are used by the
453  * higher-level functions further down. NB: As and where there's no error
454  * checking, take a look lower down where these functions are called, the
455  * checking and error handling is probably down there.
456  */
457
458 /* utility function to obtain a context */
459 static int get_context(HWCryptoHook_ContextHandle * hac,
460                        HWCryptoHook_CallerContext * cac)
461 {
462     char tempbuf[1024];
463     HWCryptoHook_ErrMsgBuf rmsg;
464
465     rmsg.buf = tempbuf;
466     rmsg.size = sizeof(tempbuf);
467
468     *hac = p_hwcrhk_Init(&hwcrhk_globals, sizeof(hwcrhk_globals), &rmsg, cac);
469     if (!*hac)
470         return 0;
471     return 1;
472 }
473
474 /* similarly to release one. */
475 static void release_context(HWCryptoHook_ContextHandle hac)
476 {
477     p_hwcrhk_Finish(hac);
478 }
479
480 /* Destructor (complements the "ENGINE_chil()" constructor) */
481 static int hwcrhk_destroy(ENGINE *e)
482 {
483     free_HWCRHK_LIBNAME();
484     ERR_unload_HWCRHK_strings();
485     CRYPTO_THREAD_lock_free(chil_lock);
486     return 1;
487 }
488
489 /* (de)initialisation functions. */
490 static int hwcrhk_init(ENGINE *e)
491 {
492     HWCryptoHook_Init_t *p1;
493     HWCryptoHook_Finish_t *p2;
494     HWCryptoHook_ModExp_t *p3;
495 #  ifndef OPENSSL_NO_RSA
496     HWCryptoHook_RSA_t *p4;
497     HWCryptoHook_RSALoadKey_t *p5;
498     HWCryptoHook_RSAGetPublicKey_t *p6;
499     HWCryptoHook_RSAUnloadKey_t *p7;
500 #  endif
501     HWCryptoHook_RandomBytes_t *p8;
502     HWCryptoHook_ModExpCRT_t *p9;
503
504     if (hwcrhk_dso != NULL) {
505         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_ALREADY_LOADED);
506         goto err;
507     }
508     /* Attempt to load libnfhwcrhk.so/nfhwcrhk.dll/whatever. */
509     hwcrhk_dso = DSO_load(NULL, get_HWCRHK_LIBNAME(), NULL, 0);
510     if (hwcrhk_dso == NULL) {
511         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
512         goto err;
513     }
514
515 #define BINDIT(t, name) (t *)DSO_bind_func(hwcrhk_dso, name)
516     if ((p1 = BINDIT(HWCryptoHook_Init_t, n_hwcrhk_Init)) == NULL
517         || (p2 = BINDIT(HWCryptoHook_Finish_t, n_hwcrhk_Finish)) == NULL
518         || (p3 = BINDIT(HWCryptoHook_ModExp_t, n_hwcrhk_ModExp)) == NULL
519 #  ifndef OPENSSL_NO_RSA
520         || (p4 = BINDIT(HWCryptoHook_RSA_t, n_hwcrhk_RSA)) == NULL
521         || (p5 = BINDIT(HWCryptoHook_RSALoadKey_t, n_hwcrhk_RSALoadKey)) == NULL
522         || (p6 = BINDIT(HWCryptoHook_RSAGetPublicKey_t, n_hwcrhk_RSAGetPublicKey)) == NULL
523         || (p7 = BINDIT(HWCryptoHook_RSAUnloadKey_t, n_hwcrhk_RSAUnloadKey)) == NULL
524 #  endif
525         || (p8 = BINDIT(HWCryptoHook_RandomBytes_t, n_hwcrhk_RandomBytes)) == NULL
526         || (p9 = BINDIT(HWCryptoHook_ModExpCRT_t, n_hwcrhk_ModExpCRT)) == NULL) {
527         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
528         goto err;
529     }
530     /* Copy the pointers */
531     p_hwcrhk_Init = p1;
532     p_hwcrhk_Finish = p2;
533     p_hwcrhk_ModExp = p3;
534 #  ifndef OPENSSL_NO_RSA
535     p_hwcrhk_RSA = p4;
536     p_hwcrhk_RSALoadKey = p5;
537     p_hwcrhk_RSAGetPublicKey = p6;
538     p_hwcrhk_RSAUnloadKey = p7;
539 #  endif
540     p_hwcrhk_RandomBytes = p8;
541     p_hwcrhk_ModExpCRT = p9;
542
543     /*
544      * Check if the application decided to support dynamic locks, and if it
545      * does, use them.
546      */
547     if (disable_mutex_callbacks == 0) {
548         hwcrhk_globals.mutex_init = hwcrhk_mutex_init;
549         hwcrhk_globals.mutex_acquire = hwcrhk_mutex_lock;
550         hwcrhk_globals.mutex_release = hwcrhk_mutex_unlock;
551         hwcrhk_globals.mutex_destroy = hwcrhk_mutex_destroy;
552     }
553
554     /*
555      * Try and get a context - if not, we may have a DSO but no accelerator!
556      */
557     if (!get_context(&hwcrhk_context, &password_context)) {
558         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_UNIT_FAILURE);
559         goto err;
560     }
561     /* Everything's fine. */
562 #  ifndef OPENSSL_NO_RSA
563     if (hndidx_rsa == -1)
564         hndidx_rsa = RSA_get_ex_new_index(0,
565                                           "nFast HWCryptoHook RSA key handle",
566                                           NULL, NULL, NULL);
567 #  endif
568     return 1;
569  err:
570     DSO_free(hwcrhk_dso);
571     hwcrhk_dso = NULL;
572     p_hwcrhk_Init = NULL;
573     p_hwcrhk_Finish = NULL;
574     p_hwcrhk_ModExp = NULL;
575 #  ifndef OPENSSL_NO_RSA
576     p_hwcrhk_RSA = NULL;
577     p_hwcrhk_RSALoadKey = NULL;
578     p_hwcrhk_RSAGetPublicKey = NULL;
579     p_hwcrhk_RSAUnloadKey = NULL;
580 #  endif
581     p_hwcrhk_ModExpCRT = NULL;
582     p_hwcrhk_RandomBytes = NULL;
583     return 0;
584 }
585
586 static int hwcrhk_finish(ENGINE *e)
587 {
588     int to_return = 1;
589     free_HWCRHK_LIBNAME();
590     if (hwcrhk_dso == NULL) {
591         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_NOT_LOADED);
592         to_return = 0;
593         goto err;
594     }
595     release_context(hwcrhk_context);
596     if (!DSO_free(hwcrhk_dso)) {
597         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_DSO_FAILURE);
598         to_return = 0;
599         goto err;
600     }
601  err:
602     BIO_free(logstream);
603     hwcrhk_dso = NULL;
604     p_hwcrhk_Init = NULL;
605     p_hwcrhk_Finish = NULL;
606     p_hwcrhk_ModExp = NULL;
607 #  ifndef OPENSSL_NO_RSA
608     p_hwcrhk_RSA = NULL;
609     p_hwcrhk_RSALoadKey = NULL;
610     p_hwcrhk_RSAGetPublicKey = NULL;
611     p_hwcrhk_RSAUnloadKey = NULL;
612 #  endif
613     p_hwcrhk_ModExpCRT = NULL;
614     p_hwcrhk_RandomBytes = NULL;
615     return to_return;
616 }
617
618 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
619 {
620     int to_return = 1;
621
622     switch (cmd) {
623     case HWCRHK_CMD_SO_PATH:
624         if (hwcrhk_dso) {
625             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_ALREADY_LOADED);
626             return 0;
627         }
628         if (p == NULL) {
629             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, ERR_R_PASSED_NULL_PARAMETER);
630             return 0;
631         }
632         return set_HWCRHK_LIBNAME((const char *)p);
633     case ENGINE_CTRL_SET_LOGSTREAM:
634         {
635             BIO *bio = (BIO *)p;
636
637             CRYPTO_THREAD_write_lock(chil_lock);
638             BIO_free(logstream);
639             logstream = NULL;
640             if (BIO_up_ref(bio))
641                 logstream = bio;
642             else
643                 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_BIO_WAS_FREED);
644         }
645         CRYPTO_THREAD_unlock(chil_lock);
646         break;
647     case ENGINE_CTRL_SET_PASSWORD_CALLBACK:
648         CRYPTO_THREAD_write_lock(chil_lock);
649         password_context.password_callback = (pem_password_cb *)f;
650         CRYPTO_THREAD_unlock(chil_lock);
651         break;
652     case ENGINE_CTRL_SET_USER_INTERFACE:
653     case HWCRHK_CMD_SET_USER_INTERFACE:
654         CRYPTO_THREAD_write_lock(chil_lock);
655         password_context.ui_method = (UI_METHOD *)p;
656         CRYPTO_THREAD_unlock(chil_lock);
657         break;
658     case ENGINE_CTRL_SET_CALLBACK_DATA:
659     case HWCRHK_CMD_SET_CALLBACK_DATA:
660         CRYPTO_THREAD_write_lock(chil_lock);
661         password_context.callback_data = p;
662         CRYPTO_THREAD_unlock(chil_lock);
663         break;
664         /*
665          * this enables or disables the "SimpleForkCheck" flag used in the
666          * initialisation structure.
667          */
668     case ENGINE_CTRL_CHIL_SET_FORKCHECK:
669     case HWCRHK_CMD_FORK_CHECK:
670         CRYPTO_THREAD_write_lock(chil_lock);
671         if (i)
672             hwcrhk_globals.flags |= HWCryptoHook_InitFlags_SimpleForkCheck;
673         else
674             hwcrhk_globals.flags &= ~HWCryptoHook_InitFlags_SimpleForkCheck;
675         CRYPTO_THREAD_unlock(chil_lock);
676         break;
677         /*
678          * This will prevent the initialisation function from "installing"
679          * the mutex-handling callbacks, even if they are available from
680          * within the library (or were provided to the library from the
681          * calling application). This is to remove any baggage for
682          * applications not using multithreading.
683          */
684     case ENGINE_CTRL_CHIL_NO_LOCKING:
685         CRYPTO_THREAD_write_lock(chil_lock);
686         disable_mutex_callbacks = 1;
687         CRYPTO_THREAD_unlock(chil_lock);
688         break;
689     case HWCRHK_CMD_THREAD_LOCKING:
690         CRYPTO_THREAD_write_lock(chil_lock);
691         disable_mutex_callbacks = ((i == 0) ? 0 : 1);
692         CRYPTO_THREAD_unlock(chil_lock);
693         break;
694
695         /* The command isn't understood by this engine */
696     default:
697         HWCRHKerr(HWCRHK_F_HWCRHK_CTRL,
698                   HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
699         to_return = 0;
700         break;
701     }
702
703     return to_return;
704 }
705
706 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
707                                      UI_METHOD *ui_method,
708                                      void *callback_data)
709 {
710 #  ifndef OPENSSL_NO_RSA
711     RSA *rtmp = NULL;
712 #  endif
713     EVP_PKEY *res = NULL;
714 #  ifndef OPENSSL_NO_RSA
715     HWCryptoHook_MPI e, n;
716     HWCryptoHook_RSAKeyHandle *hptr;
717 #  endif
718 #  if !defined(OPENSSL_NO_RSA)
719     char tempbuf[1024];
720     HWCryptoHook_ErrMsgBuf rmsg;
721     HWCryptoHook_PassphraseContext ppctx;
722 #  endif
723
724 #  if !defined(OPENSSL_NO_RSA)
725     rmsg.buf = tempbuf;
726     rmsg.size = sizeof(tempbuf);
727 #  endif
728
729     if (!hwcrhk_context) {
730         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NOT_INITIALISED);
731         goto err;
732     }
733 #  ifndef OPENSSL_NO_RSA
734     hptr = OPENSSL_malloc(sizeof(*hptr));
735     if (hptr == NULL) {
736         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
737         goto err;
738     }
739     ppctx.ui_method = ui_method;
740     ppctx.callback_data = callback_data;
741     if (p_hwcrhk_RSALoadKey(hwcrhk_context, key_id, hptr, &rmsg, &ppctx)) {
742         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
743         ERR_add_error_data(1, rmsg.buf);
744         goto err;
745     }
746     if (!*hptr) {
747         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NO_KEY);
748         goto err;
749     }
750 #  endif
751 #  ifndef OPENSSL_NO_RSA
752     rtmp = RSA_new_method(eng);
753     RSA_set_ex_data(rtmp, hndidx_rsa, (char *)hptr);
754     rtmp->e = BN_new();
755     rtmp->n = BN_new();
756     rtmp->flags |= RSA_FLAG_EXT_PKEY;
757     MPI2BN(rtmp->e, e);
758     MPI2BN(rtmp->n, n);
759     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)
760         != HWCRYPTOHOOK_ERROR_MPISIZE) {
761         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
762         ERR_add_error_data(1, rmsg.buf);
763         goto err;
764     }
765
766     bn_expand2(rtmp->e, e.size / sizeof(BN_ULONG));
767     bn_expand2(rtmp->n, n.size / sizeof(BN_ULONG));
768     MPI2BN(rtmp->e, e);
769     MPI2BN(rtmp->n, n);
770
771     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)) {
772         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
773         ERR_add_error_data(1, rmsg.buf);
774         goto err;
775     }
776     rtmp->e->top = e.size / sizeof(BN_ULONG);
777     bn_fix_top(rtmp->e);
778     rtmp->n->top = n.size / sizeof(BN_ULONG);
779     bn_fix_top(rtmp->n);
780
781     res = EVP_PKEY_new();
782     if (res == NULL) {
783         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
784         goto err;
785     }
786     EVP_PKEY_assign_RSA(res, rtmp);
787 #  endif
788
789     if (res == NULL)
790         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY,
791                   HWCRHK_R_PRIVATE_KEY_ALGORITHMS_DISABLED);
792
793     return res;
794  err:
795 #  ifndef OPENSSL_NO_RSA
796     RSA_free(rtmp);
797 #  endif
798     return NULL;
799 }
800
801 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
802                                     UI_METHOD *ui_method, void *callback_data)
803 {
804     EVP_PKEY *res = NULL;
805
806 #  ifndef OPENSSL_NO_RSA
807     res = hwcrhk_load_privkey(eng, key_id, ui_method, callback_data);
808 #  endif
809
810     if (res)
811         switch (res->type) {
812 #  ifndef OPENSSL_NO_RSA
813         case EVP_PKEY_RSA:
814             {
815                 RSA *rsa = NULL;
816
817                 CRYPTO_THREAD_write_lock(chil_lock);
818                 rsa = res->pkey.rsa;
819                 res->pkey.rsa = RSA_new();
820                 res->pkey.rsa->n = rsa->n;
821                 res->pkey.rsa->e = rsa->e;
822                 rsa->n = NULL;
823                 rsa->e = NULL;
824                 CRYPTO_THREAD_unlock(chil_lock);
825                 RSA_free(rsa);
826             }
827             break;
828 #  endif
829         default:
830             HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PUBKEY,
831                       HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
832             goto err;
833         }
834
835     return res;
836  err:
837     EVP_PKEY_free(res);
838     return NULL;
839 }
840
841 /* A little mod_exp */
842 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
843                           const BIGNUM *m, BN_CTX *ctx)
844 {
845     char tempbuf[1024];
846     HWCryptoHook_ErrMsgBuf rmsg;
847     /*
848      * Since HWCryptoHook_MPI is pretty compatible with BIGNUM's, we use them
849      * directly, plus a little macro magic.  We only thing we need to make
850      * sure of is that enough space is allocated.
851      */
852     HWCryptoHook_MPI m_a, m_p, m_n, m_r;
853     int to_return, ret;
854
855     to_return = 0;              /* expect failure */
856     rmsg.buf = tempbuf;
857     rmsg.size = sizeof(tempbuf);
858
859     if (!hwcrhk_context) {
860         HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
861         goto err;
862     }
863     /* Prepare the params */
864     bn_expand2(r, m->top);      /* Check for error !! */
865     BN2MPI(m_a, a);
866     BN2MPI(m_p, p);
867     BN2MPI(m_n, m);
868     MPI2BN(r, m_r);
869
870     /* Perform the operation */
871     ret = p_hwcrhk_ModExp(hwcrhk_context, m_a, m_p, m_n, &m_r, &rmsg);
872
873     /* Convert the response */
874     r->top = m_r.size / sizeof(BN_ULONG);
875     bn_fix_top(r);
876
877     if (ret < 0) {
878         /*
879          * FIXME: When this error is returned, HWCryptoHook is telling us
880          * that falling back to software computation might be a good thing.
881          */
882         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
883             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FALLBACK);
884         } else {
885             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FAILED);
886         }
887         ERR_add_error_data(1, rmsg.buf);
888         goto err;
889     }
890
891     to_return = 1;
892  err:
893     return to_return;
894 }
895
896 #  ifndef OPENSSL_NO_RSA
897 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
898                               BN_CTX *ctx)
899 {
900     char tempbuf[1024];
901     HWCryptoHook_ErrMsgBuf rmsg;
902     HWCryptoHook_RSAKeyHandle *hptr;
903     int to_return = 0, ret;
904
905     rmsg.buf = tempbuf;
906     rmsg.size = sizeof(tempbuf);
907
908     if (!hwcrhk_context) {
909         HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
910         goto err;
911     }
912
913     /*
914      * This provides support for nForce keys.  Since that's opaque data all
915      * we do is provide a handle to the proper key and let HWCryptoHook take
916      * care of the rest.
917      */
918     if ((hptr =
919          (HWCryptoHook_RSAKeyHandle *) RSA_get_ex_data(rsa, hndidx_rsa))
920         != NULL) {
921         HWCryptoHook_MPI m_a, m_r;
922
923         if (!rsa->n) {
924             HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
925                       HWCRHK_R_MISSING_KEY_COMPONENTS);
926             goto err;
927         }
928
929         /* Prepare the params */
930         bn_expand2(r, rsa->n->top); /* Check for error !! */
931         BN2MPI(m_a, I);
932         MPI2BN(r, m_r);
933
934         /* Perform the operation */
935         ret = p_hwcrhk_RSA(m_a, *hptr, &m_r, &rmsg);
936
937         /* Convert the response */
938         r->top = m_r.size / sizeof(BN_ULONG);
939         bn_fix_top(r);
940
941         if (ret < 0) {
942             /*
943              * FIXME: When this error is returned, HWCryptoHook is telling us
944              * that falling back to software computation might be a good
945              * thing.
946              */
947             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
948                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
949                           HWCRHK_R_REQUEST_FALLBACK);
950             } else {
951                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
952                           HWCRHK_R_REQUEST_FAILED);
953             }
954             ERR_add_error_data(1, rmsg.buf);
955             goto err;
956         }
957     } else {
958         HWCryptoHook_MPI m_a, m_p, m_q, m_dmp1, m_dmq1, m_iqmp, m_r;
959
960         if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
961             HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
962                       HWCRHK_R_MISSING_KEY_COMPONENTS);
963             goto err;
964         }
965
966         /* Prepare the params */
967         bn_expand2(r, rsa->n->top); /* Check for error !! */
968         BN2MPI(m_a, I);
969         BN2MPI(m_p, rsa->p);
970         BN2MPI(m_q, rsa->q);
971         BN2MPI(m_dmp1, rsa->dmp1);
972         BN2MPI(m_dmq1, rsa->dmq1);
973         BN2MPI(m_iqmp, rsa->iqmp);
974         MPI2BN(r, m_r);
975
976         /* Perform the operation */
977         ret = p_hwcrhk_ModExpCRT(hwcrhk_context, m_a, m_p, m_q,
978                                  m_dmp1, m_dmq1, m_iqmp, &m_r, &rmsg);
979
980         /* Convert the response */
981         r->top = m_r.size / sizeof(BN_ULONG);
982         bn_fix_top(r);
983
984         if (ret < 0) {
985             /*
986              * FIXME: When this error is returned, HWCryptoHook is telling us
987              * that falling back to software computation might be a good
988              * thing.
989              */
990             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
991                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
992                           HWCRHK_R_REQUEST_FALLBACK);
993             } else {
994                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
995                           HWCRHK_R_REQUEST_FAILED);
996             }
997             ERR_add_error_data(1, rmsg.buf);
998             goto err;
999         }
1000     }
1001     /*
1002      * If we're here, we must be here with some semblance of success :-)
1003      */
1004     to_return = 1;
1005  err:
1006     return to_return;
1007 }
1008 #  endif
1009
1010 #  ifndef OPENSSL_NO_RSA
1011 /* This function is aliased to mod_exp (with the mont stuff dropped). */
1012 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1013                                const BIGNUM *m, BN_CTX *ctx,
1014                                BN_MONT_CTX *m_ctx)
1015 {
1016     return hwcrhk_mod_exp(r, a, p, m, ctx);
1017 }
1018
1019 static int hwcrhk_rsa_finish(RSA *rsa)
1020 {
1021     HWCryptoHook_RSAKeyHandle *hptr;
1022
1023     hptr = RSA_get_ex_data(rsa, hndidx_rsa);
1024     if (hptr) {
1025         p_hwcrhk_RSAUnloadKey(*hptr, NULL);
1026         OPENSSL_free(hptr);
1027         RSA_set_ex_data(rsa, hndidx_rsa, NULL);
1028     }
1029     return 1;
1030 }
1031
1032 #  endif
1033
1034 #  ifndef OPENSSL_NO_DH
1035 /* This function is aliased to mod_exp (with the dh and mont dropped). */
1036 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
1037                              const BIGNUM *a, const BIGNUM *p,
1038                              const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
1039 {
1040     return hwcrhk_mod_exp(r, a, p, m, ctx);
1041 }
1042 #  endif
1043
1044 /* Random bytes are good */
1045 static int hwcrhk_rand_bytes(unsigned char *buf, int num)
1046 {
1047     char tempbuf[1024];
1048     HWCryptoHook_ErrMsgBuf rmsg;
1049     int to_return = 0;          /* assume failure */
1050     int ret;
1051
1052     rmsg.buf = tempbuf;
1053     rmsg.size = sizeof(tempbuf);
1054
1055     if (!hwcrhk_context) {
1056         HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_NOT_INITIALISED);
1057         goto err;
1058     }
1059
1060     ret = p_hwcrhk_RandomBytes(hwcrhk_context, buf, num, &rmsg);
1061     if (ret < 0) {
1062         /*
1063          * FIXME: When this error is returned, HWCryptoHook is telling us
1064          * that falling back to software computation might be a good thing.
1065          */
1066         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1067             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FALLBACK);
1068         } else {
1069             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FAILED);
1070         }
1071         ERR_add_error_data(1, rmsg.buf);
1072         goto err;
1073     }
1074     to_return = 1;
1075  err:
1076     return to_return;
1077 }
1078
1079 static int hwcrhk_rand_status(void)
1080 {
1081     return 1;
1082 }
1083
1084 /*
1085  * Mutex calls: since the HWCryptoHook model closely follows the POSIX model
1086  * these just wrap the POSIX functions and add some logging.
1087  */
1088
1089 static int hwcrhk_mutex_init(HWCryptoHook_Mutex * mt,
1090                              HWCryptoHook_CallerContext * cactx)
1091 {
1092     mt->lock = CRYPTO_THREAD_lock_new();
1093     if (mt->lock == NULL) {
1094         HWCRHKerr(HWCRHK_F_HWCRHK_MUTEX_INIT, ERR_R_MALLOC_FAILURE);
1095         return 1;               /* failure */
1096     }
1097     return 0;                   /* success */
1098 }
1099
1100 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex * mt)
1101 {
1102     CRYPTO_THREAD_write_lock(mt->lock);
1103     return 0;
1104 }
1105
1106 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex * mt)
1107 {
1108     CRYPTO_THREAD_unlock(mt->lock);
1109 }
1110
1111 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex * mt)
1112 {
1113     CRYPTO_THREAD_lock_free(mt->lock);
1114 }
1115
1116 static int hwcrhk_get_pass(const char *prompt_info,
1117                            int *len_io, char *buf,
1118                            HWCryptoHook_PassphraseContext * ppctx,
1119                            HWCryptoHook_CallerContext * cactx)
1120 {
1121     pem_password_cb *callback = NULL;
1122     void *callback_data = NULL;
1123     UI_METHOD *ui_method = NULL;
1124     /*
1125      * Despite what the documentation says prompt_info can be an empty
1126      * string.
1127      */
1128     if (prompt_info && !*prompt_info)
1129         prompt_info = NULL;
1130
1131     if (cactx) {
1132         if (cactx->ui_method)
1133             ui_method = cactx->ui_method;
1134         if (cactx->password_callback)
1135             callback = cactx->password_callback;
1136         if (cactx->callback_data)
1137             callback_data = cactx->callback_data;
1138     }
1139     if (ppctx) {
1140         if (ppctx->ui_method) {
1141             ui_method = ppctx->ui_method;
1142             callback = NULL;
1143         }
1144         if (ppctx->callback_data)
1145             callback_data = ppctx->callback_data;
1146     }
1147     if (callback == NULL && ui_method == NULL) {
1148         HWCRHKerr(HWCRHK_F_HWCRHK_GET_PASS, HWCRHK_R_NO_CALLBACK);
1149         return -1;
1150     }
1151
1152     if (ui_method) {
1153         UI *ui = UI_new_method(ui_method);
1154         if (ui) {
1155             int ok;
1156             char *prompt = UI_construct_prompt(ui,
1157                                                "pass phrase", prompt_info);
1158
1159             ok = UI_add_input_string(ui, prompt,
1160                                      UI_INPUT_FLAG_DEFAULT_PWD,
1161                                      buf, 0, (*len_io) - 1);
1162             UI_add_user_data(ui, callback_data);
1163             UI_ctrl(ui, UI_CTRL_PRINT_ERRORS, 1, 0, 0);
1164
1165             if (ok >= 0)
1166                 do {
1167                     ok = UI_process(ui);
1168                 }
1169                 while (ok < 0 && UI_ctrl(ui, UI_CTRL_IS_REDOABLE, 0, 0, 0));
1170
1171             if (ok >= 0)
1172                 *len_io = strlen(buf);
1173
1174             UI_free(ui);
1175             OPENSSL_free(prompt);
1176         }
1177     } else {
1178         *len_io = callback(buf, *len_io, 0, callback_data);
1179     }
1180     if (!*len_io)
1181         return -1;
1182     return 0;
1183 }
1184
1185 static int hwcrhk_insert_card(const char *prompt_info,
1186                               const char *wrong_info,
1187                               HWCryptoHook_PassphraseContext * ppctx,
1188                               HWCryptoHook_CallerContext * cactx)
1189 {
1190     int ok = -1;
1191     UI *ui;
1192     void *callback_data = NULL;
1193     UI_METHOD *ui_method = NULL;
1194
1195     if (cactx) {
1196         if (cactx->ui_method)
1197             ui_method = cactx->ui_method;
1198         if (cactx->callback_data)
1199             callback_data = cactx->callback_data;
1200     }
1201     if (ppctx) {
1202         if (ppctx->ui_method)
1203             ui_method = ppctx->ui_method;
1204         if (ppctx->callback_data)
1205             callback_data = ppctx->callback_data;
1206     }
1207     if (ui_method == NULL) {
1208         HWCRHKerr(HWCRHK_F_HWCRHK_INSERT_CARD, HWCRHK_R_NO_CALLBACK);
1209         return -1;
1210     }
1211
1212     ui = UI_new_method(ui_method);
1213
1214     if (ui) {
1215         char answer = '\0';
1216         char buf[BUFSIZ];
1217         /*
1218          * Despite what the documentation says wrong_info can be an empty
1219          * string.
1220          */
1221         if (wrong_info && *wrong_info)
1222             BIO_snprintf(buf, sizeof(buf) - 1,
1223                          "Current card: \"%s\"\n", wrong_info);
1224         else
1225             buf[0] = 0;
1226         ok = UI_dup_info_string(ui, buf);
1227         if (ok >= 0 && prompt_info) {
1228             BIO_snprintf(buf, sizeof(buf) - 1,
1229                          "Insert card \"%s\"", prompt_info);
1230             ok = UI_dup_input_boolean(ui, buf,
1231                                       "\n then hit <enter> or C<enter> to cancel\n",
1232                                       "\r\n", "Cc", UI_INPUT_FLAG_ECHO,
1233                                       &answer);
1234         }
1235         UI_add_user_data(ui, callback_data);
1236
1237         if (ok >= 0)
1238             ok = UI_process(ui);
1239         UI_free(ui);
1240
1241         if (ok == -2 || (ok >= 0 && answer == 'C'))
1242             ok = 1;
1243         else if (ok < 0)
1244             ok = -1;
1245         else
1246             ok = 0;
1247     }
1248     return ok;
1249 }
1250
1251 static void hwcrhk_log_message(void *logstr, const char *message)
1252 {
1253     BIO *lstream = NULL;
1254
1255     if (logstr)
1256         lstream = *(BIO **)logstr;
1257     if (lstream) {
1258         BIO_printf(lstream, "%s\n", message);
1259     }
1260 }
1261
1262 /*
1263  * This stuff is needed if this ENGINE is being compiled into a
1264  * self-contained shared-library.
1265  */
1266 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1267 static int bind_fn(ENGINE *e, const char *id)
1268 {
1269     if (id && (strcmp(id, engine_hwcrhk_id) != 0) &&
1270         (strcmp(id, engine_hwcrhk_id_alt) != 0))
1271         return 0;
1272     if (!bind_helper(e))
1273         return 0;
1274     return 1;
1275 }
1276
1277 IMPLEMENT_DYNAMIC_CHECK_FN()
1278     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1279 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1280 # endif                         /* !OPENSSL_NO_HW_CHIL */
1281 #endif                          /* !OPENSSL_NO_HW */