alexaClientSDK::acsdkPkcs11::PKCS11Session Class Reference

PKCS11 session wrapper. More...

#include <PKCS11Session.h>

Inheritance diagram for alexaClientSDK::acsdkPkcs11::PKCS11Session:

Collaboration diagram for alexaClientSDK::acsdkPkcs11::PKCS11Session:

Public Member Functions
	~PKCS11Session () noexcept
	Public destructor (closes session). More...
bool	logIn (const std::string &userPin) noexcept
	Log into HSM. More...
bool	logOut () noexcept
	Log out from HSM. More...
std::unique_ptr< PKCS11Key >	findKey (const PKCS11KeyDescriptor &descriptor) noexcept
	Loads existing key. More...

Detailed Description

PKCS11 session wrapper.

This class wraps PKCS#11 API session handle and related operations.

Constructor & Destructor Documentation

~PKCS11Session()

alexaClientSDK::acsdkPkcs11::PKCS11Session::~PKCS11Session ( )

noexcept

Public destructor (closes session).

Member Function Documentation

findKey()

std::unique_ptr< PKCS11Key > alexaClientSDK::acsdkPkcs11::PKCS11Session::findKey ( const PKCS11KeyDescriptor &  descriptor )

noexcept

Loads existing key.

Parameters

[in]

descriptor

Key parameters.

Returns

Key reference or nullptr on error.

logIn()

bool alexaClientSDK::acsdkPkcs11::PKCS11Session::logIn ( const std::string &  userPin )

noexcept

Log into HSM.

Parameters

[in]

userPin

User PIN.

Returns

True if operation is successful.

logOut()

bool alexaClientSDK::acsdkPkcs11::PKCS11Session::logOut ( )

noexcept

Log out from HSM.

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/PKCS11Session.h
• /workplace/avs-device-sdk/core/Crypto/acsdkPkcs11/src/PKCS11Session.cpp