Botan::PKCS11::Slot Class Reference

Represents a PKCS#11 Slot, i.e., a card reader. More...

#include <p11_types.h>

Public Member Functions
MechanismInfo	get_mechanism_info (MechanismType mechanism_type) const
	Obtains information about a particular mechanism possibly supported by a slot (C_GetMechanismInfo)
std::vector< MechanismType >	get_mechanism_list () const
	Obtains a list of mechanism types supported by the slot (C_GetMechanismList)
SlotInfo	get_slot_info () const
TokenInfo	get_token_info () const
	Obtains information about a particular token in the system (C_GetTokenInfo)
void	initialize (std::string_view label, const secure_string &so_pin) const
Module &	module () const
	Slot (Module &module, SlotId slot_id)
SlotId	slot_id () const

Static Public Member Functions
static std::vector< SlotId >	get_available_slots (Module &module, bool token_present)

Detailed Description

Represents a PKCS#11 Slot, i.e., a card reader.

Definition at line 74 of file p11_types.h.

Constructor & Destructor Documentation

Slot()

Botan::PKCS11::Slot::Slot	(	Module &	module,
		SlotId	slot_id )

Parameters

module	the PKCS#11 module to use
slot_id	the slot id to use

Definition at line 13 of file p11_slot.cpp.

: m_module(module), m_slot_id(slot_id) {}

Member Function Documentation

get_available_slots()

std::vector< SlotId > Botan::PKCS11::Slot::get_available_slots ( Module & module, bool token_present )

static

Get available slots

Parameters

module	the module to use
token_present	true if only slots with attached tokens should be returned, false for all slots

Returns

a list of available slots (calls C_GetSlotList)

Definition at line 33 of file p11_slot.cpp.

                                                                              {
   std::vector<SlotId> slot_vec;
   module->C_GetSlotList(token_present, slot_vec);
   return slot_vec;
}

get_mechanism_info()

MechanismInfo Botan::PKCS11::Slot::get_mechanism_info

(

MechanismType

mechanism_type

)

const

Obtains information about a particular mechanism possibly supported by a slot (C_GetMechanismInfo)

Definition at line 27 of file p11_slot.cpp.

                                                                         {
   MechanismInfo mechanism_info = {};
   m_module.get()->C_GetMechanismInfo(m_slot_id, mechanism_type, &mechanism_info);
   return mechanism_info;
}

get_mechanism_list()

std::vector< MechanismType > Botan::PKCS11::Slot::get_mechanism_list

(

)

const

Obtains a list of mechanism types supported by the slot (C_GetMechanismList)

Definition at line 21 of file p11_slot.cpp.

                                                        {
   std::vector<MechanismType> mechanism_list;
   m_module.get()->C_GetMechanismList(m_slot_id, mechanism_list);
   return mechanism_list;
}

get_slot_info()

SlotInfo Botan::PKCS11::Slot::get_slot_info

(

)

const

Returns

information about the slot (C_GetSlotInfo)

Definition at line 15 of file p11_slot.cpp.

                                   {
   SlotInfo slot_info = {};
   m_module.get()->C_GetSlotInfo(m_slot_id, &slot_info);
   return slot_info;
}

get_token_info()

TokenInfo Botan::PKCS11::Slot::get_token_info

(

)

const

Obtains information about a particular token in the system (C_GetTokenInfo)

Definition at line 39 of file p11_slot.cpp.

                                     {
   TokenInfo token_info;
   m_module.get()->C_GetTokenInfo(m_slot_id, &token_info);
   return token_info;
}

initialize()

void Botan::PKCS11::Slot::initialize	(	std::string_view	label,
		const secure_string &	so_pin ) const

Calls C_InitToken to initialize the token

Parameters

label	the label for the token (must not exceed 32 bytes according to PKCS#11)
so_pin	the PIN of the security officer

Definition at line 45 of file p11_slot.cpp.

                                                                             {
   m_module.get()->C_InitToken(m_slot_id, so_pin, label);
}

Referenced by Botan::PKCS11::initialize_token().

module()

Module & Botan::PKCS11::Slot::module ( ) const

inline

Returns

a reference to the module that is used

Definition at line 83 of file p11_types.h.

{ return m_module; }

slot_id()

SlotId Botan::PKCS11::Slot::slot_id ( ) const

inline

Returns

the slot id

Definition at line 86 of file p11_types.h.

{ return m_slot_id; }

Referenced by Botan::PKCS11::Session::Session().

---

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

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