10#include <botan/p11_types.h>
11#include <botan/dyn_load.h>
27bool handle_return_value(
const CK_RV function_result,
ReturnValue* return_value)
37 else if(return_value !=
nullptr)
40 *return_value =
static_cast< ReturnValue >(function_result);
57 session.
set_pin(old_pin, new_pin);
64 session.
set_pin(old_so_pin, new_so_pin);
77 if(m_func_list_ptr ==
nullptr)
88 return handle_return_value(m_func_list_ptr->C_Initialize(init_args), return_value);
94 return handle_return_value(m_func_list_ptr->C_Finalize(reserved), return_value);
100 return handle_return_value(m_func_list_ptr->C_GetInfo(info_ptr), return_value);
108 get_function_list get_function_list_ptr = pkcs11_module.
resolve<get_function_list>(
"C_GetFunctionList");
110 return handle_return_value(get_function_list_ptr(function_list_ptr_ptr), return_value);
120 return handle_return_value(m_func_list_ptr->C_GetSlotList(token_present, slot_list_ptr, count_ptr), return_value);
124 std::vector<SlotId>& slot_ids,
130 Ulong number_slots = 0;
132 bool success =
C_GetSlotList(token_present,
nullptr, &number_slots, return_value);
134 if(!success || !number_slots)
140 slot_ids.resize(number_slots);
141 return C_GetSlotList(token_present, slot_ids.data(), &number_slots, return_value);
148 return handle_return_value(m_func_list_ptr->C_GetSlotInfo(slot_id, info_ptr), return_value);
155 return handle_return_value(m_func_list_ptr->C_GetTokenInfo(slot_id, info_ptr), return_value);
163 return handle_return_value(m_func_list_ptr->C_WaitForSlotEvent(
flags, slot_ptr, reserved), return_value);
171 return handle_return_value(m_func_list_ptr->C_GetMechanismList(slot_id,
176 std::vector<MechanismType>& mechanisms,
182 Ulong number_mechanisms = 0;
184 bool success =
C_GetMechanismList(slot_id,
nullptr, &number_mechanisms, return_value);
186 if(!success || !number_mechanisms)
192 mechanisms.resize(number_mechanisms);
202 return handle_return_value(m_func_list_ptr->C_GetMechanismInfo(slot_id,
static_cast< CK_MECHANISM_TYPE >(
type),
203 info_ptr), return_value);
212 return handle_return_value(m_func_list_ptr->C_InitToken(slot_id, so_pin_ptr, so_pin_len, label_ptr), return_value);
220 return handle_return_value(m_func_list_ptr->C_InitPIN(session, pin_ptr, pin_len), return_value);
230 return handle_return_value(m_func_list_ptr->C_SetPIN(session, old_pin_ptr, old_len, new_pin_ptr, new_len),
243 return handle_return_value(m_func_list_ptr->C_OpenSession(slot_id,
flags, application, notify, session_ptr),
250 return handle_return_value(m_func_list_ptr->C_CloseSession(session), return_value);
256 return handle_return_value(m_func_list_ptr->C_CloseAllSessions(slot_id), return_value);
263 return handle_return_value(m_func_list_ptr->C_GetSessionInfo(session, info_ptr), return_value);
267 Byte* operation_state_ptr,
268 Ulong* operation_state_len_ptr,
271 return handle_return_value(m_func_list_ptr->C_GetOperationState(session, operation_state_ptr, operation_state_len_ptr),
276 Byte* operation_state_ptr,
277 Ulong operation_state_len,
282 return handle_return_value(m_func_list_ptr->C_SetOperationState(session, operation_state_ptr, operation_state_len,
283 encryption_key, authentication_key), return_value);
292 return handle_return_value(m_func_list_ptr->C_Login(session,
static_cast< CK_USER_TYPE >(user_type), pin_ptr, pin_len),
299 return handle_return_value(m_func_list_ptr->C_Logout(session), return_value);
310 return handle_return_value(m_func_list_ptr->C_CreateObject(session, attribute_template_ptr, count, object_ptr),
321 return handle_return_value(m_func_list_ptr->C_CopyObject(session,
object, attribute_template_ptr, count,
322 new_object_ptr), return_value);
329 return handle_return_value(m_func_list_ptr->C_DestroyObject(session,
object), return_value);
337 return handle_return_value(m_func_list_ptr->C_GetObjectSize(session,
object, size_ptr), return_value);
346 return handle_return_value(m_func_list_ptr->C_GetAttributeValue(session,
object, attribute_template_ptr, count),
356 return handle_return_value(m_func_list_ptr->C_SetAttributeValue(session,
object, attribute_template_ptr, count),
365 return handle_return_value(m_func_list_ptr->C_FindObjectsInit(session, attribute_template_ptr, count), return_value);
370 Ulong max_object_count,
371 Ulong* object_count_ptr,
374 return handle_return_value(m_func_list_ptr->C_FindObjects(session, object_ptr, max_object_count, object_count_ptr),
381 return handle_return_value(m_func_list_ptr->C_FindObjectsFinal(session), return_value);
391 return handle_return_value(m_func_list_ptr->C_EncryptInit(session, mechanism_ptr, key), return_value);
397 Byte* encrypted_data_ptr,
398 Ulong* encrypted_data_len_ptr,
401 return handle_return_value(m_func_list_ptr->C_Encrypt(session, data_ptr, data_len, encrypted_data_ptr,
402 encrypted_data_len_ptr), return_value);
408 Byte* encrypted_part_ptr,
409 Ulong* encrypted_part_len_ptr,
412 return handle_return_value(m_func_list_ptr->C_EncryptUpdate(session, part_ptr, part_len, encrypted_part_ptr,
413 encrypted_part_len_ptr), return_value);
417 Byte* last_encrypted_part_ptr,
418 Ulong* last_encrypted_part_len_ptr,
421 return handle_return_value(m_func_list_ptr->C_EncryptFinal(session, last_encrypted_part_ptr,
422 last_encrypted_part_len_ptr), return_value);
432 return handle_return_value(m_func_list_ptr->C_DecryptInit(session, mechanism_ptr, key), return_value);
436 Byte* encrypted_data_ptr,
437 Ulong encrypted_data_len,
442 return handle_return_value(m_func_list_ptr->C_Decrypt(session, encrypted_data_ptr, encrypted_data_len, data_ptr,
443 data_len_ptr), return_value);
447 Byte* encrypted_part_ptr,
448 Ulong encrypted_part_len,
453 return handle_return_value(m_func_list_ptr->C_DecryptUpdate(session, encrypted_part_ptr, encrypted_part_len, part_ptr,
454 part_len_ptr), return_value);
459 Ulong* last_part_len_ptr,
462 return handle_return_value(m_func_list_ptr->C_DecryptFinal(session, last_part_ptr, last_part_len_ptr), return_value);
471 return handle_return_value(m_func_list_ptr->C_DigestInit(session, mechanism), return_value);
478 Ulong* digest_len_ptr,
481 return handle_return_value(m_func_list_ptr->C_Digest(session, data_ptr, data_len, digest_ptr, digest_len_ptr),
490 return handle_return_value(m_func_list_ptr->C_DigestUpdate(session, part_ptr, part_len), return_value);
497 return handle_return_value(m_func_list_ptr->C_DigestKey(session, key), return_value);
502 Ulong* digest_len_ptr,
505 return handle_return_value(m_func_list_ptr->C_DigestFinal(session, digest_ptr, digest_len_ptr), return_value);
515 return handle_return_value(m_func_list_ptr->C_SignInit(session, mechanism_ptr, key), return_value);
522 Ulong* signature_len_ptr,
525 return handle_return_value(m_func_list_ptr->C_Sign(session, data_ptr, data_len, signature_ptr, signature_len_ptr),
534 return handle_return_value(m_func_list_ptr->C_SignUpdate(session, part_ptr, part_len), return_value);
539 Ulong* signature_len_ptr,
542 return handle_return_value(m_func_list_ptr->C_SignFinal(session, signature_ptr, signature_len_ptr), return_value);
550 return handle_return_value(m_func_list_ptr->C_SignRecoverInit(session, mechanism_ptr, key), return_value);
557 Ulong* signature_len,
560 return handle_return_value(m_func_list_ptr->C_SignRecover(session, data, data_len, signature, signature_len),
571 return handle_return_value(m_func_list_ptr->C_VerifyInit(session, mechanism_ptr, key), return_value);
581 return handle_return_value(m_func_list_ptr->C_Verify(session, data_ptr, data_len, signature_ptr, signature_len),
590 return handle_return_value(m_func_list_ptr->C_VerifyUpdate(session, part_ptr, part_len), return_value);
598 return handle_return_value(m_func_list_ptr->C_VerifyFinal(session, signature_ptr, signature_len), return_value);
606 return handle_return_value(m_func_list_ptr->C_VerifyRecoverInit(session, mechanism_ptr, key), return_value);
616 return handle_return_value(m_func_list_ptr->C_VerifyRecover(session, signature_ptr, signature_len, data_ptr,
617 data_len_ptr), return_value);
625 Byte* encrypted_part_ptr,
626 Ulong* encrypted_part_len_ptr,
629 return handle_return_value(m_func_list_ptr->C_DigestEncryptUpdate(session, part_ptr, part_len, encrypted_part_ptr,
630 encrypted_part_len_ptr), return_value);
634 Byte* encrypted_part_ptr,
635 Ulong encrypted_part_len,
640 return handle_return_value(m_func_list_ptr->C_DecryptDigestUpdate(session, encrypted_part_ptr, encrypted_part_len,
641 part_ptr, part_len_ptr), return_value);
647 Byte* encrypted_part_ptr,
648 Ulong* encrypted_part_len_ptr,
651 return handle_return_value(m_func_list_ptr->C_SignEncryptUpdate(session, part_ptr, part_len, encrypted_part_ptr,
652 encrypted_part_len_ptr), return_value);
656 Byte* encrypted_part_ptr,
657 Ulong encrypted_part_len,
662 return handle_return_value(m_func_list_ptr->C_DecryptVerifyUpdate(session, encrypted_part_ptr, encrypted_part_len,
663 part_ptr, part_len_ptr), return_value);
675 return handle_return_value(m_func_list_ptr->C_GenerateKey(session, mechanism_ptr, attribute_template_ptr, count,
676 key_ptr), return_value);
682 Ulong public_key_attribute_count,
684 Ulong private_key_attribute_count,
689 return handle_return_value(m_func_list_ptr->C_GenerateKeyPair(session, mechanism_ptr, public_key_template_ptr,
690 public_key_attribute_count, private_key_template_ptr,
691 private_key_attribute_count, public_key_ptr, private_key_ptr), return_value);
698 Byte* wrapped_key_ptr,
699 Ulong* wrapped_key_len_ptr,
702 return handle_return_value(m_func_list_ptr->C_WrapKey(session, mechanism_ptr, wrapping_key, key, wrapped_key_ptr,
703 wrapped_key_len_ptr), return_value);
709 Byte* wrapped_key_ptr,
710 Ulong wrapped_key_len,
712 Ulong attribute_count,
716 return handle_return_value(m_func_list_ptr->C_UnwrapKey(session, mechanism_ptr, unwrapping_key, wrapped_key_ptr,
717 wrapped_key_len, attribute_template_ptr,
718 attribute_count, key_ptr), return_value);
725 Ulong attribute_count,
729 return handle_return_value(m_func_list_ptr->C_DeriveKey(session, mechanism_ptr, base_key, attribute_template_ptr,
730 attribute_count, key_ptr), return_value);
740 return handle_return_value(m_func_list_ptr->C_SeedRandom(session, seed_ptr, seed_len), return_value);
744 Byte* random_data_ptr,
748 return handle_return_value(m_func_list_ptr->C_GenerateRandom(session, random_data_ptr, random_len), return_value);
756 return handle_return_value(m_func_list_ptr->C_GetFunctionStatus(session), return_value);
762 return handle_return_value(m_func_list_ptr->C_CancelFunction(session), return_value);
T resolve(const std::string &symbol)
bool C_CancelFunction(SessionHandle session, ReturnValue *return_value=ThrowException) const
bool C_Finalize(VoidPtr reserved, ReturnValue *return_value=ThrowException) const
bool C_GetSessionInfo(SessionHandle session, SessionInfo *info_ptr, ReturnValue *return_value=ThrowException) const
bool C_DecryptUpdate(SessionHandle session, Byte *encrypted_part_ptr, Ulong encrypted_part_len, Byte *part_ptr, Ulong *part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_Logout(SessionHandle session, ReturnValue *return_value=ThrowException) const
bool C_GetOperationState(SessionHandle session, Byte *operation_state_ptr, Ulong *operation_state_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_DigestKey(SessionHandle session, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_EncryptInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_WaitForSlotEvent(Flags flags, SlotId *slot_ptr, VoidPtr reserved, ReturnValue *return_value=ThrowException) const
bool C_GetTokenInfo(SlotId slot_id, TokenInfo *info_ptr, ReturnValue *return_value=ThrowException) const
bool C_SetAttributeValue(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ReturnValue *return_value=ThrowException) const
static bool C_GetFunctionList(Dynamically_Loaded_Library &pkcs11_module, FunctionListPtr *function_list_ptr_ptr, ReturnValue *return_value=ThrowException)
bool C_DecryptFinal(SessionHandle session, Byte *last_part_ptr, Ulong *last_part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_SignInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
LowLevel(FunctionListPtr ptr)
bool C_GetSlotInfo(SlotId slot_id, SlotInfo *info_ptr, ReturnValue *return_value=ThrowException) const
bool C_EncryptFinal(SessionHandle session, Byte *last_encrypted_part_ptr, Ulong *last_encrypted_part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_DecryptInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_FindObjectsInit(SessionHandle session, Attribute *attribute_template_ptr, Ulong count, ReturnValue *return_value=ThrowException) const
bool C_GetAttributeValue(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ReturnValue *return_value=ThrowException) const
bool C_DestroyObject(SessionHandle session, ObjectHandle object, ReturnValue *return_value=ThrowException) const
bool C_Digest(SessionHandle session, Byte *data_ptr, Ulong data_len, Byte *digest_ptr, Ulong *digest_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_OpenSession(SlotId slot_id, Flags flags, VoidPtr application, Notify notify, SessionHandle *session_ptr, ReturnValue *return_value=ThrowException) const
bool C_VerifyUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, ReturnValue *return_value=ThrowException) const
bool C_DeriveKey(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle base_key, Attribute *attribute_template_ptr, Ulong attribute_count, ObjectHandle *key_ptr, ReturnValue *return_value=ThrowException) const
bool C_Sign(SessionHandle session, Byte *data_ptr, Ulong data_len, Byte *signature_ptr, Ulong *signature_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_VerifyRecoverInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_InitPIN(SessionHandle session, Utf8Char *pin_ptr, Ulong pin_len, ReturnValue *return_value=ThrowException) const
bool C_CopyObject(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ObjectHandle *new_object_ptr, ReturnValue *return_value=ThrowException) const
bool C_SignEncryptUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, Byte *encrypted_part_ptr, Ulong *encrypted_part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_Initialize(VoidPtr init_args, ReturnValue *return_value=ThrowException) const
bool C_GenerateRandom(SessionHandle session, Byte *random_data_ptr, Ulong random_len, ReturnValue *return_value=ThrowException) const
bool C_DigestEncryptUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, Byte *encrypted_part_ptr, Ulong *encrypted_part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_Verify(SessionHandle session, Byte *data_ptr, Ulong data_len, Byte *signature_ptr, Ulong signature_len, ReturnValue *return_value=ThrowException) const
bool C_VerifyInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_GetFunctionStatus(SessionHandle session, ReturnValue *return_value=ThrowException) const
bool C_CloseSession(SessionHandle session, ReturnValue *return_value=ThrowException) const
bool C_SignUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, ReturnValue *return_value=ThrowException) const
bool C_DigestInit(SessionHandle session, Mechanism *mechanism_ptr, ReturnValue *return_value=ThrowException) const
bool C_GenerateKeyPair(SessionHandle session, Mechanism *mechanism_ptr, Attribute *public_key_template_ptr, Ulong public_key_attribute_count, Attribute *private_key_template_ptr, Ulong private_key_attribute_count, ObjectHandle *public_key_ptr, ObjectHandle *private_key_ptr, ReturnValue *return_value=ThrowException) const
bool C_SignRecoverInit(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle key, ReturnValue *return_value=ThrowException) const
bool C_GetInfo(Info *info_ptr, ReturnValue *return_value=ThrowException) const
bool C_WrapKey(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle wrapping_key, ObjectHandle key, Byte *wrapped_key_ptr, Ulong *wrapped_key_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_SignRecover(SessionHandle session, Byte *data_ptr, Ulong data_len, Byte *signature_ptr, Ulong *signature_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_GetMechanismList(SlotId slot_id, MechanismType *mechanism_list_ptr, Ulong *count_ptr, ReturnValue *return_value=ThrowException) const
bool C_DigestUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, ReturnValue *return_value=ThrowException) const
bool C_FindObjectsFinal(SessionHandle session, ReturnValue *return_value=ThrowException) const
bool C_VerifyFinal(SessionHandle session, Byte *signature_ptr, Ulong signature_len, ReturnValue *return_value=ThrowException) const
bool C_Decrypt(SessionHandle session, Byte *encrypted_data_ptr, Ulong encrypted_data_len, Byte *data_ptr, Ulong *data_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_SetOperationState(SessionHandle session, Byte *operation_state_ptr, Ulong operation_state_len, ObjectHandle encryption_key, ObjectHandle authentication_key, ReturnValue *return_value=ThrowException) const
bool C_CloseAllSessions(SlotId slot_id, ReturnValue *return_value=ThrowException) const
bool C_DecryptVerifyUpdate(SessionHandle session, Byte *encrypted_part_ptr, Ulong encrypted_part_len, Byte *part_ptr, Ulong *part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_CreateObject(SessionHandle session, Attribute *attribute_template_ptr, Ulong count, ObjectHandle *object_ptr, ReturnValue *return_value=ThrowException) const
bool C_VerifyRecover(SessionHandle session, Byte *signature_ptr, Ulong signature_len, Byte *data_ptr, Ulong *data_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_DecryptDigestUpdate(SessionHandle session, Byte *encrypted_part_ptr, Ulong encrypted_part_len, Byte *part_ptr, Ulong *part_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_GenerateKey(SessionHandle session, Mechanism *mechanism_ptr, Attribute *attribute_template_ptr, Ulong count, ObjectHandle *key_ptr, ReturnValue *return_value=ThrowException) const
bool C_FindObjects(SessionHandle session, ObjectHandle *object_ptr, Ulong max_object_count, Ulong *object_count_ptr, ReturnValue *return_value=ThrowException) const
bool C_Encrypt(SessionHandle session, Byte *data_ptr, Ulong data_len, Byte *encrypted_data, Ulong *encrypted_data_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_GetSlotList(Bbool token_present, SlotId *slot_list_ptr, Ulong *count_ptr, ReturnValue *return_value=ThrowException) const
bool C_GetMechanismInfo(SlotId slot_id, MechanismType type, MechanismInfo *info_ptr, ReturnValue *return_value=ThrowException) const
bool C_Login(SessionHandle session, UserType user_type, Utf8Char *pin_ptr, Ulong pin_len, ReturnValue *return_value=ThrowException) const
bool C_SeedRandom(SessionHandle session, Byte *seed_ptr, Ulong seed_len, ReturnValue *return_value=ThrowException) const
bool C_SignFinal(SessionHandle session, Byte *signature_ptr, Ulong *signature_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_InitToken(SlotId slot_id, Utf8Char *so_pin_ptr, Ulong so_pin_len, Utf8Char *label_ptr, ReturnValue *return_value=ThrowException) const
bool C_DigestFinal(SessionHandle session, Byte *digest_ptr, Ulong *digest_len_ptr, ReturnValue *return_value=ThrowException) const
bool C_GetObjectSize(SessionHandle session, ObjectHandle object, Ulong *size_ptr, ReturnValue *return_value=ThrowException) const
bool C_SetPIN(SessionHandle session, Utf8Char *old_pin_ptr, Ulong old_len, Utf8Char *new_pin_ptr, Ulong new_len, ReturnValue *return_value=ThrowException) const
bool C_UnwrapKey(SessionHandle session, Mechanism *mechanism_ptr, ObjectHandle unwrapping_key, Byte *wrapped_key_ptr, Ulong wrapped_key_len, Attribute *attribute_template_ptr, Ulong attribute_count, ObjectHandle *key_ptr, ReturnValue *return_value=ThrowException) const
bool C_EncryptUpdate(SessionHandle session, Byte *part_ptr, Ulong part_len, Byte *encrypted_part_ptr, Ulong *encrypted_part_len_ptr, ReturnValue *return_value=ThrowException) const
Represents a PKCS#11 session.
void set_pin(const secure_string &old_pin, const secure_string &new_pin) const
Calls C_SetPIN to change the PIN using the old PIN (requires a logged in session)
void init_pin(const secure_string &new_pin)
Calls C_InitPIN to change or initialize the PIN using the SO_PIN (requires a logged in session)
void login(UserType userType, const secure_string &pin)
Represents a PKCS#11 Slot, i.e., a card reader.
void initialize(const std::string &label, const secure_string &so_pin) const
ReturnValue * ThrowException
void change_pin(Slot &slot, const secure_string &old_pin, const secure_string &new_pin)
void change_so_pin(Slot &slot, const secure_string &old_so_pin, const secure_string &new_so_pin)
CK_FUNCTION_LIST_PTR FunctionListPtr
secure_vector< uint8_t > secure_string
void initialize_token(Slot &slot, const std::string &label, const secure_string &so_pin, const secure_string &pin)
CK_SESSION_HANDLE SessionHandle
void set_pin(Slot &slot, const secure_string &so_pin, const secure_string &pin)
CK_OBJECT_HANDLE ObjectHandle
CK_MECHANISM_TYPE CK_PTR CK_MECHANISM_TYPE_PTR
CK_ULONG CK_MECHANISM_TYPE