alexaClientSDK::acsdkPkcs11::PKCS11Functions Class Reference

PKCS11 API Wrapper. More...

#include <PKCS11Functions.h>

Inheritance diagram for alexaClientSDK::acsdkPkcs11::PKCS11Functions:

Collaboration diagram for alexaClientSDK::acsdkPkcs11::PKCS11Functions:

Public Member Functions
virtual	~PKCS11Functions () noexcept
	Releases library. More...
bool	listSlots (bool tokenPresent, std::vector< std::shared_ptr< PKCS11Slot >> &slots) noexcept
	Lists available PKCS11 slots by type. More...
bool	findSlotByTokenName (const std::string &tokenName, std::shared_ptr< PKCS11Slot > &slot) noexcept
	Finds PKCS11 slot by name. More...

Static Public Member Functions
static std::shared_ptr< PKCS11Functions >	create (const std::string &libpath) noexcept

Detailed Description

PKCS11 API Wrapper.

This class manages library load, initialization, and slot operations.

Constructor & Destructor Documentation

~PKCS11Functions()

alexaClientSDK::acsdkPkcs11::PKCS11Functions::~PKCS11Functions ( )

virtualnoexcept

Releases library.

Member Function Documentation

create()

std::shared_ptr< PKCS11Functions > alexaClientSDK::acsdkPkcs11::PKCS11Functions::create ( const std::string &  libpath )

staticnoexcept

Creates object.

Parameters

libpath

File path to PKCS11 library.

Returns

findSlotByTokenName()

bool alexaClientSDK::acsdkPkcs11::PKCS11Functions::findSlotByTokenName ( const std::string &  tokenName, std::shared_ptr< PKCS11Slot > &  slot  )

noexcept

Finds PKCS11 slot by name.

Parameters

[in]	tokenName	Token name.
[out]	slot	Discovered slot or nullptr if slot with given name doesn't exist.

Returns

True if operation is successful. If operation fails, the value of slot is unchanged.

listSlots()

bool alexaClientSDK::acsdkPkcs11::PKCS11Functions::listSlots ( bool  tokenPresent, std::vector< std::shared_ptr< PKCS11Slot >> &  slots  )

noexcept

Lists available PKCS11 slots by type.

Parameters

[in]	tokenPresent	Flag, if list slots with tokens (when true), or all slots.
[out]	slots	Discovered slot names.

Returns

True if operation is successful.

---

The documentation for this class was generated from the following files:

• /workplace/avs-device-sdk/core/Crypto/acsdkPkcs11/privateInclude/acsdkPkcs11/private/PKCS11Functions.h
• /workplace/avs-device-sdk/core/Crypto/acsdkPkcs11/src/PKCS11Functions.cpp
• /workplace/avs-device-sdk/core/Crypto/acsdkPkcs11/src/PKCS11FunctionsPosix.cpp
• /workplace/avs-device-sdk/core/Crypto/acsdkPkcs11/src/PKCS11FunctionsUwp.cpp