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