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 if (_fseeki64(fp, 0, SEEK_SET) == 0)
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);
77 winpr_DeleteFile(path);
81static void smartcardKeyInfo_Free(SmartcardKeyInfo* key_info)
86 delete_file(key_info->certPath);
87 delete_file(key_info->keyPath);
99 freerdp_certificate_free(scCert->certificate);
100 free(scCert->pkinitArgs);
101 free(scCert->keyName);
102 free(scCert->containerName);
104 free(scCert->userHint);
105 free(scCert->domainHint);
106 free(scCert->subject);
107 free(scCert->issuer);
108 smartcardKeyInfo_Free(scCert->key_info);
118 for (
size_t i = 0; i < count; i++)
121 smartcardCertInfo_Free(cert);
124 free((
void*)pscCert);
130 size_t curCount = *count;
134 for (
size_t i = 0; i < curCount; ++i)
136 if (_wcscmp(curInfoList[i]->containerName, certInfo->containerName) == 0)
138 smartcardCertInfo_Free(certInfo);
148 WLog_ERR(TAG,
"unable to reallocate certs");
151 curInfoList = tmpInfoList;
154 curInfoList[curCount++] = certInfo;
155 *certInfoList = curInfoList;
162 WINPR_ASSERT(scCert);
164 scCert->upn = freerdp_certificate_get_upn(scCert->certificate);
167 WLog_DBG(TAG,
"%s has no UPN, trying emailAddress", scCert->keyName);
168 scCert->upn = freerdp_certificate_get_email(scCert->certificate);
174 const char* atPos = strchr(scCert->upn,
'@');
178 WLog_ERR(TAG,
"invalid UPN, for key %s (no @)", scCert->keyName);
182 userLen = (size_t)(atPos - scCert->upn);
183 scCert->userHint = malloc(userLen + 1);
184 scCert->domainHint = _strdup(atPos + 1);
186 if (!scCert->userHint || !scCert->domainHint)
188 WLog_ERR(TAG,
"error allocating userHint or domainHint, for key %s", scCert->keyName);
192 memcpy(scCert->userHint, scCert->upn, userLen);
193 scCert->userHint[userLen] = 0;
196 scCert->subject = freerdp_certificate_get_subject(scCert->certificate);
197 scCert->issuer = freerdp_certificate_get_issuer(scCert->certificate);
201static BOOL set_info_certificate(
SmartcardCertInfo* cert, BYTE* certBytes, DWORD cbCertBytes,
202 const char* userFilter,
const char* domainFilter)
204 if (!winpr_Digest(WINPR_MD_SHA1, certBytes, cbCertBytes, cert->sha1Hash,
205 sizeof(cert->sha1Hash)))
207 WLog_ERR(TAG,
"unable to compute certificate sha1 for key %s", cert->keyName);
211 cert->certificate = freerdp_certificate_new_from_der(certBytes, cbCertBytes);
212 if (!cert->certificate)
214 WLog_ERR(TAG,
"unable to parse X509 certificate for key %s", cert->keyName);
218 if (!freerdp_certificate_check_eku(cert->certificate, NID_ms_smartcard_login))
220 WLog_DBG(TAG,
"discarding certificate without Smartcard Login EKU for key %s",
225 if (!treat_sc_cert(cert))
227 WLog_DBG(TAG,
"error treating cert");
231 if (userFilter && (!cert->upn || (strcmp(cert->upn, userFilter) != 0)))
233 if (cert->userHint && strcmp(cert->userHint, userFilter) != 0)
235 WLog_DBG(TAG,
"discarding non matching cert by user %s@%s", cert->userHint,
241 if (domainFilter && cert->domainHint && strcmp(cert->domainHint, domainFilter) != 0)
243 WLog_DBG(TAG,
"discarding non matching cert by domain(%s) %s@%s", domainFilter,
244 cert->userHint, cert->domainHint);
252static BOOL build_pkinit_args(NCRYPT_PROV_HANDLE provider,
SmartcardCertInfo* scCert)
257 const char* pkModule = winpr_NCryptGetModulePath(provider);
260 return (winpr_asprintf(&scCert->pkinitArgs, &size,
"PKCS11:module_name=%s:slotid=%" PRIu16,
261 pkModule, (UINT16)scCert->slotId) > 0);
266static BOOL list_capi_provider_keys(
const rdpSettings* settings, LPCWSTR csp, LPCWSTR scope,
267 const char* userFilter,
const char* domainFilter,
272 HCRYPTPROV hProvider = 0;
274 BYTE* certBytes =
nullptr;
275 CHAR* readerName =
nullptr;
277 if (!CryptAcquireContextW(&hProvider, scope, csp, PROV_RSA_FULL, CRYPT_SILENT))
279 WLog_DBG(TAG,
"Unable to acquire context: %d", GetLastError());
287 cert->csp = _wcsdup(csp);
293 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER,
nullptr, &dwDataLen, 0))
295 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
299 readerName = malloc(dwDataLen);
303 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER, readerName, &dwDataLen, 0))
305 WLog_DBG(TAG,
"Unable to get reader name: %d", GetLastError());
309 cert->reader = ConvertUtf8ToWCharAlloc(readerName,
nullptr);
315 if (!CryptGetProvParam(hProvider, PP_CONTAINER,
nullptr, &dwDataLen, 0))
317 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
321 cert->keyName = malloc(dwDataLen);
325 if (!CryptGetProvParam(hProvider, PP_CONTAINER, cert->keyName, &dwDataLen, 0))
327 WLog_DBG(TAG,
"Unable to get container name: %d", GetLastError());
331 cert->containerName = ConvertUtf8ToWCharAlloc(cert->keyName,
nullptr);
332 if (!cert->containerName)
336 if (!CryptGetUserKey(hProvider, AT_KEYEXCHANGE, &hKey))
338 WLog_DBG(TAG,
"Unable to get user key for %s: %d", cert->keyName, GetLastError());
343 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE,
nullptr, &dwDataLen, 0))
345 WLog_DBG(TAG,
"Unable to get key param for key %s: %d", cert->keyName, GetLastError());
349 certBytes = malloc(dwDataLen);
352 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", dwDataLen,
357 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE, certBytes, &dwDataLen, 0))
359 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
363 if (!set_info_certificate(cert, certBytes, dwDataLen, userFilter, domainFilter))
366 if (!add_cert_to_list(pcerts, pcount, cert))
375 CryptDestroyKey(hKey);
377 CryptReleaseContext(hProvider, 0);
379 smartcardCertInfo_Free(cert);
384static BOOL list_provider_keys(WINPR_ATTR_UNUSED
const rdpSettings* settings,
385 NCRYPT_PROV_HANDLE provider, LPCWSTR csp, LPCWSTR scope,
386 const char* userFilter,
const char* domainFilter,
391 PVOID enumState =
nullptr;
393 size_t count = *pcount;
395 while (NCryptEnumKeys(provider, scope, &keyName, &enumState, NCRYPT_SILENT_FLAG) ==
398 NCRYPT_KEY_HANDLE phKey = 0;
399 PBYTE certBytes =
nullptr;
400 DWORD dwFlags = NCRYPT_SILENT_FLAG;
403 BOOL haveError = TRUE;
404 SECURITY_STATUS status = 0;
410 cert->keyName = ConvertWCharToUtf8Alloc(keyName->pszName,
nullptr);
414 WLog_DBG(TAG,
"opening key %s", cert->keyName);
417 NCryptOpenKey(provider, &phKey, keyName->pszName, keyName->dwLegacyKeySpec, dwFlags);
418 if (status != ERROR_SUCCESS)
421 "unable to NCryptOpenKey(dwLegacyKeySpec=0x%08" PRIx32
" dwFlags=0x%08" PRIx32
422 "), status=%s, skipping",
423 keyName->dwLegacyKeySpec, keyName->dwFlags,
424 winpr_NCryptSecurityStatusError(status));
428 cert->csp = _wcsdup(csp);
433 status = NCryptGetProperty(phKey, NCRYPT_WINPR_SLOTID, (PBYTE)&cert->slotId, 4, &cbOutput,
435 if (status != ERROR_SUCCESS)
437 WLog_ERR(TAG,
"unable to retrieve slotId for key %s, status=%s", cert->keyName,
438 winpr_NCryptSecurityStatusError(status));
445 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
446 if (status != ERROR_SUCCESS)
448 WLog_DBG(TAG,
"unable to retrieve reader's name length for key %s", cert->keyName);
452 cert->reader = calloc(1, cbOutput + 2);
455 WLog_ERR(TAG,
"unable to allocate reader's name for key %s", cert->keyName);
459 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY, (PBYTE)cert->reader, cbOutput + 2,
461 if (status != ERROR_SUCCESS)
463 WLog_ERR(TAG,
"unable to retrieve reader's name for key %s", cert->keyName);
470 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
471 if (status == ERROR_SUCCESS)
473 cert->containerName = calloc(1, cbOutput +
sizeof(WCHAR));
474 if (!cert->containerName)
476 WLog_ERR(TAG,
"unable to allocate key container name for key %s", cert->keyName);
480 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY, (BYTE*)cert->containerName,
481 cbOutput, &cbOutput, dwFlags);
484 if (status != ERROR_SUCCESS)
486 WLog_ERR(TAG,
"unable to retrieve key container name for key %s", cert->keyName);
493 NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
494 if (status != ERROR_SUCCESS)
497 WLog_DBG(TAG,
"unable to retrieve certificate property len, status=%s, skipping",
498 winpr_NCryptSecurityStatusError(status));
502 certBytes = calloc(1, cbOutput);
505 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", cbOutput,
510 status = NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY, certBytes, cbOutput,
512 if (status != ERROR_SUCCESS)
514 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
518 if (!set_info_certificate(cert, certBytes, cbOutput, userFilter, domainFilter))
522 if (!build_pkinit_args(provider, cert))
524 WLog_ERR(TAG,
"error build pkinit args");
532 NCryptFreeBuffer(keyName);
534 NCryptFreeObject((NCRYPT_HANDLE)phKey);
537 smartcardCertInfo_Free(cert);
540 if (!add_cert_to_list(&cert_list, &count, cert))
549 char cspa[128] = WINPR_C_ARRAY_INIT;
551 (void)ConvertWCharToUtf8(csp, cspa,
sizeof(cspa));
552 char scopea[128] = WINPR_C_ARRAY_INIT;
553 (void)ConvertWCharToUtf8(scope, scopea,
sizeof(scopea));
554 WLog_WARN(TAG,
"%s [%s] no certificates found", cspa, scopea);
558 NCryptFreeBuffer(enumState);
562static BOOL smartcard_hw_enumerateCerts(
const rdpSettings* settings, LPCWSTR csp,
563 const char* reader,
const char* userFilter,
568 LPWSTR scope =
nullptr;
569 NCRYPT_PROV_HANDLE provider = 0;
570 SECURITY_STATUS status = 0;
575 WINPR_ASSERT(scCerts);
576 WINPR_ASSERT(retCount);
580 size_t readerSz = strlen(reader);
581 char* scopeStr = malloc(4 + readerSz + 1 + 1);
585 (void)_snprintf(scopeStr, readerSz + 6,
"\\\\.\\%s\\", reader);
586 scope = ConvertUtf8NToWCharAlloc(scopeStr, readerSz + 6,
nullptr);
596 LPCSTR paths[] = { Pkcs11Module,
nullptr };
601 status = winpr_NCryptOpenStorageProviderEx(&provider, csp, 0, paths);
602 if (status != ERROR_SUCCESS)
604 WLog_ERR(TAG,
"unable to open provider given by pkcs11 module");
608 status = list_provider_keys(settings, provider, csp, scope, userFilter, domainFilter,
610 NCryptFreeObject((NCRYPT_HANDLE)provider);
613 WLog_ERR(TAG,
"error listing keys from CSP loaded from %s", Pkcs11Module);
620 DWORD nproviders = 0;
624 DWORD provType, cbProvName = 0;
625 for (DWORD i = 0; CryptEnumProvidersW(i,
nullptr, 0, &provType,
nullptr, &cbProvName); ++i)
627 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
628 LPWSTR szProvName = malloc(cbProvName *
sizeof(WCHAR));
629 if (!CryptEnumProvidersW(i,
nullptr, 0, &provType, szProvName, &cbProvName))
635 if (ConvertWCharToUtf8(szProvName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
637 _snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
638 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
642 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
643 if (provType != PROV_RSA_FULL || (csp && _wcscmp(szProvName, csp) != 0))
645 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
649 if (!list_capi_provider_keys(settings, szProvName, scope, userFilter, domainFilter,
651 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
658 status = NCryptEnumStorageProviders(&nproviders, &names, NCRYPT_SILENT_FLAG);
659 if (status != ERROR_SUCCESS)
661 WLog_ERR(TAG,
"error listing providers");
665 for (DWORD i = 0; i < nproviders; i++)
667 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
670 if (ConvertWCharToUtf8(name->pszName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
672 (void)_snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
673 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
677 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
678 if (csp && _wcscmp(name->pszName, csp) != 0)
680 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
684 status = NCryptOpenStorageProvider(&provider, name->pszName, 0);
685 if (status != ERROR_SUCCESS)
688 if (!list_provider_keys(settings, provider, name->pszName, scope, userFilter,
689 domainFilter, &cert_list, &count))
690 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
692 NCryptFreeObject((NCRYPT_HANDLE)provider);
695 NCryptFreeBuffer(names);
698 *scCerts = cert_list;
704 smartcardCertList_Free(cert_list, count);
709static char* create_temporary_file(
void)
711 BYTE buffer[32] = WINPR_C_ARRAY_INIT;
712 char* path =
nullptr;
714 if (winpr_RAND(buffer,
sizeof(buffer)) < 0)
717 char* hex = winpr_BinToHexString(buffer,
sizeof(buffer), FALSE);
719 path = GetKnownSubPath(KNOWN_PATH_TEMP, hex);
724static SmartcardCertInfo* smartcardCertInfo_New(
const char* privKeyPEM,
const char* certPEM)
728 WINPR_ASSERT(privKeyPEM);
729 WINPR_ASSERT(certPEM);
736 SmartcardKeyInfo* info = cert->key_info = calloc(1,
sizeof(SmartcardKeyInfo));
740 cert->certificate = freerdp_certificate_new_from_pem(certPEM);
741 if (!cert->certificate)
743 WLog_ERR(TAG,
"unable to read smartcard certificate");
747 if (!treat_sc_cert(cert))
749 WLog_ERR(TAG,
"unable to treat smartcard certificate");
756 (void)winpr_asprintf(&str, &len,
"%s Emulator", freerdp_getApplicationDetailsString());
758 cert->reader = ConvertUtf8NToWCharAlloc(str, len,
nullptr);
764 cert->containerName = ConvertUtf8ToWCharAlloc(
"Private Key 00",
nullptr);
765 if (!cert->containerName)
773 info->keyPath = create_temporary_file();
774 WLog_DBG(TAG,
"writing PKINIT key to %s", info->keyPath);
775 if (!crypto_write_pem(info->keyPath, privKeyPEM, strlen(privKeyPEM)))
778 info->certPath = create_temporary_file();
779 WLog_DBG(TAG,
"writing PKINIT cert to %s", info->certPath);
780 if (!crypto_write_pem(info->certPath, certPEM, strlen(certPEM)))
784 const int res = winpr_asprintf(&cert->pkinitArgs, &size,
"FILE:%s,%s", info->certPath,
793 smartcardCertInfo_Free(cert);
797static BOOL smartcard_sw_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
803 WINPR_ASSERT(settings);
804 WINPR_ASSERT(scCerts);
805 WINPR_ASSERT(retCount);
811 WLog_ERR(TAG,
"Invalid smartcard private key PEM, aborting");
816 WLog_ERR(TAG,
"Invalid smartcard certificate PEM, aborting");
832 *scCerts = cert_list;
837 smartcardCertList_Free(cert_list, 1);
841BOOL smartcard_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
842 size_t* retCount, BOOL gateway)
845 LPWSTR csp =
nullptr;
848 const char* Username =
nullptr;
849 const char* Domain =
nullptr;
862 WINPR_ASSERT(settings);
863 WINPR_ASSERT(scCerts);
864 WINPR_ASSERT(retCount);
866 if (Domain && !strlen(Domain))
870 return smartcard_sw_enumerateCerts(settings, scCerts, retCount);
872 if (CspName && (!(csp = ConvertUtf8ToWCharAlloc(CspName,
nullptr))))
874 WLog_ERR(TAG,
"error while converting CSP to WCHAR");
879 smartcard_hw_enumerateCerts(settings, csp, ReaderName, Username, Domain, scCerts, retCount);
884static BOOL set_settings_from_smartcard(rdpSettings* settings, FreeRDP_Settings_Keys_String
id,
887 WINPR_ASSERT(settings);
896BOOL smartcard_getCert(
const rdpContext* context,
SmartcardCertInfo** cert, BOOL gateway)
898 WINPR_ASSERT(context);
900 const freerdp* instance = context->instance;
901 rdpSettings* settings = context->settings;
905 WINPR_ASSERT(instance);
906 WINPR_ASSERT(settings);
908 if (!smartcard_enumerateCerts(settings, &cert_list, &count, gateway))
913 WLog_ERR(TAG,
"no suitable smartcard certificates were found");
917 if (count > UINT32_MAX)
919 WLog_ERR(TAG,
"smartcard certificate count %" PRIuz
" exceeds UINT32_MAX", count);
927 if (!instance->ChooseSmartcard ||
928 !instance->ChooseSmartcard(context->instance, cert_list, (UINT32)count, &index,
931 WLog_ERR(TAG,
"more than one suitable smartcard certificate was found");
932 smartcardCertList_Free(cert_list, count);
935 *cert = cert_list[index];
937 for (DWORD i = 0; i < index; i++)
938 smartcardCertInfo_Free(cert_list[i]);
939 for (DWORD i = index + 1; i < count; i++)
940 smartcardCertInfo_Free(cert_list[i]);
943 *cert = cert_list[0];
945 FreeRDP_Settings_Keys_String username_setting =
946 gateway ? FreeRDP_GatewayUsername : FreeRDP_Username;
947 FreeRDP_Settings_Keys_String domain_setting = gateway ? FreeRDP_GatewayDomain : FreeRDP_Domain;
949 free((
void*)cert_list);
951 if (!set_settings_from_smartcard(settings, username_setting, (*cert)->userHint) ||
952 !set_settings_from_smartcard(settings, domain_setting, (*cert)->domainHint))
954 WLog_ERR(TAG,
"unable to set settings from smartcard!");
955 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