2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2008 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
57 #include <openssl/crypto.h>
58 #include <openssl/buffer.h>
59 #include <openssl/rsa.h>
60 #include <openssl/bn.h>
62 #ifdef OPENSSL_SYS_WIN32
63 #ifndef OPENSSL_NO_CAPIENG
65 #if _WIN32_WINNT < 0x0500
66 #define _WIN32_WINNT 0x0500
72 #undef X509_EXTENSIONS
75 #include <openssl/engine.h>
76 #include <openssl/pem.h>
78 #include "e_capi_err.h"
79 #include "e_capi_err.c"
82 static const char *engine_capi_id = "capi";
83 static const char *engine_capi_name = "CryptoAPI ENGINE";
85 typedef struct CAPI_CTX_st CAPI_CTX;
86 typedef struct CAPI_KEY_st CAPI_KEY;
88 static void capi_addlasterror(void);
89 static void capi_adderror(DWORD err);
91 static void CAPI_trace(CAPI_CTX *ctx, char *format, ...);
93 static int capi_list_providers(CAPI_CTX *ctx, BIO *out);
94 static int capi_list_containers(CAPI_CTX *ctx, BIO *out);
95 int capi_list_certs(CAPI_CTX *ctx, BIO *out, char *storename);
96 void capi_free_key(CAPI_KEY *key);
97 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
99 static PCCERT_CONTEXT capi_find_cert(CAPI_CTX *ctx, const char *id, HCERTSTORE hstore);
101 CAPI_KEY *capi_find_key(CAPI_CTX *ctx, const char *id);
103 static EVP_PKEY *capi_load_privkey(ENGINE *eng, const char *key_id,
104 UI_METHOD *ui_method, void *callback_data);
105 static int capi_rsa_sign(int dtype, const unsigned char *m, unsigned int m_len,
106 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
107 static int capi_rsa_priv_enc(int flen, const unsigned char *from,
108 unsigned char *to, RSA *rsa, int padding);
109 static int capi_rsa_priv_dec(int flen, const unsigned char *from,
110 unsigned char *to, RSA *rsa, int padding);
111 static int capi_rsa_free(RSA *rsa);
113 static DSA_SIG *capi_dsa_do_sign(const unsigned char *digest, int dlen,
115 static int capi_dsa_free(DSA *dsa);
117 static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
118 STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey,
119 STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data);
121 /* This structure contains CAPI ENGINE specific data:
122 * it contains various global options and affects how
123 * other functions behave.
126 #define CAPI_DBG_TRACE 2
127 #define CAPI_DBG_ERROR 1
132 /* Parameters to use for container lookup */
136 /* Certificate store name to use */
138 LPTSTR ssl_client_store;
140 /* Lookup string meanings in load_private_key */
141 /* Substring of subject: uses "storename" */
142 #define CAPI_LU_SUBSTR 0
143 /* Friendly name: uses storename */
144 #define CAPI_LU_FNAME 1
145 /* Container name: uses cspname, keytype */
146 #define CAPI_LU_CONTNAME 2
148 /* Info to dump with dumpcerts option */
149 /* Issuer and serial name strings */
150 #define CAPI_DMP_SUMMARY 0x1
152 #define CAPI_DMP_FNAME 0x2
153 /* Full X509_print dump */
154 #define CAPI_DMP_FULL 0x4
155 /* Dump PEM format certificate */
156 #define CAPI_DMP_PEM 0x8
157 /* Dump pseudo key (if possible) */
158 #define CAPI_DMP_PSKEY 0x10
159 /* Dump key info (if possible) */
160 #define CAPI_DMP_PKEYINFO 0x20
166 static CAPI_CTX *capi_ctx_new();
167 static void capi_ctx_free(CAPI_CTX *ctx);
168 static int capi_ctx_set_provname(CAPI_CTX *ctx, LPSTR pname, DWORD type, int check);
169 static int capi_ctx_set_provname_idx(CAPI_CTX *ctx, int idx);
171 #define CAPI_CMD_LIST_CERTS ENGINE_CMD_BASE
172 #define CAPI_CMD_LOOKUP_CERT (ENGINE_CMD_BASE + 1)
173 #define CAPI_CMD_DEBUG_LEVEL (ENGINE_CMD_BASE + 2)
174 #define CAPI_CMD_DEBUG_FILE (ENGINE_CMD_BASE + 3)
175 #define CAPI_CMD_KEYTYPE (ENGINE_CMD_BASE + 4)
176 #define CAPI_CMD_LIST_CSPS (ENGINE_CMD_BASE + 5)
177 #define CAPI_CMD_SET_CSP_IDX (ENGINE_CMD_BASE + 6)
178 #define CAPI_CMD_SET_CSP_NAME (ENGINE_CMD_BASE + 7)
179 #define CAPI_CMD_SET_CSP_TYPE (ENGINE_CMD_BASE + 8)
180 #define CAPI_CMD_LIST_CONTAINERS (ENGINE_CMD_BASE + 9)
181 #define CAPI_CMD_LIST_OPTIONS (ENGINE_CMD_BASE + 10)
182 #define CAPI_CMD_LOOKUP_METHOD (ENGINE_CMD_BASE + 11)
183 #define CAPI_CMD_STORE_NAME (ENGINE_CMD_BASE + 12)
185 static const ENGINE_CMD_DEFN capi_cmd_defns[] = {
186 {CAPI_CMD_LIST_CERTS,
188 "List all certificates in store",
189 ENGINE_CMD_FLAG_NO_INPUT},
190 {CAPI_CMD_LOOKUP_CERT,
192 "Lookup and output certificates",
193 ENGINE_CMD_FLAG_STRING},
194 {CAPI_CMD_DEBUG_LEVEL,
196 "debug level (1=errors, 2=trace)",
197 ENGINE_CMD_FLAG_NUMERIC},
198 {CAPI_CMD_DEBUG_FILE,
200 "debugging filename)",
201 ENGINE_CMD_FLAG_STRING},
204 "Key type: 1=AT_KEYEXCHANGE (default), 2=AT_SIGNATURE",
205 ENGINE_CMD_FLAG_NUMERIC},
209 ENGINE_CMD_FLAG_NO_INPUT},
210 {CAPI_CMD_SET_CSP_IDX,
213 ENGINE_CMD_FLAG_NUMERIC},
214 {CAPI_CMD_SET_CSP_NAME,
216 "Set CSP name, (default CSP used if not specified)",
217 ENGINE_CMD_FLAG_STRING},
218 {CAPI_CMD_SET_CSP_TYPE,
220 "Set CSP type, (default RSA_PROV_FULL)",
221 ENGINE_CMD_FLAG_NUMERIC},
222 {CAPI_CMD_LIST_CONTAINERS,
224 "list container names",
225 ENGINE_CMD_FLAG_NO_INPUT},
226 {CAPI_CMD_LIST_OPTIONS,
228 "Set list options (1=summary,2=friendly name, 4=full printout, 8=PEM output, 16=XXX, "
229 "32=private key info)",
230 ENGINE_CMD_FLAG_NUMERIC},
231 {CAPI_CMD_LOOKUP_METHOD,
233 "Set key lookup method (1=substring, 2=friendlyname, 3=container name)",
234 ENGINE_CMD_FLAG_NUMERIC},
235 {CAPI_CMD_STORE_NAME,
237 "certificate store name, default \"MY\"",
238 ENGINE_CMD_FLAG_STRING},
243 static int capi_idx = -1;
244 static int rsa_capi_idx = -1;
245 static int dsa_capi_idx = -1;
246 static int cert_capi_idx = -1;
248 static int capi_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
255 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_ENGINE_NOT_INITIALIZED);
258 ctx = ENGINE_get_ex_data(e, capi_idx);
259 out = BIO_new_fp(stdout, BIO_NOCLOSE);
262 case CAPI_CMD_LIST_CSPS:
263 ret = capi_list_providers(ctx, out);
266 case CAPI_CMD_LIST_CERTS:
267 ret = capi_list_certs(ctx, out, NULL);
270 case CAPI_CMD_LOOKUP_CERT:
271 ret = capi_list_certs(ctx, out, p);
274 case CAPI_CMD_LIST_CONTAINERS:
275 ret = capi_list_containers(ctx, out);
278 case CAPI_CMD_STORE_NAME:
280 OPENSSL_free(ctx->storename);
281 ctx->storename = BUF_strdup(p);
282 CAPI_trace(ctx, "Setting store name to %s\n", p);
285 case CAPI_CMD_DEBUG_LEVEL:
286 ctx->debug_level = (int)i;
287 CAPI_trace(ctx, "Setting debug level to %d\n", ctx->debug_level);
290 case CAPI_CMD_DEBUG_FILE:
291 ctx->debug_file = BUF_strdup(p);
292 CAPI_trace(ctx, "Setting debug file to %s\n", ctx->debug_file);
295 case CAPI_CMD_KEYTYPE:
297 CAPI_trace(ctx, "Setting key type to %d\n", ctx->keytype);
300 case CAPI_CMD_SET_CSP_IDX:
301 ret = capi_ctx_set_provname_idx(ctx, i);
304 case CAPI_CMD_LIST_OPTIONS:
308 case CAPI_CMD_LOOKUP_METHOD:
311 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_INVALID_LOOKUP_METHOD);
314 ctx->lookup_method = i;
317 case CAPI_CMD_SET_CSP_NAME:
318 ret = capi_ctx_set_provname(ctx, p, ctx->csptype, 1);
321 case CAPI_CMD_SET_CSP_TYPE:
326 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_UNKNOWN_COMMAND);
335 static RSA_METHOD capi_rsa_method =
337 "CryptoAPI RSA method",
340 capi_rsa_priv_enc, /* priv_enc */
341 capi_rsa_priv_dec, /* priv_dec */
345 capi_rsa_free, /* finish */
346 RSA_FLAG_SIGN_VER, /* flags */
348 capi_rsa_sign, /* rsa_sign */
352 static DSA_METHOD capi_dsa_method =
354 "CryptoAPI DSA method",
355 capi_dsa_do_sign, /* dsa_do_sign */
356 0, /* dsa_sign_setup */
357 0, /* dsa_do_verify */
361 capi_dsa_free, /* finish */
364 0, /* dsa_paramgen */
368 static int capi_init(ENGINE *e)
371 const RSA_METHOD *ossl_rsa_meth;
372 const DSA_METHOD *ossl_dsa_meth;
373 capi_idx = ENGINE_get_ex_new_index(0, NULL, NULL, NULL, 0);
374 cert_capi_idx = X509_get_ex_new_index(0, NULL, NULL, NULL, 0);
376 ctx = capi_ctx_new();
377 if (!ctx || (capi_idx < 0))
380 ENGINE_set_ex_data(e, capi_idx, ctx);
381 /* Setup RSA_METHOD */
382 rsa_capi_idx = RSA_get_ex_new_index(0, NULL, NULL, NULL, 0);
383 ossl_rsa_meth = RSA_PKCS1_SSLeay();
384 capi_rsa_method.rsa_pub_enc = ossl_rsa_meth->rsa_pub_enc;
385 capi_rsa_method.rsa_pub_dec = ossl_rsa_meth->rsa_pub_dec;
386 capi_rsa_method.rsa_mod_exp = ossl_rsa_meth->rsa_mod_exp;
387 capi_rsa_method.bn_mod_exp = ossl_rsa_meth->bn_mod_exp;
389 /* Setup DSA Method */
390 dsa_capi_idx = DSA_get_ex_new_index(0, NULL, NULL, NULL, 0);
391 ossl_dsa_meth = DSA_OpenSSL();
392 capi_dsa_method.dsa_do_verify = ossl_dsa_meth->dsa_do_verify;
393 capi_dsa_method.dsa_mod_exp = ossl_dsa_meth->dsa_mod_exp;
394 capi_dsa_method.bn_mod_exp = ossl_dsa_meth->bn_mod_exp;
399 CAPIerr(CAPI_F_CAPI_INIT, ERR_R_MALLOC_FAILURE);
405 static int capi_destroy(ENGINE *e)
407 ERR_unload_CAPI_strings();
411 static int capi_finish(ENGINE *e)
414 ctx = ENGINE_get_ex_data(e, capi_idx);
416 ENGINE_set_ex_data(e, capi_idx, NULL);
421 /* CryptoAPI key application data. This contains
422 * a handle to the private key container (for sign operations)
423 * and a handle to the key (for decrypt operations).
428 /* Associated certificate context (if any) */
429 PCCERT_CONTEXT pcert;
435 static int bind_capi(ENGINE *e)
437 if (!ENGINE_set_id(e, engine_capi_id)
438 || !ENGINE_set_name(e, engine_capi_name)
439 || !ENGINE_set_init_function(e, capi_init)
440 || !ENGINE_set_finish_function(e, capi_finish)
441 || !ENGINE_set_destroy_function(e, capi_destroy)
442 || !ENGINE_set_RSA(e, &capi_rsa_method)
443 || !ENGINE_set_DSA(e, &capi_dsa_method)
444 || !ENGINE_set_load_privkey_function(e, capi_load_privkey)
445 || !ENGINE_set_load_ssl_client_cert_function(e,
446 capi_load_ssl_client_cert)
447 || !ENGINE_set_cmd_defns(e, capi_cmd_defns)
448 || !ENGINE_set_ctrl_function(e, capi_ctrl))
450 ERR_load_CAPI_strings();
456 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
457 static int bind_helper(ENGINE *e, const char *id)
459 if(id && (strcmp(id, engine_capi_id) != 0))
465 IMPLEMENT_DYNAMIC_CHECK_FN()
466 IMPLEMENT_DYNAMIC_BIND_FN(bind_helper)
468 static ENGINE *engine_capi(void)
470 ENGINE *ret = ENGINE_new();
481 void ENGINE_load_capi(void)
483 /* Copied from eng_[openssl|dyn].c */
484 ENGINE *toadd = engine_capi();
493 static int lend_tobn(BIGNUM *bn, unsigned char *bin, int binlen)
496 /* Reverse buffer in place: since this is a keyblob structure
497 * that will be freed up after conversion anyway it doesn't
498 * matter if we change it.
500 for(i = 0; i < binlen / 2; i++)
504 bin[i] = bin[binlen - i - 1];
505 bin[binlen - i - 1] = c;
508 if (!BN_bin2bn(bin, binlen, bn))
513 /* Given a CAPI_KEY get an EVP_PKEY structure */
515 static EVP_PKEY *capi_get_pkey(ENGINE *eng, CAPI_KEY *key)
517 unsigned char *pubkey = NULL;
522 EVP_PKEY *ret = NULL;
523 if (!CryptExportKey(key->key, 0, PUBLICKEYBLOB, 0, NULL, &len))
525 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_PUBKEY_EXPORT_LENGTH_ERROR);
530 pubkey = OPENSSL_malloc(len);
535 if (!CryptExportKey(key->key, 0, PUBLICKEYBLOB, 0, pubkey, &len))
537 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_PUBKEY_EXPORT_ERROR);
542 bh = (BLOBHEADER *)pubkey;
543 if (bh->bType != PUBLICKEYBLOB)
545 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_PUBLIC_KEY_BLOB);
548 if (bh->aiKeyAlg == CALG_RSA_SIGN || bh->aiKeyAlg == CALG_RSA_KEYX)
552 unsigned char *rsa_modulus;
553 rp = (RSAPUBKEY *)(bh + 1);
554 if (rp->magic != 0x31415352)
557 BIO_snprintf(magstr, 10, "%lx", rp->magic);
558 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_RSA_PUBLIC_KEY_BLOB_MAGIC_NUMBER);
559 ERR_add_error_data(2, "magic=0x", magstr);
562 rsa_modulus = (unsigned char *)(rp + 1);
563 rkey = RSA_new_method(eng);
570 if (!rkey->e || !rkey->n)
573 if (!BN_set_word(rkey->e, rp->pubexp))
576 rsa_modlen = rp->bitlen / 8;
577 if (!lend_tobn(rkey->n, rsa_modulus, rsa_modlen))
580 RSA_set_ex_data(rkey, rsa_capi_idx, key);
582 if (!(ret = EVP_PKEY_new()))
585 EVP_PKEY_assign_RSA(ret, rkey);
589 else if (bh->aiKeyAlg == CALG_DSS_SIGN)
594 dp = (DSSPUBKEY *)(bh + 1);
595 if (dp->magic != 0x31535344)
598 BIO_snprintf(magstr, 10, "%lx", dp->magic);
599 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_DSA_PUBLIC_KEY_BLOB_MAGIC_NUMBER);
600 ERR_add_error_data(2, "magic=0x", magstr);
603 dsa_plen = dp->bitlen / 8;
604 btmp = (unsigned char *)(dp + 1);
605 dkey = DSA_new_method(eng);
611 dkey->pub_key = BN_new();
612 if (!dkey->p || !dkey->q || !dkey->g || !dkey->pub_key)
614 if (!lend_tobn(dkey->p, btmp, dsa_plen))
617 if (!lend_tobn(dkey->q, btmp, 20))
620 if (!lend_tobn(dkey->g, btmp, dsa_plen))
623 if (!lend_tobn(dkey->pub_key, btmp, dsa_plen))
627 DSA_set_ex_data(dkey, dsa_capi_idx, key);
629 if (!(ret = EVP_PKEY_new()))
632 EVP_PKEY_assign_DSA(ret, dkey);
638 BIO_snprintf(algstr, 10, "%lx", bh->aiKeyAlg);
639 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_UNSUPPORTED_PUBLIC_KEY_ALGORITHM);
640 ERR_add_error_data(2, "aiKeyAlg=0x", algstr);
647 OPENSSL_free(pubkey);
659 CAPIerr(CAPI_F_CAPI_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
664 static EVP_PKEY *capi_load_privkey(ENGINE *eng, const char *key_id,
665 UI_METHOD *ui_method, void *callback_data)
670 ctx = ENGINE_get_ex_data(eng, capi_idx);
674 CAPIerr(CAPI_F_CAPI_LOAD_PRIVKEY, CAPI_R_CANT_FIND_CAPI_CONTEXT);
678 key = capi_find_key(ctx, key_id);
683 ret = capi_get_pkey(eng, key);
691 /* CryptoAPI RSA operations */
693 int capi_rsa_priv_enc(int flen, const unsigned char *from,
694 unsigned char *to, RSA *rsa, int padding)
696 CAPIerr(CAPI_F_CAPI_RSA_PRIV_ENC, CAPI_R_FUNCTION_NOT_SUPPORTED);
700 int capi_rsa_sign(int dtype, const unsigned char *m, unsigned int m_len,
701 unsigned char *sigret, unsigned int *siglen, const RSA *rsa)
711 ctx = ENGINE_get_ex_data(rsa->engine, capi_idx);
713 CAPI_trace(ctx, "Called CAPI_rsa_sign()\n");
715 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
718 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_GET_KEY);
721 /* Convert the signature type to a CryptoAPI algorithm ID */
733 alg = CALG_SSL3_SHAMD5;
738 BIO_snprintf(algstr, 10, "%lx", dtype);
739 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_UNSUPPORTED_ALGORITHM_NID);
740 ERR_add_error_data(2, "NID=0x", algstr);
747 /* Create the hash object */
748 if(!CryptCreateHash(capi_key->hprov, alg, 0, 0, &hash))
750 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_CREATE_HASH_OBJECT);
754 /* Set the hash value to the value passed */
756 if(!CryptSetHashParam(hash, HP_HASHVAL, (unsigned char *)m, 0))
758 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_SET_HASH_VALUE);
764 /* Finally sign it */
765 slen = RSA_size(rsa);
766 if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, sigret, &slen))
768 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_ERROR_SIGNING_HASH);
775 /* Inplace byte reversal of signature */
776 for(i = 0; i < slen / 2; i++)
780 sigret[i] = sigret[slen - i - 1];
781 sigret[slen - i - 1] = c;
789 CryptDestroyHash(hash);
794 int capi_rsa_priv_dec(int flen, const unsigned char *from,
795 unsigned char *to, RSA *rsa, int padding)
798 unsigned char *tmpbuf;
801 ctx = ENGINE_get_ex_data(rsa->engine, capi_idx);
803 CAPI_trace(ctx, "Called capi_rsa_priv_dec()\n");
806 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
809 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_CANT_GET_KEY);
813 if(padding != RSA_PKCS1_PADDING)
816 BIO_snprintf(errstr, 10, "%d", padding);
817 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_UNSUPPORTED_PADDING);
818 ERR_add_error_data(2, "padding=", errstr);
822 /* Create temp reverse order version of input */
823 if(!(tmpbuf = OPENSSL_malloc(flen)) )
825 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, ERR_R_MALLOC_FAILURE);
828 for(i = 0; i < flen; i++)
829 tmpbuf[flen - i - 1] = from[i];
831 /* Finally decrypt it */
832 if(!CryptDecrypt(capi_key->key, 0, TRUE, 0, tmpbuf, &flen))
834 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_DECRYPT_ERROR);
836 OPENSSL_free(tmpbuf);
839 else memcpy(to, tmpbuf, flen);
841 OPENSSL_free(tmpbuf);
846 static int capi_rsa_free(RSA *rsa)
849 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
850 capi_free_key(capi_key);
851 RSA_set_ex_data(rsa, rsa_capi_idx, 0);
855 /* CryptoAPI DSA operations */
857 static DSA_SIG *capi_dsa_do_sign(const unsigned char *digest, int dlen,
865 unsigned char csigbuf[40];
867 ctx = ENGINE_get_ex_data(dsa->engine, capi_idx);
869 CAPI_trace(ctx, "Called CAPI_dsa_do_sign()\n");
871 capi_key = DSA_get_ex_data(dsa, dsa_capi_idx);
875 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_GET_KEY);
881 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_INVALID_DIGEST_LENGTH);
885 /* Create the hash object */
886 if(!CryptCreateHash(capi_key->hprov, CALG_SHA1, 0, 0, &hash))
888 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_CREATE_HASH_OBJECT);
893 /* Set the hash value to the value passed */
894 if(!CryptSetHashParam(hash, HP_HASHVAL, (unsigned char *)digest, 0))
896 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_SET_HASH_VALUE);
902 /* Finally sign it */
903 slen = sizeof(csigbuf);
904 if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, csigbuf, &slen))
906 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_ERROR_SIGNING_HASH);
917 if (!ret->r || !ret->s)
919 if (!lend_tobn(ret->r, csigbuf, 20)
920 || !lend_tobn(ret->s, csigbuf + 20, 20))
931 OPENSSL_cleanse(csigbuf, 40);
932 CryptDestroyHash(hash);
936 static int capi_dsa_free(DSA *dsa)
939 capi_key = DSA_get_ex_data(dsa, dsa_capi_idx);
940 capi_free_key(capi_key);
941 DSA_set_ex_data(dsa, dsa_capi_idx, 0);
945 static void capi_vtrace(CAPI_CTX *ctx, int level, char *format, va_list argptr)
949 if (!ctx || (ctx->debug_level < level) || (!ctx->debug_file))
951 out = BIO_new_file(ctx->debug_file, "a+");
952 BIO_vprintf(out, format, argptr);
956 static void CAPI_trace(CAPI_CTX *ctx, char *format, ...)
959 va_start(args, format);
960 capi_vtrace(ctx, CAPI_DBG_TRACE, format, args);
964 static void capi_addlasterror(void)
966 capi_adderror(GetLastError());
969 static void capi_adderror(DWORD err)
972 BIO_snprintf(errstr, 10, "%lX", err);
973 ERR_add_error_data(2, "Error code= 0x", errstr);
976 static char *wide_to_asc(LPWSTR wstr)
981 str = OPENSSL_malloc(wcslen(wstr) + 1);
984 CAPIerr(CAPI_F_WIDE_TO_ASC, ERR_R_MALLOC_FAILURE);
987 sprintf(str, "%S", wstr);
991 static int capi_get_provname(CAPI_CTX *ctx, LPSTR *pname, DWORD *ptype, DWORD idx)
995 CAPI_trace(ctx, "capi_get_provname, index=%d\n", idx);
996 if (!CryptEnumProviders(idx, NULL, 0, ptype, NULL, &len))
998 err = GetLastError();
999 if (err == ERROR_NO_MORE_ITEMS)
1001 CAPIerr(CAPI_F_CAPI_GET_PROVNAME, CAPI_R_CRYPTENUMPROVIDERS_ERROR);
1005 name = OPENSSL_malloc(len);
1006 if (!CryptEnumProviders(idx, NULL, 0, ptype, name, &len))
1008 err = GetLastError();
1009 if (err == ERROR_NO_MORE_ITEMS)
1011 CAPIerr(CAPI_F_CAPI_GET_PROVNAME, CAPI_R_CRYPTENUMPROVIDERS_ERROR);
1016 CAPI_trace(ctx, "capi_get_provname, returned name=%s, type=%d\n", name, *ptype);
1021 static int capi_list_providers(CAPI_CTX *ctx, BIO *out)
1025 LPTSTR provname = NULL;
1026 CAPI_trace(ctx, "capi_list_providers\n");
1027 BIO_printf(out, "Available CSPs:\n");
1028 for(idx = 0; ; idx++)
1030 ret = capi_get_provname(ctx, &provname, &ptype, idx);
1035 BIO_printf(out, "%d. %s, type %d\n", idx, provname, ptype);
1036 OPENSSL_free(provname);
1041 static int capi_list_containers(CAPI_CTX *ctx, BIO *out)
1045 DWORD err, idx, flags, buflen = 0, clen;
1047 CAPI_trace(ctx, "Listing containers CSP=%s, type = %d\n", ctx->cspname, ctx->csptype);
1048 if (!CryptAcquireContext(&hprov, NULL, ctx->cspname, ctx->csptype, CRYPT_VERIFYCONTEXT))
1050 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1051 capi_addlasterror();
1054 if (!CryptGetProvParam(hprov, PP_ENUMCONTAINERS, NULL, &buflen, CRYPT_FIRST))
1056 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_ENUMCONTAINERS_ERROR);
1057 capi_addlasterror();
1060 CAPI_trace(ctx, "Got max container len %d\n", buflen);
1063 cname = OPENSSL_malloc(buflen);
1066 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, ERR_R_MALLOC_FAILURE);
1070 for (idx = 0;;idx++)
1076 flags = CRYPT_FIRST;
1079 if(!CryptGetProvParam(hprov, PP_ENUMCONTAINERS, cname, &clen, flags))
1081 err = GetLastError();
1082 if (err == ERROR_NO_MORE_ITEMS)
1084 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_ENUMCONTAINERS_ERROR);
1088 CAPI_trace(ctx, "Container name %s, len=%d, index=%d, flags=%d\n", cname, clen, idx, flags);
1089 if (!cname[0] && (clen == buflen))
1091 CAPI_trace(ctx, "Enumerate bug: using workaround\n");
1094 BIO_printf(out, "%d. %s\n", idx, cname);
1102 OPENSSL_free(cname);
1103 CryptReleaseContext(hprov, 0);
1108 CRYPT_KEY_PROV_INFO *capi_get_prov_info(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1111 CRYPT_KEY_PROV_INFO *pinfo;
1113 if(!CertGetCertificateContextProperty(cert, CERT_KEY_PROV_INFO_PROP_ID, NULL, &len))
1115 pinfo = OPENSSL_malloc(len);
1118 CAPIerr(CAPI_F_CAPI_GET_PROV_INFO, ERR_R_MALLOC_FAILURE);
1121 if(!CertGetCertificateContextProperty(cert, CERT_KEY_PROV_INFO_PROP_ID, pinfo, &len))
1123 CAPIerr(CAPI_F_CAPI_GET_PROV_INFO, CAPI_R_ERROR_GETTING_KEY_PROVIDER_INFO);
1124 capi_addlasterror();
1125 OPENSSL_free(pinfo);
1131 static void capi_dump_prov_info(CAPI_CTX *ctx, BIO *out, CRYPT_KEY_PROV_INFO *pinfo)
1133 char *provname = NULL, *contname = NULL;
1136 BIO_printf(out, " No Private Key\n");
1139 provname = wide_to_asc(pinfo->pwszProvName);
1140 contname = wide_to_asc(pinfo->pwszContainerName);
1141 if (!provname || !contname)
1144 BIO_printf(out, " Private Key Info:\n");
1145 BIO_printf(out, " Provider Name: %s, Provider Type %d\n", provname, pinfo->dwProvType);
1146 BIO_printf(out, " Container Name: %s, Key Type %d\n", contname, pinfo->dwKeySpec);
1149 OPENSSL_free(provname);
1151 OPENSSL_free(contname);
1154 char * capi_cert_get_fname(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1159 CAPI_trace(ctx, "capi_cert_get_fname\n");
1160 if (!CertGetCertificateContextProperty(cert, CERT_FRIENDLY_NAME_PROP_ID, NULL, &dlen))
1162 wfname = OPENSSL_malloc(dlen);
1163 if (CertGetCertificateContextProperty(cert, CERT_FRIENDLY_NAME_PROP_ID, wfname, &dlen))
1165 char *fname = wide_to_asc(wfname);
1166 OPENSSL_free(wfname);
1169 CAPIerr(CAPI_F_CAPI_CERT_GET_FNAME, CAPI_R_ERROR_GETTING_FRIENDLY_NAME);
1170 capi_addlasterror();
1172 OPENSSL_free(wfname);
1177 void capi_dump_cert(CAPI_CTX *ctx, BIO *out, PCCERT_CONTEXT cert)
1181 unsigned long flags = ctx->dump_flags;
1182 if (flags & CAPI_DMP_FNAME)
1185 fname = capi_cert_get_fname(ctx, cert);
1188 BIO_printf(out, " Friendly Name \"%s\"\n", fname);
1189 OPENSSL_free(fname);
1192 BIO_printf(out, " <No Friendly Name>\n");
1195 p = cert->pbCertEncoded;
1196 x = d2i_X509(NULL, &p, cert->cbCertEncoded);
1198 BIO_printf(out, " <Can't parse certificate>\n");
1199 if (flags & CAPI_DMP_SUMMARY)
1201 BIO_printf(out, " Subject: ");
1202 X509_NAME_print_ex(out, X509_get_subject_name(x), 0, XN_FLAG_ONELINE);
1203 BIO_printf(out, "\n Issuer: ");
1204 X509_NAME_print_ex(out, X509_get_issuer_name(x), 0, XN_FLAG_ONELINE);
1205 BIO_printf(out, "\n");
1207 if (flags & CAPI_DMP_FULL)
1208 X509_print_ex(out, x, XN_FLAG_ONELINE,0);
1210 if (flags & CAPI_DMP_PKEYINFO)
1212 CRYPT_KEY_PROV_INFO *pinfo;
1213 pinfo = capi_get_prov_info(ctx, cert);
1214 capi_dump_prov_info(ctx, out, pinfo);
1216 OPENSSL_free(pinfo);
1219 if (flags & CAPI_DMP_PEM)
1220 PEM_write_bio_X509(out, x);
1224 HCERTSTORE capi_open_store(CAPI_CTX *ctx, char *storename)
1229 storename = ctx->storename;
1232 CAPI_trace(ctx, "Opening certificate store %s\n", storename);
1234 hstore = CertOpenSystemStore(0, storename);
1237 CAPIerr(CAPI_F_CAPI_OPEN_STORE, CAPI_R_ERROR_OPENING_STORE);
1238 capi_addlasterror();
1243 int capi_list_certs(CAPI_CTX *ctx, BIO *out, char *id)
1249 PCCERT_CONTEXT cert = NULL;
1251 storename = ctx->storename;
1254 CAPI_trace(ctx, "Listing certs for store %s\n", storename);
1256 hstore = capi_open_store(ctx, storename);
1261 cert = capi_find_cert(ctx, id, hstore);
1267 capi_dump_cert(ctx, out, cert);
1268 CertFreeCertificateContext(cert);
1274 LPWSTR fname = NULL;
1275 cert = CertEnumCertificatesInStore(hstore, cert);
1278 BIO_printf(out, "Certificate %d\n", idx);
1279 capi_dump_cert(ctx, out, cert);
1283 CertCloseStore(hstore, 0);
1287 static PCCERT_CONTEXT capi_find_cert(CAPI_CTX *ctx, const char *id, HCERTSTORE hstore)
1289 PCCERT_CONTEXT cert = NULL;
1292 switch(ctx->lookup_method)
1294 case CAPI_LU_SUBSTR:
1295 return CertFindCertificateInStore(hstore,
1296 X509_ASN_ENCODING, 0,
1297 CERT_FIND_SUBJECT_STR_A, id, NULL);
1301 cert = CertEnumCertificatesInStore(hstore, cert);
1304 fname = capi_cert_get_fname(ctx, cert);
1307 if (strcmp(fname, id))
1311 OPENSSL_free(fname);
1321 static CAPI_KEY *capi_get_key(CAPI_CTX *ctx, const char *contname, char *provname, DWORD ptype, DWORD keyspec)
1324 key = OPENSSL_malloc(sizeof(CAPI_KEY));
1325 CAPI_trace(ctx, "capi_get_key, contname=%s, provname=%s, type=%d\n",
1326 contname, provname, ptype);
1327 if (!CryptAcquireContext(&key->hprov, contname, provname, ptype, 0))
1329 CAPIerr(CAPI_F_CAPI_GET_KEY, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1330 capi_addlasterror();
1333 if (!CryptGetUserKey(key->hprov, keyspec, &key->key))
1335 CAPIerr(CAPI_F_CAPI_GET_KEY, CAPI_R_GETUSERKEY_ERROR);
1336 capi_addlasterror();
1337 CryptReleaseContext(key->hprov, 0);
1340 key->keyspec = keyspec;
1349 static CAPI_KEY *capi_get_cert_key(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1352 CRYPT_KEY_PROV_INFO *pinfo = NULL;
1353 char *provname = NULL, *contname = NULL;
1354 pinfo = capi_get_prov_info(ctx, cert);
1357 provname = wide_to_asc(pinfo->pwszProvName);
1358 contname = wide_to_asc(pinfo->pwszContainerName);
1359 if (!provname || !contname)
1362 key = capi_get_key(ctx, contname, provname,
1363 pinfo->dwProvType, pinfo->dwKeySpec);
1367 OPENSSL_free(pinfo);
1369 OPENSSL_free(provname);
1371 OPENSSL_free(contname);
1375 CAPI_KEY *capi_find_key(CAPI_CTX *ctx, const char *id)
1377 PCCERT_CONTEXT cert;
1379 CAPI_KEY *key = NULL;
1380 switch (ctx->lookup_method)
1382 case CAPI_LU_SUBSTR:
1384 hstore = capi_open_store(ctx, NULL);
1387 cert = capi_find_cert(ctx, id, hstore);
1390 key = capi_get_cert_key(ctx, cert);
1391 CertFreeCertificateContext(cert);
1393 CertCloseStore(hstore, 0);
1396 case CAPI_LU_CONTNAME:
1397 key = capi_get_key(ctx, id, ctx->cspname, ctx->csptype,
1405 void capi_free_key(CAPI_KEY *key)
1409 CryptDestroyKey(key->key);
1410 CryptReleaseContext(key->hprov, 0);
1412 CertFreeCertificateContext(key->pcert);
1417 /* Initialize a CAPI_CTX structure */
1419 static CAPI_CTX *capi_ctx_new()
1422 ctx = OPENSSL_malloc(sizeof(CAPI_CTX));
1425 CAPIerr(CAPI_F_CAPI_CTX_NEW, ERR_R_MALLOC_FAILURE);
1428 ctx->cspname = NULL;
1429 ctx->csptype = PROV_RSA_FULL;
1430 ctx->dump_flags = CAPI_DMP_SUMMARY|CAPI_DMP_FNAME;
1431 ctx->keytype = AT_KEYEXCHANGE;
1432 ctx->storename = NULL;
1433 ctx->ssl_client_store = NULL;
1434 ctx->lookup_method = CAPI_LU_SUBSTR;
1435 ctx->debug_level = 0;
1436 ctx->debug_file = NULL;
1440 static void capi_ctx_free(CAPI_CTX *ctx)
1442 CAPI_trace(ctx, "Calling capi_ctx_free with %lx\n", ctx);
1446 OPENSSL_free(ctx->cspname);
1447 if (ctx->debug_file)
1448 OPENSSL_free(ctx->debug_file);
1450 OPENSSL_free(ctx->storename);
1451 if (ctx->ssl_client_store)
1452 OPENSSL_free(ctx->ssl_client_store);
1456 static int capi_ctx_set_provname(CAPI_CTX *ctx, LPSTR pname, DWORD type, int check)
1458 CAPI_trace(ctx, "capi_ctx_set_provname, name=%s, type=%d\n", pname, type);
1462 if (!CryptAcquireContext(&hprov, NULL, pname, type,
1463 CRYPT_VERIFYCONTEXT))
1465 CAPIerr(CAPI_F_CAPI_CTX_SET_PROVNAME, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1466 capi_addlasterror();
1469 CryptReleaseContext(hprov, 0);
1471 ctx->cspname = BUF_strdup(pname);
1472 ctx->csptype = type;
1476 static int capi_ctx_set_provname_idx(CAPI_CTX *ctx, int idx)
1480 if (capi_get_provname(ctx, &pname, &type, idx) != 1)
1482 return capi_ctx_set_provname(ctx, pname, type, 0);
1485 static int cert_issuer_match(STACK_OF(X509_NAME) *ca_dn, X509 *x)
1489 /* Special case: empty list: match anything */
1490 if (sk_X509_NAME_num(ca_dn) <= 0)
1492 for (i = 0; i < sk_X509_NAME_num(ca_dn); i++)
1494 nm = sk_X509_NAME_value(ca_dn, i);
1495 if (!X509_NAME_cmp(nm, X509_get_issuer_name(x)))
1503 static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
1504 STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey,
1505 STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data)
1507 STACK_OF(X509) *certs = NULL;
1511 int i, client_cert_idx;
1513 PCCERT_CONTEXT cert = NULL, excert = NULL;
1516 ctx = ENGINE_get_ex_data(e, capi_idx);
1521 storename = ctx->ssl_client_store;
1525 hstore = capi_open_store(ctx, storename);
1528 /* Enumerate all certificates collect any matches */
1531 cert = CertEnumCertificatesInStore(hstore, cert);
1534 p = cert->pbCertEncoded;
1535 x = d2i_X509(NULL, &p, cert->cbCertEncoded);
1538 CAPI_trace(ctx, "Can't Parse Certificate %d\n", i);
1541 if (cert_issuer_match(ca_dn, x))
1543 key = capi_get_cert_key(ctx, cert);
1546 /* Match found: attach extra data to it so
1547 * we can retrieve the key later.
1549 excert = CertDuplicateCertificateContext(cert);
1550 key->pcert = excert;
1551 X509_set_ex_data(x, cert_capi_idx, key);
1554 certs = sk_X509_new_null();
1556 sk_X509_push(certs, x);
1564 CertFreeCertificateContext(cert);
1566 CertCloseStore(hstore, 0);
1572 /* Select the appropriate certificate */
1574 client_cert_idx = client_cert_select(e, ssl, certs);
1576 /* Set the selected certificate and free the rest */
1578 for(i = 0; i < sk_X509_num(certs); i++)
1580 x = sk_X509_value(certs, i);
1581 if (i == client_cert_idx)
1585 key = X509_get_ex_data(x, cert_capi_idx);
1591 sk_X509_free(certs);
1596 /* Setup key for selected certificate */
1598 key = X509_get_ex_data(*pcert, cert_capi_idx);
1599 *pkey = capi_get_pkey(e, key);
1600 X509_set_ex_data(*pcert, cert_capi_idx, NULL);
1606 #ifndef OPENSSL_CAPIENG_DIALOG
1608 /* Simple client cert selection function: always select first */
1610 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
1617 /* More complex cert selection function, using standard function
1618 * CryptUIDlgSelectCertificateFromStore() to produce a dialog box.
1622 #include <cryptuiapi.h>
1624 #define dlg_title L"OpenSSL Application SSL Client Certificate Selection"
1625 #define dlg_prompt L"Select a certificate to use for authentication"
1626 #define dlg_columns CRYPTUI_SELECT_LOCATION_COLUMN \
1627 |CRYPTUI_SELECT_INTENDEDUSE_COLUMN
1629 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
1633 PCCERT_CONTEXT cert;
1638 if (sk_X509_num(certs) == 1)
1640 ctx = ENGINE_get_ex_data(e, capi_idx);
1641 /* Create an in memory store of certificates */
1642 dstore = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0,
1643 CERT_STORE_CREATE_NEW_FLAG, NULL);
1646 CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_CREATING_STORE);
1647 capi_addlasterror();
1650 /* Add all certificates to store */
1651 for(i = 0; i < sk_X509_num(certs); i++)
1653 x = sk_X509_value(certs, i);
1654 key = X509_get_ex_data(x, cert_capi_idx);
1656 if (!CertAddCertificateContextToStore(dstore, key->pcert,
1657 CERT_STORE_ADD_NEW, NULL))
1659 CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_ADDING_CERT);
1660 capi_addlasterror();
1665 hwnd = GetActiveWindow();
1667 hwnd = GetConsoleWindow();
1668 /* Call dialog to select one */
1669 cert = CryptUIDlgSelectCertificateFromStore(dstore, hwnd,
1670 dlg_title, dlg_prompt,
1671 dlg_columns, 0, NULL);
1673 /* Find matching cert from list */
1676 for(i = 0; i < sk_X509_num(certs); i++)
1678 x = sk_X509_value(certs, i);
1679 key = X509_get_ex_data(x, cert_capi_idx);
1680 if (CertCompareCertificate(
1681 X509_ASN_ENCODING | PKCS_7_ASN_ENCODING,
1683 key->pcert->pCertInfo))
1693 CertCloseStore(dstore, 0);