Botan::PKCS11::Session Class Reference

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...
Module &	module () const
Session &	operator= (const Session &other)=delete
Session &	operator= (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)
	Calls C_SetPIN to change the PIN using the old PIN (requires a logged in session) More...
const Slot &	slot () 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

slot	the slot to use
read_only	true if the session should be read only, false to create a read-write session

Definition at line 13 of file p11_session.cpp.

   : Session(slot, PKCS11::flags(Flag::SerialSession | (read_only ? Flag::None : Flag::RwSession)), nullptr, nullptr)
   {}

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

slot	the slot to use
flags	the flags to use for the session. Remark: Flag::SerialSession is mandatory
callback_data	application-defined pointer to be passed to the notification callback
notify_callback	address of the notification callback function

Definition at line 17 of file p11_session.cpp.

   : m_slot(slot), m_handle(0), m_logged_in(false)
   {
   module()->C_OpenSession(m_slot.slot_id(), flags, callback_data, notify_callback, &m_handle);
   }

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 23 of file p11_session.cpp.

   : m_slot(slot), m_handle(handle)
   {
   SessionInfo info = get_info();
   if(info.state == static_cast<CK_STATE>(SessionState::RoPublicSession)
         || info.state == static_cast<CK_STATE>(SessionState::RwPublicSession))
      {
      m_logged_in = false;
      }
   else
      {
      m_logged_in = true;
      }
   }

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 38 of file p11_session.cpp.

   {
   try
      {
      if(m_handle)
         {
         if(m_logged_in)
            {
            module()->C_Logout(m_handle, nullptr);
            }
         module()->C_CloseSession(m_handle, nullptr);
         m_handle = 0;
         }
      }
   catch(...)
      {
      // exception during noexcept destructor is ignored
      }
   }

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 77 of file p11_session.cpp.

   {
   SessionInfo info;
   module()->C_GetSessionInfo(m_handle, &info);
   return info;
   }

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.

         {
         return m_handle;
         }

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 89 of file p11_session.cpp.

   {
   module()->C_InitPIN(m_handle, new_pin);
   }

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

userType	the user type to use for the login
pin	the PIN of the user

Definition at line 65 of file p11_session.cpp.

   {
   module()->C_Login(m_handle, user_type, pin);
   m_logged_in = true;
   }

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 71 of file p11_session.cpp.

   {
   module()->C_Logout(m_handle);
   m_logged_in = false;
   }

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.

         {
         return m_slot.module();
         }

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 58 of file p11_session.cpp.

   {
   SessionHandle handle = 0;
   std::swap(handle, m_handle);
   return handle;
   }

References handle().

set_pin()

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

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

Definition at line 84 of file p11_session.cpp.

   {
   module()->C_SetPIN(m_handle, old_pin, new_pin);
   }

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.

         {
         return m_slot;
         }

---

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

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