alexaClientSDK::acsdkPkcs11::PKCS11Config Class Reference

PKCS11 Platform Configuration. More...

#include <PKCS11Config.h>

Public Member Functions
std::string	getLibraryPath () const noexcept
	Returns file path to PKCS11 library. More...
std::string	getUserPin () const noexcept
	Returns PIN for authentication. More...
std::string	getTokenName () const noexcept
	Returns token name. More...
std::string	getDefaultKeyName () const noexcept
	Returns main encryption key alias. More...

Static Public Member Functions
static std::shared_ptr< PKCS11Config >	create () noexcept
	Creates object. More...

Detailed Description

PKCS11 Platform Configuration.

This class provides access to PKCS11 configuration. Te configuration file includes path to PKCS#11 module, token name, PIN, and default key alias to use with encryption function.

The configuration file shall have restricted access to service account, that executes application.

See also

Hardware Security Module Functions

Member Function Documentation

create()

std::shared_ptr< PKCS11Config > alexaClientSDK::acsdkPkcs11::PKCS11Config::create ( )

staticnoexcept

Creates object.

Returns

Object reference or nullptr on error.

getDefaultKeyName()

std::string alexaClientSDK::acsdkPkcs11::PKCS11Config::getDefaultKeyName ( ) const

noexcept

Returns main encryption key alias.

Returns

Object name for the main encryption key to use.

getLibraryPath()

std::string alexaClientSDK::acsdkPkcs11::PKCS11Config::getLibraryPath ( ) const

noexcept

Returns file path to PKCS11 library.

Returns

Path to PKCS11 shared library object.

getTokenName()

std::string alexaClientSDK::acsdkPkcs11::PKCS11Config::getTokenName ( ) const

noexcept

Returns token name.

Returns

Token name to use for key store operations.

getUserPin()

std::string alexaClientSDK::acsdkPkcs11::PKCS11Config::getUserPin ( ) const

noexcept

Returns PIN for authentication.

Returns

User PIN.

---

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

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