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/engine.h>
60 #include <openssl/rsa.h>
61 #include <openssl/bn.h>
62 #include <openssl/pem.h>
64 #ifdef OPENSSL_SYS_WIN32
65 #ifndef OPENSSL_NO_CAPIENG
68 #define _WIN32_WINNT 0x400
76 #include "e_capi_err.h"
77 #include "e_capi_err.c"
80 static const char *engine_capi_id = "capi";
81 static const char *engine_capi_name = "CryptoAPI ENGINE";
83 typedef struct CAPI_CTX_st CAPI_CTX;
84 typedef struct CAPI_KEY_st CAPI_KEY;
86 static void capi_addlasterror(void);
87 static void capi_adderror(DWORD err);
89 static void CAPI_trace(CAPI_CTX *ctx, char *format, ...);
91 static int capi_list_providers(CAPI_CTX *ctx, BIO *out);
92 static int capi_list_containers(CAPI_CTX *ctx, BIO *out);
93 int capi_list_certs(CAPI_CTX *ctx, BIO *out, char *storename);
94 void capi_free_key(CAPI_KEY *key);
95 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
97 static PCCERT_CONTEXT capi_find_cert(CAPI_CTX *ctx, const char *id, HCERTSTORE hstore);
99 CAPI_KEY *capi_find_key(CAPI_CTX *ctx, const char *id);
101 static EVP_PKEY *capi_load_privkey(ENGINE *eng, const char *key_id,
102 UI_METHOD *ui_method, void *callback_data);
103 static int capi_rsa_sign(int dtype, const unsigned char *m, unsigned int m_len,
104 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
105 static int capi_rsa_priv_enc(int flen, const unsigned char *from,
106 unsigned char *to, RSA *rsa, int padding);
107 static int capi_rsa_priv_dec(int flen, const unsigned char *from,
108 unsigned char *to, RSA *rsa, int padding);
109 static int capi_rsa_free(RSA *rsa);
111 static DSA_SIG *capi_dsa_do_sign(const unsigned char *digest, int dlen,
113 static int capi_dsa_free(DSA *dsa);
115 static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
116 STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey,
117 STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data);
119 /* This structure contains CAPI ENGINE specific data:
120 * it contains various global options and affects how
121 * other functions behave.
124 #define CAPI_DBG_TRACE 2
125 #define CAPI_DBG_ERROR 1
130 /* Parameters to use for container lookup */
134 /* Certificate store name to use */
136 LPTSTR ssl_client_store;
138 /* Lookup string meanings in load_private_key */
139 /* Substring of subject: uses "storename" */
140 #define CAPI_LU_SUBSTR 0
141 /* Friendly name: uses storename */
142 #define CAPI_LU_FNAME 1
143 /* Container name: uses cspname, keytype */
144 #define CAPI_LU_CONTNAME 2
146 /* Info to dump with dumpcerts option */
147 /* Issuer and serial name strings */
148 #define CAPI_DMP_SUMMARY 0x1
150 #define CAPI_DMP_FNAME 0x2
151 /* Full X509_print dump */
152 #define CAPI_DMP_FULL 0x4
153 /* Dump PEM format certificate */
154 #define CAPI_DMP_PEM 0x8
155 /* Dump pseudo key (if possible) */
156 #define CAPI_DMP_PSKEY 0x10
157 /* Dump key info (if possible) */
158 #define CAPI_DMP_PKEYINFO 0x20
164 static CAPI_CTX *capi_ctx_new();
165 static void capi_ctx_free(CAPI_CTX *ctx);
166 static int capi_ctx_set_provname(CAPI_CTX *ctx, LPSTR pname, DWORD type, int check);
167 static int capi_ctx_set_provname_idx(CAPI_CTX *ctx, int idx);
169 #define CAPI_CMD_LIST_CERTS ENGINE_CMD_BASE
170 #define CAPI_CMD_LOOKUP_CERT (ENGINE_CMD_BASE + 1)
171 #define CAPI_CMD_DEBUG_LEVEL (ENGINE_CMD_BASE + 2)
172 #define CAPI_CMD_DEBUG_FILE (ENGINE_CMD_BASE + 3)
173 #define CAPI_CMD_KEYTYPE (ENGINE_CMD_BASE + 4)
174 #define CAPI_CMD_LIST_CSPS (ENGINE_CMD_BASE + 5)
175 #define CAPI_CMD_SET_CSP_IDX (ENGINE_CMD_BASE + 6)
176 #define CAPI_CMD_SET_CSP_NAME (ENGINE_CMD_BASE + 7)
177 #define CAPI_CMD_SET_CSP_TYPE (ENGINE_CMD_BASE + 8)
178 #define CAPI_CMD_LIST_CONTAINERS (ENGINE_CMD_BASE + 9)
179 #define CAPI_CMD_LIST_OPTIONS (ENGINE_CMD_BASE + 10)
180 #define CAPI_CMD_LOOKUP_METHOD (ENGINE_CMD_BASE + 11)
181 #define CAPI_CMD_STORE_NAME (ENGINE_CMD_BASE + 12)
183 static const ENGINE_CMD_DEFN capi_cmd_defns[] = {
184 {CAPI_CMD_LIST_CERTS,
186 "List all certificates in store",
187 ENGINE_CMD_FLAG_NO_INPUT},
188 {CAPI_CMD_LOOKUP_CERT,
190 "Lookup and output certificates",
191 ENGINE_CMD_FLAG_STRING},
192 {CAPI_CMD_DEBUG_LEVEL,
194 "debug level (1=errors, 2=trace)",
195 ENGINE_CMD_FLAG_NUMERIC},
196 {CAPI_CMD_DEBUG_FILE,
198 "debugging filename)",
199 ENGINE_CMD_FLAG_STRING},
202 "Key type: 1=AT_KEYEXCHANGE (default), 2=AT_SIGNATURE",
203 ENGINE_CMD_FLAG_NUMERIC},
207 ENGINE_CMD_FLAG_NO_INPUT},
208 {CAPI_CMD_SET_CSP_IDX,
211 ENGINE_CMD_FLAG_NUMERIC},
212 {CAPI_CMD_SET_CSP_NAME,
214 "Set CSP name, (default CSP used if not specified)",
215 ENGINE_CMD_FLAG_STRING},
216 {CAPI_CMD_SET_CSP_TYPE,
218 "Set CSP type, (default RSA_PROV_FULL)",
219 ENGINE_CMD_FLAG_NUMERIC},
220 {CAPI_CMD_LIST_CONTAINERS,
222 "list container names",
223 ENGINE_CMD_FLAG_NO_INPUT},
224 {CAPI_CMD_LIST_OPTIONS,
226 "Set list options (1=summary,2=friendly name, 4=full printout, 8=PEM output, 16=XXX, "
227 "32=private key info)",
228 ENGINE_CMD_FLAG_NUMERIC},
229 {CAPI_CMD_LOOKUP_METHOD,
231 "Set key lookup method (1=substring, 2=friendlyname, 3=container name)",
232 ENGINE_CMD_FLAG_NUMERIC},
233 {CAPI_CMD_STORE_NAME,
235 "certificate store name, default \"MY\"",
236 ENGINE_CMD_FLAG_STRING},
241 static int capi_idx = -1;
242 static int rsa_capi_idx = -1;
243 static int dsa_capi_idx = -1;
244 static int cert_capi_idx = -1;
246 static int capi_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
253 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_ENGINE_NOT_INITIALIZED);
256 ctx = ENGINE_get_ex_data(e, capi_idx);
257 out = BIO_new_fp(stdout, BIO_NOCLOSE);
260 case CAPI_CMD_LIST_CSPS:
261 ret = capi_list_providers(ctx, out);
264 case CAPI_CMD_LIST_CERTS:
265 ret = capi_list_certs(ctx, out, NULL);
268 case CAPI_CMD_LOOKUP_CERT:
269 ret = capi_list_certs(ctx, out, p);
272 case CAPI_CMD_LIST_CONTAINERS:
273 ret = capi_list_containers(ctx, out);
276 case CAPI_CMD_STORE_NAME:
278 OPENSSL_free(ctx->storename);
279 ctx->storename = BUF_strdup(p);
280 CAPI_trace(ctx, "Setting store name to %s\n", p);
283 case CAPI_CMD_DEBUG_LEVEL:
284 ctx->debug_level = (int)i;
285 CAPI_trace(ctx, "Setting debug level to %d\n", ctx->debug_level);
288 case CAPI_CMD_DEBUG_FILE:
289 ctx->debug_file = BUF_strdup(p);
290 CAPI_trace(ctx, "Setting debug file to %s\n", ctx->debug_file);
293 case CAPI_CMD_KEYTYPE:
295 CAPI_trace(ctx, "Setting key type to %d\n", ctx->keytype);
298 case CAPI_CMD_SET_CSP_IDX:
299 ret = capi_ctx_set_provname_idx(ctx, i);
302 case CAPI_CMD_LIST_OPTIONS:
306 case CAPI_CMD_LOOKUP_METHOD:
309 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_INVALID_LOOKUP_METHOD);
312 ctx->lookup_method = i;
315 case CAPI_CMD_SET_CSP_NAME:
316 ret = capi_ctx_set_provname(ctx, p, ctx->csptype, 1);
319 case CAPI_CMD_SET_CSP_TYPE:
324 CAPIerr(CAPI_F_CAPI_CTRL, CAPI_R_UNKNOWN_COMMAND);
333 static RSA_METHOD capi_rsa_method =
335 "CryptoAPI RSA method",
338 capi_rsa_priv_enc, /* priv_enc */
339 capi_rsa_priv_dec, /* priv_dec */
343 capi_rsa_free, /* finish */
344 RSA_FLAG_SIGN_VER, /* flags */
346 capi_rsa_sign, /* rsa_sign */
350 static DSA_METHOD capi_dsa_method =
352 "CryptoAPI DSA method",
353 capi_dsa_do_sign, /* dsa_do_sign */
354 0, /* dsa_sign_setup */
355 0, /* dsa_do_verify */
359 capi_dsa_free, /* finish */
362 0, /* dsa_paramgen */
366 static int capi_init(ENGINE *e)
369 const RSA_METHOD *ossl_rsa_meth;
370 const DSA_METHOD *ossl_dsa_meth;
371 capi_idx = ENGINE_get_ex_new_index(0, NULL, NULL, NULL, 0);
372 cert_capi_idx = X509_get_ex_new_index(0, NULL, NULL, NULL, 0);
374 ctx = capi_ctx_new();
375 if (!ctx || (capi_idx < 0))
378 ENGINE_set_ex_data(e, capi_idx, ctx);
379 /* Setup RSA_METHOD */
380 rsa_capi_idx = RSA_get_ex_new_index(0, NULL, NULL, NULL, 0);
381 ossl_rsa_meth = RSA_PKCS1_SSLeay();
382 capi_rsa_method.rsa_pub_enc = ossl_rsa_meth->rsa_pub_enc;
383 capi_rsa_method.rsa_pub_dec = ossl_rsa_meth->rsa_pub_dec;
384 capi_rsa_method.rsa_mod_exp = ossl_rsa_meth->rsa_mod_exp;
385 capi_rsa_method.bn_mod_exp = ossl_rsa_meth->bn_mod_exp;
387 /* Setup DSA Method */
388 dsa_capi_idx = DSA_get_ex_new_index(0, NULL, NULL, NULL, 0);
389 ossl_dsa_meth = DSA_OpenSSL();
390 capi_dsa_method.dsa_do_verify = ossl_dsa_meth->dsa_do_verify;
391 capi_dsa_method.dsa_mod_exp = ossl_dsa_meth->dsa_mod_exp;
392 capi_dsa_method.bn_mod_exp = ossl_dsa_meth->bn_mod_exp;
397 CAPIerr(CAPI_F_CAPI_INIT, ERR_R_MALLOC_FAILURE);
403 static int capi_destroy(ENGINE *e)
405 ERR_unload_CAPI_strings();
409 static int capi_finish(ENGINE *e)
412 ctx = ENGINE_get_ex_data(e, capi_idx);
414 ENGINE_set_ex_data(e, capi_idx, NULL);
419 /* CryptoAPI key application data. This contains
420 * a handle to the private key container (for sign operations)
421 * and a handle to the key (for decrypt operations).
426 /* Associated certificate context (if any) */
427 PCCERT_CONTEXT pcert;
433 static int bind_capi(ENGINE *e)
435 if (!ENGINE_set_id(e, engine_capi_id)
436 || !ENGINE_set_name(e, engine_capi_name)
437 || !ENGINE_set_init_function(e, capi_init)
438 || !ENGINE_set_finish_function(e, capi_finish)
439 || !ENGINE_set_destroy_function(e, capi_destroy)
440 || !ENGINE_set_RSA(e, &capi_rsa_method)
441 || !ENGINE_set_DSA(e, &capi_dsa_method)
442 || !ENGINE_set_load_privkey_function(e, capi_load_privkey)
443 || !ENGINE_set_load_ssl_client_cert_function(e,
444 capi_load_ssl_client_cert)
445 || !ENGINE_set_cmd_defns(e, capi_cmd_defns)
446 || !ENGINE_set_ctrl_function(e, capi_ctrl))
448 ERR_load_CAPI_strings();
454 #ifndef OPENSSL_NO_DYNAMIC_ENGINE
455 static int bind_helper(ENGINE *e, const char *id)
457 if(id && (strcmp(id, engine_capi_id) != 0))
463 IMPLEMENT_DYNAMIC_CHECK_FN()
464 IMPLEMENT_DYNAMIC_BIND_FN(bind_helper)
466 static ENGINE *engine_capi(void)
468 ENGINE *ret = ENGINE_new();
479 void ENGINE_load_capi(void)
481 /* Copied from eng_[openssl|dyn].c */
482 ENGINE *toadd = engine_capi();
491 static int lend_tobn(BIGNUM *bn, unsigned char *bin, int binlen)
494 /* Reverse buffer in place: since this is a keyblob structure
495 * that will be freed up after conversion anyway it doesn't
496 * matter if we change it.
498 for(i = 0; i < binlen / 2; i++)
502 bin[i] = bin[binlen - i - 1];
503 bin[binlen - i - 1] = c;
506 if (!BN_bin2bn(bin, binlen, bn))
511 /* Given a CAPI_KEY get an EVP_PKEY structure */
513 static EVP_PKEY *capi_get_pkey(ENGINE *eng, CAPI_KEY *key)
515 unsigned char *pubkey = NULL;
520 EVP_PKEY *ret = NULL;
521 if (!CryptExportKey(key->key, 0, PUBLICKEYBLOB, 0, NULL, &len))
523 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_PUBKEY_EXPORT_LENGTH_ERROR);
528 pubkey = OPENSSL_malloc(len);
533 if (!CryptExportKey(key->key, 0, PUBLICKEYBLOB, 0, pubkey, &len))
535 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_PUBKEY_EXPORT_ERROR);
540 bh = (BLOBHEADER *)pubkey;
541 if (bh->bType != PUBLICKEYBLOB)
543 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_PUBLIC_KEY_BLOB);
546 if (bh->aiKeyAlg == CALG_RSA_SIGN || bh->aiKeyAlg == CALG_RSA_KEYX)
550 unsigned char *rsa_modulus;
551 rp = (RSAPUBKEY *)(bh + 1);
552 if (rp->magic != 0x31415352)
555 BIO_snprintf(magstr, 10, "%lx", rp->magic);
556 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_RSA_PUBLIC_KEY_BLOB_MAGIC_NUMBER);
557 ERR_add_error_data(2, "magic=0x", magstr);
560 rsa_modulus = (unsigned char *)(rp + 1);
561 rkey = RSA_new_method(eng);
568 if (!rkey->e || !rkey->n)
571 if (!BN_set_word(rkey->e, rp->pubexp))
574 rsa_modlen = rp->bitlen / 8;
575 if (!lend_tobn(rkey->n, rsa_modulus, rsa_modlen))
578 RSA_set_ex_data(rkey, rsa_capi_idx, key);
580 if (!(ret = EVP_PKEY_new()))
583 EVP_PKEY_assign_RSA(ret, rkey);
587 else if (bh->aiKeyAlg == CALG_DSS_SIGN)
592 dp = (DSSPUBKEY *)(bh + 1);
593 if (dp->magic != 0x31535344)
596 BIO_snprintf(magstr, 10, "%lx", dp->magic);
597 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_INVALID_DSA_PUBLIC_KEY_BLOB_MAGIC_NUMBER);
598 ERR_add_error_data(2, "magic=0x", magstr);
601 dsa_plen = dp->bitlen / 8;
602 btmp = (unsigned char *)(dp + 1);
603 dkey = DSA_new_method(eng);
609 dkey->pub_key = BN_new();
610 if (!dkey->p || !dkey->q || !dkey->g || !dkey->pub_key)
612 if (!lend_tobn(dkey->p, btmp, dsa_plen))
615 if (!lend_tobn(dkey->q, btmp, 20))
618 if (!lend_tobn(dkey->g, btmp, dsa_plen))
621 if (!lend_tobn(dkey->pub_key, btmp, dsa_plen))
625 DSA_set_ex_data(dkey, dsa_capi_idx, key);
627 if (!(ret = EVP_PKEY_new()))
630 EVP_PKEY_assign_DSA(ret, dkey);
636 BIO_snprintf(algstr, 10, "%lx", bh->aiKeyAlg);
637 CAPIerr(CAPI_F_CAPI_GET_PKEY, CAPI_R_UNSUPPORTED_PUBLIC_KEY_ALGORITHM);
638 ERR_add_error_data(2, "aiKeyAlg=0x", algstr);
645 OPENSSL_free(pubkey);
657 CAPIerr(CAPI_F_CAPI_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
662 static EVP_PKEY *capi_load_privkey(ENGINE *eng, const char *key_id,
663 UI_METHOD *ui_method, void *callback_data)
668 ctx = ENGINE_get_ex_data(eng, capi_idx);
672 CAPIerr(CAPI_F_CAPI_LOAD_PRIVKEY, CAPI_R_CANT_FIND_CAPI_CONTEXT);
676 key = capi_find_key(ctx, key_id);
681 ret = capi_get_pkey(eng, key);
689 /* CryptoAPI RSA operations */
691 int capi_rsa_priv_enc(int flen, const unsigned char *from,
692 unsigned char *to, RSA *rsa, int padding)
694 CAPIerr(CAPI_F_CAPI_RSA_PRIV_ENC, CAPI_R_FUNCTION_NOT_SUPPORTED);
698 int capi_rsa_sign(int dtype, const unsigned char *m, unsigned int m_len,
699 unsigned char *sigret, unsigned int *siglen, const RSA *rsa)
709 ctx = ENGINE_get_ex_data(rsa->engine, capi_idx);
711 CAPI_trace(ctx, "Called CAPI_rsa_sign()\n");
713 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
716 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_GET_KEY);
719 /* Convert the signature type to a CryptoAPI algorithm ID */
731 alg = CALG_SSL3_SHAMD5;
736 BIO_snprintf(algstr, 10, "%lx", dtype);
737 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_UNSUPPORTED_ALGORITHM_NID);
738 ERR_add_error_data(2, "NID=0x", algstr);
745 /* Create the hash object */
746 if(!CryptCreateHash(capi_key->hprov, alg, 0, 0, &hash))
748 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_CREATE_HASH_OBJECT);
752 /* Set the hash value to the value passed */
754 if(!CryptSetHashParam(hash, HP_HASHVAL, (unsigned char *)m, 0))
756 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_CANT_SET_HASH_VALUE);
762 /* Finally sign it */
763 slen = RSA_size(rsa);
764 if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, sigret, &slen))
766 CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_ERROR_SIGNING_HASH);
773 /* Inplace byte reversal of signature */
774 for(i = 0; i < slen / 2; i++)
778 sigret[i] = sigret[slen - i - 1];
779 sigret[slen - i - 1] = c;
787 CryptDestroyHash(hash);
792 int capi_rsa_priv_dec(int flen, const unsigned char *from,
793 unsigned char *to, RSA *rsa, int padding)
796 unsigned char *tmpbuf;
799 ctx = ENGINE_get_ex_data(rsa->engine, capi_idx);
801 CAPI_trace(ctx, "Called capi_rsa_priv_dec()\n");
804 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
807 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_CANT_GET_KEY);
811 if(padding != RSA_PKCS1_PADDING)
814 BIO_snprintf(errstr, 10, "%d", padding);
815 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_UNSUPPORTED_PADDING);
816 ERR_add_error_data(2, "padding=", errstr);
820 /* Create temp reverse order version of input */
821 if(!(tmpbuf = OPENSSL_malloc(flen)) )
823 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, ERR_R_MALLOC_FAILURE);
826 for(i = 0; i < flen; i++)
827 tmpbuf[flen - i - 1] = from[i];
829 /* Finally decrypt it */
830 if(!CryptDecrypt(capi_key->key, 0, TRUE, 0, tmpbuf, &flen))
832 CAPIerr(CAPI_F_CAPI_RSA_PRIV_DEC, CAPI_R_DECRYPT_ERROR);
834 OPENSSL_free(tmpbuf);
837 else memcpy(to, tmpbuf, flen);
839 OPENSSL_free(tmpbuf);
844 static int capi_rsa_free(RSA *rsa)
847 capi_key = RSA_get_ex_data(rsa, rsa_capi_idx);
848 capi_free_key(capi_key);
849 RSA_set_ex_data(rsa, rsa_capi_idx, 0);
853 /* CryptoAPI DSA operations */
855 static DSA_SIG *capi_dsa_do_sign(const unsigned char *digest, int dlen,
863 unsigned char csigbuf[40];
865 ctx = ENGINE_get_ex_data(dsa->engine, capi_idx);
867 CAPI_trace(ctx, "Called CAPI_dsa_do_sign()\n");
869 capi_key = DSA_get_ex_data(dsa, dsa_capi_idx);
873 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_GET_KEY);
879 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_INVALID_DIGEST_LENGTH);
883 /* Create the hash object */
884 if(!CryptCreateHash(capi_key->hprov, CALG_SHA1, 0, 0, &hash))
886 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_CREATE_HASH_OBJECT);
891 /* Set the hash value to the value passed */
892 if(!CryptSetHashParam(hash, HP_HASHVAL, (unsigned char *)digest, 0))
894 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_CANT_SET_HASH_VALUE);
900 /* Finally sign it */
901 slen = sizeof(csigbuf);
902 if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, csigbuf, &slen))
904 CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_ERROR_SIGNING_HASH);
915 if (!ret->r || !ret->s)
917 if (!lend_tobn(ret->r, csigbuf, 20)
918 || !lend_tobn(ret->s, csigbuf + 20, 20))
929 OPENSSL_cleanse(csigbuf, 40);
930 CryptDestroyHash(hash);
934 static int capi_dsa_free(DSA *dsa)
937 capi_key = DSA_get_ex_data(dsa, dsa_capi_idx);
938 capi_free_key(capi_key);
939 DSA_set_ex_data(dsa, dsa_capi_idx, 0);
943 static void capi_vtrace(CAPI_CTX *ctx, int level, char *format, va_list argptr)
947 if (!ctx || (ctx->debug_level < level) || (!ctx->debug_file))
949 out = BIO_new_file(ctx->debug_file, "a+");
950 BIO_vprintf(out, format, argptr);
954 static void CAPI_trace(CAPI_CTX *ctx, char *format, ...)
957 va_start(args, format);
958 capi_vtrace(ctx, CAPI_DBG_TRACE, format, args);
962 static void capi_addlasterror(void)
964 capi_adderror(GetLastError());
967 static void capi_adderror(DWORD err)
970 BIO_snprintf(errstr, 10, "%lX", err);
971 ERR_add_error_data(2, "Error code= 0x", errstr);
974 static char *wide_to_asc(LPWSTR wstr)
979 str = OPENSSL_malloc(wcslen(wstr) + 1);
982 CAPIerr(CAPI_F_WIDE_TO_ASC, ERR_R_MALLOC_FAILURE);
985 sprintf(str, "%S", wstr);
989 static int capi_get_provname(CAPI_CTX *ctx, LPSTR *pname, DWORD *ptype, DWORD idx)
993 CAPI_trace(ctx, "capi_get_provname, index=%d\n", idx);
994 if (!CryptEnumProviders(idx, NULL, 0, ptype, NULL, &len))
996 err = GetLastError();
997 if (err == ERROR_NO_MORE_ITEMS)
999 CAPIerr(CAPI_F_CAPI_GET_PROVNAME, CAPI_R_CRYPTENUMPROVIDERS_ERROR);
1003 name = OPENSSL_malloc(len);
1004 if (!CryptEnumProviders(idx, NULL, 0, ptype, name, &len))
1006 err = GetLastError();
1007 if (err == ERROR_NO_MORE_ITEMS)
1009 CAPIerr(CAPI_F_CAPI_GET_PROVNAME, CAPI_R_CRYPTENUMPROVIDERS_ERROR);
1014 CAPI_trace(ctx, "capi_get_provname, returned name=%s, type=%d\n", name, *ptype);
1019 static int capi_list_providers(CAPI_CTX *ctx, BIO *out)
1023 LPTSTR provname = NULL;
1024 CAPI_trace(ctx, "capi_list_providers\n");
1025 BIO_printf(out, "Available CSPs:\n");
1026 for(idx = 0; ; idx++)
1028 ret = capi_get_provname(ctx, &provname, &ptype, idx);
1033 BIO_printf(out, "%d. %s, type %d\n", idx, provname, ptype);
1034 OPENSSL_free(provname);
1039 static int capi_list_containers(CAPI_CTX *ctx, BIO *out)
1043 DWORD err, idx, flags, buflen = 0, clen;
1045 CAPI_trace(ctx, "Listing containers CSP=%s, type = %d\n", ctx->cspname, ctx->csptype);
1046 if (!CryptAcquireContext(&hprov, NULL, ctx->cspname, ctx->csptype, CRYPT_VERIFYCONTEXT))
1048 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1049 capi_addlasterror();
1052 if (!CryptGetProvParam(hprov, PP_ENUMCONTAINERS, NULL, &buflen, CRYPT_FIRST))
1054 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_ENUMCONTAINERS_ERROR);
1055 capi_addlasterror();
1058 CAPI_trace(ctx, "Got max container len %d\n", buflen);
1061 cname = OPENSSL_malloc(buflen);
1064 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, ERR_R_MALLOC_FAILURE);
1068 for (idx = 0;;idx++)
1074 flags = CRYPT_FIRST;
1077 if(!CryptGetProvParam(hprov, PP_ENUMCONTAINERS, cname, &clen, flags))
1079 err = GetLastError();
1080 if (err == ERROR_NO_MORE_ITEMS)
1082 CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_ENUMCONTAINERS_ERROR);
1086 CAPI_trace(ctx, "Container name %s, len=%d, index=%d, flags=%d\n", cname, clen, idx, flags);
1087 if (!cname[0] && (clen == buflen))
1089 CAPI_trace(ctx, "Enumerate bug: using workaround\n");
1092 BIO_printf(out, "%d. %s\n", idx, cname);
1100 OPENSSL_free(cname);
1101 CryptReleaseContext(hprov, 0);
1106 CRYPT_KEY_PROV_INFO *capi_get_prov_info(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1109 CRYPT_KEY_PROV_INFO *pinfo;
1111 if(!CertGetCertificateContextProperty(cert, CERT_KEY_PROV_INFO_PROP_ID, NULL, &len))
1113 pinfo = OPENSSL_malloc(len);
1116 CAPIerr(CAPI_F_CAPI_GET_PROV_INFO, ERR_R_MALLOC_FAILURE);
1119 if(!CertGetCertificateContextProperty(cert, CERT_KEY_PROV_INFO_PROP_ID, pinfo, &len))
1121 CAPIerr(CAPI_F_CAPI_GET_PROV_INFO, CAPI_R_ERROR_GETTING_KEY_PROVIDER_INFO);
1122 capi_addlasterror();
1123 OPENSSL_free(pinfo);
1129 static void capi_dump_prov_info(CAPI_CTX *ctx, BIO *out, CRYPT_KEY_PROV_INFO *pinfo)
1131 char *provname = NULL, *contname = NULL;
1134 BIO_printf(out, " No Private Key\n");
1137 provname = wide_to_asc(pinfo->pwszProvName);
1138 contname = wide_to_asc(pinfo->pwszContainerName);
1139 if (!provname || !contname)
1142 BIO_printf(out, " Private Key Info:\n");
1143 BIO_printf(out, " Provider Name: %s, Provider Type %d\n", provname, pinfo->dwProvType);
1144 BIO_printf(out, " Container Name: %s, Key Type %d\n", contname, pinfo->dwKeySpec);
1147 OPENSSL_free(provname);
1149 OPENSSL_free(contname);
1152 char * capi_cert_get_fname(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1157 CAPI_trace(ctx, "capi_cert_get_fname\n");
1158 if (!CertGetCertificateContextProperty(cert, CERT_FRIENDLY_NAME_PROP_ID, NULL, &dlen))
1160 wfname = OPENSSL_malloc(dlen);
1161 if (CertGetCertificateContextProperty(cert, CERT_FRIENDLY_NAME_PROP_ID, wfname, &dlen))
1163 char *fname = wide_to_asc(wfname);
1164 OPENSSL_free(wfname);
1167 CAPIerr(CAPI_F_CAPI_CERT_GET_FNAME, CAPI_R_ERROR_GETTING_FRIENDLY_NAME);
1168 capi_addlasterror();
1170 OPENSSL_free(wfname);
1175 void capi_dump_cert(CAPI_CTX *ctx, BIO *out, PCCERT_CONTEXT cert)
1179 unsigned long flags = ctx->dump_flags;
1180 if (flags & CAPI_DMP_FNAME)
1183 fname = capi_cert_get_fname(ctx, cert);
1186 BIO_printf(out, " Friendly Name \"%s\"\n", fname);
1187 OPENSSL_free(fname);
1190 BIO_printf(out, " <No Friendly Name>\n");
1193 p = cert->pbCertEncoded;
1194 x = d2i_X509(NULL, &p, cert->cbCertEncoded);
1196 BIO_printf(out, " <Can't parse certificate>\n");
1197 if (flags & CAPI_DMP_SUMMARY)
1199 BIO_printf(out, " Subject: ");
1200 X509_NAME_print_ex(out, X509_get_subject_name(x), 0, XN_FLAG_ONELINE);
1201 BIO_printf(out, "\n Issuer: ");
1202 X509_NAME_print_ex(out, X509_get_issuer_name(x), 0, XN_FLAG_ONELINE);
1203 BIO_printf(out, "\n");
1205 if (flags & CAPI_DMP_FULL)
1206 X509_print_ex(out, x, XN_FLAG_ONELINE,0);
1208 if (flags & CAPI_DMP_PKEYINFO)
1210 CRYPT_KEY_PROV_INFO *pinfo;
1211 pinfo = capi_get_prov_info(ctx, cert);
1212 capi_dump_prov_info(ctx, out, pinfo);
1214 OPENSSL_free(pinfo);
1217 if (flags & CAPI_DMP_PEM)
1218 PEM_write_bio_X509(out, x);
1222 HCERTSTORE capi_open_store(CAPI_CTX *ctx, char *storename)
1227 storename = ctx->storename;
1230 CAPI_trace(ctx, "Opening certificate store %s\n", storename);
1232 hstore = CertOpenSystemStore(0, storename);
1235 CAPIerr(CAPI_F_CAPI_OPEN_STORE, CAPI_R_ERROR_OPENING_STORE);
1236 capi_addlasterror();
1241 int capi_list_certs(CAPI_CTX *ctx, BIO *out, char *id)
1247 PCCERT_CONTEXT cert = NULL;
1249 storename = ctx->storename;
1252 CAPI_trace(ctx, "Listing certs for store %s\n", storename);
1254 hstore = capi_open_store(ctx, storename);
1259 cert = capi_find_cert(ctx, id, hstore);
1265 capi_dump_cert(ctx, out, cert);
1266 CertFreeCertificateContext(cert);
1272 LPWSTR fname = NULL;
1273 cert = CertEnumCertificatesInStore(hstore, cert);
1276 BIO_printf(out, "Certificate %d\n", idx);
1277 capi_dump_cert(ctx, out, cert);
1281 CertCloseStore(hstore, 0);
1285 static PCCERT_CONTEXT capi_find_cert(CAPI_CTX *ctx, const char *id, HCERTSTORE hstore)
1287 PCCERT_CONTEXT cert = NULL;
1290 switch(ctx->lookup_method)
1292 case CAPI_LU_SUBSTR:
1293 return CertFindCertificateInStore(hstore,
1294 X509_ASN_ENCODING, 0,
1295 CERT_FIND_SUBJECT_STR_A, id, NULL);
1299 cert = CertEnumCertificatesInStore(hstore, cert);
1302 fname = capi_cert_get_fname(ctx, cert);
1305 if (strcmp(fname, id))
1309 OPENSSL_free(fname);
1319 static CAPI_KEY *capi_get_key(CAPI_CTX *ctx, const char *contname, char *provname, DWORD ptype, DWORD keyspec)
1322 key = OPENSSL_malloc(sizeof(CAPI_KEY));
1323 CAPI_trace(ctx, "capi_get_key, contname=%s, provname=%s, type=%d\n",
1324 contname, provname, ptype);
1325 if (!CryptAcquireContext(&key->hprov, contname, provname, ptype, 0))
1327 CAPIerr(CAPI_F_CAPI_GET_KEY, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1328 capi_addlasterror();
1331 if (!CryptGetUserKey(key->hprov, keyspec, &key->key))
1333 CAPIerr(CAPI_F_CAPI_GET_KEY, CAPI_R_GETUSERKEY_ERROR);
1334 capi_addlasterror();
1335 CryptReleaseContext(key->hprov, 0);
1338 key->keyspec = keyspec;
1347 static CAPI_KEY *capi_get_cert_key(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
1350 CRYPT_KEY_PROV_INFO *pinfo = NULL;
1351 char *provname = NULL, *contname = NULL;
1352 pinfo = capi_get_prov_info(ctx, cert);
1355 provname = wide_to_asc(pinfo->pwszProvName);
1356 contname = wide_to_asc(pinfo->pwszContainerName);
1357 if (!provname || !contname)
1360 key = capi_get_key(ctx, contname, provname,
1361 pinfo->dwProvType, pinfo->dwKeySpec);
1365 OPENSSL_free(pinfo);
1367 OPENSSL_free(provname);
1369 OPENSSL_free(contname);
1373 CAPI_KEY *capi_find_key(CAPI_CTX *ctx, const char *id)
1375 PCCERT_CONTEXT cert;
1377 CAPI_KEY *key = NULL;
1378 switch (ctx->lookup_method)
1380 case CAPI_LU_SUBSTR:
1382 hstore = capi_open_store(ctx, NULL);
1385 cert = capi_find_cert(ctx, id, hstore);
1388 key = capi_get_cert_key(ctx, cert);
1389 CertFreeCertificateContext(cert);
1391 CertCloseStore(hstore, 0);
1394 case CAPI_LU_CONTNAME:
1395 key = capi_get_key(ctx, id, ctx->cspname, ctx->csptype,
1403 void capi_free_key(CAPI_KEY *key)
1407 CryptDestroyKey(key->key);
1408 CryptReleaseContext(key->hprov, 0);
1410 CertFreeCertificateContext(key->pcert);
1415 /* Initialize a CAPI_CTX structure */
1417 static CAPI_CTX *capi_ctx_new()
1420 ctx = OPENSSL_malloc(sizeof(CAPI_CTX));
1423 CAPIerr(CAPI_F_CAPI_CTX_NEW, ERR_R_MALLOC_FAILURE);
1426 ctx->cspname = NULL;
1427 ctx->csptype = PROV_RSA_FULL;
1428 ctx->dump_flags = CAPI_DMP_SUMMARY|CAPI_DMP_FNAME;
1429 ctx->keytype = AT_KEYEXCHANGE;
1430 ctx->storename = NULL;
1431 ctx->ssl_client_store = NULL;
1432 ctx->lookup_method = CAPI_LU_SUBSTR;
1433 ctx->debug_level = 0;
1434 ctx->debug_file = NULL;
1438 static void capi_ctx_free(CAPI_CTX *ctx)
1440 CAPI_trace(ctx, "Calling capi_ctx_free with %lx\n", ctx);
1444 OPENSSL_free(ctx->cspname);
1445 if (ctx->debug_file)
1446 OPENSSL_free(ctx->debug_file);
1448 OPENSSL_free(ctx->storename);
1449 if (ctx->ssl_client_store)
1450 OPENSSL_free(ctx->ssl_client_store);
1454 static int capi_ctx_set_provname(CAPI_CTX *ctx, LPSTR pname, DWORD type, int check)
1456 CAPI_trace(ctx, "capi_ctx_set_provname, name=%s, type=%d\n", pname, type);
1460 if (!CryptAcquireContext(&hprov, NULL, pname, type,
1461 CRYPT_VERIFYCONTEXT))
1463 CAPIerr(CAPI_F_CAPI_CTX_SET_PROVNAME, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
1464 capi_addlasterror();
1467 CryptReleaseContext(hprov, 0);
1469 ctx->cspname = BUF_strdup(pname);
1470 ctx->csptype = type;
1474 static int capi_ctx_set_provname_idx(CAPI_CTX *ctx, int idx)
1478 if (capi_get_provname(ctx, &pname, &type, idx) != 1)
1480 return capi_ctx_set_provname(ctx, pname, type, 0);
1483 static int cert_issuer_match(STACK_OF(X509_NAME) *ca_dn, X509 *x)
1487 /* Special case: empty list: match anything */
1488 if (sk_X509_NAME_num(ca_dn) <= 0)
1490 for (i = 0; i < sk_X509_NAME_num(ca_dn); i++)
1492 nm = sk_X509_NAME_value(ca_dn, i);
1493 if (!X509_NAME_cmp(nm, X509_get_issuer_name(x)))
1501 static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
1502 STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey,
1503 STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data)
1505 STACK_OF(X509) *certs = NULL;
1509 int i, client_cert_idx;
1511 PCCERT_CONTEXT cert = NULL, excert = NULL;
1514 ctx = ENGINE_get_ex_data(e, capi_idx);
1519 storename = ctx->ssl_client_store;
1523 hstore = capi_open_store(ctx, storename);
1526 /* Enumerate all certificates collect any matches */
1529 cert = CertEnumCertificatesInStore(hstore, cert);
1532 p = cert->pbCertEncoded;
1533 x = d2i_X509(NULL, &p, cert->cbCertEncoded);
1536 CAPI_trace(ctx, "Can't Parse Certificate %d\n", i);
1539 if (cert_issuer_match(ca_dn, x))
1541 key = capi_get_cert_key(ctx, cert);
1544 /* Match found: attach extra data to it so
1545 * we can retrieve the key later.
1547 excert = CertDuplicateCertificateContext(cert);
1548 key->pcert = excert;
1549 X509_set_ex_data(x, cert_capi_idx, key);
1552 certs = sk_X509_new_null();
1554 sk_X509_push(certs, x);
1562 CertFreeCertificateContext(cert);
1564 CertCloseStore(hstore, 0);
1570 /* Select the appropriate certificate */
1572 client_cert_idx = client_cert_select(e, ssl, certs);
1574 /* Set the selected certificate and free the rest */
1576 for(i = 0; i < sk_X509_num(certs); i++)
1578 x = sk_X509_value(certs, i);
1579 if (i == client_cert_idx)
1583 key = X509_get_ex_data(x, cert_capi_idx);
1589 sk_X509_free(certs);
1594 /* Setup key for selected certificate */
1596 key = X509_get_ex_data(*pcert, cert_capi_idx);
1597 *pkey = capi_get_pkey(e, key);
1598 X509_set_ex_data(*pcert, cert_capi_idx, NULL);
1604 #ifndef OPENSSL_CAPIENG_DIALOG
1606 /* Simple client cert selection function: always select first */
1608 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
1615 /* More complex cert selection function, using standard function
1616 * CryptUIDlgSelectCertificateFromStore() to produce a dialog box.
1619 #include <cryptuiapi.h>
1621 #define dlg_title L"OpenSSL Application SSL Client Certificate Selection"
1622 #define dlg_prompt L"Select a certificate to use for authentication"
1623 #define dlg_columns CRYPTUI_SELECT_LOCATION_COLUMN \
1624 |CRYPTUI_SELECT_INTENDEDUSE_COLUMN
1626 static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
1630 PCCERT_CONTEXT cert;
1635 ctx = ENGINE_get_ex_data(e, capi_idx);
1636 /* Create an in memory store of certificates */
1637 dstore = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0,
1638 CERT_STORE_CREATE_NEW_FLAG, NULL);
1641 CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_CREATING_STORE);
1642 capi_addlasterror();
1645 /* Add all certificates to store */
1646 for(i = 0; i < sk_X509_num(certs); i++)
1648 x = sk_X509_value(certs, i);
1649 key = X509_get_ex_data(x, cert_capi_idx);
1651 if (!CertAddCertificateContextToStore(dstore, key->pcert,
1652 CERT_STORE_ADD_NEW, NULL))
1654 CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_ADDING_CERT);
1655 capi_addlasterror();
1660 hwnd = GetActiveWindow();
1662 hwnd = GetConsoleWindow();
1663 /* Call dialog to select one */
1664 cert = CryptUIDlgSelectCertificateFromStore(dstore, hwnd,
1665 dlg_title, dlg_prompt,
1666 dlg_columns, 0, NULL);
1668 /* Find matching cert from list */
1671 for(i = 0; i < sk_X509_num(certs); i++)
1673 x = sk_X509_value(certs, i);
1674 key = X509_get_ex_data(x, cert_capi_idx);
1675 if (CertCompareCertificate(
1676 X509_ASN_ENCODING | PKCS_7_ASN_ENCODING,
1678 key->pcert->pCertInfo))
1688 CertCloseStore(dstore, 0);