Botan 2.19.1
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::PKCS11::Session Class Referencefinal

Represents a PKCS#11 session. More...

#include <p11_types.h>

Public Member Functions

SessionInfo get_info () const
 
SessionHandle handle () const
 
void init_pin (const secure_string &new_pin)
 Calls C_InitPIN to change or initialize the PIN using the SO_PIN (requires a logged in session) More...
 
void login (UserType userType, const secure_string &pin)
 
void logoff ()
 Logout from this session. More...
 
Modulemodule () const
 
Sessionoperator= (const Session &other)=delete
 
Sessionoperator= (Session &&other)=delete
 
SessionHandle release ()
 
 Session (const Session &other)=delete
 
 Session (Session &&other)=default
 
 Session (Slot &slot, bool read_only)
 
 Session (Slot &slot, Flags flags, VoidPtr callback_data, Notify notify_callback)
 
 Session (Slot &slot, SessionHandle handle)
 Takes ownership of a session. More...
 
void set_pin (const secure_string &old_pin, const secure_string &new_pin) const
 Calls C_SetPIN to change the PIN using the old PIN (requires a logged in session) More...
 
const Slotslot () const
 
 ~Session () noexcept
 Logout user and close the session on destruction. More...
 

Detailed Description

Represents a PKCS#11 session.

Definition at line 130 of file p11_types.h.

Constructor & Destructor Documentation

◆ Session() [1/5]

Botan::PKCS11::Session::Session ( Slot slot,
bool  read_only 
)
Parameters
slotthe slot to use
read_onlytrue if the session should be read only, false to create a read-write session

Definition at line 14 of file p11_session.cpp.

15 : Session(slot, PKCS11::flags(Flag::SerialSession | (read_only ? Flag::None : Flag::RwSession)), nullptr, nullptr)
16 {}
const Slot & slot() const
Definition: p11_types.h:161
Session(Slot &slot, bool read_only)
Definition: p11_session.cpp:14
Flags flags(Flag flags)
Definition: p11.h:860

References Botan::PKCS11::None, Botan::PKCS11::RwSession, and Botan::PKCS11::SerialSession.

◆ Session() [2/5]

Botan::PKCS11::Session::Session ( Slot slot,
Flags  flags,
VoidPtr  callback_data,
Notify  notify_callback 
)
Parameters
slotthe slot to use
flagsthe flags to use for the session. Remark: Flag::SerialSession is mandatory
callback_dataapplication-defined pointer to be passed to the notification callback
notify_callbackaddress of the notification callback function

Definition at line 18 of file p11_session.cpp.

19 : m_slot(slot), m_handle(0), m_logged_in(false)
20 {
21 module()->C_OpenSession(m_slot.slot_id(), flags, callback_data, notify_callback, &m_handle);
22 }
bool C_OpenSession(SlotId slot_id, Flags flags, VoidPtr application, Notify notify, SessionHandle *session_ptr, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:236
Module & module() const
Definition: p11_types.h:173
SlotId slot_id() const
Definition: p11_types.h:92

References Botan::PKCS11::LowLevel::C_OpenSession(), Botan::PKCS11::flags(), module(), and Botan::PKCS11::Slot::slot_id().

◆ Session() [3/5]

Botan::PKCS11::Session::Session ( Slot slot,
SessionHandle  handle 
)

Takes ownership of a session.

Definition at line 24 of file p11_session.cpp.

25 : m_slot(slot), m_handle(handle)
26 {
27 SessionInfo info = get_info();
28 if(info.state == static_cast<CK_STATE>(SessionState::RoPublicSession)
29 || info.state == static_cast<CK_STATE>(SessionState::RwPublicSession))
30 {
31 m_logged_in = false;
32 }
33 else
34 {
35 m_logged_in = true;
36 }
37 }
SessionHandle handle() const
Definition: p11_types.h:167
SessionInfo get_info() const
Definition: p11_session.cpp:78
CK_SESSION_INFO SessionInfo
Definition: p11.h:846
CK_ULONG CK_STATE
Definition: pkcs11t.h:271

References get_info(), Botan::PKCS11::RoPublicSession, Botan::PKCS11::RwPublicSession, and CK_SESSION_INFO::state.

◆ Session() [4/5]

Botan::PKCS11::Session::Session ( Session &&  other)
default

◆ Session() [5/5]

Botan::PKCS11::Session::Session ( const Session other)
delete

◆ ~Session()

Botan::PKCS11::Session::~Session ( )
noexcept

Logout user and close the session on destruction.

Definition at line 39 of file p11_session.cpp.

40 {
41 try
42 {
43 if(m_handle)
44 {
45 if(m_logged_in)
46 {
47 module()->C_Logout(m_handle, nullptr);
48 }
49 module()->C_CloseSession(m_handle, nullptr);
50 m_handle = 0;
51 }
52 }
53 catch(...)
54 {
55 // exception during noexcept destructor is ignored
56 }
57 }
bool C_Logout(SessionHandle session, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:296
bool C_CloseSession(SessionHandle session, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:247

References Botan::PKCS11::LowLevel::C_CloseSession(), Botan::PKCS11::LowLevel::C_Logout(), and module().

Member Function Documentation

◆ get_info()

SessionInfo Botan::PKCS11::Session::get_info ( ) const
Returns
information about this session

Definition at line 78 of file p11_session.cpp.

79 {
80 SessionInfo info;
81 module()->C_GetSessionInfo(m_handle, &info);
82 return info;
83 }
bool C_GetSessionInfo(SessionHandle session, SessionInfo *info_ptr, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:259

References Botan::PKCS11::LowLevel::C_GetSessionInfo(), and module().

Referenced by Session().

◆ handle()

SessionHandle Botan::PKCS11::Session::handle ( ) const
inline
Returns
the session handle of this session

Definition at line 167 of file p11_types.h.

168 {
169 return m_handle;
170 }

Referenced by release().

◆ init_pin()

void Botan::PKCS11::Session::init_pin ( const secure_string new_pin)

Calls C_InitPIN to change or initialize the PIN using the SO_PIN (requires a logged in session)

Definition at line 90 of file p11_session.cpp.

91 {
92 module()->C_InitPIN(m_handle, new_pin);
93 }
bool C_InitPIN(SessionHandle session, Utf8Char *pin_ptr, Ulong pin_len, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:215

References Botan::PKCS11::LowLevel::C_InitPIN(), and module().

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

◆ login()

void Botan::PKCS11::Session::login ( UserType  userType,
const secure_string pin 
)

Login to this session

Parameters
userTypethe user type to use for the login
pinthe PIN of the user

Definition at line 66 of file p11_session.cpp.

67 {
68 module()->C_Login(m_handle, user_type, pin);
69 m_logged_in = true;
70 }
bool C_Login(SessionHandle session, UserType user_type, Utf8Char *pin_ptr, Ulong pin_len, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:286

References Botan::PKCS11::LowLevel::C_Login(), and module().

Referenced by Botan::PKCS11::change_pin(), Botan::PKCS11::change_so_pin(), and Botan::PKCS11::set_pin().

◆ logoff()

void Botan::PKCS11::Session::logoff ( )

Logout from this session.

Definition at line 72 of file p11_session.cpp.

73 {
74 module()->C_Logout(m_handle);
75 m_logged_in = false;
76 }

References Botan::PKCS11::LowLevel::C_Logout(), and module().

◆ module()

Module & Botan::PKCS11::Session::module ( ) const
inline
Returns
a reference to the used module

Definition at line 173 of file p11_types.h.

174 {
175 return m_slot.module();
176 }
Module & module() const
Definition: p11_types.h:86

Referenced by get_info(), init_pin(), login(), logoff(), Session(), set_pin(), and ~Session().

◆ operator=() [1/2]

Session & Botan::PKCS11::Session::operator= ( const Session other)
delete

◆ operator=() [2/2]

Session & Botan::PKCS11::Session::operator= ( Session &&  other)
delete

◆ release()

SessionHandle Botan::PKCS11::Session::release ( )
Returns
the released session handle

Definition at line 59 of file p11_session.cpp.

60 {
62 std::swap(handle, m_handle);
63 return handle;
64 }
CK_SESSION_HANDLE SessionHandle
Definition: p11.h:845

References handle().

◆ set_pin()

void Botan::PKCS11::Session::set_pin ( const secure_string old_pin,
const secure_string new_pin 
) const

Calls C_SetPIN to change the PIN using the old PIN (requires a logged in session)

Definition at line 85 of file p11_session.cpp.

86 {
87 module()->C_SetPIN(m_handle, old_pin, new_pin);
88 }
bool C_SetPIN(SessionHandle session, Utf8Char *old_pin_ptr, Ulong old_len, Utf8Char *new_pin_ptr, Ulong new_len, ReturnValue *return_value=ThrowException) const
Definition: p11.cpp:223

References Botan::PKCS11::LowLevel::C_SetPIN(), and module().

Referenced by Botan::PKCS11::change_pin(), and Botan::PKCS11::change_so_pin().

◆ slot()

const Slot & Botan::PKCS11::Session::slot ( ) const
inline
Returns
a reference to the slot

Definition at line 161 of file p11_types.h.

162 {
163 return m_slot;
164 }

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