FreeRDP
Loading...
Searching...
No Matches
ncrypt_pkcs11.c
1
20#include <stdlib.h>
21
22#include <winpr/library.h>
23#include <winpr/assert.h>
24#include <winpr/spec.h>
25#include <winpr/smartcard.h>
26#include <winpr/asn1.h>
27
28#include "../log.h"
29#include "ncrypt.h"
30
31/* https://github.com/latchset/pkcs11-headers/blob/main/public-domain/3.1/pkcs11.h */
32#include "pkcs11-headers/pkcs11.h"
33
34#define TAG WINPR_TAG("ncryptp11")
35
36#define MAX_SLOTS 64
37#define MAX_KEYS 64
38#define MAX_KEYS_PER_SLOT 64
39
41typedef struct
42{
43 NCryptBaseProvider baseProvider;
44
45 HANDLE library;
46 CK_FUNCTION_LIST_PTR p11;
47 char* modulePath;
48} NCryptP11ProviderHandle;
49
51typedef struct
52{
53 NCryptBaseHandle base;
54 NCryptP11ProviderHandle* provider;
55 CK_SLOT_ID slotId;
56 CK_BYTE keyCertId[64];
57 CK_ULONG keyCertIdLen;
58} NCryptP11KeyHandle;
59
60typedef struct
61{
62 CK_SLOT_ID slotId;
63 CK_SLOT_INFO slotInfo;
64 CK_KEY_TYPE keyType;
65 CK_CHAR keyLabel[256];
66 CK_ULONG idLen;
67 CK_BYTE id[64];
68} NCryptKeyEnum;
69
70typedef struct
71{
72 CK_ULONG nslots;
73 CK_SLOT_ID slots[MAX_SLOTS];
74 CK_ULONG nKeys;
75 NCryptKeyEnum keys[MAX_KEYS];
76 CK_ULONG keyIndex;
77} P11EnumKeysState;
78
79typedef struct
80{
81 const char* label;
82 BYTE tag[3];
83} piv_cert_tags_t;
84static const piv_cert_tags_t piv_cert_tags[] = {
85 { "Certificate for PIV Authentication", "\x5F\xC1\x05" },
86 { "Certificate for Digital Signature", "\x5F\xC1\x0A" },
87 { "Certificate for Key Management", "\x5F\xC1\x0B" },
88 { "Certificate for Card Authentication", "\x5F\xC1\x01" },
89};
90
91static const BYTE APDU_PIV_SELECT_AID[] = { 0x00, 0xA4, 0x04, 0x00, 0x09, 0xA0, 0x00, 0x00,
92 0x03, 0x08, 0x00, 0x00, 0x10, 0x00, 0x00 };
93static const BYTE APDU_PIV_GET_CHUID[] = { 0x00, 0xCB, 0x3F, 0xFF, 0x05, 0x5C,
94 0x03, 0x5F, 0xC1, 0x02, 0x00 };
95#define PIV_CONTAINER_NAME_LEN 36
96
97static CK_OBJECT_CLASS object_class_public_key = CKO_PUBLIC_KEY;
98static CK_BBOOL object_verify = CK_TRUE;
99static CK_KEY_TYPE object_ktype_rsa = CKK_RSA;
100
101static CK_ATTRIBUTE public_key_filter[] = {
102 { CKA_CLASS, &object_class_public_key, sizeof(object_class_public_key) },
103 { CKA_VERIFY, &object_verify, sizeof(object_verify) },
104 { CKA_KEY_TYPE, &object_ktype_rsa, sizeof(object_ktype_rsa) }
105};
106
107static const char* CK_RV_error_string(CK_RV rv);
108
109static SECURITY_STATUS NCryptP11StorageProvider_dtor(NCRYPT_HANDLE handle)
110{
111 NCryptP11ProviderHandle* provider = (NCryptP11ProviderHandle*)handle;
112 CK_RV rv = CKR_OK;
113
114 if (provider)
115 {
116 if (provider->p11 && provider->p11->C_Finalize)
117 rv = provider->p11->C_Finalize(NULL);
118 if (rv != CKR_OK)
119 WLog_WARN(TAG, "C_Finalize failed with %s [0x%08" PRIx32 "]", CK_RV_error_string(rv),
120 rv);
121
122 free(provider->modulePath);
123
124 if (provider->library)
125 FreeLibrary(provider->library);
126 }
127
128 return winpr_NCryptDefault_dtor(handle);
129}
130
131static void fix_padded_string(char* str, size_t maxlen)
132{
133 if (maxlen == 0)
134 return;
135
136 WINPR_ASSERT(str);
137 char* ptr = &str[maxlen - 1];
138
139 while ((ptr > str) && (*ptr == ' '))
140 {
141 *ptr = '\0';
142 ptr--;
143 }
144}
145
146static BOOL attributes_have_unallocated_buffers(CK_ATTRIBUTE_PTR attributes, CK_ULONG count)
147{
148 for (CK_ULONG i = 0; i < count; i++)
149 {
150 if (!attributes[i].pValue && (attributes[i].ulValueLen != CK_UNAVAILABLE_INFORMATION))
151 return TRUE;
152 }
153
154 return FALSE;
155}
156
157static BOOL attribute_allocate_attribute_array(CK_ATTRIBUTE_PTR attribute)
158{
159 WINPR_ASSERT(attribute);
160 attribute->pValue = calloc(attribute->ulValueLen, sizeof(void*));
161 return !!attribute->pValue;
162}
163
164static BOOL attribute_allocate_ulong_array(CK_ATTRIBUTE_PTR attribute)
165{
166 attribute->pValue = calloc(attribute->ulValueLen, sizeof(CK_ULONG));
167 return !!attribute->pValue;
168}
169
170static BOOL attribute_allocate_buffer(CK_ATTRIBUTE_PTR attribute)
171{
172 attribute->pValue = calloc(attribute->ulValueLen, 1);
173 return !!attribute->pValue;
174}
175
176static BOOL attributes_allocate_buffers(CK_ATTRIBUTE_PTR attributes, CK_ULONG count)
177{
178 BOOL ret = TRUE;
179
180 for (CK_ULONG i = 0; i < count; i++)
181 {
182 if (attributes[i].pValue || (attributes[i].ulValueLen == CK_UNAVAILABLE_INFORMATION))
183 continue;
184
185 switch (attributes[i].type)
186 {
187 case CKA_WRAP_TEMPLATE:
188 case CKA_UNWRAP_TEMPLATE:
189 ret &= attribute_allocate_attribute_array(&attributes[i]);
190 break;
191
192 case CKA_ALLOWED_MECHANISMS:
193 ret &= attribute_allocate_ulong_array(&attributes[i]);
194 break;
195
196 default:
197 ret &= attribute_allocate_buffer(&attributes[i]);
198 break;
199 }
200 }
201
202 return ret;
203}
204
205static CK_RV object_load_attributes(NCryptP11ProviderHandle* provider, CK_SESSION_HANDLE session,
206 CK_OBJECT_HANDLE object, CK_ATTRIBUTE_PTR attributes,
207 CK_ULONG count)
208{
209 WINPR_ASSERT(provider);
210 WINPR_ASSERT(provider->p11);
211 WINPR_ASSERT(provider->p11->C_GetAttributeValue);
212
213 CK_RV rv = provider->p11->C_GetAttributeValue(session, object, attributes, count);
214
215 switch (rv)
216 {
217 case CKR_OK:
218 if (!attributes_have_unallocated_buffers(attributes, count))
219 return rv;
220 /* fallthrough */
221 WINPR_FALLTHROUGH
222 case CKR_ATTRIBUTE_SENSITIVE:
223 case CKR_ATTRIBUTE_TYPE_INVALID:
224 case CKR_BUFFER_TOO_SMALL:
225 /* attributes need some buffers for the result value */
226 if (!attributes_allocate_buffers(attributes, count))
227 return CKR_HOST_MEMORY;
228
229 rv = provider->p11->C_GetAttributeValue(session, object, attributes, count);
230 if (rv != CKR_OK)
231 WLog_WARN(TAG, "C_GetAttributeValue failed with %s [0x%08" PRIx32 "]",
232 CK_RV_error_string(rv), rv);
233 break;
234 default:
235 WLog_WARN(TAG, "C_GetAttributeValue failed with %s [0x%08" PRIx32 "]",
236 CK_RV_error_string(rv), rv);
237 return rv;
238 }
239
240 switch (rv)
241 {
242 case CKR_ATTRIBUTE_SENSITIVE:
243 case CKR_ATTRIBUTE_TYPE_INVALID:
244 case CKR_BUFFER_TOO_SMALL:
245 WLog_ERR(TAG,
246 "C_GetAttributeValue failed with %s [0x%08" PRIx32
247 "] even after buffer allocation",
248 CK_RV_error_string(rv), rv);
249 break;
250 default:
251 break;
252 }
253 return rv;
254}
255
256static const char* CK_RV_error_string(CK_RV rv)
257{
258 static char generic_buffer[200];
259#define ERR_ENTRY(X) \
260 case X: \
261 return #X
262
263 switch (rv)
264 {
265 ERR_ENTRY(CKR_OK);
266 ERR_ENTRY(CKR_CANCEL);
267 ERR_ENTRY(CKR_HOST_MEMORY);
268 ERR_ENTRY(CKR_SLOT_ID_INVALID);
269 ERR_ENTRY(CKR_GENERAL_ERROR);
270 ERR_ENTRY(CKR_FUNCTION_FAILED);
271 ERR_ENTRY(CKR_ARGUMENTS_BAD);
272 ERR_ENTRY(CKR_NO_EVENT);
273 ERR_ENTRY(CKR_NEED_TO_CREATE_THREADS);
274 ERR_ENTRY(CKR_CANT_LOCK);
275 ERR_ENTRY(CKR_ATTRIBUTE_READ_ONLY);
276 ERR_ENTRY(CKR_ATTRIBUTE_SENSITIVE);
277 ERR_ENTRY(CKR_ATTRIBUTE_TYPE_INVALID);
278 ERR_ENTRY(CKR_ATTRIBUTE_VALUE_INVALID);
279 ERR_ENTRY(CKR_DATA_INVALID);
280 ERR_ENTRY(CKR_DATA_LEN_RANGE);
281 ERR_ENTRY(CKR_DEVICE_ERROR);
282 ERR_ENTRY(CKR_DEVICE_MEMORY);
283 ERR_ENTRY(CKR_DEVICE_REMOVED);
284 ERR_ENTRY(CKR_ENCRYPTED_DATA_INVALID);
285 ERR_ENTRY(CKR_ENCRYPTED_DATA_LEN_RANGE);
286 ERR_ENTRY(CKR_FUNCTION_CANCELED);
287 ERR_ENTRY(CKR_FUNCTION_NOT_PARALLEL);
288 ERR_ENTRY(CKR_FUNCTION_NOT_SUPPORTED);
289 ERR_ENTRY(CKR_KEY_HANDLE_INVALID);
290 ERR_ENTRY(CKR_KEY_SIZE_RANGE);
291 ERR_ENTRY(CKR_KEY_TYPE_INCONSISTENT);
292 ERR_ENTRY(CKR_KEY_NOT_NEEDED);
293 ERR_ENTRY(CKR_KEY_CHANGED);
294 ERR_ENTRY(CKR_KEY_NEEDED);
295 ERR_ENTRY(CKR_KEY_INDIGESTIBLE);
296 ERR_ENTRY(CKR_KEY_FUNCTION_NOT_PERMITTED);
297 ERR_ENTRY(CKR_KEY_NOT_WRAPPABLE);
298 ERR_ENTRY(CKR_KEY_UNEXTRACTABLE);
299 ERR_ENTRY(CKR_MECHANISM_INVALID);
300 ERR_ENTRY(CKR_MECHANISM_PARAM_INVALID);
301 ERR_ENTRY(CKR_OBJECT_HANDLE_INVALID);
302 ERR_ENTRY(CKR_OPERATION_ACTIVE);
303 ERR_ENTRY(CKR_OPERATION_NOT_INITIALIZED);
304 ERR_ENTRY(CKR_PIN_INCORRECT);
305 ERR_ENTRY(CKR_PIN_INVALID);
306 ERR_ENTRY(CKR_PIN_LEN_RANGE);
307 ERR_ENTRY(CKR_PIN_EXPIRED);
308 ERR_ENTRY(CKR_PIN_LOCKED);
309 ERR_ENTRY(CKR_SESSION_CLOSED);
310 ERR_ENTRY(CKR_SESSION_COUNT);
311 ERR_ENTRY(CKR_SESSION_HANDLE_INVALID);
312 ERR_ENTRY(CKR_SESSION_PARALLEL_NOT_SUPPORTED);
313 ERR_ENTRY(CKR_SESSION_READ_ONLY);
314 ERR_ENTRY(CKR_SESSION_EXISTS);
315 ERR_ENTRY(CKR_SESSION_READ_ONLY_EXISTS);
316 ERR_ENTRY(CKR_SESSION_READ_WRITE_SO_EXISTS);
317 ERR_ENTRY(CKR_SIGNATURE_INVALID);
318 ERR_ENTRY(CKR_SIGNATURE_LEN_RANGE);
319 ERR_ENTRY(CKR_TEMPLATE_INCOMPLETE);
320 ERR_ENTRY(CKR_TEMPLATE_INCONSISTENT);
321 ERR_ENTRY(CKR_TOKEN_NOT_PRESENT);
322 ERR_ENTRY(CKR_TOKEN_NOT_RECOGNIZED);
323 ERR_ENTRY(CKR_TOKEN_WRITE_PROTECTED);
324 ERR_ENTRY(CKR_UNWRAPPING_KEY_HANDLE_INVALID);
325 ERR_ENTRY(CKR_UNWRAPPING_KEY_SIZE_RANGE);
326 ERR_ENTRY(CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT);
327 ERR_ENTRY(CKR_USER_ALREADY_LOGGED_IN);
328 ERR_ENTRY(CKR_USER_NOT_LOGGED_IN);
329 ERR_ENTRY(CKR_USER_PIN_NOT_INITIALIZED);
330 ERR_ENTRY(CKR_USER_TYPE_INVALID);
331 ERR_ENTRY(CKR_USER_ANOTHER_ALREADY_LOGGED_IN);
332 ERR_ENTRY(CKR_USER_TOO_MANY_TYPES);
333 ERR_ENTRY(CKR_WRAPPED_KEY_INVALID);
334 ERR_ENTRY(CKR_WRAPPED_KEY_LEN_RANGE);
335 ERR_ENTRY(CKR_WRAPPING_KEY_HANDLE_INVALID);
336 ERR_ENTRY(CKR_WRAPPING_KEY_SIZE_RANGE);
337 ERR_ENTRY(CKR_WRAPPING_KEY_TYPE_INCONSISTENT);
338 ERR_ENTRY(CKR_RANDOM_SEED_NOT_SUPPORTED);
339 ERR_ENTRY(CKR_RANDOM_NO_RNG);
340 ERR_ENTRY(CKR_DOMAIN_PARAMS_INVALID);
341 ERR_ENTRY(CKR_BUFFER_TOO_SMALL);
342 ERR_ENTRY(CKR_SAVED_STATE_INVALID);
343 ERR_ENTRY(CKR_INFORMATION_SENSITIVE);
344 ERR_ENTRY(CKR_STATE_UNSAVEABLE);
345 ERR_ENTRY(CKR_CRYPTOKI_NOT_INITIALIZED);
346 ERR_ENTRY(CKR_CRYPTOKI_ALREADY_INITIALIZED);
347 ERR_ENTRY(CKR_MUTEX_BAD);
348 ERR_ENTRY(CKR_MUTEX_NOT_LOCKED);
349 ERR_ENTRY(CKR_FUNCTION_REJECTED);
350 default:
351 (void)snprintf(generic_buffer, sizeof(generic_buffer), "unknown 0x%lx", rv);
352 return generic_buffer;
353 }
354#undef ERR_ENTRY
355}
356
357#define loge(tag, msg, rv, index, slot) \
358 log_((tag), (msg), (rv), (index), (slot), __FILE__, __func__, __LINE__)
359static void log_(const char* tag, const char* msg, CK_RV rv, CK_ULONG index, CK_SLOT_ID slot,
360 const char* file, const char* fkt, size_t line)
361{
362 const DWORD log_level = WLOG_ERROR;
363 static wLog* log_cached_ptr = NULL;
364 if (!log_cached_ptr)
365 log_cached_ptr = WLog_Get(tag);
366 if (!WLog_IsLevelActive(log_cached_ptr, log_level))
367 return;
368
369 WLog_PrintTextMessage(log_cached_ptr, log_level, line, file, fkt,
370 "%s for slot #%lu(%lu), rv=%s", msg, index, slot, CK_RV_error_string(rv));
371}
372
373static SECURITY_STATUS collect_keys(NCryptP11ProviderHandle* provider, P11EnumKeysState* state)
374{
375 CK_OBJECT_HANDLE slotObjects[MAX_KEYS_PER_SLOT] = { 0 };
376
377 WINPR_ASSERT(provider);
378
379 CK_FUNCTION_LIST_PTR p11 = provider->p11;
380 WINPR_ASSERT(p11);
381
382 WLog_DBG(TAG, "checking %" PRIu32 " slots for valid keys...", state->nslots);
383 state->nKeys = 0;
384 for (CK_ULONG i = 0; i < state->nslots; i++)
385 {
386 CK_SESSION_HANDLE session = (CK_SESSION_HANDLE)NULL;
387 CK_SLOT_INFO slotInfo = { 0 };
388 CK_TOKEN_INFO tokenInfo = { 0 };
389
390 WINPR_ASSERT(p11->C_GetSlotInfo);
391 CK_RV rv = p11->C_GetSlotInfo(state->slots[i], &slotInfo);
392 if (rv != CKR_OK)
393 {
394 loge(TAG, "unable to retrieve information", rv, i, state->slots[i]);
395 continue;
396 }
397
398 fix_padded_string((char*)slotInfo.slotDescription, sizeof(slotInfo.slotDescription));
399 WLog_DBG(TAG, "collecting keys for slot #%" PRIu32 "(%" PRIu32 ") descr='%s' flags=0x%x", i,
400 state->slots[i], slotInfo.slotDescription, slotInfo.flags);
401
402 /* this is a safety guard as we're supposed to have listed only readers with tokens in them
403 */
404 if (!(slotInfo.flags & CKF_TOKEN_PRESENT))
405 {
406 WLog_INFO(TAG, "token not present for slot #%" PRIu32 "(%" PRIu32 ")", i,
407 state->slots[i]);
408 continue;
409 }
410
411 WINPR_ASSERT(p11->C_GetTokenInfo);
412 rv = p11->C_GetTokenInfo(state->slots[i], &tokenInfo);
413 if (rv != CKR_OK)
414 loge(TAG, "unable to retrieve token info", rv, i, state->slots[i]);
415 else
416 {
417 fix_padded_string((char*)tokenInfo.label, sizeof(tokenInfo.label));
418 WLog_DBG(TAG, "token, label='%s' flags=0x%x", tokenInfo.label, tokenInfo.flags);
419 }
420
421 WINPR_ASSERT(p11->C_OpenSession);
422 rv = p11->C_OpenSession(state->slots[i], CKF_SERIAL_SESSION, NULL, NULL, &session);
423 if (rv != CKR_OK)
424 {
425 WLog_ERR(TAG,
426 "unable to openSession for slot #%" PRIu32 "(%" PRIu32 "), session=%p rv=%s",
427 i, state->slots[i], session, CK_RV_error_string(rv));
428 continue;
429 }
430
431 WINPR_ASSERT(p11->C_FindObjectsInit);
432 rv = p11->C_FindObjectsInit(session, public_key_filter, ARRAYSIZE(public_key_filter));
433 if (rv != CKR_OK)
434 {
435 // TODO: shall it be fatal ?
436 loge(TAG, "unable to initiate search", rv, i, state->slots[i]);
437 goto cleanup_FindObjectsInit;
438 }
439
440 CK_ULONG nslotObjects = 0;
441 WINPR_ASSERT(p11->C_FindObjects);
442 rv = p11->C_FindObjects(session, &slotObjects[0], ARRAYSIZE(slotObjects), &nslotObjects);
443 if (rv != CKR_OK)
444 {
445 loge(TAG, "unable to findObjects", rv, i, state->slots[i]);
446 goto cleanup_FindObjects;
447 }
448
449 WLog_DBG(TAG, "slot has %d objects", nslotObjects);
450 for (CK_ULONG j = 0; j < nslotObjects; j++)
451 {
452 NCryptKeyEnum* key = &state->keys[state->nKeys];
453 CK_OBJECT_CLASS dataClass = CKO_PUBLIC_KEY;
454 CK_ATTRIBUTE key_or_certAttrs[] = {
455 { CKA_ID, &key->id, sizeof(key->id) },
456 { CKA_CLASS, &dataClass, sizeof(dataClass) },
457 { CKA_LABEL, &key->keyLabel, sizeof(key->keyLabel) },
458 { CKA_KEY_TYPE, &key->keyType, sizeof(key->keyType) }
459 };
460
461 rv = object_load_attributes(provider, session, slotObjects[j], key_or_certAttrs,
462 ARRAYSIZE(key_or_certAttrs));
463 if (rv != CKR_OK)
464 {
465 WLog_ERR(TAG, "error getting attributes, rv=%s", CK_RV_error_string(rv));
466 continue;
467 }
468
469 key->idLen = key_or_certAttrs[0].ulValueLen;
470 key->slotId = state->slots[i];
471 key->slotInfo = slotInfo;
472 state->nKeys++;
473 }
474
475 cleanup_FindObjects:
476 WINPR_ASSERT(p11->C_FindObjectsFinal);
477 rv = p11->C_FindObjectsFinal(session);
478 if (rv != CKR_OK)
479 loge(TAG, "error during C_FindObjectsFinal", rv, i, state->slots[i]);
480 cleanup_FindObjectsInit:
481 WINPR_ASSERT(p11->C_CloseSession);
482 rv = p11->C_CloseSession(session);
483 if (rv != CKR_OK)
484 loge(TAG, "error closing session", rv, i, state->slots[i]);
485 }
486
487 return ERROR_SUCCESS;
488}
489
490static BOOL convertKeyType(CK_KEY_TYPE k, LPWSTR dest, DWORD len, DWORD* outlen)
491{
492 const WCHAR* r = NULL;
493 size_t retLen = 0;
494
495#define ALGO_CASE(V, S) \
496 case V: \
497 r = S; \
498 retLen = _wcsnlen((S), ARRAYSIZE((S))); \
499 break
500 switch (k)
501 {
502 ALGO_CASE(CKK_RSA, BCRYPT_RSA_ALGORITHM);
503 ALGO_CASE(CKK_DSA, BCRYPT_DSA_ALGORITHM);
504 ALGO_CASE(CKK_DH, BCRYPT_DH_ALGORITHM);
505 ALGO_CASE(CKK_EC, BCRYPT_ECDSA_ALGORITHM);
506 ALGO_CASE(CKK_RC2, BCRYPT_RC2_ALGORITHM);
507 ALGO_CASE(CKK_RC4, BCRYPT_RC4_ALGORITHM);
508 ALGO_CASE(CKK_DES, BCRYPT_DES_ALGORITHM);
509 ALGO_CASE(CKK_DES3, BCRYPT_3DES_ALGORITHM);
510 case CKK_DES2:
511 case CKK_X9_42_DH:
512 case CKK_KEA:
513 case CKK_GENERIC_SECRET:
514 case CKK_CAST:
515 case CKK_CAST3:
516 case CKK_CAST128:
517 case CKK_RC5:
518 case CKK_IDEA:
519 case CKK_SKIPJACK:
520 case CKK_BATON:
521 case CKK_JUNIPER:
522 case CKK_CDMF:
523 case CKK_AES:
524 case CKK_BLOWFISH:
525 case CKK_TWOFISH:
526 default:
527 break;
528 }
529#undef ALGO_CASE
530
531 if (retLen > UINT32_MAX)
532 return FALSE;
533
534 if (outlen)
535 *outlen = (UINT32)retLen;
536
537 if (!r)
538 {
539 if (dest && len > 0)
540 dest[0] = 0;
541 return FALSE;
542 }
543
544 if (dest)
545 {
546 if (retLen + 1 > len)
547 {
548 WLog_ERR(TAG, "target buffer is too small for algo name");
549 return FALSE;
550 }
551
552 memcpy(dest, r, sizeof(WCHAR) * retLen);
553 dest[retLen] = 0;
554 }
555
556 return TRUE;
557}
558
559static void wprintKeyName(LPWSTR str, CK_SLOT_ID slotId, CK_BYTE* id, CK_ULONG idLen)
560{
561 char asciiName[128] = { 0 };
562 char* ptr = asciiName;
563 const CK_BYTE* bytePtr = NULL;
564
565 *ptr = '\\';
566 ptr++;
567
568 bytePtr = ((CK_BYTE*)&slotId);
569 for (CK_ULONG i = 0; i < sizeof(slotId); i++, bytePtr++, ptr += 2)
570 (void)snprintf(ptr, 3, "%.2x", *bytePtr);
571
572 *ptr = '\\';
573 ptr++;
574
575 for (CK_ULONG i = 0; i < idLen; i++, id++, ptr += 2)
576 (void)snprintf(ptr, 3, "%.2x", *id);
577
578 (void)ConvertUtf8NToWChar(asciiName, ARRAYSIZE(asciiName), str,
579 strnlen(asciiName, ARRAYSIZE(asciiName)) + 1);
580}
581
582static size_t parseHex(const char* str, const char* end, CK_BYTE* target)
583{
584 size_t ret = 0;
585
586 for (; str != end && *str; str++, ret++, target++)
587 {
588 int v = 0;
589 if (*str <= '9' && *str >= '0')
590 {
591 v = (*str - '0');
592 }
593 else if (*str <= 'f' && *str >= 'a')
594 {
595 v = (10 + *str - 'a');
596 }
597 else if (*str <= 'F' && *str >= 'A')
598 {
599 v |= (10 + *str - 'A');
600 }
601 else
602 {
603 return 0;
604 }
605 v <<= 4;
606 str++;
607
608 if (!*str || str == end)
609 return 0;
610
611 if (*str <= '9' && *str >= '0')
612 {
613 v |= (*str - '0');
614 }
615 else if (*str <= 'f' && *str >= 'a')
616 {
617 v |= (10 + *str - 'a');
618 }
619 else if (*str <= 'F' && *str >= 'A')
620 {
621 v |= (10 + *str - 'A');
622 }
623 else
624 {
625 return 0;
626 }
627
628 *target = v & 0xFF;
629 }
630 return ret;
631}
632
633static SECURITY_STATUS parseKeyName(LPCWSTR pszKeyName, CK_SLOT_ID* slotId, CK_BYTE* id,
634 CK_ULONG* idLen)
635{
636 char asciiKeyName[128] = { 0 };
637 char* pos = NULL;
638
639 if (ConvertWCharToUtf8(pszKeyName, asciiKeyName, ARRAYSIZE(asciiKeyName)) < 0)
640 return NTE_BAD_KEY;
641
642 if (*asciiKeyName != '\\')
643 return NTE_BAD_KEY;
644
645 pos = strchr(&asciiKeyName[1], '\\');
646 if (!pos)
647 return NTE_BAD_KEY;
648
649 if ((size_t)(pos - &asciiKeyName[1]) > sizeof(CK_SLOT_ID) * 2ull)
650 return NTE_BAD_KEY;
651
652 *slotId = (CK_SLOT_ID)0;
653 if (parseHex(&asciiKeyName[1], pos, (CK_BYTE*)slotId) != sizeof(CK_SLOT_ID))
654 return NTE_BAD_KEY;
655
656 *idLen = parseHex(pos + 1, NULL, id);
657 if (!*idLen)
658 return NTE_BAD_KEY;
659
660 return ERROR_SUCCESS;
661}
662
663static SECURITY_STATUS NCryptP11EnumKeys(NCRYPT_PROV_HANDLE hProvider, LPCWSTR pszScope,
664 NCryptKeyName** ppKeyName, PVOID* ppEnumState,
665 WINPR_ATTR_UNUSED DWORD dwFlags)
666{
667 NCryptP11ProviderHandle* provider = (NCryptP11ProviderHandle*)hProvider;
668 P11EnumKeysState* state = (P11EnumKeysState*)*ppEnumState;
669 CK_RV rv = { 0 };
670 CK_SLOT_ID currentSlot = { 0 };
671 CK_SESSION_HANDLE currentSession = (CK_SESSION_HANDLE)NULL;
672 char slotFilterBuffer[65] = { 0 };
673 char* slotFilter = NULL;
674 size_t slotFilterLen = 0;
675
676 SECURITY_STATUS ret = checkNCryptHandle((NCRYPT_HANDLE)hProvider, WINPR_NCRYPT_PROVIDER);
677 if (ret != ERROR_SUCCESS)
678 return ret;
679
680 if (pszScope)
681 {
682 /*
683 * check whether pszScope is of the form \\.<reader name>\ for filtering by
684 * card reader
685 */
686 char asciiScope[128 + 6 + 1] = { 0 };
687 size_t asciiScopeLen = 0;
688
689 if (ConvertWCharToUtf8(pszScope, asciiScope, ARRAYSIZE(asciiScope) - 1) < 0)
690 {
691 WLog_WARN(TAG, "Invalid scope");
692 return NTE_INVALID_PARAMETER;
693 }
694
695 if (strstr(asciiScope, "\\\\.\\") != asciiScope)
696 {
697 WLog_WARN(TAG, "Invalid scope '%s'", asciiScope);
698 return NTE_INVALID_PARAMETER;
699 }
700
701 asciiScopeLen = strnlen(asciiScope, ARRAYSIZE(asciiScope));
702 if ((asciiScopeLen < 1) || (asciiScope[asciiScopeLen - 1] != '\\'))
703 {
704 WLog_WARN(TAG, "Invalid scope '%s'", asciiScope);
705 return NTE_INVALID_PARAMETER;
706 }
707
708 asciiScope[asciiScopeLen - 1] = 0;
709
710 strncpy(slotFilterBuffer, &asciiScope[4], sizeof(slotFilterBuffer));
711 slotFilter = slotFilterBuffer;
712 slotFilterLen = asciiScopeLen - 5;
713 }
714
715 if (!state)
716 {
717 state = (P11EnumKeysState*)calloc(1, sizeof(*state));
718 if (!state)
719 return NTE_NO_MEMORY;
720
721 WINPR_ASSERT(provider->p11->C_GetSlotList);
722 rv = provider->p11->C_GetSlotList(CK_TRUE, NULL, &state->nslots);
723 if (rv != CKR_OK)
724 {
725 free(state);
726 /* TODO: perhaps convert rv to NTE_*** errors */
727 WLog_WARN(TAG, "C_GetSlotList failed with %s [0x%08" PRIx32 "]", CK_RV_error_string(rv),
728 rv);
729 return NTE_FAIL;
730 }
731
732 if (state->nslots > MAX_SLOTS)
733 state->nslots = MAX_SLOTS;
734
735 rv = provider->p11->C_GetSlotList(CK_TRUE, state->slots, &state->nslots);
736 if (rv != CKR_OK)
737 {
738 free(state);
739 /* TODO: perhaps convert rv to NTE_*** errors */
740 WLog_WARN(TAG, "C_GetSlotList failed with %s [0x%08" PRIx32 "]", CK_RV_error_string(rv),
741 rv);
742 return NTE_FAIL;
743 }
744
745 ret = collect_keys(provider, state);
746 if (ret != ERROR_SUCCESS)
747 {
748 free(state);
749 return ret;
750 }
751
752 *ppEnumState = state;
753 }
754
755 for (; state->keyIndex < state->nKeys; state->keyIndex++)
756 {
757 NCryptKeyName* keyName = NULL;
758 NCryptKeyEnum* key = &state->keys[state->keyIndex];
759 CK_OBJECT_CLASS oclass = CKO_CERTIFICATE;
760 CK_CERTIFICATE_TYPE ctype = CKC_X_509;
761 CK_ATTRIBUTE certificateFilter[] = { { CKA_CLASS, &oclass, sizeof(oclass) },
762 { CKA_CERTIFICATE_TYPE, &ctype, sizeof(ctype) },
763 { CKA_ID, key->id, key->idLen } };
764 CK_ULONG ncertObjects = 0;
765 CK_OBJECT_HANDLE certObject = 0;
766
767 /* check the reader filter if any */
768 if (slotFilter && memcmp(key->slotInfo.slotDescription, slotFilter, slotFilterLen) != 0)
769 continue;
770
771 if (!currentSession || (currentSlot != key->slotId))
772 {
773 /* if the current session doesn't match the current key's slot, open a new one
774 */
775 if (currentSession)
776 {
777 WINPR_ASSERT(provider->p11->C_CloseSession);
778 rv = provider->p11->C_CloseSession(currentSession);
779 if (rv != CKR_OK)
780 WLog_WARN(TAG, "C_CloseSession failed with %s [0x%08" PRIx32 "]",
781 CK_RV_error_string(rv), rv);
782 currentSession = (CK_SESSION_HANDLE)NULL;
783 }
784
785 WINPR_ASSERT(provider->p11->C_OpenSession);
786 rv = provider->p11->C_OpenSession(key->slotId, CKF_SERIAL_SESSION, NULL, NULL,
787 &currentSession);
788 if (rv != CKR_OK)
789 {
790 WLog_ERR(TAG, "C_OpenSession failed with %s [0x%08" PRIx32 "] for slot %d",
791 CK_RV_error_string(rv), rv, key->slotId);
792 continue;
793 }
794 currentSlot = key->slotId;
795 }
796
797 /* look if we can find a certificate that matches the key's id */
798 WINPR_ASSERT(provider->p11->C_FindObjectsInit);
799 rv = provider->p11->C_FindObjectsInit(currentSession, certificateFilter,
800 ARRAYSIZE(certificateFilter));
801 if (rv != CKR_OK)
802 {
803 WLog_ERR(TAG, "C_FindObjectsInit failed with %s [0x%08" PRIx32 "] for slot %d",
804 CK_RV_error_string(rv), rv, key->slotId);
805 continue;
806 }
807
808 WINPR_ASSERT(provider->p11->C_FindObjects);
809 rv = provider->p11->C_FindObjects(currentSession, &certObject, 1, &ncertObjects);
810 if (rv != CKR_OK)
811 {
812 WLog_ERR(TAG, "C_FindObjects failed with %s [0x%08" PRIx32 "] for slot %d",
813 CK_RV_error_string(rv), rv, currentSlot);
814 goto cleanup_FindObjects;
815 }
816
817 if (ncertObjects)
818 {
819 /* sizeof keyName struct + "<slotId><certId>" + keyName->pszAlgid */
820 DWORD algoSz = 0;
821 size_t KEYNAME_SZ =
822 (1 + (sizeof(key->slotId) * 2) /*slotId*/ + 1 + (key->idLen * 2) + 1) * 2;
823
824 convertKeyType(key->keyType, NULL, 0, &algoSz);
825 KEYNAME_SZ += (1ULL + algoSz) * 2ULL;
826
827 keyName = calloc(1, sizeof(*keyName) + KEYNAME_SZ);
828 if (!keyName)
829 {
830 WLog_ERR(TAG, "unable to allocate keyName");
831 goto cleanup_FindObjects;
832 }
833 keyName->dwLegacyKeySpec = AT_KEYEXCHANGE | AT_SIGNATURE;
834 keyName->dwFlags = NCRYPT_MACHINE_KEY_FLAG;
835 keyName->pszName = (LPWSTR)(keyName + 1);
836 wprintKeyName(keyName->pszName, key->slotId, key->id, key->idLen);
837
838 keyName->pszAlgid = keyName->pszName + _wcslen(keyName->pszName) + 1;
839 convertKeyType(key->keyType, keyName->pszAlgid, algoSz + 1, NULL);
840 }
841
842 cleanup_FindObjects:
843 WINPR_ASSERT(provider->p11->C_FindObjectsFinal);
844 rv = provider->p11->C_FindObjectsFinal(currentSession);
845 if (rv != CKR_OK)
846 WLog_ERR(TAG, "C_FindObjectsFinal failed with %s [0x%08" PRIx32 "]",
847 CK_RV_error_string(rv), rv);
848
849 if (keyName)
850 {
851 *ppKeyName = keyName;
852 state->keyIndex++;
853 return ERROR_SUCCESS;
854 }
855 }
856
857 return NTE_NO_MORE_ITEMS;
858}
859
860static SECURITY_STATUS get_piv_container_name(NCryptP11KeyHandle* key, const BYTE* piv_tag,
861 BYTE* output, size_t output_len)
862{
863 CK_SLOT_INFO slot_info = { 0 };
864 CK_FUNCTION_LIST_PTR p11 = NULL;
865 WCHAR* reader = NULL;
866 SCARDCONTEXT context = 0;
867 SCARDHANDLE card = 0;
868 DWORD proto = 0;
869 const SCARD_IO_REQUEST* pci = NULL;
870 BYTE buf[258] = { 0 };
871 char container_name[PIV_CONTAINER_NAME_LEN + 1] = { 0 };
872 DWORD buf_len = 0;
873 SECURITY_STATUS ret = NTE_BAD_KEY;
874 WinPrAsn1Decoder dec = { 0 };
875 WinPrAsn1Decoder dec2 = { 0 };
876 size_t len = 0;
877 BYTE tag = 0;
878 BYTE* p = NULL;
879 wStream s = { 0 };
880
881 WINPR_ASSERT(key);
882 WINPR_ASSERT(piv_tag);
883
884 WINPR_ASSERT(key->provider);
885 p11 = key->provider->p11;
886 WINPR_ASSERT(p11);
887
888 /* Get the reader the card is in */
889 WINPR_ASSERT(p11->C_GetSlotInfo);
890 if (p11->C_GetSlotInfo(key->slotId, &slot_info) != CKR_OK)
891 return NTE_BAD_KEY;
892
893 fix_padded_string((char*)slot_info.slotDescription, sizeof(slot_info.slotDescription));
894 reader = ConvertUtf8NToWCharAlloc((char*)slot_info.slotDescription,
895 ARRAYSIZE(slot_info.slotDescription), NULL);
896 ret = NTE_NO_MEMORY;
897 if (!reader)
898 goto out;
899
900 ret = NTE_BAD_KEY;
901 if (SCardEstablishContext(SCARD_SCOPE_USER, NULL, NULL, &context) != SCARD_S_SUCCESS)
902 goto out;
903
904 if (SCardConnectW(context, reader, SCARD_SHARE_SHARED, SCARD_PROTOCOL_Tx, &card, &proto) !=
905 SCARD_S_SUCCESS)
906 goto out;
907 pci = (proto == SCARD_PROTOCOL_T0) ? SCARD_PCI_T0 : SCARD_PCI_T1;
908
909 buf_len = sizeof(buf);
910 if (SCardTransmit(card, pci, APDU_PIV_SELECT_AID, sizeof(APDU_PIV_SELECT_AID), NULL, buf,
911 &buf_len) != SCARD_S_SUCCESS)
912 goto out;
913 if ((buf[buf_len - 2] != 0x90 || buf[buf_len - 1] != 0) && buf[buf_len - 2] != 0x61)
914 goto out;
915
916 buf_len = sizeof(buf);
917 if (SCardTransmit(card, pci, APDU_PIV_GET_CHUID, sizeof(APDU_PIV_GET_CHUID), NULL, buf,
918 &buf_len) != SCARD_S_SUCCESS)
919 goto out;
920 if ((buf[buf_len - 2] != 0x90 || buf[buf_len - 1] != 0) && buf[buf_len - 2] != 0x61)
921 goto out;
922
923 /* Find the GUID field in the CHUID data object */
924 WinPrAsn1Decoder_InitMem(&dec, WINPR_ASN1_BER, buf, buf_len);
925 if (!WinPrAsn1DecReadTagAndLen(&dec, &tag, &len) || tag != 0x53)
926 goto out;
927 while (WinPrAsn1DecReadTagLenValue(&dec, &tag, &len, &dec2) && tag != 0x34)
928 ;
929 if (tag != 0x34 || len != 16)
930 goto out;
931
932 s = WinPrAsn1DecGetStream(&dec2);
933 p = Stream_Buffer(&s);
934
935 /* Construct the value Windows would use for a PIV key's container name */
936 (void)snprintf(container_name, PIV_CONTAINER_NAME_LEN + 1,
937 "%.2x%.2x%.2x%.2x-%.2x%.2x-%.2x%.2x-%.2x%.2x-%.2x%.2x%.2x%.2x%.2x%.2x", p[3],
938 p[2], p[1], p[0], p[5], p[4], p[7], p[6], p[8], p[9], p[10], p[11], p[12],
939 piv_tag[0], piv_tag[1], piv_tag[2]);
940
941 /* And convert it to UTF-16 */
942 union
943 {
944 WCHAR* wc;
945 BYTE* b;
946 } cnv;
947 cnv.b = output;
948 if (ConvertUtf8NToWChar(container_name, ARRAYSIZE(container_name), cnv.wc,
949 output_len / sizeof(WCHAR)) > 0)
950 ret = ERROR_SUCCESS;
951
952out:
953 free(reader);
954 if (card)
955 SCardDisconnect(card, SCARD_LEAVE_CARD);
956 if (context)
957 SCardReleaseContext(context);
958 return ret;
959}
960
961static SECURITY_STATUS check_for_piv_container_name(NCryptP11KeyHandle* key, BYTE* pbOutput,
962 DWORD cbOutput, DWORD* pcbResult, char* label,
963 size_t label_len)
964{
965 for (size_t i = 0; i < ARRAYSIZE(piv_cert_tags); i++)
966 {
967 const piv_cert_tags_t* cur = &piv_cert_tags[i];
968 if (strncmp(label, cur->label, label_len) == 0)
969 {
970 *pcbResult = (PIV_CONTAINER_NAME_LEN + 1) * sizeof(WCHAR);
971 if (!pbOutput)
972 return ERROR_SUCCESS;
973 else if (cbOutput < (PIV_CONTAINER_NAME_LEN + 1) * sizeof(WCHAR))
974 return NTE_NO_MEMORY;
975 else
976 return get_piv_container_name(key, cur->tag, pbOutput, cbOutput);
977 }
978 }
979 return NTE_NOT_FOUND;
980}
981
982static SECURITY_STATUS NCryptP11KeyGetProperties(NCryptP11KeyHandle* keyHandle,
983 NCryptKeyGetPropertyEnum property, PBYTE pbOutput,
984 DWORD cbOutput, DWORD* pcbResult,
985 WINPR_ATTR_UNUSED DWORD dwFlags)
986{
987 SECURITY_STATUS ret = NTE_FAIL;
988 CK_RV rv = 0;
989 CK_SESSION_HANDLE session = 0;
990 CK_OBJECT_HANDLE objectHandle = 0;
991 CK_ULONG objectCount = 0;
992 NCryptP11ProviderHandle* provider = NULL;
993 CK_OBJECT_CLASS oclass = CKO_CERTIFICATE;
994 CK_CERTIFICATE_TYPE ctype = CKC_X_509;
995 CK_ATTRIBUTE certificateFilter[] = { { CKA_CLASS, &oclass, sizeof(oclass) },
996 { CKA_CERTIFICATE_TYPE, &ctype, sizeof(ctype) },
997 { CKA_ID, keyHandle->keyCertId,
998 keyHandle->keyCertIdLen } };
999 CK_ATTRIBUTE* objectFilter = certificateFilter;
1000 CK_ULONG objectFilterLen = ARRAYSIZE(certificateFilter);
1001
1002 WINPR_ASSERT(keyHandle);
1003 provider = keyHandle->provider;
1004 WINPR_ASSERT(provider);
1005
1006 switch (property)
1007
1008 {
1009 case NCRYPT_PROPERTY_CERTIFICATE:
1010 case NCRYPT_PROPERTY_NAME:
1011 break;
1012 case NCRYPT_PROPERTY_READER:
1013 {
1014 CK_SLOT_INFO slotInfo;
1015
1016 WINPR_ASSERT(provider->p11->C_GetSlotInfo);
1017 rv = provider->p11->C_GetSlotInfo(keyHandle->slotId, &slotInfo);
1018 if (rv != CKR_OK)
1019 return NTE_BAD_KEY;
1020
1021#define SLOT_DESC_SZ sizeof(slotInfo.slotDescription)
1022 fix_padded_string((char*)slotInfo.slotDescription, SLOT_DESC_SZ);
1023 const size_t len = 2ULL * (strnlen((char*)slotInfo.slotDescription, SLOT_DESC_SZ) + 1);
1024 if (len > UINT32_MAX)
1025 return NTE_BAD_DATA;
1026 *pcbResult = (UINT32)len;
1027 if (pbOutput)
1028 {
1029 union
1030 {
1031 WCHAR* wc;
1032 BYTE* b;
1033 } cnv;
1034 cnv.b = pbOutput;
1035 if (cbOutput < *pcbResult)
1036 return NTE_NO_MEMORY;
1037
1038 if (ConvertUtf8ToWChar((char*)slotInfo.slotDescription, cnv.wc,
1039 cbOutput / sizeof(WCHAR)) < 0)
1040 return NTE_NO_MEMORY;
1041 }
1042 return ERROR_SUCCESS;
1043 }
1044 case NCRYPT_PROPERTY_SLOTID:
1045 {
1046 *pcbResult = 4;
1047 if (pbOutput)
1048 {
1049 UINT32* ptr = (UINT32*)pbOutput;
1050
1051 if (cbOutput < 4)
1052 return NTE_NO_MEMORY;
1053 if (keyHandle->slotId > UINT32_MAX)
1054 {
1055 ret = NTE_BAD_DATA;
1056 goto out_final;
1057 }
1058 *ptr = (UINT32)keyHandle->slotId;
1059 }
1060 return ERROR_SUCCESS;
1061 }
1062 case NCRYPT_PROPERTY_UNKNOWN:
1063 default:
1064 return NTE_NOT_SUPPORTED;
1065 }
1066
1067 WINPR_ASSERT(provider->p11->C_OpenSession);
1068 rv = provider->p11->C_OpenSession(keyHandle->slotId, CKF_SERIAL_SESSION, NULL, NULL, &session);
1069 if (rv != CKR_OK)
1070 {
1071 WLog_ERR(TAG, "error opening session on slot %d", keyHandle->slotId);
1072 return NTE_FAIL;
1073 }
1074
1075 WINPR_ASSERT(provider->p11->C_FindObjectsInit);
1076 rv = provider->p11->C_FindObjectsInit(session, objectFilter, objectFilterLen);
1077 if (rv != CKR_OK)
1078 {
1079 WLog_ERR(TAG, "unable to initiate search for slot %d", keyHandle->slotId);
1080 goto out;
1081 }
1082
1083 WINPR_ASSERT(provider->p11->C_FindObjects);
1084 rv = provider->p11->C_FindObjects(session, &objectHandle, 1, &objectCount);
1085 if (rv != CKR_OK)
1086 {
1087 WLog_ERR(TAG, "unable to findObjects for slot %d", keyHandle->slotId);
1088 goto out_final;
1089 }
1090 if (!objectCount)
1091 {
1092 ret = NTE_NOT_FOUND;
1093 goto out_final;
1094 }
1095
1096 switch (property)
1097 {
1098 case NCRYPT_PROPERTY_CERTIFICATE:
1099 {
1100 CK_ATTRIBUTE certValue = { CKA_VALUE, pbOutput, cbOutput };
1101
1102 WINPR_ASSERT(provider->p11->C_GetAttributeValue);
1103 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &certValue, 1);
1104 if (rv != CKR_OK)
1105 {
1106 // TODO: do a kind of translation from CKR_* to NTE_*
1107 }
1108
1109 if (certValue.ulValueLen > UINT32_MAX)
1110 {
1111 ret = NTE_BAD_DATA;
1112 goto out_final;
1113 }
1114 *pcbResult = (UINT32)certValue.ulValueLen;
1115 ret = ERROR_SUCCESS;
1116 break;
1117 }
1118 case NCRYPT_PROPERTY_NAME:
1119 {
1120 CK_ATTRIBUTE attr = { CKA_LABEL, NULL, 0 };
1121 char* label = NULL;
1122
1123 WINPR_ASSERT(provider->p11->C_GetAttributeValue);
1124 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &attr, 1);
1125 if (rv == CKR_OK)
1126 {
1127 label = calloc(1, attr.ulValueLen);
1128 if (!label)
1129 {
1130 ret = NTE_NO_MEMORY;
1131 break;
1132 }
1133
1134 attr.pValue = label;
1135 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &attr, 1);
1136 }
1137
1138 if (rv == CKR_OK)
1139 {
1140 /* Check if we have a PIV card */
1141 ret = check_for_piv_container_name(keyHandle, pbOutput, cbOutput, pcbResult, label,
1142 attr.ulValueLen);
1143
1144 /* Otherwise, at least for GIDS cards the label will be the correct value */
1145 if (ret == NTE_NOT_FOUND)
1146 {
1147 union
1148 {
1149 WCHAR* wc;
1150 BYTE* b;
1151 } cnv;
1152 const size_t olen = pbOutput ? cbOutput / sizeof(WCHAR) : 0;
1153 cnv.b = pbOutput;
1154 SSIZE_T size = ConvertUtf8NToWChar(label, attr.ulValueLen, cnv.wc, olen);
1155 if (size < 0)
1156 ret = ERROR_CONVERT_TO_LARGE;
1157 else
1158 ret = ERROR_SUCCESS;
1159 }
1160 }
1161
1162 free(label);
1163 break;
1164 }
1165 default:
1166 ret = NTE_NOT_SUPPORTED;
1167 break;
1168 }
1169
1170out_final:
1171 WINPR_ASSERT(provider->p11->C_FindObjectsFinal);
1172 rv = provider->p11->C_FindObjectsFinal(session);
1173 if (rv != CKR_OK)
1174 {
1175 WLog_ERR(TAG, "error in C_FindObjectsFinal() for slot %d", keyHandle->slotId);
1176 }
1177out:
1178 WINPR_ASSERT(provider->p11->C_CloseSession);
1179 rv = provider->p11->C_CloseSession(session);
1180 if (rv != CKR_OK)
1181 {
1182 WLog_ERR(TAG, "error in C_CloseSession() for slot %d", keyHandle->slotId);
1183 }
1184 return ret;
1185}
1186
1187static SECURITY_STATUS NCryptP11GetProperty(NCRYPT_HANDLE hObject, NCryptKeyGetPropertyEnum prop,
1188 PBYTE pbOutput, DWORD cbOutput, DWORD* pcbResult,
1189 DWORD dwFlags)
1190{
1191 NCryptBaseHandle* base = (NCryptBaseHandle*)hObject;
1192
1193 WINPR_ASSERT(base);
1194 switch (base->type)
1195 {
1196 case WINPR_NCRYPT_PROVIDER:
1197 return ERROR_CALL_NOT_IMPLEMENTED;
1198 case WINPR_NCRYPT_KEY:
1199 return NCryptP11KeyGetProperties((NCryptP11KeyHandle*)hObject, prop, pbOutput, cbOutput,
1200 pcbResult, dwFlags);
1201 default:
1202 return ERROR_INVALID_HANDLE;
1203 }
1204 return ERROR_SUCCESS;
1205}
1206
1207static SECURITY_STATUS NCryptP11OpenKey(NCRYPT_PROV_HANDLE hProvider, NCRYPT_KEY_HANDLE* phKey,
1208 LPCWSTR pszKeyName, WINPR_ATTR_UNUSED DWORD dwLegacyKeySpec,
1209 WINPR_ATTR_UNUSED DWORD dwFlags)
1210{
1211 SECURITY_STATUS ret = 0;
1212 CK_SLOT_ID slotId = 0;
1213 CK_BYTE keyCertId[64] = { 0 };
1214 CK_ULONG keyCertIdLen = 0;
1215 NCryptP11KeyHandle* keyHandle = NULL;
1216
1217 ret = parseKeyName(pszKeyName, &slotId, keyCertId, &keyCertIdLen);
1218 if (ret != ERROR_SUCCESS)
1219 return ret;
1220
1221 keyHandle = (NCryptP11KeyHandle*)ncrypt_new_handle(
1222 WINPR_NCRYPT_KEY, sizeof(*keyHandle), NCryptP11GetProperty, winpr_NCryptDefault_dtor);
1223 if (!keyHandle)
1224 return NTE_NO_MEMORY;
1225
1226 keyHandle->provider = (NCryptP11ProviderHandle*)hProvider;
1227 keyHandle->slotId = slotId;
1228 memcpy(keyHandle->keyCertId, keyCertId, sizeof(keyCertId));
1229 keyHandle->keyCertIdLen = keyCertIdLen;
1230 *phKey = (NCRYPT_KEY_HANDLE)keyHandle;
1231 return ERROR_SUCCESS;
1232}
1233
1234static SECURITY_STATUS initialize_pkcs11(HANDLE handle,
1235 CK_RV (*c_get_function_list)(CK_FUNCTION_LIST_PTR_PTR),
1236 NCRYPT_PROV_HANDLE* phProvider)
1237{
1238 SECURITY_STATUS status = ERROR_SUCCESS;
1239 NCryptP11ProviderHandle* ret = NULL;
1240 CK_RV rv = 0;
1241
1242 WINPR_ASSERT(c_get_function_list);
1243 WINPR_ASSERT(phProvider);
1244
1245 ret = (NCryptP11ProviderHandle*)ncrypt_new_handle(
1246 WINPR_NCRYPT_PROVIDER, sizeof(*ret), NCryptP11GetProperty, NCryptP11StorageProvider_dtor);
1247 if (!ret)
1248 return NTE_NO_MEMORY;
1249
1250 ret->library = handle;
1251 ret->baseProvider.enumKeysFn = NCryptP11EnumKeys;
1252 ret->baseProvider.openKeyFn = NCryptP11OpenKey;
1253
1254 rv = c_get_function_list(&ret->p11);
1255 if (rv != CKR_OK)
1256 {
1257 status = NTE_PROVIDER_DLL_FAIL;
1258 goto fail;
1259 }
1260
1261 WINPR_ASSERT(ret->p11);
1262 WINPR_ASSERT(ret->p11->C_Initialize);
1263 rv = ret->p11->C_Initialize(NULL);
1264 if (rv != CKR_OK)
1265 {
1266 status = NTE_PROVIDER_DLL_FAIL;
1267 goto fail;
1268 }
1269
1270 *phProvider = (NCRYPT_PROV_HANDLE)ret;
1271
1272fail:
1273 if (status != ERROR_SUCCESS)
1274 ret->baseProvider.baseHandle.releaseFn((NCRYPT_HANDLE)ret);
1275 return status;
1276}
1277
1278SECURITY_STATUS NCryptOpenP11StorageProviderEx(NCRYPT_PROV_HANDLE* phProvider,
1279 WINPR_ATTR_UNUSED LPCWSTR pszProviderName,
1280 WINPR_ATTR_UNUSED DWORD dwFlags, LPCSTR* modulePaths)
1281{
1282 SECURITY_STATUS status = ERROR_INVALID_PARAMETER;
1283 LPCSTR defaultPaths[] = { "p11-kit-proxy.so", "opensc-pkcs11.so", NULL };
1284
1285 if (!phProvider)
1286 return ERROR_INVALID_PARAMETER;
1287
1288 if (!modulePaths)
1289 modulePaths = defaultPaths;
1290
1291 while (*modulePaths)
1292 {
1293 const char* modulePath = *modulePaths++;
1294 HANDLE library = LoadLibrary(modulePath);
1295 typedef CK_RV (*c_get_function_list_t)(CK_FUNCTION_LIST_PTR_PTR);
1296 NCryptP11ProviderHandle* provider = NULL;
1297
1298 WLog_DBG(TAG, "Trying pkcs11 module '%s'", modulePath);
1299 if (!library)
1300 {
1301 status = NTE_PROV_DLL_NOT_FOUND;
1302 goto out_load_library;
1303 }
1304
1305 c_get_function_list_t c_get_function_list =
1306 GetProcAddressAs(library, "C_GetFunctionList", c_get_function_list_t);
1307
1308 if (!c_get_function_list)
1309 {
1310 status = NTE_PROV_TYPE_ENTRY_BAD;
1311 goto out_load_library;
1312 }
1313
1314 status = initialize_pkcs11(library, c_get_function_list, phProvider);
1315 if (status != ERROR_SUCCESS)
1316 {
1317 status = NTE_PROVIDER_DLL_FAIL;
1318 goto out_load_library;
1319 }
1320
1321 provider = (NCryptP11ProviderHandle*)*phProvider;
1322 provider->modulePath = _strdup(modulePath);
1323 if (!provider->modulePath)
1324 {
1325 status = NTE_NO_MEMORY;
1326 goto out_load_library;
1327 }
1328
1329 WLog_DBG(TAG, "module '%s' loaded", modulePath);
1330 return ERROR_SUCCESS;
1331
1332 out_load_library:
1333 if (library)
1334 FreeLibrary(library);
1335 }
1336
1337 return status;
1338}
1339
1340const char* NCryptGetModulePath(NCRYPT_PROV_HANDLE phProvider)
1341{
1342 NCryptP11ProviderHandle* provider = (NCryptP11ProviderHandle*)phProvider;
1343
1344 WINPR_ASSERT(provider);
1345
1346 return provider->modulePath;
1347}
CK_ATTRIBUTE
Definition pkcs11.h:1116
CK_SLOT_INFO
Definition pkcs11.h:1182
CK_TOKEN_INFO
Definition pkcs11.h:1190
NCryptBaseHandle
common ncrypt handle items
Definition libwinpr/ncrypt/ncrypt.h:58
NCryptBaseProvider
common ncrypt provider items
Definition libwinpr/ncrypt/ncrypt.h:74
NCryptKeyName
a key name descriptor
Definition include/winpr/ncrypt.h:149
SCARD_IO_REQUEST
Definition include/winpr/smartcard.h:263