Botan::PKCS11::Module Class Reference

#include <p11_types.h>

Public Member Functions
Info	get_info () const
const Dynamically_Loaded_Library &	library ()
std::string_view	library_path () const
	Module (const Module &other)=delete
	Module (Module &&other) noexcept
BOTAN_FUTURE_EXPLICIT	Module (std::string_view file_path, C_InitializeArgs init_args={ nullptr, nullptr, nullptr, nullptr, static_cast< CK_FLAGS >(Flag::OsLockingOk), nullptr})
LowLevel *	operator-> () const
Module &	operator= (const Module &other)=delete
Module &	operator= (Module &&other)=delete
void	reload (C_InitializeArgs init_args={ nullptr, nullptr, nullptr, nullptr, static_cast< CK_FLAGS >(Flag::OsLockingOk), nullptr})
	~Module () noexcept
	Calls C_Finalize().

Detailed Description

Loads the PKCS#11 shared library Calls C_Initialize on load and C_Finalize on destruction

Definition at line 27 of file p11_types.h.

Constructor & Destructor Documentation

Module() [1/3]

Botan::PKCS11::Module::Module	(	std::string_view	file_path,
		C_InitializeArgs	init_args = { nullptr, nullptr, nullptr, nullptr, static_cast<CK_FLAGS>(Flag::OsLockingOk), nullptr} )

Loads the shared library and calls C_Initialize. The latest supported "PKCS 11" interface is used.

Parameters

file_path	the path to the PKCS#11 shared library
init_args	flags to use for C_Initialize

Definition at line 15 of file p11_module.cpp.

                                                                   : m_file_path(file_path) {
   if(file_path.empty()) {
      throw Invalid_Argument("PKCS11 no module path specified");
   }
   reload(init_args);
}

References reload().

Referenced by Module(), Module(), operator=(), and operator=().

Module() [2/3]

Botan::PKCS11::Module::Module ( Module && other )

defaultnoexcept

References Module().

Module() [3/3]

Botan::PKCS11::Module::Module ( const Module & other )

delete

References Module().

~Module()

Botan::PKCS11::Module::~Module ( )

noexcept

Calls C_Finalize().

Definition at line 24 of file p11_module.cpp.

                         {
   try {
      m_low_level->C_Finalize(nullptr, nullptr);
   } catch(...) {
      // we are noexcept and must swallow any exception here
   }
}

Member Function Documentation

get_info()

Info Botan::PKCS11::Module::get_info ( ) const

inline

Returns

general information about Cryptoki

Definition at line 61 of file p11_types.h.

                                   {
         Info info;
         m_low_level->C_GetInfo(&info);
         return info;
      }

library()

const Dynamically_Loaded_Library & Botan::PKCS11::Module::library ( )

inline

Definition at line 69 of file p11_types.h.

{ return *m_library; }

library_path()

std::string_view Botan::PKCS11::Module::library_path ( ) const

inline

Definition at line 67 of file p11_types.h.

{ return m_file_path; }

operator->()

LowLevel * Botan::PKCS11::Module::operator-> ( ) const

inline

Definition at line 58 of file p11_types.h.

{ return m_low_level.get(); }

operator=() [1/2]

Module & Botan::PKCS11::Module::operator= ( const Module & other )

delete

References Module(), Botan::PKCS11::OsLockingOk, and reload().

operator=() [2/2]

Module & Botan::PKCS11::Module::operator= ( Module && other )

delete

References Module().

reload()

void Botan::PKCS11::Module::reload

(

C_InitializeArgs

init_args = { nullptr, nullptr, nullptr, nullptr, static_cast<CK_FLAGS>(Flag::OsLockingOk), nullptr}

)

Reloads the module and reinitializes it.

Parameters

init_args

flags to use for C_Initialize

Definition at line 32 of file p11_module.cpp.

                                              {
   if(m_low_level) {
      m_low_level->C_Finalize(nullptr);
   }
   m_library = std::make_unique<Dynamically_Loaded_Library>(m_file_path);
   m_low_level = std::make_unique<LowLevel>(InterfaceWrapper::latest_p11_interface(*m_library));
 
   m_low_level->C_Initialize(&init_args);
}

References Botan::PKCS11::InterfaceWrapper::latest_p11_interface().

Referenced by Module(), and operator=().

---

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

• src/lib/prov/pkcs11/p11_types.h
• src/lib/prov/pkcs11/p11_module.cpp