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_PrintMessage(log_cached_ptr, WLOG_MESSAGE_TEXT, log_level, line, file, fkt,
370 "%s for slot #%" PRIu32 "(%" PRIu32 "), rv=%s", msg, index, slot,
371 CK_RV_error_string(rv));
372}
373
374static SECURITY_STATUS collect_keys(NCryptP11ProviderHandle* provider, P11EnumKeysState* state)
375{
376 CK_OBJECT_HANDLE slotObjects[MAX_KEYS_PER_SLOT] = { 0 };
377
378 WINPR_ASSERT(provider);
379
380 CK_FUNCTION_LIST_PTR p11 = provider->p11;
381 WINPR_ASSERT(p11);
382
383 WLog_DBG(TAG, "checking %" PRIu32 " slots for valid keys...", state->nslots);
384 state->nKeys = 0;
385 for (CK_ULONG i = 0; i < state->nslots; i++)
386 {
387 CK_SESSION_HANDLE session = (CK_SESSION_HANDLE)NULL;
388 CK_SLOT_INFO slotInfo = { 0 };
389 CK_TOKEN_INFO tokenInfo = { 0 };
390
391 WINPR_ASSERT(p11->C_GetSlotInfo);
392 CK_RV rv = p11->C_GetSlotInfo(state->slots[i], &slotInfo);
393 if (rv != CKR_OK)
394 {
395 loge(TAG, "unable to retrieve information", rv, i, state->slots[i]);
396 continue;
397 }
398
399 fix_padded_string((char*)slotInfo.slotDescription, sizeof(slotInfo.slotDescription));
400 WLog_DBG(TAG, "collecting keys for slot #%" PRIu32 "(%" PRIu32 ") descr='%s' flags=0x%x", i,
401 state->slots[i], slotInfo.slotDescription, slotInfo.flags);
402
403 /* this is a safety guard as we're supposed to have listed only readers with tokens in them
404 */
405 if (!(slotInfo.flags & CKF_TOKEN_PRESENT))
406 {
407 WLog_INFO(TAG, "token not present for slot #%" PRIu32 "(%" PRIu32 ")", i,
408 state->slots[i]);
409 continue;
410 }
411
412 WINPR_ASSERT(p11->C_GetTokenInfo);
413 rv = p11->C_GetTokenInfo(state->slots[i], &tokenInfo);
414 if (rv != CKR_OK)
415 loge(TAG, "unable to retrieve token info", rv, i, state->slots[i]);
416 else
417 {
418 fix_padded_string((char*)tokenInfo.label, sizeof(tokenInfo.label));
419 WLog_DBG(TAG, "token, label='%s' flags=0x%x", tokenInfo.label, tokenInfo.flags);
420 }
421
422 WINPR_ASSERT(p11->C_OpenSession);
423 rv = p11->C_OpenSession(state->slots[i], CKF_SERIAL_SESSION, NULL, NULL, &session);
424 if (rv != CKR_OK)
425 {
426 WLog_ERR(TAG,
427 "unable to openSession for slot #%" PRIu32 "(%" PRIu32 "), session=%p rv=%s",
428 i, state->slots[i], session, CK_RV_error_string(rv));
429 continue;
430 }
431
432 WINPR_ASSERT(p11->C_FindObjectsInit);
433 rv = p11->C_FindObjectsInit(session, public_key_filter, ARRAYSIZE(public_key_filter));
434 if (rv != CKR_OK)
435 {
436 // TODO: shall it be fatal ?
437 loge(TAG, "unable to initiate search", rv, i, state->slots[i]);
438 goto cleanup_FindObjectsInit;
439 }
440
441 CK_ULONG nslotObjects = 0;
442 WINPR_ASSERT(p11->C_FindObjects);
443 rv = p11->C_FindObjects(session, &slotObjects[0], ARRAYSIZE(slotObjects), &nslotObjects);
444 if (rv != CKR_OK)
445 {
446 loge(TAG, "unable to findObjects", rv, i, state->slots[i]);
447 goto cleanup_FindObjects;
448 }
449
450 WLog_DBG(TAG, "slot has %d objects", nslotObjects);
451 for (CK_ULONG j = 0; j < nslotObjects; j++)
452 {
453 NCryptKeyEnum* key = &state->keys[state->nKeys];
454 CK_OBJECT_CLASS dataClass = CKO_PUBLIC_KEY;
455 CK_ATTRIBUTE key_or_certAttrs[] = {
456 { CKA_ID, &key->id, sizeof(key->id) },
457 { CKA_CLASS, &dataClass, sizeof(dataClass) },
458 { CKA_LABEL, &key->keyLabel, sizeof(key->keyLabel) },
459 { CKA_KEY_TYPE, &key->keyType, sizeof(key->keyType) }
460 };
461
462 rv = object_load_attributes(provider, session, slotObjects[j], key_or_certAttrs,
463 ARRAYSIZE(key_or_certAttrs));
464 if (rv != CKR_OK)
465 {
466 WLog_ERR(TAG, "error getting attributes, rv=%s", CK_RV_error_string(rv));
467 continue;
468 }
469
470 key->idLen = key_or_certAttrs[0].ulValueLen;
471 key->slotId = state->slots[i];
472 key->slotInfo = slotInfo;
473 state->nKeys++;
474 }
475
476 cleanup_FindObjects:
477 WINPR_ASSERT(p11->C_FindObjectsFinal);
478 rv = p11->C_FindObjectsFinal(session);
479 if (rv != CKR_OK)
480 loge(TAG, "error during C_FindObjectsFinal", rv, i, state->slots[i]);
481 cleanup_FindObjectsInit:
482 WINPR_ASSERT(p11->C_CloseSession);
483 rv = p11->C_CloseSession(session);
484 if (rv != CKR_OK)
485 loge(TAG, "error closing session", rv, i, state->slots[i]);
486 }
487
488 return ERROR_SUCCESS;
489}
490
491static BOOL convertKeyType(CK_KEY_TYPE k, LPWSTR dest, DWORD len, DWORD* outlen)
492{
493 const WCHAR* r = NULL;
494 size_t retLen = 0;
495
496#define ALGO_CASE(V, S) \
497 case V: \
498 r = S; \
499 retLen = _wcsnlen((S), ARRAYSIZE((S))); \
500 break
501 switch (k)
502 {
503 ALGO_CASE(CKK_RSA, BCRYPT_RSA_ALGORITHM);
504 ALGO_CASE(CKK_DSA, BCRYPT_DSA_ALGORITHM);
505 ALGO_CASE(CKK_DH, BCRYPT_DH_ALGORITHM);
506 ALGO_CASE(CKK_EC, BCRYPT_ECDSA_ALGORITHM);
507 ALGO_CASE(CKK_RC2, BCRYPT_RC2_ALGORITHM);
508 ALGO_CASE(CKK_RC4, BCRYPT_RC4_ALGORITHM);
509 ALGO_CASE(CKK_DES, BCRYPT_DES_ALGORITHM);
510 ALGO_CASE(CKK_DES3, BCRYPT_3DES_ALGORITHM);
511 case CKK_DES2:
512 case CKK_X9_42_DH:
513 case CKK_KEA:
514 case CKK_GENERIC_SECRET:
515 case CKK_CAST:
516 case CKK_CAST3:
517 case CKK_CAST128:
518 case CKK_RC5:
519 case CKK_IDEA:
520 case CKK_SKIPJACK:
521 case CKK_BATON:
522 case CKK_JUNIPER:
523 case CKK_CDMF:
524 case CKK_AES:
525 case CKK_BLOWFISH:
526 case CKK_TWOFISH:
527 default:
528 break;
529 }
530#undef ALGO_CASE
531
532 if (retLen > UINT32_MAX)
533 return FALSE;
534
535 if (outlen)
536 *outlen = (UINT32)retLen;
537
538 if (!r)
539 {
540 if (dest && len > 0)
541 dest[0] = 0;
542 return FALSE;
543 }
544
545 if (dest)
546 {
547 if (retLen + 1 > len)
548 {
549 WLog_ERR(TAG, "target buffer is too small for algo name");
550 return FALSE;
551 }
552
553 memcpy(dest, r, sizeof(WCHAR) * retLen);
554 dest[retLen] = 0;
555 }
556
557 return TRUE;
558}
559
560static void wprintKeyName(LPWSTR str, CK_SLOT_ID slotId, CK_BYTE* id, CK_ULONG idLen)
561{
562 char asciiName[128] = { 0 };
563 char* ptr = asciiName;
564 const CK_BYTE* bytePtr = NULL;
565
566 *ptr = '\\';
567 ptr++;
568
569 bytePtr = ((CK_BYTE*)&slotId);
570 for (CK_ULONG i = 0; i < sizeof(slotId); i++, bytePtr++, ptr += 2)
571 (void)snprintf(ptr, 3, "%.2x", *bytePtr);
572
573 *ptr = '\\';
574 ptr++;
575
576 for (CK_ULONG i = 0; i < idLen; i++, id++, ptr += 2)
577 (void)snprintf(ptr, 3, "%.2x", *id);
578
579 (void)ConvertUtf8NToWChar(asciiName, ARRAYSIZE(asciiName), str,
580 strnlen(asciiName, ARRAYSIZE(asciiName)) + 1);
581}
582
583static size_t parseHex(const char* str, const char* end, CK_BYTE* target)
584{
585 size_t ret = 0;
586
587 for (; str != end && *str; str++, ret++, target++)
588 {
589 int v = 0;
590 if (*str <= '9' && *str >= '0')
591 {
592 v = (*str - '0');
593 }
594 else if (*str <= 'f' && *str >= 'a')
595 {
596 v = (10 + *str - 'a');
597 }
598 else if (*str <= 'F' && *str >= 'A')
599 {
600 v |= (10 + *str - 'A');
601 }
602 else
603 {
604 return 0;
605 }
606 v <<= 4;
607 str++;
608
609 if (!*str || str == end)
610 return 0;
611
612 if (*str <= '9' && *str >= '0')
613 {
614 v |= (*str - '0');
615 }
616 else if (*str <= 'f' && *str >= 'a')
617 {
618 v |= (10 + *str - 'a');
619 }
620 else if (*str <= 'F' && *str >= 'A')
621 {
622 v |= (10 + *str - 'A');
623 }
624 else
625 {
626 return 0;
627 }
628
629 *target = v & 0xFF;
630 }
631 return ret;
632}
633
634static SECURITY_STATUS parseKeyName(LPCWSTR pszKeyName, CK_SLOT_ID* slotId, CK_BYTE* id,
635 CK_ULONG* idLen)
636{
637 char asciiKeyName[128] = { 0 };
638 char* pos = NULL;
639
640 if (ConvertWCharToUtf8(pszKeyName, asciiKeyName, ARRAYSIZE(asciiKeyName)) < 0)
641 return NTE_BAD_KEY;
642
643 if (*asciiKeyName != '\\')
644 return NTE_BAD_KEY;
645
646 pos = strchr(&asciiKeyName[1], '\\');
647 if (!pos)
648 return NTE_BAD_KEY;
649
650 if ((size_t)(pos - &asciiKeyName[1]) > sizeof(CK_SLOT_ID) * 2ull)
651 return NTE_BAD_KEY;
652
653 *slotId = (CK_SLOT_ID)0;
654 if (parseHex(&asciiKeyName[1], pos, (CK_BYTE*)slotId) != sizeof(CK_SLOT_ID))
655 return NTE_BAD_KEY;
656
657 *idLen = parseHex(pos + 1, NULL, id);
658 if (!*idLen)
659 return NTE_BAD_KEY;
660
661 return ERROR_SUCCESS;
662}
663
664static SECURITY_STATUS NCryptP11EnumKeys(NCRYPT_PROV_HANDLE hProvider, LPCWSTR pszScope,
665 NCryptKeyName** ppKeyName, PVOID* ppEnumState,
666 WINPR_ATTR_UNUSED DWORD dwFlags)
667{
668 NCryptP11ProviderHandle* provider = (NCryptP11ProviderHandle*)hProvider;
669 P11EnumKeysState* state = (P11EnumKeysState*)*ppEnumState;
670 CK_RV rv = { 0 };
671 CK_SLOT_ID currentSlot = { 0 };
672 CK_SESSION_HANDLE currentSession = (CK_SESSION_HANDLE)NULL;
673 char slotFilterBuffer[65] = { 0 };
674 char* slotFilter = NULL;
675 size_t slotFilterLen = 0;
676
677 SECURITY_STATUS ret = checkNCryptHandle((NCRYPT_HANDLE)hProvider, WINPR_NCRYPT_PROVIDER);
678 if (ret != ERROR_SUCCESS)
679 return ret;
680
681 if (pszScope)
682 {
683 /*
684 * check whether pszScope is of the form \\.<reader name>\ for filtering by
685 * card reader
686 */
687 char asciiScope[128 + 6 + 1] = { 0 };
688 size_t asciiScopeLen = 0;
689
690 if (ConvertWCharToUtf8(pszScope, asciiScope, ARRAYSIZE(asciiScope) - 1) < 0)
691 {
692 WLog_WARN(TAG, "Invalid scope");
693 return NTE_INVALID_PARAMETER;
694 }
695
696 if (strstr(asciiScope, "\\\\.\\") != asciiScope)
697 {
698 WLog_WARN(TAG, "Invalid scope '%s'", asciiScope);
699 return NTE_INVALID_PARAMETER;
700 }
701
702 asciiScopeLen = strnlen(asciiScope, ARRAYSIZE(asciiScope));
703 if ((asciiScopeLen < 1) || (asciiScope[asciiScopeLen - 1] != '\\'))
704 {
705 WLog_WARN(TAG, "Invalid scope '%s'", asciiScope);
706 return NTE_INVALID_PARAMETER;
707 }
708
709 asciiScope[asciiScopeLen - 1] = 0;
710
711 strncpy(slotFilterBuffer, &asciiScope[4], sizeof(slotFilterBuffer));
712 slotFilter = slotFilterBuffer;
713 slotFilterLen = asciiScopeLen - 5;
714 }
715
716 if (!state)
717 {
718 state = (P11EnumKeysState*)calloc(1, sizeof(*state));
719 if (!state)
720 return NTE_NO_MEMORY;
721
722 WINPR_ASSERT(provider->p11->C_GetSlotList);
723 rv = provider->p11->C_GetSlotList(CK_TRUE, NULL, &state->nslots);
724 if (rv != CKR_OK)
725 {
726 free(state);
727 /* TODO: perhaps convert rv to NTE_*** errors */
728 WLog_WARN(TAG, "C_GetSlotList failed with %s [0x%08" PRIx32 "]", CK_RV_error_string(rv),
729 rv);
730 return NTE_FAIL;
731 }
732
733 if (state->nslots > MAX_SLOTS)
734 state->nslots = MAX_SLOTS;
735
736 rv = provider->p11->C_GetSlotList(CK_TRUE, state->slots, &state->nslots);
737 if (rv != CKR_OK)
738 {
739 free(state);
740 /* TODO: perhaps convert rv to NTE_*** errors */
741 WLog_WARN(TAG, "C_GetSlotList failed with %s [0x%08" PRIx32 "]", CK_RV_error_string(rv),
742 rv);
743 return NTE_FAIL;
744 }
745
746 ret = collect_keys(provider, state);
747 if (ret != ERROR_SUCCESS)
748 {
749 free(state);
750 return ret;
751 }
752
753 *ppEnumState = state;
754 }
755
756 for (; state->keyIndex < state->nKeys; state->keyIndex++)
757 {
758 NCryptKeyName* keyName = NULL;
759 NCryptKeyEnum* key = &state->keys[state->keyIndex];
760 CK_OBJECT_CLASS oclass = CKO_CERTIFICATE;
761 CK_CERTIFICATE_TYPE ctype = CKC_X_509;
762 CK_ATTRIBUTE certificateFilter[] = { { CKA_CLASS, &oclass, sizeof(oclass) },
763 { CKA_CERTIFICATE_TYPE, &ctype, sizeof(ctype) },
764 { CKA_ID, key->id, key->idLen } };
765 CK_ULONG ncertObjects = 0;
766 CK_OBJECT_HANDLE certObject = 0;
767
768 /* check the reader filter if any */
769 if (slotFilter && memcmp(key->slotInfo.slotDescription, slotFilter, slotFilterLen) != 0)
770 continue;
771
772 if (!currentSession || (currentSlot != key->slotId))
773 {
774 /* if the current session doesn't match the current key's slot, open a new one
775 */
776 if (currentSession)
777 {
778 WINPR_ASSERT(provider->p11->C_CloseSession);
779 rv = provider->p11->C_CloseSession(currentSession);
780 if (rv != CKR_OK)
781 WLog_WARN(TAG, "C_CloseSession failed with %s [0x%08" PRIx32 "]",
782 CK_RV_error_string(rv), rv);
783 currentSession = (CK_SESSION_HANDLE)NULL;
784 }
785
786 WINPR_ASSERT(provider->p11->C_OpenSession);
787 rv = provider->p11->C_OpenSession(key->slotId, CKF_SERIAL_SESSION, NULL, NULL,
788 &currentSession);
789 if (rv != CKR_OK)
790 {
791 WLog_ERR(TAG, "C_OpenSession failed with %s [0x%08" PRIx32 "] for slot %d",
792 CK_RV_error_string(rv), rv, key->slotId);
793 continue;
794 }
795 currentSlot = key->slotId;
796 }
797
798 /* look if we can find a certificate that matches the key's id */
799 WINPR_ASSERT(provider->p11->C_FindObjectsInit);
800 rv = provider->p11->C_FindObjectsInit(currentSession, certificateFilter,
801 ARRAYSIZE(certificateFilter));
802 if (rv != CKR_OK)
803 {
804 WLog_ERR(TAG, "C_FindObjectsInit failed with %s [0x%08" PRIx32 "] for slot %d",
805 CK_RV_error_string(rv), rv, key->slotId);
806 continue;
807 }
808
809 WINPR_ASSERT(provider->p11->C_FindObjects);
810 rv = provider->p11->C_FindObjects(currentSession, &certObject, 1, &ncertObjects);
811 if (rv != CKR_OK)
812 {
813 WLog_ERR(TAG, "C_FindObjects failed with %s [0x%08" PRIx32 "] for slot %d",
814 CK_RV_error_string(rv), rv, currentSlot);
815 goto cleanup_FindObjects;
816 }
817
818 if (ncertObjects)
819 {
820 /* sizeof keyName struct + "<slotId><certId>" + keyName->pszAlgid */
821 DWORD algoSz = 0;
822 size_t KEYNAME_SZ =
823 (1 + (sizeof(key->slotId) * 2) /*slotId*/ + 1 + (key->idLen * 2) + 1) * 2;
824
825 convertKeyType(key->keyType, NULL, 0, &algoSz);
826 KEYNAME_SZ += (1ULL + algoSz) * 2ULL;
827
828 keyName = calloc(1, sizeof(*keyName) + KEYNAME_SZ);
829 if (!keyName)
830 {
831 WLog_ERR(TAG, "unable to allocate keyName");
832 goto cleanup_FindObjects;
833 }
834 keyName->dwLegacyKeySpec = AT_KEYEXCHANGE | AT_SIGNATURE;
835 keyName->dwFlags = NCRYPT_MACHINE_KEY_FLAG;
836 keyName->pszName = (LPWSTR)(keyName + 1);
837 wprintKeyName(keyName->pszName, key->slotId, key->id, key->idLen);
838
839 keyName->pszAlgid = keyName->pszName + _wcslen(keyName->pszName) + 1;
840 convertKeyType(key->keyType, keyName->pszAlgid, algoSz + 1, NULL);
841 }
842
843 cleanup_FindObjects:
844 WINPR_ASSERT(provider->p11->C_FindObjectsFinal);
845 rv = provider->p11->C_FindObjectsFinal(currentSession);
846 if (rv != CKR_OK)
847 WLog_ERR(TAG, "C_FindObjectsFinal failed with %s [0x%08" PRIx32 "]",
848 CK_RV_error_string(rv), rv);
849
850 if (keyName)
851 {
852 *ppKeyName = keyName;
853 state->keyIndex++;
854 return ERROR_SUCCESS;
855 }
856 }
857
858 return NTE_NO_MORE_ITEMS;
859}
860
861static SECURITY_STATUS get_piv_container_name(NCryptP11KeyHandle* key, const BYTE* piv_tag,
862 BYTE* output, size_t output_len)
863{
864 CK_SLOT_INFO slot_info = { 0 };
865 CK_FUNCTION_LIST_PTR p11 = NULL;
866 WCHAR* reader = NULL;
867 SCARDCONTEXT context = 0;
868 SCARDHANDLE card = 0;
869 DWORD proto = 0;
870 const SCARD_IO_REQUEST* pci = NULL;
871 BYTE buf[258] = { 0 };
872 char container_name[PIV_CONTAINER_NAME_LEN + 1] = { 0 };
873 DWORD buf_len = 0;
874 SECURITY_STATUS ret = NTE_BAD_KEY;
875 WinPrAsn1Decoder dec = { 0 };
876 WinPrAsn1Decoder dec2 = { 0 };
877 size_t len = 0;
878 BYTE tag = 0;
879 BYTE* p = NULL;
880 wStream s = { 0 };
881
882 WINPR_ASSERT(key);
883 WINPR_ASSERT(piv_tag);
884
885 WINPR_ASSERT(key->provider);
886 p11 = key->provider->p11;
887 WINPR_ASSERT(p11);
888
889 /* Get the reader the card is in */
890 WINPR_ASSERT(p11->C_GetSlotInfo);
891 if (p11->C_GetSlotInfo(key->slotId, &slot_info) != CKR_OK)
892 return NTE_BAD_KEY;
893
894 fix_padded_string((char*)slot_info.slotDescription, sizeof(slot_info.slotDescription));
895 reader = ConvertUtf8NToWCharAlloc((char*)slot_info.slotDescription,
896 ARRAYSIZE(slot_info.slotDescription), NULL);
897 ret = NTE_NO_MEMORY;
898 if (!reader)
899 goto out;
900
901 ret = NTE_BAD_KEY;
902 if (SCardEstablishContext(SCARD_SCOPE_USER, NULL, NULL, &context) != SCARD_S_SUCCESS)
903 goto out;
904
905 if (SCardConnectW(context, reader, SCARD_SHARE_SHARED, SCARD_PROTOCOL_Tx, &card, &proto) !=
906 SCARD_S_SUCCESS)
907 goto out;
908 pci = (proto == SCARD_PROTOCOL_T0) ? SCARD_PCI_T0 : SCARD_PCI_T1;
909
910 buf_len = sizeof(buf);
911 if (SCardTransmit(card, pci, APDU_PIV_SELECT_AID, sizeof(APDU_PIV_SELECT_AID), NULL, buf,
912 &buf_len) != SCARD_S_SUCCESS)
913 goto out;
914 if ((buf[buf_len - 2] != 0x90 || buf[buf_len - 1] != 0) && buf[buf_len - 2] != 0x61)
915 goto out;
916
917 buf_len = sizeof(buf);
918 if (SCardTransmit(card, pci, APDU_PIV_GET_CHUID, sizeof(APDU_PIV_GET_CHUID), NULL, buf,
919 &buf_len) != SCARD_S_SUCCESS)
920 goto out;
921 if ((buf[buf_len - 2] != 0x90 || buf[buf_len - 1] != 0) && buf[buf_len - 2] != 0x61)
922 goto out;
923
924 /* Find the GUID field in the CHUID data object */
925 WinPrAsn1Decoder_InitMem(&dec, WINPR_ASN1_BER, buf, buf_len);
926 if (!WinPrAsn1DecReadTagAndLen(&dec, &tag, &len) || tag != 0x53)
927 goto out;
928 while (WinPrAsn1DecReadTagLenValue(&dec, &tag, &len, &dec2) && tag != 0x34)
929 ;
930 if (tag != 0x34 || len != 16)
931 goto out;
932
933 s = WinPrAsn1DecGetStream(&dec2);
934 p = Stream_Buffer(&s);
935
936 /* Construct the value Windows would use for a PIV key's container name */
937 (void)snprintf(container_name, PIV_CONTAINER_NAME_LEN + 1,
938 "%.2x%.2x%.2x%.2x-%.2x%.2x-%.2x%.2x-%.2x%.2x-%.2x%.2x%.2x%.2x%.2x%.2x", p[3],
939 p[2], p[1], p[0], p[5], p[4], p[7], p[6], p[8], p[9], p[10], p[11], p[12],
940 piv_tag[0], piv_tag[1], piv_tag[2]);
941
942 /* And convert it to UTF-16 */
943 union
944 {
945 WCHAR* wc;
946 BYTE* b;
947 } cnv;
948 cnv.b = output;
949 if (ConvertUtf8NToWChar(container_name, ARRAYSIZE(container_name), cnv.wc,
950 output_len / sizeof(WCHAR)) > 0)
951 ret = ERROR_SUCCESS;
952
953out:
954 free(reader);
955 if (card)
956 SCardDisconnect(card, SCARD_LEAVE_CARD);
957 if (context)
958 SCardReleaseContext(context);
959 return ret;
960}
961
962static SECURITY_STATUS check_for_piv_container_name(NCryptP11KeyHandle* key, BYTE* pbOutput,
963 DWORD cbOutput, DWORD* pcbResult, char* label,
964 size_t label_len)
965{
966 for (size_t i = 0; i < ARRAYSIZE(piv_cert_tags); i++)
967 {
968 const piv_cert_tags_t* cur = &piv_cert_tags[i];
969 if (strncmp(label, cur->label, label_len) == 0)
970 {
971 *pcbResult = (PIV_CONTAINER_NAME_LEN + 1) * sizeof(WCHAR);
972 if (!pbOutput)
973 return ERROR_SUCCESS;
974 else if (cbOutput < (PIV_CONTAINER_NAME_LEN + 1) * sizeof(WCHAR))
975 return NTE_NO_MEMORY;
976 else
977 return get_piv_container_name(key, cur->tag, pbOutput, cbOutput);
978 }
979 }
980 return NTE_NOT_FOUND;
981}
982
983static SECURITY_STATUS NCryptP11KeyGetProperties(NCryptP11KeyHandle* keyHandle,
984 NCryptKeyGetPropertyEnum property, PBYTE pbOutput,
985 DWORD cbOutput, DWORD* pcbResult,
986 WINPR_ATTR_UNUSED DWORD dwFlags)
987{
988 SECURITY_STATUS ret = NTE_FAIL;
989 CK_RV rv = 0;
990 CK_SESSION_HANDLE session = 0;
991 CK_OBJECT_HANDLE objectHandle = 0;
992 CK_ULONG objectCount = 0;
993 NCryptP11ProviderHandle* provider = NULL;
994 CK_OBJECT_CLASS oclass = CKO_CERTIFICATE;
995 CK_CERTIFICATE_TYPE ctype = CKC_X_509;
996 CK_ATTRIBUTE certificateFilter[] = { { CKA_CLASS, &oclass, sizeof(oclass) },
997 { CKA_CERTIFICATE_TYPE, &ctype, sizeof(ctype) },
998 { CKA_ID, keyHandle->keyCertId,
999 keyHandle->keyCertIdLen } };
1000 CK_ATTRIBUTE* objectFilter = certificateFilter;
1001 CK_ULONG objectFilterLen = ARRAYSIZE(certificateFilter);
1002
1003 WINPR_ASSERT(keyHandle);
1004 provider = keyHandle->provider;
1005 WINPR_ASSERT(provider);
1006
1007 switch (property)
1008
1009 {
1010 case NCRYPT_PROPERTY_CERTIFICATE:
1011 case NCRYPT_PROPERTY_NAME:
1012 break;
1013 case NCRYPT_PROPERTY_READER:
1014 {
1015 CK_SLOT_INFO slotInfo;
1016
1017 WINPR_ASSERT(provider->p11->C_GetSlotInfo);
1018 rv = provider->p11->C_GetSlotInfo(keyHandle->slotId, &slotInfo);
1019 if (rv != CKR_OK)
1020 return NTE_BAD_KEY;
1021
1022#define SLOT_DESC_SZ sizeof(slotInfo.slotDescription)
1023 fix_padded_string((char*)slotInfo.slotDescription, SLOT_DESC_SZ);
1024 const size_t len = 2ULL * (strnlen((char*)slotInfo.slotDescription, SLOT_DESC_SZ) + 1);
1025 if (len > UINT32_MAX)
1026 return NTE_BAD_DATA;
1027 *pcbResult = (UINT32)len;
1028 if (pbOutput)
1029 {
1030 union
1031 {
1032 WCHAR* wc;
1033 BYTE* b;
1034 } cnv;
1035 cnv.b = pbOutput;
1036 if (cbOutput < *pcbResult)
1037 return NTE_NO_MEMORY;
1038
1039 if (ConvertUtf8ToWChar((char*)slotInfo.slotDescription, cnv.wc,
1040 cbOutput / sizeof(WCHAR)) < 0)
1041 return NTE_NO_MEMORY;
1042 }
1043 return ERROR_SUCCESS;
1044 }
1045 case NCRYPT_PROPERTY_SLOTID:
1046 {
1047 *pcbResult = 4;
1048 if (pbOutput)
1049 {
1050 UINT32* ptr = (UINT32*)pbOutput;
1051
1052 if (cbOutput < 4)
1053 return NTE_NO_MEMORY;
1054 if (keyHandle->slotId > UINT32_MAX)
1055 {
1056 ret = NTE_BAD_DATA;
1057 goto out_final;
1058 }
1059 *ptr = (UINT32)keyHandle->slotId;
1060 }
1061 return ERROR_SUCCESS;
1062 }
1063 case NCRYPT_PROPERTY_UNKNOWN:
1064 default:
1065 return NTE_NOT_SUPPORTED;
1066 }
1067
1068 WINPR_ASSERT(provider->p11->C_OpenSession);
1069 rv = provider->p11->C_OpenSession(keyHandle->slotId, CKF_SERIAL_SESSION, NULL, NULL, &session);
1070 if (rv != CKR_OK)
1071 {
1072 WLog_ERR(TAG, "error opening session on slot %d", keyHandle->slotId);
1073 return NTE_FAIL;
1074 }
1075
1076 WINPR_ASSERT(provider->p11->C_FindObjectsInit);
1077 rv = provider->p11->C_FindObjectsInit(session, objectFilter, objectFilterLen);
1078 if (rv != CKR_OK)
1079 {
1080 WLog_ERR(TAG, "unable to initiate search for slot %d", keyHandle->slotId);
1081 goto out;
1082 }
1083
1084 WINPR_ASSERT(provider->p11->C_FindObjects);
1085 rv = provider->p11->C_FindObjects(session, &objectHandle, 1, &objectCount);
1086 if (rv != CKR_OK)
1087 {
1088 WLog_ERR(TAG, "unable to findObjects for slot %d", keyHandle->slotId);
1089 goto out_final;
1090 }
1091 if (!objectCount)
1092 {
1093 ret = NTE_NOT_FOUND;
1094 goto out_final;
1095 }
1096
1097 switch (property)
1098 {
1099 case NCRYPT_PROPERTY_CERTIFICATE:
1100 {
1101 CK_ATTRIBUTE certValue = { CKA_VALUE, pbOutput, cbOutput };
1102
1103 WINPR_ASSERT(provider->p11->C_GetAttributeValue);
1104 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &certValue, 1);
1105 if (rv != CKR_OK)
1106 {
1107 // TODO: do a kind of translation from CKR_* to NTE_*
1108 }
1109
1110 if (certValue.ulValueLen > UINT32_MAX)
1111 {
1112 ret = NTE_BAD_DATA;
1113 goto out_final;
1114 }
1115 *pcbResult = (UINT32)certValue.ulValueLen;
1116 ret = ERROR_SUCCESS;
1117 break;
1118 }
1119 case NCRYPT_PROPERTY_NAME:
1120 {
1121 CK_ATTRIBUTE attr = { CKA_LABEL, NULL, 0 };
1122 char* label = NULL;
1123
1124 WINPR_ASSERT(provider->p11->C_GetAttributeValue);
1125 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &attr, 1);
1126 if (rv == CKR_OK)
1127 {
1128 label = calloc(1, attr.ulValueLen);
1129 if (!label)
1130 {
1131 ret = NTE_NO_MEMORY;
1132 break;
1133 }
1134
1135 attr.pValue = label;
1136 rv = provider->p11->C_GetAttributeValue(session, objectHandle, &attr, 1);
1137 }
1138
1139 if (rv == CKR_OK)
1140 {
1141 /* Check if we have a PIV card */
1142 ret = check_for_piv_container_name(keyHandle, pbOutput, cbOutput, pcbResult, label,
1143 attr.ulValueLen);
1144
1145 /* Otherwise, at least for GIDS cards the label will be the correct value */
1146 if (ret == NTE_NOT_FOUND)
1147 {
1148 union
1149 {
1150 WCHAR* wc;
1151 BYTE* b;
1152 } cnv;
1153 const size_t olen = pbOutput ? cbOutput / sizeof(WCHAR) : 0;
1154 cnv.b = pbOutput;
1155 SSIZE_T size = ConvertUtf8NToWChar(label, attr.ulValueLen, cnv.wc, olen);
1156 if (size < 0)
1157 ret = ERROR_CONVERT_TO_LARGE;
1158 else
1159 ret = ERROR_SUCCESS;
1160 }
1161 }
1162
1163 free(label);
1164 break;
1165 }
1166 default:
1167 ret = NTE_NOT_SUPPORTED;
1168 break;
1169 }
1170
1171out_final:
1172 WINPR_ASSERT(provider->p11->C_FindObjectsFinal);
1173 rv = provider->p11->C_FindObjectsFinal(session);
1174 if (rv != CKR_OK)
1175 {
1176 WLog_ERR(TAG, "error in C_FindObjectsFinal() for slot %d", keyHandle->slotId);
1177 }
1178out:
1179 WINPR_ASSERT(provider->p11->C_CloseSession);
1180 rv = provider->p11->C_CloseSession(session);
1181 if (rv != CKR_OK)
1182 {
1183 WLog_ERR(TAG, "error in C_CloseSession() for slot %d", keyHandle->slotId);
1184 }
1185 return ret;
1186}
1187
1188static SECURITY_STATUS NCryptP11GetProperty(NCRYPT_HANDLE hObject, NCryptKeyGetPropertyEnum prop,
1189 PBYTE pbOutput, DWORD cbOutput, DWORD* pcbResult,
1190 DWORD dwFlags)
1191{
1192 NCryptBaseHandle* base = (NCryptBaseHandle*)hObject;
1193
1194 WINPR_ASSERT(base);
1195 switch (base->type)
1196 {
1197 case WINPR_NCRYPT_PROVIDER:
1198 return ERROR_CALL_NOT_IMPLEMENTED;
1199 case WINPR_NCRYPT_KEY:
1200 return NCryptP11KeyGetProperties((NCryptP11KeyHandle*)hObject, prop, pbOutput, cbOutput,
1201 pcbResult, dwFlags);
1202 default:
1203 return ERROR_INVALID_HANDLE;
1204 }
1205 return ERROR_SUCCESS;
1206}
1207
1208static SECURITY_STATUS NCryptP11OpenKey(NCRYPT_PROV_HANDLE hProvider, NCRYPT_KEY_HANDLE* phKey,
1209 LPCWSTR pszKeyName, WINPR_ATTR_UNUSED DWORD dwLegacyKeySpec,
1210 WINPR_ATTR_UNUSED DWORD dwFlags)
1211{
1212 SECURITY_STATUS ret = 0;
1213 CK_SLOT_ID slotId = 0;
1214 CK_BYTE keyCertId[64] = { 0 };
1215 CK_ULONG keyCertIdLen = 0;
1216 NCryptP11KeyHandle* keyHandle = NULL;
1217
1218 ret = parseKeyName(pszKeyName, &slotId, keyCertId, &keyCertIdLen);
1219 if (ret != ERROR_SUCCESS)
1220 return ret;
1221
1222 keyHandle = (NCryptP11KeyHandle*)ncrypt_new_handle(
1223 WINPR_NCRYPT_KEY, sizeof(*keyHandle), NCryptP11GetProperty, winpr_NCryptDefault_dtor);
1224 if (!keyHandle)
1225 return NTE_NO_MEMORY;
1226
1227 keyHandle->provider = (NCryptP11ProviderHandle*)hProvider;
1228 keyHandle->slotId = slotId;
1229 memcpy(keyHandle->keyCertId, keyCertId, sizeof(keyCertId));
1230 keyHandle->keyCertIdLen = keyCertIdLen;
1231 *phKey = (NCRYPT_KEY_HANDLE)keyHandle;
1232 return ERROR_SUCCESS;
1233}
1234
1235static SECURITY_STATUS initialize_pkcs11(HANDLE handle,
1236 CK_RV (*c_get_function_list)(CK_FUNCTION_LIST_PTR_PTR),
1237 NCRYPT_PROV_HANDLE* phProvider)
1238{
1239 SECURITY_STATUS status = ERROR_SUCCESS;
1240 NCryptP11ProviderHandle* ret = NULL;
1241 CK_RV rv = 0;
1242
1243 WINPR_ASSERT(c_get_function_list);
1244 WINPR_ASSERT(phProvider);
1245
1246 ret = (NCryptP11ProviderHandle*)ncrypt_new_handle(
1247 WINPR_NCRYPT_PROVIDER, sizeof(*ret), NCryptP11GetProperty, NCryptP11StorageProvider_dtor);
1248 if (!ret)
1249 return NTE_NO_MEMORY;
1250
1251 ret->library = handle;
1252 ret->baseProvider.enumKeysFn = NCryptP11EnumKeys;
1253 ret->baseProvider.openKeyFn = NCryptP11OpenKey;
1254
1255 rv = c_get_function_list(&ret->p11);
1256 if (rv != CKR_OK)
1257 {
1258 status = NTE_PROVIDER_DLL_FAIL;
1259 goto fail;
1260 }
1261
1262 WINPR_ASSERT(ret->p11);
1263 WINPR_ASSERT(ret->p11->C_Initialize);
1264 rv = ret->p11->C_Initialize(NULL);
1265 if (rv != CKR_OK)
1266 {
1267 status = NTE_PROVIDER_DLL_FAIL;
1268 goto fail;
1269 }
1270
1271 *phProvider = (NCRYPT_PROV_HANDLE)ret;
1272
1273fail:
1274 if (status != ERROR_SUCCESS)
1275 ret->baseProvider.baseHandle.releaseFn((NCRYPT_HANDLE)ret);
1276 return status;
1277}
1278
1279SECURITY_STATUS NCryptOpenP11StorageProviderEx(NCRYPT_PROV_HANDLE* phProvider,
1280 WINPR_ATTR_UNUSED LPCWSTR pszProviderName,
1281 WINPR_ATTR_UNUSED DWORD dwFlags, LPCSTR* modulePaths)
1282{
1283 SECURITY_STATUS status = ERROR_INVALID_PARAMETER;
1284 LPCSTR defaultPaths[] = { "p11-kit-proxy.so", "opensc-pkcs11.so", NULL };
1285
1286 if (!phProvider)
1287 return ERROR_INVALID_PARAMETER;
1288
1289 if (!modulePaths)
1290 modulePaths = defaultPaths;
1291
1292 while (*modulePaths)
1293 {
1294 const char* modulePath = *modulePaths++;
1295 HANDLE library = LoadLibrary(modulePath);
1296 typedef CK_RV (*c_get_function_list_t)(CK_FUNCTION_LIST_PTR_PTR);
1297 NCryptP11ProviderHandle* provider = NULL;
1298
1299 WLog_DBG(TAG, "Trying pkcs11 module '%s'", modulePath);
1300 if (!library)
1301 {
1302 status = NTE_PROV_DLL_NOT_FOUND;
1303 goto out_load_library;
1304 }
1305
1306 c_get_function_list_t c_get_function_list =
1307 GetProcAddressAs(library, "C_GetFunctionList", c_get_function_list_t);
1308
1309 if (!c_get_function_list)
1310 {
1311 status = NTE_PROV_TYPE_ENTRY_BAD;
1312 goto out_load_library;
1313 }
1314
1315 status = initialize_pkcs11(library, c_get_function_list, phProvider);
1316 if (status != ERROR_SUCCESS)
1317 {
1318 status = NTE_PROVIDER_DLL_FAIL;
1319 goto out_load_library;
1320 }
1321
1322 provider = (NCryptP11ProviderHandle*)*phProvider;
1323 provider->modulePath = _strdup(modulePath);
1324 if (!provider->modulePath)
1325 {
1326 status = NTE_NO_MEMORY;
1327 goto out_load_library;
1328 }
1329
1330 WLog_DBG(TAG, "module '%s' loaded", modulePath);
1331 return ERROR_SUCCESS;
1332
1333 out_load_library:
1334 if (library)
1335 FreeLibrary(library);
1336 }
1337
1338 return status;
1339}
1340
1341const char* NCryptGetModulePath(NCRYPT_PROV_HANDLE phProvider)
1342{
1343 NCryptP11ProviderHandle* provider = (NCryptP11ProviderHandle*)phProvider;
1344
1345 WINPR_ASSERT(provider);
1346
1347 return provider->modulePath;
1348}
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:148
SCARD_IO_REQUEST
Definition include/winpr/smartcard.h:262