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);
264 const char* certId =
nullptr;
267 const char* secondBackslash = strchr(scCert->keyName + 1,
'\\');
269 certId = secondBackslash + 1;
272 if (certId && *certId)
273 return (winpr_asprintf(&scCert->pkinitArgs, &size,
274 "PKCS11:module_name=%s:slotid=%" PRIu16
":certid=%s", pkModule,
275 (UINT16)scCert->slotId, certId) > 0);
277 return (winpr_asprintf(&scCert->pkinitArgs, &size,
"PKCS11:module_name=%s:slotid=%" PRIu16,
278 pkModule, (UINT16)scCert->slotId) > 0);
283static BOOL list_capi_provider_keys(
const rdpSettings* settings, LPCWSTR csp, LPCWSTR scope,
284 const char* userFilter,
const char* domainFilter,
289 HCRYPTPROV hProvider = 0;
291 BYTE* certBytes =
nullptr;
292 CHAR* readerName =
nullptr;
294 if (!CryptAcquireContextW(&hProvider, scope, csp, PROV_RSA_FULL, CRYPT_SILENT))
296 WLog_DBG(TAG,
"Unable to acquire context: %d", GetLastError());
304 cert->csp = _wcsdup(csp);
310 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER,
nullptr, &dwDataLen, 0))
312 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
316 readerName = malloc(dwDataLen);
320 if (!CryptGetProvParam(hProvider, PP_SMARTCARD_READER, readerName, &dwDataLen, 0))
322 WLog_DBG(TAG,
"Unable to get reader name: %d", GetLastError());
326 cert->reader = ConvertUtf8ToWCharAlloc(readerName,
nullptr);
332 if (!CryptGetProvParam(hProvider, PP_CONTAINER,
nullptr, &dwDataLen, 0))
334 WLog_DBG(TAG,
"Unable to get provider param: %d", GetLastError());
338 cert->keyName = malloc(dwDataLen);
342 if (!CryptGetProvParam(hProvider, PP_CONTAINER, cert->keyName, &dwDataLen, 0))
344 WLog_DBG(TAG,
"Unable to get container name: %d", GetLastError());
348 cert->containerName = ConvertUtf8ToWCharAlloc(cert->keyName,
nullptr);
349 if (!cert->containerName)
353 if (!CryptGetUserKey(hProvider, AT_KEYEXCHANGE, &hKey))
355 WLog_DBG(TAG,
"Unable to get user key for %s: %d", cert->keyName, GetLastError());
360 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE,
nullptr, &dwDataLen, 0))
362 WLog_DBG(TAG,
"Unable to get key param for key %s: %d", cert->keyName, GetLastError());
366 certBytes = malloc(dwDataLen);
369 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", dwDataLen,
374 if (!CryptGetKeyParam(hKey, KP_CERTIFICATE, certBytes, &dwDataLen, 0))
376 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
380 if (!set_info_certificate(cert, certBytes, dwDataLen, userFilter, domainFilter))
383 if (!add_cert_to_list(pcerts, pcount, cert))
392 CryptDestroyKey(hKey);
394 CryptReleaseContext(hProvider, 0);
396 smartcardCertInfo_Free(cert);
401static BOOL list_provider_keys(WINPR_ATTR_UNUSED
const rdpSettings* settings,
402 NCRYPT_PROV_HANDLE provider, LPCWSTR csp, LPCWSTR scope,
403 const char* userFilter,
const char* domainFilter,
408 PVOID enumState =
nullptr;
410 size_t count = *pcount;
412 while (NCryptEnumKeys(provider, scope, &keyName, &enumState, NCRYPT_SILENT_FLAG) ==
415 NCRYPT_KEY_HANDLE phKey = 0;
416 PBYTE certBytes =
nullptr;
417 DWORD dwFlags = NCRYPT_SILENT_FLAG;
420 BOOL haveError = TRUE;
421 SECURITY_STATUS status = 0;
427 cert->keyName = ConvertWCharToUtf8Alloc(keyName->pszName,
nullptr);
431 WLog_DBG(TAG,
"opening key %s", cert->keyName);
434 NCryptOpenKey(provider, &phKey, keyName->pszName, keyName->dwLegacyKeySpec, dwFlags);
435 if (status != ERROR_SUCCESS)
438 "unable to NCryptOpenKey(dwLegacyKeySpec=0x%08" PRIx32
" dwFlags=0x%08" PRIx32
439 "), status=%s, skipping",
440 keyName->dwLegacyKeySpec, keyName->dwFlags,
441 winpr_NCryptSecurityStatusError(status));
445 cert->csp = _wcsdup(csp);
450 status = NCryptGetProperty(phKey, NCRYPT_WINPR_SLOTID, (PBYTE)&cert->slotId, 4, &cbOutput,
452 if (status != ERROR_SUCCESS)
454 WLog_ERR(TAG,
"unable to retrieve slotId for key %s, status=%s", cert->keyName,
455 winpr_NCryptSecurityStatusError(status));
462 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
463 if (status != ERROR_SUCCESS)
465 WLog_DBG(TAG,
"unable to retrieve reader's name length for key %s", cert->keyName);
469 cert->reader = calloc(1, cbOutput + 2);
472 WLog_ERR(TAG,
"unable to allocate reader's name for key %s", cert->keyName);
476 status = NCryptGetProperty(phKey, NCRYPT_READER_PROPERTY, (PBYTE)cert->reader, cbOutput + 2,
478 if (status != ERROR_SUCCESS)
480 WLog_ERR(TAG,
"unable to retrieve reader's name for key %s", cert->keyName);
487 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
488 if (status == ERROR_SUCCESS)
490 cert->containerName = calloc(1, cbOutput +
sizeof(WCHAR));
491 if (!cert->containerName)
493 WLog_ERR(TAG,
"unable to allocate key container name for key %s", cert->keyName);
497 status = NCryptGetProperty(phKey, NCRYPT_NAME_PROPERTY, (BYTE*)cert->containerName,
498 cbOutput, &cbOutput, dwFlags);
501 if (status != ERROR_SUCCESS)
503 WLog_ERR(TAG,
"unable to retrieve key container name for key %s", cert->keyName);
510 NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY,
nullptr, 0, &cbOutput, dwFlags);
511 if (status != ERROR_SUCCESS)
514 WLog_DBG(TAG,
"unable to retrieve certificate property len, status=%s, skipping",
515 winpr_NCryptSecurityStatusError(status));
519 certBytes = calloc(1, cbOutput);
522 WLog_ERR(TAG,
"unable to allocate %" PRIu32
" certBytes for key %s", cbOutput,
527 status = NCryptGetProperty(phKey, NCRYPT_CERTIFICATE_PROPERTY, certBytes, cbOutput,
529 if (status != ERROR_SUCCESS)
531 WLog_ERR(TAG,
"unable to retrieve certificate for key %s", cert->keyName);
535 if (!set_info_certificate(cert, certBytes, cbOutput, userFilter, domainFilter))
539 if (!build_pkinit_args(provider, cert))
541 WLog_ERR(TAG,
"error build pkinit args");
549 NCryptFreeBuffer(keyName);
551 NCryptFreeObject((NCRYPT_HANDLE)phKey);
554 smartcardCertInfo_Free(cert);
557 if (!add_cert_to_list(&cert_list, &count, cert))
566 char cspa[128] = WINPR_C_ARRAY_INIT;
568 (void)ConvertWCharToUtf8(csp, cspa,
sizeof(cspa));
569 char scopea[128] = WINPR_C_ARRAY_INIT;
570 (void)ConvertWCharToUtf8(scope, scopea,
sizeof(scopea));
571 WLog_WARN(TAG,
"%s [%s] no certificates found", cspa, scopea);
575 NCryptFreeBuffer(enumState);
579static BOOL smartcard_hw_enumerateCerts(
const rdpSettings* settings, LPCWSTR csp,
580 const char* reader,
const char* userFilter,
585 LPWSTR scope =
nullptr;
586 NCRYPT_PROV_HANDLE provider = 0;
587 SECURITY_STATUS status = 0;
592 WINPR_ASSERT(scCerts);
593 WINPR_ASSERT(retCount);
597 size_t readerSz = strlen(reader);
598 char* scopeStr = malloc(4 + readerSz + 1 + 1);
602 (void)_snprintf(scopeStr, readerSz + 6,
"\\\\.\\%s\\", reader);
603 scope = ConvertUtf8NToWCharAlloc(scopeStr, readerSz + 6,
nullptr);
613 LPCSTR paths[] = { Pkcs11Module,
nullptr };
618 status = winpr_NCryptOpenStorageProviderEx(&provider, csp, 0, paths);
619 if (status != ERROR_SUCCESS)
621 WLog_ERR(TAG,
"unable to open provider given by pkcs11 module");
625 status = list_provider_keys(settings, provider, csp, scope, userFilter, domainFilter,
627 NCryptFreeObject((NCRYPT_HANDLE)provider);
630 WLog_ERR(TAG,
"error listing keys from CSP loaded from %s", Pkcs11Module);
637 DWORD nproviders = 0;
641 DWORD provType, cbProvName = 0;
642 for (DWORD i = 0; CryptEnumProvidersW(i,
nullptr, 0, &provType,
nullptr, &cbProvName); ++i)
644 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
645 LPWSTR szProvName = malloc(cbProvName *
sizeof(WCHAR));
646 if (!CryptEnumProvidersW(i,
nullptr, 0, &provType, szProvName, &cbProvName))
652 if (ConvertWCharToUtf8(szProvName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
654 _snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
655 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
659 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
660 if (provType != PROV_RSA_FULL || (csp && _wcscmp(szProvName, csp) != 0))
662 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
666 if (!list_capi_provider_keys(settings, szProvName, scope, userFilter, domainFilter,
668 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
675 status = NCryptEnumStorageProviders(&nproviders, &names, NCRYPT_SILENT_FLAG);
676 if (status != ERROR_SUCCESS)
678 WLog_ERR(TAG,
"error listing providers");
682 for (DWORD i = 0; i < nproviders; i++)
684 char providerNameStr[256] = WINPR_C_ARRAY_INIT;
687 if (ConvertWCharToUtf8(name->pszName, providerNameStr, ARRAYSIZE(providerNameStr)) < 0)
689 (void)_snprintf(providerNameStr,
sizeof(providerNameStr),
"<unknown>");
690 WLog_ERR(TAG,
"unable to convert provider name to char*, will show it as '%s'",
694 WLog_DBG(TAG,
"exploring CSP '%s'", providerNameStr);
695 if (csp && _wcscmp(name->pszName, csp) != 0)
697 WLog_DBG(TAG,
"CSP '%s' filtered out", providerNameStr);
701 status = NCryptOpenStorageProvider(&provider, name->pszName, 0);
702 if (status != ERROR_SUCCESS)
705 if (!list_provider_keys(settings, provider, name->pszName, scope, userFilter,
706 domainFilter, &cert_list, &count))
707 WLog_INFO(TAG,
"error when retrieving keys in CSP '%s'", providerNameStr);
709 NCryptFreeObject((NCRYPT_HANDLE)provider);
712 NCryptFreeBuffer(names);
715 *scCerts = cert_list;
721 smartcardCertList_Free(cert_list, count);
726static char* create_temporary_file(
void)
728 BYTE buffer[32] = WINPR_C_ARRAY_INIT;
729 char* path =
nullptr;
731 if (winpr_RAND(buffer,
sizeof(buffer)) < 0)
734 char* hex = winpr_BinToHexString(buffer,
sizeof(buffer), FALSE);
736 path = GetKnownSubPath(KNOWN_PATH_TEMP, hex);
741static SmartcardCertInfo* smartcardCertInfo_New(
const char* privKeyPEM,
const char* certPEM)
745 WINPR_ASSERT(privKeyPEM);
746 WINPR_ASSERT(certPEM);
753 SmartcardKeyInfo* info = cert->key_info = calloc(1,
sizeof(SmartcardKeyInfo));
757 cert->certificate = freerdp_certificate_new_from_pem(certPEM);
758 if (!cert->certificate)
760 WLog_ERR(TAG,
"unable to read smartcard certificate");
764 if (!treat_sc_cert(cert))
766 WLog_ERR(TAG,
"unable to treat smartcard certificate");
773 (void)winpr_asprintf(&str, &len,
"%s Emulator", freerdp_getApplicationDetailsString());
775 cert->reader = ConvertUtf8NToWCharAlloc(str, len,
nullptr);
781 cert->containerName = ConvertUtf8ToWCharAlloc(
"Private Key 00",
nullptr);
782 if (!cert->containerName)
790 info->keyPath = create_temporary_file();
791 WLog_DBG(TAG,
"writing PKINIT key to %s", info->keyPath);
792 if (!crypto_write_pem(info->keyPath, privKeyPEM, strlen(privKeyPEM)))
795 info->certPath = create_temporary_file();
796 WLog_DBG(TAG,
"writing PKINIT cert to %s", info->certPath);
797 if (!crypto_write_pem(info->certPath, certPEM, strlen(certPEM)))
801 const int res = winpr_asprintf(&cert->pkinitArgs, &size,
"FILE:%s,%s", info->certPath,
810 smartcardCertInfo_Free(cert);
814static BOOL smartcard_sw_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
820 WINPR_ASSERT(settings);
821 WINPR_ASSERT(scCerts);
822 WINPR_ASSERT(retCount);
828 WLog_ERR(TAG,
"Invalid smartcard private key PEM, aborting");
833 WLog_ERR(TAG,
"Invalid smartcard certificate PEM, aborting");
849 *scCerts = cert_list;
854 smartcardCertList_Free(cert_list, 1);
858BOOL smartcard_enumerateCerts(
const rdpSettings* settings,
SmartcardCertInfo*** scCerts,
859 size_t* retCount, BOOL gateway)
862 LPWSTR csp =
nullptr;
865 const char* Username =
nullptr;
866 const char* Domain =
nullptr;
879 WINPR_ASSERT(settings);
880 WINPR_ASSERT(scCerts);
881 WINPR_ASSERT(retCount);
883 if (Domain && !strlen(Domain))
887 return smartcard_sw_enumerateCerts(settings, scCerts, retCount);
889 if (CspName && (!(csp = ConvertUtf8ToWCharAlloc(CspName,
nullptr))))
891 WLog_ERR(TAG,
"error while converting CSP to WCHAR");
896 smartcard_hw_enumerateCerts(settings, csp, ReaderName, Username, Domain, scCerts, retCount);
901static BOOL set_settings_from_smartcard(rdpSettings* settings, FreeRDP_Settings_Keys_String
id,
904 WINPR_ASSERT(settings);
913BOOL smartcard_getCert(
const rdpContext* context,
SmartcardCertInfo** cert, BOOL gateway)
915 WINPR_ASSERT(context);
917 const freerdp* instance = context->instance;
918 rdpSettings* settings = context->settings;
922 WINPR_ASSERT(instance);
923 WINPR_ASSERT(settings);
925 if (!smartcard_enumerateCerts(settings, &cert_list, &count, gateway))
930 WLog_ERR(TAG,
"no suitable smartcard certificates were found");
934 if (count > UINT32_MAX)
936 WLog_ERR(TAG,
"smartcard certificate count %" PRIuz
" exceeds UINT32_MAX", count);
944 if (!instance->ChooseSmartcard ||
945 !instance->ChooseSmartcard(context->instance, cert_list, (UINT32)count, &index,
948 WLog_ERR(TAG,
"more than one suitable smartcard certificate was found");
949 smartcardCertList_Free(cert_list, count);
952 *cert = cert_list[index];
954 for (DWORD i = 0; i < index; i++)
955 smartcardCertInfo_Free(cert_list[i]);
956 for (DWORD i = index + 1; i < count; i++)
957 smartcardCertInfo_Free(cert_list[i]);
960 *cert = cert_list[0];
962 FreeRDP_Settings_Keys_String username_setting =
963 gateway ? FreeRDP_GatewayUsername : FreeRDP_Username;
964 FreeRDP_Settings_Keys_String domain_setting = gateway ? FreeRDP_GatewayDomain : FreeRDP_Domain;
966 free((
void*)cert_list);
968 if (!set_settings_from_smartcard(settings, username_setting, (*cert)->userHint) ||
969 !set_settings_from_smartcard(settings, domain_setting, (*cert)->domainHint))
971 WLog_ERR(TAG,
"unable to set settings from smartcard!");
972 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_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
Returns a boolean settings value.
a provider name descriptor