PR: 2141
[openssl.git] / engines / e_capi.c
index be01278ad4643980e951e9531227405b7292c5a4..8da67982b0be9a3292efbc468036b77e8dd0f1ea 100644 (file)
 #include <string.h>
 #include <openssl/crypto.h>
 #include <openssl/buffer.h>
-#include <openssl/engine.h>
-#include <openssl/rsa.h>
 #include <openssl/bn.h>
-#include <openssl/pem.h>
 
 #ifdef OPENSSL_SYS_WIN32
 #ifndef OPENSSL_NO_CAPIENG
 
+#include <openssl/rsa.h>
+
+#include <windows.h>
+
 #ifndef _WIN32_WINNT
-#define _WIN32_WINNT 0x400
+#define _WIN32_WINNT 0x0400
 #endif
 
-#include <windows.h>
 #include <wincrypt.h>
 
-#undef X509_NAME
+/*
+ * This module uses several "new" interfaces, among which is
+ * CertGetCertificateContextProperty. CERT_KEY_PROV_INFO_PROP_ID is
+ * one of possible values you can pass to function in question. By
+ * checking if it's defined we can see if wincrypt.h and accompanying
+ * crypt32.lib are in shape. Yes, it's rather "weak" test and if
+ * compilation fails, then re-configure with -DOPENSSL_NO_CAPIENG.
+ */
+#ifdef CERT_KEY_PROV_INFO_PROP_ID
+# define __COMPILE_CAPIENG
+#endif /* CERT_KEY_PROV_INFO_PROP_ID */
+#endif /* OPENSSL_NO_CAPIENG */
+#endif /* OPENSSL_SYS_WIN32 */
+
+#ifdef __COMPILE_CAPIENG
+
+#undef X509_EXTENSIONS
+#undef X509_CERT_PAIR
+
+/* Definitions which may be missing from earlier version of headers */
+#ifndef CERT_STORE_OPEN_EXISTING_FLAG
+#define CERT_STORE_OPEN_EXISTING_FLAG                   0x00004000
+#endif
+
+#ifndef CERT_STORE_CREATE_NEW_FLAG
+#define CERT_STORE_CREATE_NEW_FLAG                      0x00002000
+#endif
+
+#include <openssl/engine.h>
+#include <openssl/pem.h>
+#include <openssl/x509v3.h>
 
 #include "e_capi_err.h"
 #include "e_capi_err.c"
@@ -92,7 +122,6 @@ static int capi_list_providers(CAPI_CTX *ctx, BIO *out);
 static int capi_list_containers(CAPI_CTX *ctx, BIO *out);
 int capi_list_certs(CAPI_CTX *ctx, BIO *out, char *storename);
 void capi_free_key(CAPI_KEY *key);
-static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
 
 static PCCERT_CONTEXT capi_find_cert(CAPI_CTX *ctx, const char *id, HCERTSTORE hstore);
 
@@ -115,7 +144,17 @@ static int capi_dsa_free(DSA *dsa);
 static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
        STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey,
        STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data);
-       
+
+static int cert_select_simple(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
+#ifdef OPENSSL_CAPIENG_DIALOG
+static int cert_select_dialog(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
+#endif
+
+typedef PCCERT_CONTEXT (WINAPI *CERTDLG)(HCERTSTORE, HWND, LPCWSTR,
+                                               LPCWSTR, DWORD, DWORD,
+                                               void *);
+typedef HWND (WINAPI *GETCONSWIN)(void);
+
 /* This structure contains CAPI ENGINE specific data:
  * it contains various global options and affects how
  * other functions behave.
@@ -129,19 +168,21 @@ struct CAPI_CTX_st {
        char *debug_file;
        /* Parameters to use for container lookup */
        DWORD keytype;
-       LPTSTR cspname;
+       LPSTR cspname;
        DWORD csptype;
        /* Certificate store name to use */
-       LPTSTR storename;
-       LPTSTR ssl_client_store;
+       LPSTR storename;
+       LPSTR ssl_client_store;
+       /* System store flags */
+       DWORD store_flags;
 
 /* Lookup string meanings in load_private_key */
 /* Substring of subject: uses "storename" */
-#define CAPI_LU_SUBSTR         0
+#define CAPI_LU_SUBSTR         1
 /* Friendly name: uses storename */
-#define CAPI_LU_FNAME          1
+#define CAPI_LU_FNAME          2
 /* Container name: uses cspname, keytype */
-#define CAPI_LU_CONTNAME       2
+#define CAPI_LU_CONTNAME       3
        int lookup_method;
 /* Info to dump with dumpcerts option */
 /* Issuer and serial name strings */
@@ -158,6 +199,10 @@ struct CAPI_CTX_st {
 #define CAPI_DMP_PKEYINFO      0x20
 
        DWORD dump_flags;
+       int (*client_cert_select)(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs);
+
+       CERTDLG certselectdlg;
+       GETCONSWIN getconswindow;
 };
 
 
@@ -179,6 +224,7 @@ static int capi_ctx_set_provname_idx(CAPI_CTX *ctx, int idx);
 #define CAPI_CMD_LIST_OPTIONS          (ENGINE_CMD_BASE + 10)
 #define CAPI_CMD_LOOKUP_METHOD         (ENGINE_CMD_BASE + 11)
 #define CAPI_CMD_STORE_NAME            (ENGINE_CMD_BASE + 12)
+#define CAPI_CMD_STORE_FLAGS           (ENGINE_CMD_BASE + 13)
 
 static const ENGINE_CMD_DEFN capi_cmd_defns[] = {
        {CAPI_CMD_LIST_CERTS,
@@ -234,6 +280,10 @@ static const ENGINE_CMD_DEFN capi_cmd_defns[] = {
                "store_name",
                "certificate store name, default \"MY\"",
                ENGINE_CMD_FLAG_STRING},
+       {CAPI_CMD_STORE_FLAGS,
+               "store_flags",
+               "Certificate store flags: 1 = system store",
+               ENGINE_CMD_FLAG_NUMERIC},
 
        {0, NULL, NULL, 0}
        };
@@ -280,6 +330,20 @@ static int capi_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void))
                CAPI_trace(ctx, "Setting store name to %s\n", p);
                break;
 
+               case CAPI_CMD_STORE_FLAGS:
+               if (i & 1)
+                       {
+                       ctx->store_flags |= CERT_SYSTEM_STORE_LOCAL_MACHINE;
+                       ctx->store_flags &= ~CERT_SYSTEM_STORE_CURRENT_USER;
+                       }
+               else
+                       {
+                       ctx->store_flags |= CERT_SYSTEM_STORE_CURRENT_USER;
+                       ctx->store_flags &= ~CERT_SYSTEM_STORE_LOCAL_MACHINE;
+                       }
+               CAPI_trace(ctx, "Setting flags to %d\n", i);
+               break;
+
                case CAPI_CMD_DEBUG_LEVEL:
                ctx->debug_level = (int)i;
                CAPI_trace(ctx, "Setting debug level to %d\n", ctx->debug_level);
@@ -391,6 +455,20 @@ static int capi_init(ENGINE *e)
        capi_dsa_method.dsa_mod_exp = ossl_dsa_meth->dsa_mod_exp;
        capi_dsa_method.bn_mod_exp = ossl_dsa_meth->bn_mod_exp;
 
+#ifdef OPENSSL_CAPIENG_DIALOG
+       {
+       HMODULE cryptui = LoadLibrary(TEXT("CRYPTUI.DLL"));
+       HMODULE kernel = GetModuleHandle(TEXT("KERNEL32.DLL"));
+       if (cryptui)
+               ctx->certselectdlg = (CERTDLG)GetProcAddress(cryptui, "CryptUIDlgSelectCertificateFromStore");
+       if (kernel)
+               ctx->getconswindow = (GETCONSWIN)GetProcAddress(kernel, "GetConsoleWindow");
+       if (cryptui && !OPENSSL_isservice())
+               ctx->client_cert_select = cert_select_dialog;
+       }
+#endif
+               
+
        return 1;
 
        memerr:
@@ -654,7 +732,7 @@ static EVP_PKEY *capi_get_pkey(ENGINE *eng, CAPI_KEY *key)
        return ret;
 
 memerr:
-       CAPIerr(CAPI_F_CAPI_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
+       CAPIerr(CAPI_F_CAPI_GET_PKEY, ERR_R_MALLOC_FAILURE);
        goto err;
 
        }
@@ -761,7 +839,7 @@ int capi_rsa_sign(int dtype, const unsigned char *m, unsigned int m_len,
 
 /* Finally sign it */
        slen = RSA_size(rsa);
-       if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, sigret, &slen))
+       if(!CryptSignHashA(hash, capi_key->keyspec, NULL, 0, sigret, &slen))
                {
                CAPIerr(CAPI_F_CAPI_RSA_SIGN, CAPI_R_ERROR_SIGNING_HASH);
                capi_addlasterror();
@@ -899,7 +977,7 @@ static DSA_SIG *capi_dsa_do_sign(const unsigned char *digest, int dlen,
 
        /* Finally sign it */
        slen = sizeof(csigbuf);
-       if(!CryptSignHash(hash, capi_key->keyspec, NULL, 0, csigbuf, &slen))
+       if(!CryptSignHashA(hash, capi_key->keyspec, NULL, 0, csigbuf, &slen))
                {
                CAPIerr(CAPI_F_CAPI_DSA_DO_SIGN, CAPI_R_ERROR_SIGNING_HASH);
                capi_addlasterror();
@@ -974,15 +1052,29 @@ static void capi_adderror(DWORD err)
 static char *wide_to_asc(LPWSTR wstr)
        {
        char *str;
+       int len_0,sz;
+
        if (!wstr)
                return NULL;
-       str = OPENSSL_malloc(wcslen(wstr) + 1);
+       len_0 = (int)wcslen(wstr)+1;    /* WideCharToMultiByte expects int */
+        sz = WideCharToMultiByte(CP_ACP,0,wstr,len_0,NULL,0,NULL,NULL);
+       if (!sz)
+               {
+               CAPIerr(CAPI_F_WIDE_TO_ASC, CAPI_R_WIN32_ERROR);
+               return NULL;
+               }
+       str = OPENSSL_malloc(sz);
        if (!str)
                {
                CAPIerr(CAPI_F_WIDE_TO_ASC, ERR_R_MALLOC_FAILURE);
                return NULL;
                }
-       sprintf(str, "%S", wstr);
+       if (!WideCharToMultiByte(CP_ACP,0,wstr,len_0,str,sz,NULL,NULL))
+               {
+               OPENSSL_free(str);
+               CAPIerr(CAPI_F_WIDE_TO_ASC, CAPI_R_WIN32_ERROR);
+               return NULL;
+               }
        return str;
        }
 
@@ -991,7 +1083,7 @@ static int capi_get_provname(CAPI_CTX *ctx, LPSTR *pname, DWORD *ptype, DWORD id
        LPSTR name;
        DWORD len, err;
        CAPI_trace(ctx, "capi_get_provname, index=%d\n", idx);
-       if (!CryptEnumProviders(idx, NULL, 0, ptype, NULL, &len))
+       if (!CryptEnumProvidersA(idx, NULL, 0, ptype, NULL, &len))
                {
                err = GetLastError();
                if (err == ERROR_NO_MORE_ITEMS)
@@ -1001,7 +1093,7 @@ static int capi_get_provname(CAPI_CTX *ctx, LPSTR *pname, DWORD *ptype, DWORD id
                return 0;
                }
        name = OPENSSL_malloc(len);
-               if (!CryptEnumProviders(idx, NULL, 0, ptype, name, &len))
+       if (!CryptEnumProvidersA(idx, NULL, 0, ptype, name, &len))
                {
                err = GetLastError();
                if (err == ERROR_NO_MORE_ITEMS)
@@ -1020,7 +1112,7 @@ static int capi_list_providers(CAPI_CTX *ctx, BIO *out)
        {
        DWORD idx, ptype;
        int ret;
-       LPTSTR provname = NULL;
+       LPSTR provname = NULL;
        CAPI_trace(ctx, "capi_list_providers\n");
        BIO_printf(out, "Available CSPs:\n");
        for(idx = 0; ; idx++)
@@ -1043,7 +1135,7 @@ static int capi_list_containers(CAPI_CTX *ctx, BIO *out)
        DWORD err, idx, flags, buflen = 0, clen;
        LPSTR cname;
        CAPI_trace(ctx, "Listing containers CSP=%s, type = %d\n", ctx->cspname, ctx->csptype);
-       if (!CryptAcquireContext(&hprov, NULL, ctx->cspname, ctx->csptype, CRYPT_VERIFYCONTEXT))
+       if (!CryptAcquireContextA(&hprov, NULL, ctx->cspname, ctx->csptype, CRYPT_VERIFYCONTEXT))
                {
                CAPIerr(CAPI_F_CAPI_LIST_CONTAINERS, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
                capi_addlasterror();
@@ -1229,7 +1321,8 @@ HCERTSTORE capi_open_store(CAPI_CTX *ctx, char *storename)
                storename = "MY";
        CAPI_trace(ctx, "Opening certificate store %s\n", storename);
 
-       hstore = CertOpenSystemStore(0, storename);
+       hstore = CertOpenStore(CERT_STORE_PROV_SYSTEM_A, 0, 0, 
+                               ctx->store_flags, storename);
        if (!hstore)
                {
                CAPIerr(CAPI_F_CAPI_OPEN_STORE, CAPI_R_ERROR_OPENING_STORE);
@@ -1322,7 +1415,7 @@ static CAPI_KEY *capi_get_key(CAPI_CTX *ctx, const char *contname, char *provnam
        key = OPENSSL_malloc(sizeof(CAPI_KEY));
        CAPI_trace(ctx, "capi_get_key, contname=%s, provname=%s, type=%d\n", 
                                                contname, provname, ptype);
-       if (!CryptAcquireContext(&key->hprov, contname, provname, ptype, 0))
+       if (!CryptAcquireContextA(&key->hprov, contname, provname, ptype, 0))
                {
                CAPIerr(CAPI_F_CAPI_GET_KEY, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
                capi_addlasterror();
@@ -1346,7 +1439,7 @@ static CAPI_KEY *capi_get_key(CAPI_CTX *ctx, const char *contname, char *provnam
 
 static CAPI_KEY *capi_get_cert_key(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
        {
-       CAPI_KEY *key;
+       CAPI_KEY *key = NULL;
        CRYPT_KEY_PROV_INFO *pinfo = NULL;
        char *provname = NULL, *contname = NULL;
        pinfo = capi_get_prov_info(ctx, cert);
@@ -1355,8 +1448,7 @@ static CAPI_KEY *capi_get_cert_key(CAPI_CTX *ctx, PCCERT_CONTEXT cert)
        provname = wide_to_asc(pinfo->pwszProvName);
        contname = wide_to_asc(pinfo->pwszContainerName);
        if (!provname || !contname)
-               return 0;
-
+               goto err;
        key = capi_get_key(ctx, contname, provname,
                                pinfo->dwProvType, pinfo->dwKeySpec);
 
@@ -1429,9 +1521,13 @@ static CAPI_CTX *capi_ctx_new()
        ctx->keytype = AT_KEYEXCHANGE;
        ctx->storename = NULL;
        ctx->ssl_client_store = NULL;
+       ctx->store_flags = CERT_STORE_OPEN_EXISTING_FLAG |
+                               CERT_STORE_READONLY_FLAG |
+                               CERT_SYSTEM_STORE_CURRENT_USER;
        ctx->lookup_method = CAPI_LU_SUBSTR;
        ctx->debug_level = 0;
        ctx->debug_file = NULL;
+       ctx->client_cert_select = cert_select_simple;
        return ctx;
        }
 
@@ -1457,7 +1553,7 @@ static int capi_ctx_set_provname(CAPI_CTX *ctx, LPSTR pname, DWORD type, int che
        if (check)
                {
                HCRYPTPROV hprov;
-               if (!CryptAcquireContext(&hprov, NULL, pname, type,
+               if (!CryptAcquireContextA(&hprov, NULL, pname, type,
                                                CRYPT_VERIFYCONTEXT))
                        {
                        CAPIerr(CAPI_F_CAPI_CTX_SET_PROVNAME, CAPI_R_CRYPTACQUIRECONTEXT_ERROR);
@@ -1536,11 +1632,15 @@ static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
                        CAPI_trace(ctx, "Can't Parse Certificate %d\n", i);
                        continue;
                        }
-               if (cert_issuer_match(ca_dn, x))
+               if (cert_issuer_match(ca_dn, x)
+                       && X509_check_purpose(x, X509_PURPOSE_SSL_CLIENT, 0))
                        {
                        key = capi_get_cert_key(ctx, cert);
                        if (!key)
+                               {
+                               X509_free(x);
                                continue;
+                               }
                        /* Match found: attach extra data to it so
                         * we can retrieve the key later.
                         */
@@ -1569,7 +1669,7 @@ static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
 
        /* Select the appropriate certificate */
 
-       client_cert_idx = client_cert_select(e, ssl, certs);
+       client_cert_idx = ctx->client_cert_select(e, ssl, certs);
 
        /* Set the selected certificate and free the rest */
 
@@ -1601,29 +1701,35 @@ static int capi_load_ssl_client_cert(ENGINE *e, SSL *ssl,
 
        }
 
-#ifndef OPENSSL_CAPIENG_DIALOG
 
 /* Simple client cert selection function: always select first */
 
-static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
+static int cert_select_simple(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
        {
        return 0;
        }
 
-#else
+#ifdef OPENSSL_CAPIENG_DIALOG
 
 /* More complex cert selection function, using standard function
  * CryptUIDlgSelectCertificateFromStore() to produce a dialog box.
  */
 
-#include <cryptuiapi.h>
+/* Definitions which are in cryptuiapi.h but this is not present in older
+ * versions of headers.
+ */
+
+#ifndef CRYPTUI_SELECT_LOCATION_COLUMN
+#define CRYPTUI_SELECT_LOCATION_COLUMN                   0x000000010
+#define CRYPTUI_SELECT_INTENDEDUSE_COLUMN                0x000000004
+#endif
 
 #define dlg_title L"OpenSSL Application SSL Client Certificate Selection"
 #define dlg_prompt L"Select a certificate to use for authentication"
 #define dlg_columns     CRYPTUI_SELECT_LOCATION_COLUMN \
                        |CRYPTUI_SELECT_INTENDEDUSE_COLUMN
 
-static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
+static int cert_select_dialog(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
        {
        X509 *x;
        HCERTSTORE dstore;
@@ -1632,13 +1738,15 @@ static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
        CAPI_KEY *key;
        HWND hwnd;
        int i, idx = -1;
+       if (sk_X509_num(certs) == 1)
+               return 0;
        ctx = ENGINE_get_ex_data(e, capi_idx);
        /* Create an in memory store of certificates */
        dstore = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0,
                                        CERT_STORE_CREATE_NEW_FLAG, NULL);
        if (!dstore)
                {
-               CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_CREATING_STORE);
+               CAPIerr(CAPI_F_CERT_SELECT_DIALOG, CAPI_R_ERROR_CREATING_STORE);
                capi_addlasterror();
                goto err;
                }
@@ -1651,19 +1759,20 @@ static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
                if (!CertAddCertificateContextToStore(dstore, key->pcert,
                                                CERT_STORE_ADD_NEW, NULL))
                        {
-                       CAPIerr(CAPI_F_CLIENT_CERT_SELECT, CAPI_R_ERROR_ADDING_CERT);
+                       CAPIerr(CAPI_F_CERT_SELECT_DIALOG, CAPI_R_ERROR_ADDING_CERT);
                        capi_addlasterror();
                        goto err;
                        }
 
                }
-       hwnd = GetActiveWindow();
+       hwnd = GetForegroundWindow();
        if (!hwnd)
-               hwnd = GetConsoleWindow();
+               hwnd = GetActiveWindow();
+       if (!hwnd && ctx->getconswindow)
+               hwnd = ctx->getconswindow();
        /* Call dialog to select one */
-       cert = CryptUIDlgSelectCertificateFromStore(dstore, hwnd,
-                                                       dlg_title, dlg_prompt,
-                                                       dlg_columns, 0, NULL);
+       cert = ctx->certselectdlg(dstore, hwnd, dlg_title, dlg_prompt,
+                                               dlg_columns, 0, NULL);
 
        /* Find matching cert from list */
        if (cert)
@@ -1691,5 +1800,13 @@ static int client_cert_select(ENGINE *e, SSL *ssl, STACK_OF(X509) *certs)
        }
 #endif
 
+#else /* !__COMPILE_CAPIENG */
+#include <openssl/engine.h>
+#ifndef OPENSSL_NO_DYNAMIC_ENGINE
+OPENSSL_EXPORT
+int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { return 0; }
+IMPLEMENT_DYNAMIC_CHECK_FN()
+#else
+void ENGINE_load_capi(void){}
 #endif
 #endif