1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
5 #include "ask-password-api.h"
9 #include "format-table.h"
11 #include "memory-util.h"
13 #include "openssl-util.h"
15 #include "pkcs11-util.h"
16 #include "random-util.h"
17 #include "string-util.h"
20 bool pkcs11_uri_valid(const char *uri
) {
23 /* A very superficial checker for RFC7512 PKCS#11 URI syntax */
28 p
= startswith(uri
, "pkcs11:");
35 if (!in_charset(p
, ALPHANUMERICAL
".~/-_?;&%="))
43 int uri_from_string(const char *p
, P11KitUri
**ret
) {
44 _cleanup_(p11_kit_uri_freep
) P11KitUri
*uri
= NULL
;
49 uri
= p11_kit_uri_new();
53 if (p11_kit_uri_parse(p
, P11_KIT_URI_FOR_ANY
, uri
) != P11_KIT_URI_OK
)
60 P11KitUri
*uri_from_module_info(const CK_INFO
*info
) {
65 uri
= p11_kit_uri_new();
69 *p11_kit_uri_get_module_info(uri
) = *info
;
73 P11KitUri
*uri_from_slot_info(const CK_SLOT_INFO
*slot_info
) {
78 uri
= p11_kit_uri_new();
82 *p11_kit_uri_get_slot_info(uri
) = *slot_info
;
86 P11KitUri
*uri_from_token_info(const CK_TOKEN_INFO
*token_info
) {
91 uri
= p11_kit_uri_new();
95 *p11_kit_uri_get_token_info(uri
) = *token_info
;
99 CK_RV
pkcs11_get_slot_list_malloc(
101 CK_SLOT_ID
**ret_slotids
,
102 CK_ULONG
*ret_n_slotids
) {
108 assert(ret_n_slotids
);
110 for (unsigned tries
= 0; tries
< 16; tries
++) {
111 _cleanup_free_ CK_SLOT_ID
*slotids
= NULL
;
112 CK_ULONG n_slotids
= 0;
114 rv
= m
->C_GetSlotList(0, NULL
, &n_slotids
);
117 if (n_slotids
== 0) {
123 slotids
= new(CK_SLOT_ID
, n_slotids
);
125 return CKR_HOST_MEMORY
;
127 rv
= m
->C_GetSlotList(0, slotids
, &n_slotids
);
129 *ret_slotids
= TAKE_PTR(slotids
);
130 *ret_n_slotids
= n_slotids
;
134 if (rv
!= CKR_BUFFER_TOO_SMALL
)
137 /* Hu? Maybe somebody plugged something in and things changed? Let's try again */
140 return CKR_BUFFER_TOO_SMALL
;
143 char *pkcs11_token_label(const CK_TOKEN_INFO
*token_info
) {
146 /* The label is not NUL terminated and likely padded with spaces, let's make a copy here, so that we
148 t
= strndup((char*) token_info
->label
, sizeof(token_info
->label
));
156 char *pkcs11_token_manufacturer_id(const CK_TOKEN_INFO
*token_info
) {
159 t
= strndup((char*) token_info
->manufacturerID
, sizeof(token_info
->manufacturerID
));
167 char *pkcs11_token_model(const CK_TOKEN_INFO
*token_info
) {
170 t
= strndup((char*) token_info
->model
, sizeof(token_info
->model
));
178 int pkcs11_token_login_by_pin(
180 CK_SESSION_HANDLE session
,
181 const CK_TOKEN_INFO
*token_info
,
182 const char *token_label
,
191 if (FLAGS_SET(token_info
->flags
, CKF_PROTECTED_AUTHENTICATION_PATH
)) {
192 rv
= m
->C_Login(session
, CKU_USER
, NULL
, 0);
194 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
195 "Failed to log into security token '%s': %s", token_label
, p11_kit_strerror(rv
));
197 log_info("Successfully logged into security token '%s' via protected authentication path.", token_label
);
201 if (!FLAGS_SET(token_info
->flags
, CKF_LOGIN_REQUIRED
)) {
202 log_info("No login into security token '%s' required.", token_label
);
209 rv
= m
->C_Login(session
, CKU_USER
, (CK_UTF8CHAR
*) pin
, pin_size
);
211 log_info("Successfully logged into security token '%s'.", token_label
);
215 if (rv
== CKR_PIN_LOCKED
)
216 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
217 "PIN has been locked, please reset PIN of security token '%s'.", token_label
);
218 if (!IN_SET(rv
, CKR_PIN_INCORRECT
, CKR_PIN_LEN_RANGE
))
219 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
220 "Failed to log into security token '%s': %s", token_label
, p11_kit_strerror(rv
));
222 return log_notice_errno(SYNTHETIC_ERRNO(ENOLCK
),
223 "PIN for token '%s' is incorrect, please try again.",
227 int pkcs11_token_login(
229 CK_SESSION_HANDLE session
,
231 const CK_TOKEN_INFO
*token_info
,
232 const char *friendly_name
,
233 const char *icon_name
,
234 const char *key_name
,
235 const char *credential_name
,
238 char **ret_used_pin
) {
240 _cleanup_free_
char *token_uri_string
= NULL
, *token_uri_escaped
= NULL
, *id
= NULL
, *token_label
= NULL
;
241 _cleanup_(p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
242 CK_TOKEN_INFO updated_token_info
;
249 token_label
= pkcs11_token_label(token_info
);
253 token_uri
= uri_from_token_info(token_info
);
257 uri_result
= p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
258 if (uri_result
!= P11_KIT_URI_OK
)
259 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", p11_kit_uri_message(uri_result
));
261 r
= pkcs11_token_login_by_pin(m
, session
, token_info
, token_label
, /* pin= */ NULL
, 0);
262 if (r
== 0 && ret_used_pin
)
263 *ret_used_pin
= NULL
;
265 if (r
!= -ENOANO
) /* pin required */
268 token_uri_escaped
= cescape(token_uri_string
);
269 if (!token_uri_escaped
)
272 id
= strjoin("pkcs11:", token_uri_escaped
);
276 for (unsigned tries
= 0; tries
< 3; tries
++) {
277 _cleanup_strv_free_erase_
char **passwords
= NULL
;
278 _cleanup_(erase_and_freep
) char *envpin
= NULL
;
280 r
= getenv_steal_erase("PIN", &envpin
);
282 return log_error_errno(r
, "Failed to acquire PIN from environment: %m");
284 passwords
= strv_new(envpin
);
289 return log_error_errno(SYNTHETIC_ERRNO(ENOPKG
), "PIN querying disabled via 'headless' option. Use the 'PIN' environment variable.");
291 _cleanup_free_
char *text
= NULL
;
293 if (FLAGS_SET(token_info
->flags
, CKF_USER_PIN_FINAL_TRY
))
295 "Please enter correct PIN for security token '%s' in order to unlock %s (final try):",
296 token_label
, friendly_name
);
297 else if (FLAGS_SET(token_info
->flags
, CKF_USER_PIN_COUNT_LOW
))
299 "PIN has been entered incorrectly previously, please enter correct PIN for security token '%s' in order to unlock %s:",
300 token_label
, friendly_name
);
303 "Please enter PIN for security token '%s' in order to unlock %s:",
304 token_label
, friendly_name
);
307 "Please enter PIN for security token '%s' in order to unlock %s (try #%u):",
308 token_label
, friendly_name
, tries
+1);
312 /* We never cache PINs, simply because it's fatal if we use wrong PINs, since usually there are only 3 tries */
313 r
= ask_password_auto(text
, icon_name
, id
, key_name
, credential_name
, until
, 0, &passwords
);
315 return log_error_errno(r
, "Failed to query PIN for security token '%s': %m", token_label
);
318 STRV_FOREACH(i
, passwords
) {
319 r
= pkcs11_token_login_by_pin(m
, session
, token_info
, token_label
, *i
, strlen(*i
));
320 if (r
== 0 && ret_used_pin
) {
333 /* Referesh the token info, so that we can prompt knowing the new flags if they changed. */
334 rv
= m
->C_GetTokenInfo(slotid
, &updated_token_info
);
336 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
337 "Failed to acquire updated security token information for slot %lu: %s",
338 slotid
, p11_kit_strerror(rv
));
340 token_info
= &updated_token_info
;
344 return log_error_errno(SYNTHETIC_ERRNO(EPERM
), "Too many attempts to log into token '%s'.", token_label
);
347 int pkcs11_token_find_x509_certificate(
349 CK_SESSION_HANDLE session
,
350 P11KitUri
*search_uri
,
351 CK_OBJECT_HANDLE
*ret_object
) {
353 bool found_class
= false, found_certificate_type
= false;
354 _cleanup_free_ CK_ATTRIBUTE
*attributes_buffer
= NULL
;
355 CK_ULONG n_attributes
, a
, n_objects
;
356 CK_ATTRIBUTE
*attributes
= NULL
;
357 CK_OBJECT_HANDLE objects
[2];
364 attributes
= p11_kit_uri_get_attributes(search_uri
, &n_attributes
);
365 for (a
= 0; a
< n_attributes
; a
++) {
367 /* We use the URI's included match attributes, but make them more strict. This allows users
368 * to specify a token URL instead of an object URL and the right thing should happen if
369 * there's only one suitable key on the token. */
371 switch (attributes
[a
].type
) {
376 if (attributes
[a
].ulValueLen
!= sizeof(c
))
377 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CLASS attribute size.");
379 memcpy(&c
, attributes
[a
].pValue
, sizeof(c
));
380 if (c
!= CKO_CERTIFICATE
)
381 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an X.509 certificate, refusing.");
387 case CKA_CERTIFICATE_TYPE
: {
388 CK_CERTIFICATE_TYPE t
;
390 if (attributes
[a
].ulValueLen
!= sizeof(t
))
391 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CERTIFICATE_TYPE attribute size.");
393 memcpy(&t
, attributes
[a
].pValue
, sizeof(t
));
395 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an X.509 certificate, refusing.");
397 found_certificate_type
= true;
402 if (!found_class
|| !found_certificate_type
) {
403 /* Hmm, let's slightly extend the attribute list we search for */
405 attributes_buffer
= new(CK_ATTRIBUTE
, n_attributes
+ !found_class
+ !found_certificate_type
);
406 if (!attributes_buffer
)
409 memcpy(attributes_buffer
, attributes
, sizeof(CK_ATTRIBUTE
) * n_attributes
);
412 static const CK_OBJECT_CLASS
class = CKO_CERTIFICATE
;
414 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
416 .pValue
= (CK_OBJECT_CLASS
*) &class,
417 .ulValueLen
= sizeof(class),
421 if (!found_certificate_type
) {
422 static const CK_CERTIFICATE_TYPE type
= CKC_X_509
;
424 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
425 .type
= CKA_CERTIFICATE_TYPE
,
426 .pValue
= (CK_CERTIFICATE_TYPE
*) &type
,
427 .ulValueLen
= sizeof(type
),
431 attributes
= attributes_buffer
;
434 rv
= m
->C_FindObjectsInit(session
, attributes
, n_attributes
);
436 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
437 "Failed to initialize object find call: %s", p11_kit_strerror(rv
));
439 rv
= m
->C_FindObjects(session
, objects
, ELEMENTSOF(objects
), &n_objects
);
440 rv2
= m
->C_FindObjectsFinal(session
);
442 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
443 "Failed to find objects: %s", p11_kit_strerror(rv
));
445 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
446 "Failed to finalize object find call: %s", p11_kit_strerror(rv
));
448 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
),
449 "Failed to find selected X509 certificate on token.");
451 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
452 "Configured URI matches multiple certificates, refusing.");
454 *ret_object
= objects
[0];
459 int pkcs11_token_read_x509_certificate(
461 CK_SESSION_HANDLE session
,
462 CK_OBJECT_HANDLE object
,
465 _cleanup_free_
void *buffer
= NULL
;
466 _cleanup_free_
char *t
= NULL
;
467 CK_ATTRIBUTE attribute
= {
471 _cleanup_(X509_freep
) X509
*x509
= NULL
;
472 X509_NAME
*name
= NULL
;
473 const unsigned char *p
;
475 rv
= m
->C_GetAttributeValue(session
, object
, &attribute
, 1);
477 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
478 "Failed to read X.509 certificate size off token: %s", p11_kit_strerror(rv
));
480 buffer
= malloc(attribute
.ulValueLen
);
484 attribute
.pValue
= buffer
;
486 rv
= m
->C_GetAttributeValue(session
, object
, &attribute
, 1);
488 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
489 "Failed to read X.509 certificate data off token: %s", p11_kit_strerror(rv
));
491 p
= attribute
.pValue
;
492 x509
= d2i_X509(NULL
, &p
, attribute
.ulValueLen
);
494 return log_error_errno(SYNTHETIC_ERRNO(EBADMSG
), "Failed parse X.509 certificate.");
496 name
= X509_get_subject_name(x509
);
498 return log_error_errno(SYNTHETIC_ERRNO(EBADMSG
), "Failed to acquire X.509 subject name.");
500 t
= X509_NAME_oneline(name
, NULL
, 0);
502 return log_error_errno(SYNTHETIC_ERRNO(EIO
), "Failed to format X.509 subject name as string.");
504 log_debug("Using X.509 certificate issued for '%s'.", t
);
506 *ret_cert
= TAKE_PTR(x509
);
511 int pkcs11_token_find_private_key(
513 CK_SESSION_HANDLE session
,
514 P11KitUri
*search_uri
,
515 CK_OBJECT_HANDLE
*ret_object
) {
517 bool found_decrypt
= false, found_class
= false, found_key_type
= false;
518 _cleanup_free_ CK_ATTRIBUTE
*attributes_buffer
= NULL
;
519 CK_ULONG n_attributes
, a
, n_objects
;
520 CK_ATTRIBUTE
*attributes
= NULL
;
521 CK_OBJECT_HANDLE objects
[2];
528 attributes
= p11_kit_uri_get_attributes(search_uri
, &n_attributes
);
529 for (a
= 0; a
< n_attributes
; a
++) {
531 /* We use the URI's included match attributes, but make them more strict. This allows users
532 * to specify a token URL instead of an object URL and the right thing should happen if
533 * there's only one suitable key on the token. */
535 switch (attributes
[a
].type
) {
540 if (attributes
[a
].ulValueLen
!= sizeof(c
))
541 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CLASS attribute size.");
543 memcpy(&c
, attributes
[a
].pValue
, sizeof(c
));
544 if (c
!= CKO_PRIVATE_KEY
)
545 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
546 "Selected PKCS#11 object is not a private key, refusing.");
555 if (attributes
[a
].ulValueLen
!= sizeof(b
))
556 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_DECRYPT attribute size.");
558 memcpy(&b
, attributes
[a
].pValue
, sizeof(b
));
560 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
561 "Selected PKCS#11 object is not suitable for decryption, refusing.");
563 found_decrypt
= true;
570 if (attributes
[a
].ulValueLen
!= sizeof(t
))
571 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_KEY_TYPE attribute size.");
573 memcpy(&t
, attributes
[a
].pValue
, sizeof(t
));
575 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an RSA key, refusing.");
577 found_key_type
= true;
582 if (!found_decrypt
|| !found_class
|| !found_key_type
) {
583 /* Hmm, let's slightly extend the attribute list we search for */
585 attributes_buffer
= new(CK_ATTRIBUTE
, n_attributes
+ !found_decrypt
+ !found_class
+ !found_key_type
);
586 if (!attributes_buffer
)
589 memcpy(attributes_buffer
, attributes
, sizeof(CK_ATTRIBUTE
) * n_attributes
);
591 if (!found_decrypt
) {
592 static const CK_BBOOL yes
= true;
594 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
596 .pValue
= (CK_BBOOL
*) &yes
,
597 .ulValueLen
= sizeof(yes
),
602 static const CK_OBJECT_CLASS
class = CKO_PRIVATE_KEY
;
604 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
606 .pValue
= (CK_OBJECT_CLASS
*) &class,
607 .ulValueLen
= sizeof(class),
611 if (!found_key_type
) {
612 static const CK_KEY_TYPE type
= CKK_RSA
;
614 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
615 .type
= CKA_KEY_TYPE
,
616 .pValue
= (CK_KEY_TYPE
*) &type
,
617 .ulValueLen
= sizeof(type
),
621 attributes
= attributes_buffer
;
624 rv
= m
->C_FindObjectsInit(session
, attributes
, n_attributes
);
626 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
627 "Failed to initialize object find call: %s", p11_kit_strerror(rv
));
629 rv
= m
->C_FindObjects(session
, objects
, ELEMENTSOF(objects
), &n_objects
);
630 rv2
= m
->C_FindObjectsFinal(session
);
632 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
633 "Failed to find objects: %s", p11_kit_strerror(rv
));
635 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
636 "Failed to finalize object find call: %s", p11_kit_strerror(rv
));
638 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
),
639 "Failed to find selected private key suitable for decryption on token.");
641 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
642 "Configured private key URI matches multiple keys, refusing.");
644 *ret_object
= objects
[0];
648 int pkcs11_token_decrypt_data(
650 CK_SESSION_HANDLE session
,
651 CK_OBJECT_HANDLE object
,
652 const void *encrypted_data
,
653 size_t encrypted_data_size
,
654 void **ret_decrypted_data
,
655 size_t *ret_decrypted_data_size
) {
657 static const CK_MECHANISM mechanism
= {
658 .mechanism
= CKM_RSA_PKCS
660 _cleanup_(erase_and_freep
) CK_BYTE
*dbuffer
= NULL
;
661 CK_ULONG dbuffer_size
= 0;
665 assert(encrypted_data
);
666 assert(encrypted_data_size
> 0);
667 assert(ret_decrypted_data
);
668 assert(ret_decrypted_data_size
);
670 rv
= m
->C_DecryptInit(session
, (CK_MECHANISM
*) &mechanism
, object
);
672 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
673 "Failed to initialize decryption on security token: %s", p11_kit_strerror(rv
));
675 dbuffer_size
= encrypted_data_size
; /* Start with something reasonable */
676 dbuffer
= malloc(dbuffer_size
);
680 rv
= m
->C_Decrypt(session
, (CK_BYTE
*) encrypted_data
, encrypted_data_size
, dbuffer
, &dbuffer_size
);
681 if (rv
== CKR_BUFFER_TOO_SMALL
) {
682 erase_and_free(dbuffer
);
684 dbuffer
= malloc(dbuffer_size
);
688 rv
= m
->C_Decrypt(session
, (CK_BYTE
*) encrypted_data
, encrypted_data_size
, dbuffer
, &dbuffer_size
);
691 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
692 "Failed to decrypt key on security token: %s", p11_kit_strerror(rv
));
694 log_info("Successfully decrypted key with security token.");
696 *ret_decrypted_data
= TAKE_PTR(dbuffer
);
697 *ret_decrypted_data_size
= dbuffer_size
;
701 int pkcs11_token_acquire_rng(
703 CK_SESSION_HANDLE session
) {
705 _cleanup_free_
void *buffer
= NULL
;
712 /* While we are at it, let's read some RNG data from the PKCS#11 token and pass it to the kernel
713 * random pool. This should be cheap if we are talking to the device already. Note that we don't
714 * credit any entropy, since we don't know about the quality of the pkcs#11 token's RNG. Why bother
715 * at all? There are two sides to the argument whether to generate private keys on tokens or on the
716 * host. By crediting some data from the token RNG to the host's pool we at least can say that any
717 * key generated from it is at least as good as both sources individually. */
719 rps
= random_pool_size();
721 buffer
= malloc(rps
);
725 rv
= m
->C_GenerateRandom(session
, buffer
, rps
);
727 return log_debug_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
728 "Failed to generate RNG data on security token: %s", p11_kit_strerror(rv
));
730 r
= random_write_entropy(-1, buffer
, rps
, false);
732 return log_debug_errno(r
, "Failed to write PKCS#11 acquired random data to /dev/urandom: %m");
734 log_debug("Successfully written %zu bytes random data acquired via PKCS#11 to kernel random pool.", rps
);
739 static int token_process(
742 const CK_SLOT_INFO
*slot_info
,
743 const CK_TOKEN_INFO
*token_info
,
744 P11KitUri
*search_uri
,
745 pkcs11_find_token_callback_t callback
,
748 _cleanup_free_
char *token_label
= NULL
;
749 CK_SESSION_HANDLE session
;
757 token_label
= pkcs11_token_label(token_info
);
761 rv
= m
->C_OpenSession(slotid
, CKF_SERIAL_SESSION
, NULL
, NULL
, &session
);
763 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
764 "Failed to create session for security token '%s': %s", token_label
, p11_kit_strerror(rv
));
767 r
= callback(m
, session
, slotid
, slot_info
, token_info
, search_uri
, userdata
);
769 r
= 1; /* if not callback was specified, just say we found what we were looking for */
771 rv
= m
->C_CloseSession(session
);
773 log_warning("Failed to close session on PKCS#11 token, ignoring: %s", p11_kit_strerror(rv
));
778 static int slot_process(
781 P11KitUri
*search_uri
,
782 pkcs11_find_token_callback_t callback
,
785 _cleanup_(p11_kit_uri_freep
) P11KitUri
* slot_uri
= NULL
, *token_uri
= NULL
;
786 _cleanup_free_
char *token_uri_string
= NULL
;
787 CK_TOKEN_INFO token_info
;
788 CK_SLOT_INFO slot_info
;
794 /* We return -EAGAIN for all failures we can attribute to a specific slot in some way, so that the
795 * caller might try other slots before giving up. */
797 rv
= m
->C_GetSlotInfo(slotid
, &slot_info
);
799 log_warning("Failed to acquire slot info for slot %lu, ignoring slot: %s", slotid
, p11_kit_strerror(rv
));
803 slot_uri
= uri_from_slot_info(&slot_info
);
808 _cleanup_free_
char *slot_uri_string
= NULL
;
810 uri_result
= p11_kit_uri_format(slot_uri
, P11_KIT_URI_FOR_ANY
, &slot_uri_string
);
811 if (uri_result
!= P11_KIT_URI_OK
) {
812 log_warning("Failed to format slot URI, ignoring slot: %s", p11_kit_uri_message(uri_result
));
816 log_debug("Found slot with URI %s", slot_uri_string
);
819 rv
= m
->C_GetTokenInfo(slotid
, &token_info
);
820 if (rv
== CKR_TOKEN_NOT_PRESENT
) {
821 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
822 "Token not present in slot, ignoring.");
823 } else if (rv
!= CKR_OK
) {
824 log_warning("Failed to acquire token info for slot %lu, ignoring slot: %s", slotid
, p11_kit_strerror(rv
));
828 token_uri
= uri_from_token_info(&token_info
);
832 uri_result
= p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
833 if (uri_result
!= P11_KIT_URI_OK
) {
834 log_warning("Failed to format slot URI: %s", p11_kit_uri_message(uri_result
));
838 if (search_uri
&& !p11_kit_uri_match_token_info(search_uri
, &token_info
))
839 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
840 "Found non-matching token with URI %s.",
843 log_debug("Found matching token with URI %s.", token_uri_string
);
845 return token_process(
855 static int module_process(
857 P11KitUri
*search_uri
,
858 pkcs11_find_token_callback_t callback
,
861 _cleanup_free_
char *name
= NULL
, *module_uri_string
= NULL
;
862 _cleanup_(p11_kit_uri_freep
) P11KitUri
* module_uri
= NULL
;
863 _cleanup_free_ CK_SLOT_ID
*slotids
= NULL
;
864 CK_ULONG n_slotids
= 0;
873 /* We ignore most errors from modules here, in order to skip over faulty modules: one faulty module
874 * should not have the effect that we don't try the others anymore. We indicate such per-module
875 * failures with -EAGAIN, which let's the caller try the next module. */
877 name
= p11_kit_module_get_name(m
);
881 log_debug("Trying PKCS#11 module %s.", name
);
883 rv
= m
->C_GetInfo(&info
);
885 log_warning("Failed to get info on PKCS#11 module, ignoring module: %s", p11_kit_strerror(rv
));
889 module_uri
= uri_from_module_info(&info
);
893 uri_result
= p11_kit_uri_format(module_uri
, P11_KIT_URI_FOR_ANY
, &module_uri_string
);
894 if (uri_result
!= P11_KIT_URI_OK
) {
895 log_warning("Failed to format module URI, ignoring module: %s", p11_kit_uri_message(uri_result
));
899 log_debug("Found module with URI %s", module_uri_string
);
901 rv
= pkcs11_get_slot_list_malloc(m
, &slotids
, &n_slotids
);
903 log_warning("Failed to get slot list, ignoring module: %s", p11_kit_strerror(rv
));
907 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
908 "This module has no slots? Ignoring module.");
910 for (k
= 0; k
< n_slotids
; k
++) {
924 int pkcs11_find_token(
925 const char *pkcs11_uri
,
926 pkcs11_find_token_callback_t callback
,
929 _cleanup_(p11_kit_modules_finalize_and_releasep
) CK_FUNCTION_LIST
**modules
= NULL
;
930 _cleanup_(p11_kit_uri_freep
) P11KitUri
*search_uri
= NULL
;
933 /* Execute the specified callback for each matching token found. If nothing is found returns
934 * -EAGAIN. Logs about all errors, except for EAGAIN, which the caller has to log about. */
937 r
= uri_from_string(pkcs11_uri
, &search_uri
);
939 return log_error_errno(r
, "Failed to parse PKCS#11 URI '%s': %m", pkcs11_uri
);
942 modules
= p11_kit_modules_load_and_initialize(0);
944 return log_error_errno(SYNTHETIC_ERRNO(EIO
), "Failed to initialize pkcs11 modules");
946 for (CK_FUNCTION_LIST
**i
= modules
; *i
; i
++) {
960 struct pkcs11_acquire_certificate_callback_data
{
963 const char *askpw_friendly_name
, *askpw_icon_name
;
966 static void pkcs11_acquire_certificate_callback_data_release(struct pkcs11_acquire_certificate_callback_data
*data
) {
967 erase_and_free(data
->pin_used
);
968 X509_free(data
->cert
);
971 static int pkcs11_acquire_certificate_callback(
973 CK_SESSION_HANDLE session
,
975 const CK_SLOT_INFO
*slot_info
,
976 const CK_TOKEN_INFO
*token_info
,
980 _cleanup_(erase_and_freep
) char *pin_used
= NULL
;
981 struct pkcs11_acquire_certificate_callback_data
*data
= ASSERT_PTR(userdata
);
982 CK_OBJECT_HANDLE object
;
990 /* Called for every token matching our URI */
992 r
= pkcs11_token_login(m
, session
, slot_id
, token_info
, data
->askpw_friendly_name
, data
->askpw_icon_name
, "pkcs11-pin", "pkcs11-pin", UINT64_MAX
, false, &pin_used
);
996 r
= pkcs11_token_find_x509_certificate(m
, session
, uri
, &object
);
1000 r
= pkcs11_token_read_x509_certificate(m
, session
, object
, &data
->cert
);
1004 /* Let's read some random data off the token and write it to the kernel pool before we generate our
1005 * random key from it. This way we can claim the quality of the RNG is at least as good as the
1006 * kernel's and the token's pool */
1007 (void) pkcs11_token_acquire_rng(m
, session
);
1009 data
->pin_used
= TAKE_PTR(pin_used
);
1013 int pkcs11_acquire_certificate(
1015 const char *askpw_friendly_name
,
1016 const char *askpw_icon_name
,
1018 char **ret_pin_used
) {
1020 _cleanup_(pkcs11_acquire_certificate_callback_data_release
) struct pkcs11_acquire_certificate_callback_data data
= {
1021 .askpw_friendly_name
= askpw_friendly_name
,
1022 .askpw_icon_name
= askpw_icon_name
,
1029 r
= pkcs11_find_token(uri
, pkcs11_acquire_certificate_callback
, &data
);
1030 if (r
== -EAGAIN
) /* pkcs11_find_token() doesn't log about this error, but all others */
1031 return log_error_errno(SYNTHETIC_ERRNO(ENXIO
),
1032 "Specified PKCS#11 token with URI '%s' not found.",
1037 *ret_cert
= TAKE_PTR(data
.cert
);
1040 *ret_pin_used
= TAKE_PTR(data
.pin_used
);
1046 static int list_callback(
1047 CK_FUNCTION_LIST
*m
,
1048 CK_SESSION_HANDLE session
,
1050 const CK_SLOT_INFO
*slot_info
,
1051 const CK_TOKEN_INFO
*token_info
,
1055 _cleanup_free_
char *token_uri_string
= NULL
, *token_label
= NULL
, *token_manufacturer_id
= NULL
, *token_model
= NULL
;
1056 _cleanup_(p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
1057 Table
*t
= userdata
;
1063 /* We only care about hardware devices here with a token inserted. Let's filter everything else
1064 * out. (Note that the user can explicitly specify non-hardware tokens if they like, but during
1065 * enumeration we'll filter those, since software tokens are typically the system certificate store
1066 * and such, and it's typically not what people want to bind their home directories to.) */
1067 if (!FLAGS_SET(token_info
->flags
, CKF_HW_SLOT
|CKF_TOKEN_PRESENT
))
1070 token_label
= pkcs11_token_label(token_info
);
1074 token_manufacturer_id
= pkcs11_token_manufacturer_id(token_info
);
1075 if (!token_manufacturer_id
)
1078 token_model
= pkcs11_token_model(token_info
);
1082 token_uri
= uri_from_token_info(token_info
);
1086 uri_result
= p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
1087 if (uri_result
!= P11_KIT_URI_OK
)
1088 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", p11_kit_uri_message(uri_result
));
1092 TABLE_STRING
, token_uri_string
,
1093 TABLE_STRING
, token_label
,
1094 TABLE_STRING
, token_manufacturer_id
,
1095 TABLE_STRING
, token_model
);
1097 return table_log_add_error(r
);
1099 return -EAGAIN
; /* keep scanning */
1103 int pkcs11_list_tokens(void) {
1105 _cleanup_(table_unrefp
) Table
*t
= NULL
;
1108 t
= table_new("uri", "label", "manufacturer", "model");
1112 r
= pkcs11_find_token(NULL
, list_callback
, t
);
1113 if (r
< 0 && r
!= -EAGAIN
)
1116 if (table_get_rows(t
) <= 1) {
1117 log_info("No suitable PKCS#11 tokens found.");
1121 r
= table_print(t
, stdout
);
1123 return log_error_errno(r
, "Failed to show device table: %m");
1127 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1128 "PKCS#11 tokens not supported on this build.");
1133 static int auto_callback(
1134 CK_FUNCTION_LIST
*m
,
1135 CK_SESSION_HANDLE session
,
1137 const CK_SLOT_INFO
*slot_info
,
1138 const CK_TOKEN_INFO
*token_info
,
1142 _cleanup_(p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
1143 char **t
= userdata
;
1149 if (!FLAGS_SET(token_info
->flags
, CKF_HW_SLOT
|CKF_TOKEN_PRESENT
))
1153 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
1154 "More than one suitable PKCS#11 token found.");
1156 token_uri
= uri_from_token_info(token_info
);
1160 uri_result
= p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, t
);
1161 if (uri_result
!= P11_KIT_URI_OK
)
1162 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", p11_kit_uri_message(uri_result
));
1168 int pkcs11_find_token_auto(char **ret
) {
1172 r
= pkcs11_find_token(NULL
, auto_callback
, ret
);
1174 return log_error_errno(SYNTHETIC_ERRNO(ENODEV
), "No suitable PKCS#11 tokens found.");
1180 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1181 "PKCS#11 tokens not supported on this build.");
1186 void pkcs11_crypt_device_callback_data_release(pkcs11_crypt_device_callback_data
*data
) {
1187 erase_and_free(data
->decrypted_key
);
1189 if (data
->free_encrypted_key
)
1190 free(data
->encrypted_key
);
1193 int pkcs11_crypt_device_callback(
1194 CK_FUNCTION_LIST
*m
,
1195 CK_SESSION_HANDLE session
,
1197 const CK_SLOT_INFO
*slot_info
,
1198 const CK_TOKEN_INFO
*token_info
,
1202 pkcs11_crypt_device_callback_data
*data
= ASSERT_PTR(userdata
);
1203 CK_OBJECT_HANDLE object
;
1211 /* Called for every token matching our URI */
1213 r
= pkcs11_token_login(
1218 data
->friendly_name
,
1221 "cryptsetup.pkcs11-pin",
1228 /* We are likely called during early boot, where entropy is scarce. Mix some data from the PKCS#11
1229 * token, if it supports that. It should be cheap, given that we already are talking to it anyway and
1230 * shouldn't hurt. */
1231 (void) pkcs11_token_acquire_rng(m
, session
);
1233 r
= pkcs11_token_find_private_key(m
, session
, uri
, &object
);
1237 r
= pkcs11_token_decrypt_data(
1241 data
->encrypted_key
,
1242 data
->encrypted_key_size
,
1243 &data
->decrypted_key
,
1244 &data
->decrypted_key_size
);