21#include <winpr/error.h>
22#include <winpr/ncrypt.h>
23#include <winpr/string.h>
24#include <winpr/wlog.h>
25#include <winpr/crypto.h>
26#include <winpr/path.h>
28#include <freerdp/log.h>
29#include <freerdp/freerdp.h>
30#include <winpr/print.h>
32#include <freerdp/utils/smartcardlogon.h>
33#include <freerdp/crypto/crypto.h>
34#include <freerdp/utils/helpers.h>
36#include <openssl/obj_mac.h>
38#define TAG FREERDP_TAG("smartcardlogon")
40struct SmartcardKeyInfo_st
46static void delete_file(
char* path)
53 FILE* fp = winpr_fopen(path,
"r+");
56 const char buffer[8192] = WINPR_C_ARRAY_INIT;
58 int rs = _fseeki64(fp, 0, SEEK_END);
61 (void)_fseeki64(fp, 0, SEEK_SET);
63 for (INT64 x = 0; x < size; x +=
sizeof(buffer))
65 const size_t dnmemb = (size_t)(size - x);
66 const size_t nmemb = MIN(
sizeof(buffer), dnmemb);
67 const size_t count = fwrite(buffer, nmemb, 1, fp);
76 winpr_DeleteFile(path);
80static void smartcardKeyInfo_Free(SmartcardKeyInfo* key_info)
85 delete_file(key_info->certPath);
86 delete_file(key_info->keyPath);
98 freerdp_certificate_free(scCert->certificate);
99 free(scCert->pkinitArgs);
100 free(scCert->keyName);
101 free(scCert->containerName);
103 free(scCert->userHint);
104 free(scCert->domainHint);
105 free(scCert->subject);
106 free(scCert->issuer);
107 smartcardKeyInfo_Free(scCert->key_info);
117 for (
size_t i = 0; i < count; i++)
120 smartcardCertInfo_Free(cert);
123 free((
void*)pscCert);
129 size_t curCount = *count;
133 for (
size_t i = 0; i < curCount; ++i)
135 if (_wcscmp(curInfoList[i]->containerName, certInfo->containerName) == 0)
137 smartcardCertInfo_Free(certInfo);
147 WLog_ERR(TAG,
"unable to reallocate certs");
150 curInfoList = tmpInfoList;
153 curInfoList[curCount++] = certInfo;
154 *certInfoList = curInfoList;
161 WINPR_ASSERT(scCert);
163 scCert->upn = freerdp_certificate_get_upn(scCert->certificate);
166 WLog_DBG(TAG,
"%s has no UPN, trying emailAddress", scCert->keyName);
167 scCert->upn = freerdp_certificate_get_email(scCert->certificate);
173 const char* atPos = strchr(scCert->upn,
'@');
177 WLog_ERR(TAG,
"invalid UPN, for key %s (no @)", scCert->keyName);
181 userLen = (size_t)(atPos - scCert->upn);
182 scCert->userHint = malloc(userLen + 1);
183 scCert->domainHint = _strdup(atPos + 1);
185 if (!scCert->userHint || !scCert->domainHint)
187 WLog_ERR(TAG,
"error allocating userHint or domainHint, for key %s", scCert->keyName);
191 memcpy(scCert->userHint, scCert->upn, userLen);
192 scCert->userHint[userLen] = 0;
195 scCert->subject = freerdp_certificate_get_subject(scCert->certificate);
196 scCert->issuer = freerdp_certificate_get_issuer(scCert->certificate);
200static BOOL set_info_certificate(
SmartcardCertInfo* cert, BYTE* certBytes, DWORD cbCertBytes,
201 const char* userFilter,
const char* domainFilter)
203 if (!winpr_Digest(WINPR_MD_SHA1, certBytes, cbCertBytes, cert->sha1Hash,
204 sizeof(cert->sha1Hash)))
206 WLog_ERR(TAG,
"unable to compute certificate sha1 for key %s", cert->keyName);
210 cert->certificate = freerdp_certificate_new_from_der(certBytes, cbCertBytes);
211 if (!cert->certificate)
213 WLog_ERR(TAG,
"unable to parse X509 certificate for key %s", cert->keyName);
217 if (!freerdp_certificate_check_eku(cert->certificate, NID_ms_smartcard_login))
219 WLog_DBG(TAG,
"discarding certificate without Smartcard Login EKU for key %s",
224 if (!treat_sc_cert(cert))
226 WLog_DBG(TAG,
"error treating cert");
230 if (userFilter && (!cert->upn || (strcmp(cert->upn, userFilter) != 0)))
232 if (cert->userHint && strcmp(cert->userHint, userFilter) != 0)
234 WLog_DBG(TAG,
"discarding non matching cert by user %s@%s", cert->userHint,
240 if (domainFilter && cert->domainHint && strcmp(cert->domainHint, domainFilter) != 0)
242 WLog_DBG(TAG,
"discarding non matching cert by domain(%s) %s@%s", domainFilter,
243 cert->userHint, cert->domainHint);
251static BOOL build_pkinit_args(NCRYPT_PROV_HANDLE provider,
SmartcardCertInfo* scCert)
256 const char* pkModule = winpr_NCryptGetModulePath(provider);
259 return (winpr_asprintf(&scCert->pkinitArgs, &size,
"PKCS11:module_name=%s:slotid=%" PRIu16,
260 pkModule, (UINT16)scCert->slotId) > 0);
265static BOOL list_capi_provider_keys(
const rdpSettings* settings, LPCWSTR csp, LPCWSTR scope,
266 const char* userFilter,
const char* domainFilter,
271 HCRYPTPROV hProvider = 0;
273 BYTE* certBytes =
nullptr;
274 CHAR* readerName =
nullptr;
276 if (!CryptAcquireContextW(&hProvider, scope, csp, PROV_RSA_FULL, CRYPT_SILENT))
278 WLog_DBG(TAG,
"Unable to acquire context: %d", GetLastError());
286 cert->csp = _wcsdup(csp);
292 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER,
nullptr, &dwDataLen, 0))
294 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
298 readerName = malloc(dwDataLen);
302 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER, readerName, &dwDataLen, 0))
304 WLog_DBG(TAG,
"Unable to get reader name: %d", GetLastError());
308 cert->reader = ConvertUtf8ToWCharAlloc(readerName,
nullptr);
314 if (!CryptGetProvParam(hProvider, PP_CONTAINER,
nullptr, &dwDataLen, 0))
316 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
320 cert->keyName = malloc(dwDataLen);
324 if (!CryptGetProvParam(hProvider, PP_CONTAINER, cert->keyName, &dwDataLen, 0))
326 WLog_DBG(TAG,
"Unable to get container name: %d", GetLastError());
330 cert->containerName = ConvertUtf8ToWCharAlloc(cert->keyName,
nullptr);
331 if (!cert->containerName)
335 if (!CryptGetUserKey(hProvider, AT_KEYEXCHANGE, &hKey))
337 WLog_DBG(TAG,
"Unable to get user key for %s: %d", cert->keyName, GetLastError());
342 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE,
nullptr, &dwDataLen, 0))
344 WLog_DBG(TAG,
"Unable to get key param for key %s: %d", cert->keyName, GetLastError());
348 certBytes = malloc(dwDataLen);
351 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", dwDataLen,
356 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE, certBytes, &dwDataLen, 0))
358 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
362 if (!set_info_certificate(cert, certBytes, dwDataLen, userFilter, domainFilter))
365 if (!add_cert_to_list(pcerts, pcount, cert))
374 CryptDestroyKey(hKey);
376 CryptReleaseContext(hProvider, 0);
378 smartcardCertInfo_Free(cert);
383static BOOL list_provider_keys(WINPR_ATTR_UNUSED
const rdpSettings* settings,
384 NCRYPT_PROV_HANDLE provider, LPCWSTR csp, LPCWSTR scope,
385 const char* userFilter,
const char* domainFilter,
390 PVOID enumState =
nullptr;
392 size_t count = *pcount;
394 while (NCryptEnumKeys(provider, scope, &keyName, &enumState, NCRYPT_SILENT_FLAG) ==
397 NCRYPT_KEY_HANDLE phKey = 0;
398 PBYTE certBytes =
nullptr;
399 DWORD dwFlags = NCRYPT_SILENT_FLAG;
402 BOOL haveError = TRUE;
403 SECURITY_STATUS status = 0;
409 cert->keyName = ConvertWCharToUtf8Alloc(keyName->pszName,
nullptr);
413 WLog_DBG(TAG,
"opening key %s", cert->keyName);
416 NCryptOpenKey(provider, &phKey, keyName->pszName, keyName->dwLegacyKeySpec, dwFlags);
417 if (status != ERROR_SUCCESS)
420 "unable to NCryptOpenKey(dwLegacyKeySpec=0x%08" PRIx32
" dwFlags=0x%08" PRIx32
421 "), status=%s, skipping",
422 keyName->dwLegacyKeySpec, keyName->dwFlags,
423 winpr_NCryptSecurityStatusError(status));
427 cert->csp = _wcsdup(csp);
432 status = NCryptGetProperty(phKey, NCRYPT_WINPR_SLOTID, (PBYTE)&cert->slotId, 4, &cbOutput,
434 if (status != ERROR_SUCCESS)
436 WLog_ERR(TAG,
"unable to retrieve slotId for key %s, status=%s", cert->keyName,
437 winpr_NCryptSecurityStatusError(status));
444 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
445 if (status != ERROR_SUCCESS)
447 WLog_DBG(TAG,
"unable to retrieve reader's name length for key %s", cert->keyName);
451 cert->reader = calloc(1, cbOutput + 2);
454 WLog_ERR(TAG,
"unable to allocate reader's name for key %s", cert->keyName);
458 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY, (PBYTE)cert->reader, cbOutput + 2,
460 if (status != ERROR_SUCCESS)
462 WLog_ERR(TAG,
"unable to retrieve reader's name for key %s", cert->keyName);
469 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
470 if (status == ERROR_SUCCESS)
472 cert->containerName = calloc(1, cbOutput +
sizeof(WCHAR));
473 if (!cert->containerName)
475 WLog_ERR(TAG,
"unable to allocate key container name for key %s", cert->keyName);
479 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY, (BYTE*)cert->containerName,
480 cbOutput, &cbOutput, dwFlags);
483 if (status != ERROR_SUCCESS)
485 WLog_ERR(TAG,
"unable to retrieve key container name for key %s", cert->keyName);
492 NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
493 if (status != ERROR_SUCCESS)
496 WLog_DBG(TAG,
"unable to retrieve certificate property len, status=%s, skipping",
497 winpr_NCryptSecurityStatusError(status));
501 certBytes = calloc(1, cbOutput);
504 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", cbOutput,
509 status = NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY, certBytes, cbOutput,
511 if (status != ERROR_SUCCESS)
513 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
517 if (!set_info_certificate(cert, certBytes, cbOutput, userFilter, domainFilter))
521 if (!build_pkinit_args(provider, cert))
523 WLog_ERR(TAG,
"error build pkinit args");
531 NCryptFreeBuffer(keyName);
533 NCryptFreeObject((NCRYPT_HANDLE)phKey);
536 smartcardCertInfo_Free(cert);
539 if (!add_cert_to_list(&cert_list, &count, cert))
548 char cspa[128] = WINPR_C_ARRAY_INIT;
550 (void)ConvertWCharToUtf8(csp, cspa,
sizeof(cspa));
551 char scopea[128] = WINPR_C_ARRAY_INIT;
552 (void)ConvertWCharToUtf8(scope, scopea,
sizeof(scopea));
553 WLog_WARN(TAG,
"%s [%s] no certificates found", cspa, scopea);
557 NCryptFreeBuffer(enumState);
561static BOOL smartcard_hw_enumerateCerts(
const rdpSettings* settings, LPCWSTR csp,
562 const char* reader,
const char* userFilter,
567 LPWSTR scope =
nullptr;
568 NCRYPT_PROV_HANDLE provider = 0;
569 SECURITY_STATUS status = 0;
574 WINPR_ASSERT(scCerts);
575 WINPR_ASSERT(retCount);
579 size_t readerSz = strlen(reader);
580 char* scopeStr = malloc(4 + readerSz + 1 + 1);
584 (void)_snprintf(scopeStr, readerSz + 6,
"\\\\.\\%s\\", reader);
585 scope = ConvertUtf8NToWCharAlloc(scopeStr, readerSz + 6,
nullptr);
595 LPCSTR paths[] = { Pkcs11Module,
nullptr };
600 status = winpr_NCryptOpenStorageProviderEx(&provider, csp, 0, paths);
601 if (status != ERROR_SUCCESS)
603 WLog_ERR(TAG,
"unable to open provider given by pkcs11 module");
607 status = list_provider_keys(settings, provider, csp, scope, userFilter, domainFilter,
609 NCryptFreeObject((NCRYPT_HANDLE)provider);
612 WLog_ERR(TAG,
"error listing keys from CSP loaded from %s", Pkcs11Module);
619 DWORD nproviders = 0;
623 DWORD provType, cbProvName = 0;
624 for (DWORD i = 0; CryptEnumProvidersW(i,
nullptr, 0, &provType,
nullptr, &cbProvName); ++i)
626 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
627 LPWSTR szProvName = malloc(cbProvName *
sizeof(WCHAR));
628 if (!CryptEnumProvidersW(i,
nullptr, 0, &provType, szProvName, &cbProvName))
634 if (ConvertWCharToUtf8(szProvName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
636 _snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
637 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
641 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
642 if (provType != PROV_RSA_FULL || (csp && _wcscmp(szProvName, csp) != 0))
644 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
648 if (!list_capi_provider_keys(settings, szProvName, scope, userFilter, domainFilter,
650 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
657 status = NCryptEnumStorageProviders(&nproviders, &names, NCRYPT_SILENT_FLAG);
658 if (status != ERROR_SUCCESS)
660 WLog_ERR(TAG,
"error listing providers");
664 for (DWORD i = 0; i < nproviders; i++)
666 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
669 if (ConvertWCharToUtf8(name->pszName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
671 (void)_snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
672 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
676 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
677 if (csp && _wcscmp(name->pszName, csp) != 0)
679 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
683 status = NCryptOpenStorageProvider(&provider, name->pszName, 0);
684 if (status != ERROR_SUCCESS)
687 if (!list_provider_keys(settings, provider, name->pszName, scope, userFilter,
688 domainFilter, &cert_list, &count))
689 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
691 NCryptFreeObject((NCRYPT_HANDLE)provider);
694 NCryptFreeBuffer(names);
697 *scCerts = cert_list;
703 smartcardCertList_Free(cert_list, count);
708static char* create_temporary_file(
void)
710 BYTE buffer[32] = WINPR_C_ARRAY_INIT;
711 char* path =
nullptr;
713 if (winpr_RAND(buffer,
sizeof(buffer)) < 0)
716 char* hex = winpr_BinToHexString(buffer,
sizeof(buffer), FALSE);
718 path = GetKnownSubPath(KNOWN_PATH_TEMP, hex);
723static SmartcardCertInfo* smartcardCertInfo_New(
const char* privKeyPEM,
const char* certPEM)
727 WINPR_ASSERT(privKeyPEM);
728 WINPR_ASSERT(certPEM);
735 SmartcardKeyInfo* info = cert->key_info = calloc(1,
sizeof(SmartcardKeyInfo));
739 cert->certificate = freerdp_certificate_new_from_pem(certPEM);
740 if (!cert->certificate)
742 WLog_ERR(TAG,
"unable to read smartcard certificate");
746 if (!treat_sc_cert(cert))
748 WLog_ERR(TAG,
"unable to treat smartcard certificate");
755 (void)winpr_asprintf(&str, &len,
"%s Emulator", freerdp_getApplicationDetailsString());
757 cert->reader = ConvertUtf8NToWCharAlloc(str, len,
nullptr);
763 cert->containerName = ConvertUtf8ToWCharAlloc(
"Private Key 00",
nullptr);
764 if (!cert->containerName)
772 info->keyPath = create_temporary_file();
773 WLog_DBG(TAG,
"writing PKINIT key to %s", info->keyPath);
774 if (!crypto_write_pem(info->keyPath, privKeyPEM, strlen(privKeyPEM)))
777 info->certPath = create_temporary_file();
778 WLog_DBG(TAG,
"writing PKINIT cert to %s", info->certPath);
779 if (!crypto_write_pem(info->certPath, certPEM, strlen(certPEM)))
783 const int res = winpr_asprintf(&cert->pkinitArgs, &size,
"FILE:%s,%s", info->certPath,
792 smartcardCertInfo_Free(cert);
796static BOOL smartcard_sw_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
802 WINPR_ASSERT(settings);
803 WINPR_ASSERT(scCerts);
804 WINPR_ASSERT(retCount);
810 WLog_ERR(TAG,
"Invalid smartcard private key PEM, aborting");
815 WLog_ERR(TAG,
"Invalid smartcard certificate PEM, aborting");
831 *scCerts = cert_list;
836 smartcardCertList_Free(cert_list, 1);
840BOOL smartcard_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
841 size_t* retCount, BOOL gateway)
844 LPWSTR csp =
nullptr;
847 const char* Username =
nullptr;
848 const char* Domain =
nullptr;
861 WINPR_ASSERT(settings);
862 WINPR_ASSERT(scCerts);
863 WINPR_ASSERT(retCount);
865 if (Domain && !strlen(Domain))
869 return smartcard_sw_enumerateCerts(settings, scCerts, retCount);
871 if (CspName && (!(csp = ConvertUtf8ToWCharAlloc(CspName,
nullptr))))
873 WLog_ERR(TAG,
"error while converting CSP to WCHAR");
878 smartcard_hw_enumerateCerts(settings, csp, ReaderName, Username, Domain, scCerts, retCount);
883static BOOL set_settings_from_smartcard(rdpSettings* settings, FreeRDP_Settings_Keys_String
id,
886 WINPR_ASSERT(settings);
895BOOL smartcard_getCert(
const rdpContext* context,
SmartcardCertInfo** cert, BOOL gateway)
897 WINPR_ASSERT(context);
899 const freerdp* instance = context->instance;
900 rdpSettings* settings = context->settings;
904 WINPR_ASSERT(instance);
905 WINPR_ASSERT(settings);
907 if (!smartcard_enumerateCerts(settings, &cert_list, &count, gateway))
912 WLog_ERR(TAG,
"no suitable smartcard certificates were found");
916 if (count > UINT32_MAX)
918 WLog_ERR(TAG,
"smartcard certificate count %" PRIuz
" exceeds UINT32_MAX", count);
926 if (!instance->ChooseSmartcard ||
927 !instance->ChooseSmartcard(context->instance, cert_list, (UINT32)count, &index,
930 WLog_ERR(TAG,
"more than one suitable smartcard certificate was found");
931 smartcardCertList_Free(cert_list, count);
934 *cert = cert_list[index];
936 for (DWORD i = 0; i < index; i++)
937 smartcardCertInfo_Free(cert_list[i]);
938 for (DWORD i = index + 1; i < count; i++)
939 smartcardCertInfo_Free(cert_list[i]);
942 *cert = cert_list[0];
944 FreeRDP_Settings_Keys_String username_setting =
945 gateway ? FreeRDP_GatewayUsername : FreeRDP_Username;
946 FreeRDP_Settings_Keys_String domain_setting = gateway ? FreeRDP_GatewayDomain : FreeRDP_Domain;
948 free((
void*)cert_list);
950 if (!set_settings_from_smartcard(settings, username_setting, (*cert)->userHint) ||
951 !set_settings_from_smartcard(settings, domain_setting, (*cert)->domainHint))
953 WLog_ERR(TAG,
"unable to set settings from smartcard!");
954 smartcardCertInfo_Free(*cert);
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
a provider name descriptor