1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
5 #include "ask-password-api.h"
6 #include "dlfcn-util.h"
10 #include "format-table.h"
12 #include "memory-util.h"
14 #include "openssl-util.h"
16 #include "pkcs11-util.h"
17 #include "random-util.h"
18 #include "string-util.h"
21 bool pkcs11_uri_valid(const char *uri
) {
24 /* A very superficial checker for RFC7512 PKCS#11 URI syntax */
29 p
= startswith(uri
, "pkcs11:");
36 if (!in_charset(p
, ALPHANUMERICAL
".~/-_?;&%="))
44 static void *p11kit_dl
= NULL
;
46 char *(*sym_p11_kit_module_get_name
)(CK_FUNCTION_LIST
*module
);
47 void (*sym_p11_kit_modules_finalize_and_release
)(CK_FUNCTION_LIST
**modules
);
48 CK_FUNCTION_LIST
**(*sym_p11_kit_modules_load_and_initialize
)(int flags
);
49 const char *(*sym_p11_kit_strerror
)(CK_RV rv
);
50 int (*sym_p11_kit_uri_format
)(P11KitUri
*uri
, P11KitUriType uri_type
, char **string
);
51 void (*sym_p11_kit_uri_free
)(P11KitUri
*uri
);
52 CK_ATTRIBUTE_PTR (*sym_p11_kit_uri_get_attributes
)(P11KitUri
*uri
, CK_ULONG
*n_attrs
);
53 CK_INFO_PTR (*sym_p11_kit_uri_get_module_info
)(P11KitUri
*uri
);
54 CK_SLOT_INFO_PTR (*sym_p11_kit_uri_get_slot_info
)(P11KitUri
*uri
);
55 CK_TOKEN_INFO_PTR (*sym_p11_kit_uri_get_token_info
)(P11KitUri
*uri
);
56 int (*sym_p11_kit_uri_match_token_info
)(const P11KitUri
*uri
, const CK_TOKEN_INFO
*token_info
);
57 const char *(*sym_p11_kit_uri_message
)(int code
);
58 P11KitUri
*(*sym_p11_kit_uri_new
)(void);
59 int (*sym_p11_kit_uri_parse
)(const char *string
, P11KitUriType uri_type
, P11KitUri
*uri
);
61 int dlopen_p11kit(void) {
62 return dlopen_many_sym_or_warn(
64 "libp11-kit.so.0", LOG_DEBUG
,
65 DLSYM_ARG(p11_kit_module_get_name
),
66 DLSYM_ARG(p11_kit_modules_finalize_and_release
),
67 DLSYM_ARG(p11_kit_modules_load_and_initialize
),
68 DLSYM_ARG(p11_kit_strerror
),
69 DLSYM_ARG(p11_kit_uri_format
),
70 DLSYM_ARG(p11_kit_uri_free
),
71 DLSYM_ARG(p11_kit_uri_get_attributes
),
72 DLSYM_ARG(p11_kit_uri_get_module_info
),
73 DLSYM_ARG(p11_kit_uri_get_slot_info
),
74 DLSYM_ARG(p11_kit_uri_get_token_info
),
75 DLSYM_ARG(p11_kit_uri_match_token_info
),
76 DLSYM_ARG(p11_kit_uri_message
),
77 DLSYM_ARG(p11_kit_uri_new
),
78 DLSYM_ARG(p11_kit_uri_parse
));
81 int uri_from_string(const char *p
, P11KitUri
**ret
) {
82 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
*uri
= NULL
;
92 uri
= sym_p11_kit_uri_new();
96 if (sym_p11_kit_uri_parse(p
, P11_KIT_URI_FOR_ANY
, uri
) != P11_KIT_URI_OK
)
103 P11KitUri
*uri_from_module_info(const CK_INFO
*info
) {
108 if (dlopen_p11kit() < 0)
111 uri
= sym_p11_kit_uri_new();
115 *sym_p11_kit_uri_get_module_info(uri
) = *info
;
119 P11KitUri
*uri_from_slot_info(const CK_SLOT_INFO
*slot_info
) {
124 if (dlopen_p11kit() < 0)
127 uri
= sym_p11_kit_uri_new();
131 *sym_p11_kit_uri_get_slot_info(uri
) = *slot_info
;
135 P11KitUri
*uri_from_token_info(const CK_TOKEN_INFO
*token_info
) {
140 if (dlopen_p11kit() < 0)
143 uri
= sym_p11_kit_uri_new();
147 *sym_p11_kit_uri_get_token_info(uri
) = *token_info
;
151 CK_RV
pkcs11_get_slot_list_malloc(
153 CK_SLOT_ID
**ret_slotids
,
154 CK_ULONG
*ret_n_slotids
) {
160 assert(ret_n_slotids
);
162 for (unsigned tries
= 0; tries
< 16; tries
++) {
163 _cleanup_free_ CK_SLOT_ID
*slotids
= NULL
;
164 CK_ULONG n_slotids
= 0;
166 rv
= m
->C_GetSlotList(0, NULL
, &n_slotids
);
169 if (n_slotids
== 0) {
175 slotids
= new(CK_SLOT_ID
, n_slotids
);
177 return CKR_HOST_MEMORY
;
179 rv
= m
->C_GetSlotList(0, slotids
, &n_slotids
);
181 *ret_slotids
= TAKE_PTR(slotids
);
182 *ret_n_slotids
= n_slotids
;
186 if (rv
!= CKR_BUFFER_TOO_SMALL
)
189 /* Hu? Maybe somebody plugged something in and things changed? Let's try again */
192 return CKR_BUFFER_TOO_SMALL
;
195 char *pkcs11_token_label(const CK_TOKEN_INFO
*token_info
) {
198 /* The label is not NUL terminated and likely padded with spaces, let's make a copy here, so that we
200 t
= strndup((char*) token_info
->label
, sizeof(token_info
->label
));
208 char *pkcs11_token_manufacturer_id(const CK_TOKEN_INFO
*token_info
) {
211 t
= strndup((char*) token_info
->manufacturerID
, sizeof(token_info
->manufacturerID
));
219 char *pkcs11_token_model(const CK_TOKEN_INFO
*token_info
) {
222 t
= strndup((char*) token_info
->model
, sizeof(token_info
->model
));
230 int pkcs11_token_login_by_pin(
232 CK_SESSION_HANDLE session
,
233 const CK_TOKEN_INFO
*token_info
,
234 const char *token_label
,
248 if (FLAGS_SET(token_info
->flags
, CKF_PROTECTED_AUTHENTICATION_PATH
)) {
249 rv
= m
->C_Login(session
, CKU_USER
, NULL
, 0);
251 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
252 "Failed to log into security token '%s': %s", token_label
, sym_p11_kit_strerror(rv
));
254 log_info("Successfully logged into security token '%s' via protected authentication path.", token_label
);
258 if (!FLAGS_SET(token_info
->flags
, CKF_LOGIN_REQUIRED
)) {
259 log_info("No login into security token '%s' required.", token_label
);
266 rv
= m
->C_Login(session
, CKU_USER
, (CK_UTF8CHAR
*) pin
, pin_size
);
268 log_info("Successfully logged into security token '%s'.", token_label
);
272 if (rv
== CKR_PIN_LOCKED
)
273 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
274 "PIN has been locked, please reset PIN of security token '%s'.", token_label
);
275 if (!IN_SET(rv
, CKR_PIN_INCORRECT
, CKR_PIN_LEN_RANGE
))
276 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
277 "Failed to log into security token '%s': %s", token_label
, sym_p11_kit_strerror(rv
));
279 return log_notice_errno(SYNTHETIC_ERRNO(ENOLCK
),
280 "PIN for token '%s' is incorrect, please try again.",
284 int pkcs11_token_login(
286 CK_SESSION_HANDLE session
,
288 const CK_TOKEN_INFO
*token_info
,
289 const char *friendly_name
,
290 const char *icon_name
,
291 const char *key_name
,
292 const char *credential_name
,
295 char **ret_used_pin
) {
297 _cleanup_free_
char *token_uri_string
= NULL
, *token_uri_escaped
= NULL
, *id
= NULL
, *token_label
= NULL
;
298 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
299 CK_TOKEN_INFO updated_token_info
;
310 token_label
= pkcs11_token_label(token_info
);
314 token_uri
= uri_from_token_info(token_info
);
318 uri_result
= sym_p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
319 if (uri_result
!= P11_KIT_URI_OK
)
320 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", sym_p11_kit_uri_message(uri_result
));
322 r
= pkcs11_token_login_by_pin(m
, session
, token_info
, token_label
, /* pin= */ NULL
, 0);
323 if (r
== 0 && ret_used_pin
)
324 *ret_used_pin
= NULL
;
326 if (r
!= -ENOANO
) /* pin required */
329 token_uri_escaped
= cescape(token_uri_string
);
330 if (!token_uri_escaped
)
333 id
= strjoin("pkcs11:", token_uri_escaped
);
337 for (unsigned tries
= 0; tries
< 3; tries
++) {
338 _cleanup_strv_free_erase_
char **passwords
= NULL
;
339 _cleanup_(erase_and_freep
) char *envpin
= NULL
;
341 r
= getenv_steal_erase("PIN", &envpin
);
343 return log_error_errno(r
, "Failed to acquire PIN from environment: %m");
345 passwords
= strv_new(envpin
);
350 return log_error_errno(SYNTHETIC_ERRNO(ENOPKG
), "PIN querying disabled via 'headless' option. Use the 'PIN' environment variable.");
352 _cleanup_free_
char *text
= NULL
;
354 if (FLAGS_SET(token_info
->flags
, CKF_USER_PIN_FINAL_TRY
))
356 "Please enter correct PIN for security token '%s' in order to unlock %s (final try):",
357 token_label
, friendly_name
);
358 else if (FLAGS_SET(token_info
->flags
, CKF_USER_PIN_COUNT_LOW
))
360 "PIN has been entered incorrectly previously, please enter correct PIN for security token '%s' in order to unlock %s:",
361 token_label
, friendly_name
);
364 "Please enter PIN for security token '%s' in order to unlock %s:",
365 token_label
, friendly_name
);
368 "Please enter PIN for security token '%s' in order to unlock %s (try #%u):",
369 token_label
, friendly_name
, tries
+1);
373 /* We never cache PINs, simply because it's fatal if we use wrong PINs, since usually there are only 3 tries */
374 r
= ask_password_auto(text
, icon_name
, id
, key_name
, credential_name
, until
, 0, &passwords
);
376 return log_error_errno(r
, "Failed to query PIN for security token '%s': %m", token_label
);
379 STRV_FOREACH(i
, passwords
) {
380 r
= pkcs11_token_login_by_pin(m
, session
, token_info
, token_label
, *i
, strlen(*i
));
381 if (r
== 0 && ret_used_pin
) {
394 /* Refresh the token info, so that we can prompt knowing the new flags if they changed. */
395 rv
= m
->C_GetTokenInfo(slotid
, &updated_token_info
);
397 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
398 "Failed to acquire updated security token information for slot %lu: %s",
399 slotid
, sym_p11_kit_strerror(rv
));
401 token_info
= &updated_token_info
;
405 return log_error_errno(SYNTHETIC_ERRNO(EPERM
), "Too many attempts to log into token '%s'.", token_label
);
408 int pkcs11_token_find_x509_certificate(
410 CK_SESSION_HANDLE session
,
411 P11KitUri
*search_uri
,
412 CK_OBJECT_HANDLE
*ret_object
) {
414 bool found_class
= false, found_certificate_type
= false;
415 _cleanup_free_ CK_ATTRIBUTE
*attributes_buffer
= NULL
;
416 CK_ULONG n_attributes
, a
, n_objects
;
417 CK_ATTRIBUTE
*attributes
= NULL
;
418 CK_OBJECT_HANDLE objects
[2];
430 attributes
= sym_p11_kit_uri_get_attributes(search_uri
, &n_attributes
);
431 for (a
= 0; a
< n_attributes
; a
++) {
433 /* We use the URI's included match attributes, but make them more strict. This allows users
434 * to specify a token URL instead of an object URL and the right thing should happen if
435 * there's only one suitable key on the token. */
437 switch (attributes
[a
].type
) {
442 if (attributes
[a
].ulValueLen
!= sizeof(c
))
443 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CLASS attribute size.");
445 memcpy(&c
, attributes
[a
].pValue
, sizeof(c
));
446 if (c
!= CKO_CERTIFICATE
)
447 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an X.509 certificate, refusing.");
453 case CKA_CERTIFICATE_TYPE
: {
454 CK_CERTIFICATE_TYPE t
;
456 if (attributes
[a
].ulValueLen
!= sizeof(t
))
457 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CERTIFICATE_TYPE attribute size.");
459 memcpy(&t
, attributes
[a
].pValue
, sizeof(t
));
461 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an X.509 certificate, refusing.");
463 found_certificate_type
= true;
468 if (!found_class
|| !found_certificate_type
) {
469 /* Hmm, let's slightly extend the attribute list we search for */
471 attributes_buffer
= new(CK_ATTRIBUTE
, n_attributes
+ !found_class
+ !found_certificate_type
);
472 if (!attributes_buffer
)
475 memcpy(attributes_buffer
, attributes
, sizeof(CK_ATTRIBUTE
) * n_attributes
);
478 static const CK_OBJECT_CLASS
class = CKO_CERTIFICATE
;
480 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
482 .pValue
= (CK_OBJECT_CLASS
*) &class,
483 .ulValueLen
= sizeof(class),
487 if (!found_certificate_type
) {
488 static const CK_CERTIFICATE_TYPE type
= CKC_X_509
;
490 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
491 .type
= CKA_CERTIFICATE_TYPE
,
492 .pValue
= (CK_CERTIFICATE_TYPE
*) &type
,
493 .ulValueLen
= sizeof(type
),
497 attributes
= attributes_buffer
;
500 rv
= m
->C_FindObjectsInit(session
, attributes
, n_attributes
);
502 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
503 "Failed to initialize object find call: %s", sym_p11_kit_strerror(rv
));
505 rv
= m
->C_FindObjects(session
, objects
, ELEMENTSOF(objects
), &n_objects
);
506 rv2
= m
->C_FindObjectsFinal(session
);
508 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
509 "Failed to find objects: %s", sym_p11_kit_strerror(rv
));
511 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
512 "Failed to finalize object find call: %s", sym_p11_kit_strerror(rv
));
514 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
),
515 "Failed to find selected X509 certificate on token.");
517 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
518 "Configured URI matches multiple certificates, refusing.");
520 *ret_object
= objects
[0];
525 int pkcs11_token_read_x509_certificate(
527 CK_SESSION_HANDLE session
,
528 CK_OBJECT_HANDLE object
,
531 _cleanup_free_
void *buffer
= NULL
;
532 _cleanup_free_
char *t
= NULL
;
533 CK_ATTRIBUTE attribute
= {
537 _cleanup_(X509_freep
) X509
*x509
= NULL
;
538 X509_NAME
*name
= NULL
;
539 const unsigned char *p
;
546 rv
= m
->C_GetAttributeValue(session
, object
, &attribute
, 1);
548 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
549 "Failed to read X.509 certificate size off token: %s", sym_p11_kit_strerror(rv
));
551 buffer
= malloc(attribute
.ulValueLen
);
555 attribute
.pValue
= buffer
;
557 rv
= m
->C_GetAttributeValue(session
, object
, &attribute
, 1);
559 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
560 "Failed to read X.509 certificate data off token: %s", sym_p11_kit_strerror(rv
));
562 p
= attribute
.pValue
;
563 x509
= d2i_X509(NULL
, &p
, attribute
.ulValueLen
);
565 return log_error_errno(SYNTHETIC_ERRNO(EBADMSG
), "Failed parse X.509 certificate.");
567 name
= X509_get_subject_name(x509
);
569 return log_error_errno(SYNTHETIC_ERRNO(EBADMSG
), "Failed to acquire X.509 subject name.");
571 t
= X509_NAME_oneline(name
, NULL
, 0);
573 return log_error_errno(SYNTHETIC_ERRNO(EIO
), "Failed to format X.509 subject name as string.");
575 log_debug("Using X.509 certificate issued for '%s'.", t
);
577 *ret_cert
= TAKE_PTR(x509
);
582 int pkcs11_token_find_private_key(
584 CK_SESSION_HANDLE session
,
585 P11KitUri
*search_uri
,
586 CK_OBJECT_HANDLE
*ret_object
) {
588 bool found_decrypt
= false, found_class
= false, found_key_type
= false;
589 _cleanup_free_ CK_ATTRIBUTE
*attributes_buffer
= NULL
;
590 CK_ULONG n_attributes
, a
, n_objects
;
591 CK_ATTRIBUTE
*attributes
= NULL
;
592 CK_OBJECT_HANDLE objects
[2];
604 attributes
= sym_p11_kit_uri_get_attributes(search_uri
, &n_attributes
);
605 for (a
= 0; a
< n_attributes
; a
++) {
607 /* We use the URI's included match attributes, but make them more strict. This allows users
608 * to specify a token URL instead of an object URL and the right thing should happen if
609 * there's only one suitable key on the token. */
611 switch (attributes
[a
].type
) {
616 if (attributes
[a
].ulValueLen
!= sizeof(c
))
617 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_CLASS attribute size.");
619 memcpy(&c
, attributes
[a
].pValue
, sizeof(c
));
620 if (c
!= CKO_PRIVATE_KEY
)
621 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
622 "Selected PKCS#11 object is not a private key, refusing.");
631 if (attributes
[a
].ulValueLen
!= sizeof(b
))
632 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_DECRYPT attribute size.");
634 memcpy(&b
, attributes
[a
].pValue
, sizeof(b
));
636 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
637 "Selected PKCS#11 object is not suitable for decryption, refusing.");
639 found_decrypt
= true;
646 if (attributes
[a
].ulValueLen
!= sizeof(t
))
647 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Invalid PKCS#11 CKA_KEY_TYPE attribute size.");
649 memcpy(&t
, attributes
[a
].pValue
, sizeof(t
));
651 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Selected PKCS#11 object is not an RSA key, refusing.");
653 found_key_type
= true;
658 if (!found_decrypt
|| !found_class
|| !found_key_type
) {
659 /* Hmm, let's slightly extend the attribute list we search for */
661 attributes_buffer
= new(CK_ATTRIBUTE
, n_attributes
+ !found_decrypt
+ !found_class
+ !found_key_type
);
662 if (!attributes_buffer
)
665 memcpy(attributes_buffer
, attributes
, sizeof(CK_ATTRIBUTE
) * n_attributes
);
667 if (!found_decrypt
) {
668 static const CK_BBOOL yes
= true;
670 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
672 .pValue
= (CK_BBOOL
*) &yes
,
673 .ulValueLen
= sizeof(yes
),
678 static const CK_OBJECT_CLASS
class = CKO_PRIVATE_KEY
;
680 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
682 .pValue
= (CK_OBJECT_CLASS
*) &class,
683 .ulValueLen
= sizeof(class),
687 if (!found_key_type
) {
688 static const CK_KEY_TYPE type
= CKK_RSA
;
690 attributes_buffer
[n_attributes
++] = (CK_ATTRIBUTE
) {
691 .type
= CKA_KEY_TYPE
,
692 .pValue
= (CK_KEY_TYPE
*) &type
,
693 .ulValueLen
= sizeof(type
),
697 attributes
= attributes_buffer
;
700 rv
= m
->C_FindObjectsInit(session
, attributes
, n_attributes
);
702 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
703 "Failed to initialize object find call: %s", sym_p11_kit_strerror(rv
));
705 rv
= m
->C_FindObjects(session
, objects
, ELEMENTSOF(objects
), &n_objects
);
706 rv2
= m
->C_FindObjectsFinal(session
);
708 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
709 "Failed to find objects: %s", sym_p11_kit_strerror(rv
));
711 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
712 "Failed to finalize object find call: %s", sym_p11_kit_strerror(rv
));
714 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
),
715 "Failed to find selected private key suitable for decryption on token.");
717 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
718 "Configured private key URI matches multiple keys, refusing.");
720 *ret_object
= objects
[0];
724 int pkcs11_token_decrypt_data(
726 CK_SESSION_HANDLE session
,
727 CK_OBJECT_HANDLE object
,
728 const void *encrypted_data
,
729 size_t encrypted_data_size
,
730 void **ret_decrypted_data
,
731 size_t *ret_decrypted_data_size
) {
733 static const CK_MECHANISM mechanism
= {
734 .mechanism
= CKM_RSA_PKCS
736 _cleanup_(erase_and_freep
) CK_BYTE
*dbuffer
= NULL
;
737 CK_ULONG dbuffer_size
= 0;
742 assert(encrypted_data
);
743 assert(encrypted_data_size
> 0);
744 assert(ret_decrypted_data
);
745 assert(ret_decrypted_data_size
);
751 rv
= m
->C_DecryptInit(session
, (CK_MECHANISM
*) &mechanism
, object
);
753 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
754 "Failed to initialize decryption on security token: %s", sym_p11_kit_strerror(rv
));
756 dbuffer_size
= encrypted_data_size
; /* Start with something reasonable */
757 dbuffer
= malloc(dbuffer_size
);
761 rv
= m
->C_Decrypt(session
, (CK_BYTE
*) encrypted_data
, encrypted_data_size
, dbuffer
, &dbuffer_size
);
762 if (rv
== CKR_BUFFER_TOO_SMALL
) {
763 erase_and_free(dbuffer
);
765 dbuffer
= malloc(dbuffer_size
);
769 rv
= m
->C_Decrypt(session
, (CK_BYTE
*) encrypted_data
, encrypted_data_size
, dbuffer
, &dbuffer_size
);
772 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
773 "Failed to decrypt key on security token: %s", sym_p11_kit_strerror(rv
));
775 log_info("Successfully decrypted key with security token.");
777 *ret_decrypted_data
= TAKE_PTR(dbuffer
);
778 *ret_decrypted_data_size
= dbuffer_size
;
782 int pkcs11_token_acquire_rng(
784 CK_SESSION_HANDLE session
) {
786 _cleanup_free_
void *buffer
= NULL
;
797 /* While we are at it, let's read some RNG data from the PKCS#11 token and pass it to the kernel
798 * random pool. This should be cheap if we are talking to the device already. Note that we don't
799 * credit any entropy, since we don't know about the quality of the pkcs#11 token's RNG. Why bother
800 * at all? There are two sides to the argument whether to generate private keys on tokens or on the
801 * host. By crediting some data from the token RNG to the host's pool we at least can say that any
802 * key generated from it is at least as good as both sources individually. */
804 rps
= random_pool_size();
806 buffer
= malloc(rps
);
810 rv
= m
->C_GenerateRandom(session
, buffer
, rps
);
812 return log_debug_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
813 "Failed to generate RNG data on security token: %s", sym_p11_kit_strerror(rv
));
815 r
= random_write_entropy(-1, buffer
, rps
, false);
817 return log_debug_errno(r
, "Failed to write PKCS#11 acquired random data to /dev/urandom: %m");
819 log_debug("Successfully written %zu bytes random data acquired via PKCS#11 to kernel random pool.", rps
);
824 static int token_process(
827 const CK_SLOT_INFO
*slot_info
,
828 const CK_TOKEN_INFO
*token_info
,
829 P11KitUri
*search_uri
,
830 pkcs11_find_token_callback_t callback
,
833 _cleanup_free_
char *token_label
= NULL
;
834 CK_SESSION_HANDLE session
;
842 token_label
= pkcs11_token_label(token_info
);
846 rv
= m
->C_OpenSession(slotid
, CKF_SERIAL_SESSION
, NULL
, NULL
, &session
);
848 return log_error_errno(SYNTHETIC_ERRNO(EIO
),
849 "Failed to create session for security token '%s': %s", token_label
, sym_p11_kit_strerror(rv
));
852 r
= callback(m
, session
, slotid
, slot_info
, token_info
, search_uri
, userdata
);
854 r
= 1; /* if not callback was specified, just say we found what we were looking for */
856 rv
= m
->C_CloseSession(session
);
858 log_warning("Failed to close session on PKCS#11 token, ignoring: %s", sym_p11_kit_strerror(rv
));
863 static int slot_process(
866 P11KitUri
*search_uri
,
867 pkcs11_find_token_callback_t callback
,
870 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
* slot_uri
= NULL
, *token_uri
= NULL
;
871 _cleanup_free_
char *token_uri_string
= NULL
;
872 CK_TOKEN_INFO token_info
;
873 CK_SLOT_INFO slot_info
;
883 /* We return -EAGAIN for all failures we can attribute to a specific slot in some way, so that the
884 * caller might try other slots before giving up. */
886 rv
= m
->C_GetSlotInfo(slotid
, &slot_info
);
888 log_warning("Failed to acquire slot info for slot %lu, ignoring slot: %s", slotid
, sym_p11_kit_strerror(rv
));
892 slot_uri
= uri_from_slot_info(&slot_info
);
897 _cleanup_free_
char *slot_uri_string
= NULL
;
899 uri_result
= sym_p11_kit_uri_format(slot_uri
, P11_KIT_URI_FOR_ANY
, &slot_uri_string
);
900 if (uri_result
!= P11_KIT_URI_OK
) {
901 log_warning("Failed to format slot URI, ignoring slot: %s", sym_p11_kit_uri_message(uri_result
));
905 log_debug("Found slot with URI %s", slot_uri_string
);
908 rv
= m
->C_GetTokenInfo(slotid
, &token_info
);
909 if (rv
== CKR_TOKEN_NOT_PRESENT
) {
910 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
911 "Token not present in slot, ignoring.");
912 } else if (rv
!= CKR_OK
) {
913 log_warning("Failed to acquire token info for slot %lu, ignoring slot: %s", slotid
, sym_p11_kit_strerror(rv
));
917 token_uri
= uri_from_token_info(&token_info
);
921 uri_result
= sym_p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
922 if (uri_result
!= P11_KIT_URI_OK
) {
923 log_warning("Failed to format slot URI: %s", sym_p11_kit_uri_message(uri_result
));
927 if (search_uri
&& !sym_p11_kit_uri_match_token_info(search_uri
, &token_info
))
928 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
929 "Found non-matching token with URI %s.",
932 log_debug("Found matching token with URI %s.", token_uri_string
);
934 return token_process(
944 static int module_process(
946 P11KitUri
*search_uri
,
947 pkcs11_find_token_callback_t callback
,
950 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
* module_uri
= NULL
;
951 _cleanup_free_
char *name
= NULL
, *module_uri_string
= NULL
;
952 _cleanup_free_ CK_SLOT_ID
*slotids
= NULL
;
953 CK_ULONG n_slotids
= 0;
966 /* We ignore most errors from modules here, in order to skip over faulty modules: one faulty module
967 * should not have the effect that we don't try the others anymore. We indicate such per-module
968 * failures with -EAGAIN, which let's the caller try the next module. */
970 name
= sym_p11_kit_module_get_name(m
);
974 log_debug("Trying PKCS#11 module %s.", name
);
976 rv
= m
->C_GetInfo(&info
);
978 log_warning("Failed to get info on PKCS#11 module, ignoring module: %s", sym_p11_kit_strerror(rv
));
982 module_uri
= uri_from_module_info(&info
);
986 uri_result
= sym_p11_kit_uri_format(module_uri
, P11_KIT_URI_FOR_ANY
, &module_uri_string
);
987 if (uri_result
!= P11_KIT_URI_OK
) {
988 log_warning("Failed to format module URI, ignoring module: %s", sym_p11_kit_uri_message(uri_result
));
992 log_debug("Found module with URI %s", module_uri_string
);
994 rv
= pkcs11_get_slot_list_malloc(m
, &slotids
, &n_slotids
);
996 log_warning("Failed to get slot list, ignoring module: %s", sym_p11_kit_strerror(rv
));
1000 return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN
),
1001 "This module has no slots? Ignoring module.");
1003 for (k
= 0; k
< n_slotids
; k
++) {
1017 int pkcs11_find_token(
1018 const char *pkcs11_uri
,
1019 pkcs11_find_token_callback_t callback
,
1022 _cleanup_(sym_p11_kit_modules_finalize_and_releasep
) CK_FUNCTION_LIST
**modules
= NULL
;
1023 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
*search_uri
= NULL
;
1026 r
= dlopen_p11kit();
1030 /* Execute the specified callback for each matching token found. If nothing is found returns
1031 * -EAGAIN. Logs about all errors, except for EAGAIN, which the caller has to log about. */
1034 r
= uri_from_string(pkcs11_uri
, &search_uri
);
1036 return log_error_errno(r
, "Failed to parse PKCS#11 URI '%s': %m", pkcs11_uri
);
1039 modules
= sym_p11_kit_modules_load_and_initialize(0);
1041 return log_error_errno(SYNTHETIC_ERRNO(EIO
), "Failed to initialize pkcs11 modules");
1043 for (CK_FUNCTION_LIST
**i
= modules
; *i
; i
++) {
1057 struct pkcs11_acquire_certificate_callback_data
{
1060 const char *askpw_friendly_name
, *askpw_icon_name
;
1063 static void pkcs11_acquire_certificate_callback_data_release(struct pkcs11_acquire_certificate_callback_data
*data
) {
1064 erase_and_free(data
->pin_used
);
1065 X509_free(data
->cert
);
1068 static int pkcs11_acquire_certificate_callback(
1069 CK_FUNCTION_LIST
*m
,
1070 CK_SESSION_HANDLE session
,
1072 const CK_SLOT_INFO
*slot_info
,
1073 const CK_TOKEN_INFO
*token_info
,
1077 _cleanup_(erase_and_freep
) char *pin_used
= NULL
;
1078 struct pkcs11_acquire_certificate_callback_data
*data
= ASSERT_PTR(userdata
);
1079 CK_OBJECT_HANDLE object
;
1087 /* Called for every token matching our URI */
1089 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
);
1093 r
= pkcs11_token_find_x509_certificate(m
, session
, uri
, &object
);
1097 r
= pkcs11_token_read_x509_certificate(m
, session
, object
, &data
->cert
);
1101 /* Let's read some random data off the token and write it to the kernel pool before we generate our
1102 * random key from it. This way we can claim the quality of the RNG is at least as good as the
1103 * kernel's and the token's pool */
1104 (void) pkcs11_token_acquire_rng(m
, session
);
1106 data
->pin_used
= TAKE_PTR(pin_used
);
1110 int pkcs11_acquire_certificate(
1112 const char *askpw_friendly_name
,
1113 const char *askpw_icon_name
,
1115 char **ret_pin_used
) {
1117 _cleanup_(pkcs11_acquire_certificate_callback_data_release
) struct pkcs11_acquire_certificate_callback_data data
= {
1118 .askpw_friendly_name
= askpw_friendly_name
,
1119 .askpw_icon_name
= askpw_icon_name
,
1126 r
= pkcs11_find_token(uri
, pkcs11_acquire_certificate_callback
, &data
);
1127 if (r
== -EAGAIN
) /* pkcs11_find_token() doesn't log about this error, but all others */
1128 return log_error_errno(SYNTHETIC_ERRNO(ENXIO
),
1129 "Specified PKCS#11 token with URI '%s' not found.",
1134 *ret_cert
= TAKE_PTR(data
.cert
);
1137 *ret_pin_used
= TAKE_PTR(data
.pin_used
);
1143 static int list_callback(
1144 CK_FUNCTION_LIST
*m
,
1145 CK_SESSION_HANDLE session
,
1147 const CK_SLOT_INFO
*slot_info
,
1148 const CK_TOKEN_INFO
*token_info
,
1152 _cleanup_free_
char *token_uri_string
= NULL
, *token_label
= NULL
, *token_manufacturer_id
= NULL
, *token_model
= NULL
;
1153 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
1154 Table
*t
= userdata
;
1160 r
= dlopen_p11kit();
1164 /* We only care about hardware devices here with a token inserted. Let's filter everything else
1165 * out. (Note that the user can explicitly specify non-hardware tokens if they like, but during
1166 * enumeration we'll filter those, since software tokens are typically the system certificate store
1167 * and such, and it's typically not what people want to bind their home directories to.) */
1168 if (!FLAGS_SET(slot_info
->flags
, CKF_HW_SLOT
|CKF_TOKEN_PRESENT
))
1171 token_label
= pkcs11_token_label(token_info
);
1175 token_manufacturer_id
= pkcs11_token_manufacturer_id(token_info
);
1176 if (!token_manufacturer_id
)
1179 token_model
= pkcs11_token_model(token_info
);
1183 token_uri
= uri_from_token_info(token_info
);
1187 uri_result
= sym_p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, &token_uri_string
);
1188 if (uri_result
!= P11_KIT_URI_OK
)
1189 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", sym_p11_kit_uri_message(uri_result
));
1193 TABLE_STRING
, token_uri_string
,
1194 TABLE_STRING
, token_label
,
1195 TABLE_STRING
, token_manufacturer_id
,
1196 TABLE_STRING
, token_model
);
1198 return table_log_add_error(r
);
1200 return -EAGAIN
; /* keep scanning */
1204 int pkcs11_list_tokens(void) {
1206 _cleanup_(table_unrefp
) Table
*t
= NULL
;
1209 t
= table_new("uri", "label", "manufacturer", "model");
1213 r
= pkcs11_find_token(NULL
, list_callback
, t
);
1214 if (r
< 0 && r
!= -EAGAIN
)
1217 if (table_get_rows(t
) <= 1) {
1218 log_info("No suitable PKCS#11 tokens found.");
1222 r
= table_print(t
, stdout
);
1224 return log_error_errno(r
, "Failed to show device table: %m");
1228 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1229 "PKCS#11 tokens not supported on this build.");
1234 static int auto_callback(
1235 CK_FUNCTION_LIST
*m
,
1236 CK_SESSION_HANDLE session
,
1238 const CK_SLOT_INFO
*slot_info
,
1239 const CK_TOKEN_INFO
*token_info
,
1243 _cleanup_(sym_p11_kit_uri_freep
) P11KitUri
*token_uri
= NULL
;
1244 char **t
= userdata
;
1250 r
= dlopen_p11kit();
1254 if (!FLAGS_SET(token_info
->flags
, CKF_HW_SLOT
|CKF_TOKEN_PRESENT
))
1258 return log_error_errno(SYNTHETIC_ERRNO(ENOTUNIQ
),
1259 "More than one suitable PKCS#11 token found.");
1261 token_uri
= uri_from_token_info(token_info
);
1265 uri_result
= sym_p11_kit_uri_format(token_uri
, P11_KIT_URI_FOR_ANY
, t
);
1266 if (uri_result
!= P11_KIT_URI_OK
)
1267 return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN
), "Failed to format slot URI: %s", sym_p11_kit_uri_message(uri_result
));
1273 int pkcs11_find_token_auto(char **ret
) {
1277 r
= pkcs11_find_token(NULL
, auto_callback
, ret
);
1279 return log_error_errno(SYNTHETIC_ERRNO(ENODEV
), "No suitable PKCS#11 tokens found.");
1285 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
1286 "PKCS#11 tokens not supported on this build.");
1291 void pkcs11_crypt_device_callback_data_release(pkcs11_crypt_device_callback_data
*data
) {
1292 erase_and_free(data
->decrypted_key
);
1294 if (data
->free_encrypted_key
)
1295 free(data
->encrypted_key
);
1298 int pkcs11_crypt_device_callback(
1299 CK_FUNCTION_LIST
*m
,
1300 CK_SESSION_HANDLE session
,
1302 const CK_SLOT_INFO
*slot_info
,
1303 const CK_TOKEN_INFO
*token_info
,
1307 pkcs11_crypt_device_callback_data
*data
= ASSERT_PTR(userdata
);
1308 CK_OBJECT_HANDLE object
;
1316 /* Called for every token matching our URI */
1318 r
= pkcs11_token_login(
1323 data
->friendly_name
,
1326 "cryptsetup.pkcs11-pin",
1333 /* We are likely called during early boot, where entropy is scarce. Mix some data from the PKCS#11
1334 * token, if it supports that. It should be cheap, given that we already are talking to it anyway and
1335 * shouldn't hurt. */
1336 (void) pkcs11_token_acquire_rng(m
, session
);
1338 r
= pkcs11_token_find_private_key(m
, session
, uri
, &object
);
1342 r
= pkcs11_token_decrypt_data(
1346 data
->encrypted_key
,
1347 data
->encrypted_key_size
,
1348 &data
->decrypted_key
,
1349 &data
->decrypted_key_size
);