Botan::PKCS11::Object Class Reference

#include <p11_object.h>

Public Member Functions
ObjectHandle	copy (const AttributeContainer &modified_attributes) const
void	destroy () const
	Destroys the object.
secure_vector< uint8_t >	get_attribute_value (AttributeType attribute) const
ObjectHandle	handle () const
Module &	module () const
	Object (const Object &)=default
	Object (Session &session, const ObjectProperties &obj_props)
	Object (Session &session, ObjectHandle handle)
Object &	operator= (const Object &)=delete
Session &	session () const
void	set_attribute_value (AttributeType attribute, const secure_vector< uint8_t > &value) const
	Sets the given value for the attribute (using C_SetAttributeValue)
virtual	~Object ()=default

Static Public Member Functions
template<typename T >
static std::vector< T >	search (Session &session)
	Searches for all objects of the given type.
template<typename T >
static std::vector< T >	search (Session &session, const std::vector< Attribute > &search_template)
	Searches for all objects of the given type that match search_template
template<typename T >
static std::vector< T >	search (Session &session, const std::vector< uint8_t > &id)
	Searches for all objects of the given type using the id (CKA_ID)
template<typename T >
static std::vector< T >	search (Session &session, std::string_view label)
	Searches for all objects of the given type using the label (CKA_LABEL)
template<typename T >
static std::vector< T >	search (Session &session, std::string_view label, const std::vector< uint8_t > &id)
	Searches for all objects of the given type using the label (CKA_LABEL) and id (CKA_ID)

Protected Member Functions
	Object (Session &session)
void	reset_handle (ObjectHandle handle)

Detailed Description

Represents a PKCS#11 object.

Definition at line 633 of file p11_object.h.

Constructor & Destructor Documentation

Object() [1/4]

Botan::PKCS11::Object::Object	(	Session &	session,
		ObjectHandle	handle
	)

Creates an Object from an existing PKCS#11 object

Parameters

session	the session the object belongs to
handle	handle of the object

Definition at line 192 of file p11_object.cpp.

   : m_session(session), m_handle(handle)
   {}

Object() [2/4]

Botan::PKCS11::Object::Object	(	Session &	session,
		const ObjectProperties &	obj_props
	)

Creates the object

Parameters

session	the session in which the object should be created
obj_props	properties of this object

Definition at line 196 of file p11_object.cpp.

   : m_session(session), m_handle(0)
   {
   m_session.get().module()->C_CreateObject(m_session.get().handle(), obj_props.data(), static_cast<Ulong>(obj_props.count()), &m_handle);
   }

References Botan::PKCS11::AttributeContainer::count(), and Botan::PKCS11::AttributeContainer::data().

Object() [3/4]

Botan::PKCS11::Object::Object ( const Object &  )

default

~Object()

virtual Botan::PKCS11::Object::~Object ( )

virtualdefault

Object() [4/4]

Botan::PKCS11::Object::Object ( Session &  session )

inlineprotected

Definition at line 708 of file p11_object.h.

         : m_session(session)
         {}

Member Function Documentation

copy()

ObjectHandle Botan::PKCS11::Object::copy

(

const AttributeContainer &

modified_attributes

)

const

Copies the object

Parameters

modified_attributes

the attributes of the copied object

Definition at line 220 of file p11_object.cpp.

   {
   ObjectHandle copied_handle;
   module()->C_CopyObject(m_session.get().handle(), m_handle,
                          modified_attributes.data(), static_cast<Ulong>(modified_attributes.count()),
                          &copied_handle);
   return copied_handle;
   }

References Botan::PKCS11::LowLevel::C_CopyObject(), Botan::PKCS11::AttributeContainer::count(), Botan::PKCS11::AttributeContainer::data(), and module().

destroy()

void Botan::PKCS11::Object::destroy

(

)

const

Destroys the object.

Definition at line 215 of file p11_object.cpp.

   {
   module()->C_DestroyObject(m_session.get().handle(), m_handle);
   }

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

get_attribute_value()

secure_vector< uint8_t > Botan::PKCS11::Object::get_attribute_value

(

AttributeType

attribute

)

const

Returns

the value of the given attribute (using C_GetAttributeValue)

Definition at line 202 of file p11_object.cpp.

   {
   std::map<AttributeType, secure_vector<uint8_t>> attribute_map = { { attribute, secure_vector<uint8_t>() } };
   module()->C_GetAttributeValue(m_session.get().handle(), m_handle, attribute_map);
   return attribute_map.at(attribute);
   }

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

handle()

ObjectHandle Botan::PKCS11::Object::handle ( ) const

inline

Returns

the handle of this object.

Definition at line 691 of file p11_object.h.

         {
         return m_handle;
         }

Referenced by search().

module()

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

inline

Returns

the module this object belongs to

Definition at line 703 of file p11_object.h.

         {
         return m_session.get().module();
         }

Referenced by copy(), destroy(), get_attribute_value(), and set_attribute_value().

operator=()

Object & Botan::PKCS11::Object::operator= ( const Object &  )

delete

reset_handle()

void Botan::PKCS11::Object::reset_handle ( ObjectHandle  handle )

inlineprotected

Definition at line 712 of file p11_object.h.

         {
         if(m_handle != CK_INVALID_HANDLE)
            throw Invalid_Argument("Cannot reset handle on already valid PKCS11 object");
         m_handle = handle;
         }

References CK_INVALID_HANDLE.

search() [1/5]

template<typename T >

std::vector< T > Botan::PKCS11::Object::search ( Session &  session )

static

Searches for all objects of the given type.

Definition at line 764 of file p11_object.h.

   {
   return search<T>(session, AttributeContainer(T::Class).attributes());
   }

References session().

search() [2/5]

template<typename T >

std::vector< T > Botan::PKCS11::Object::search ( Session &  session, const std::vector< Attribute > &  search_template  )

static

Searches for all objects of the given type that match search_template

Definition at line 725 of file p11_object.h.

   {
   ObjectFinder finder(session, search_template);
   std::vector<ObjectHandle> handles = finder.find();
   std::vector<T> result;
   result.reserve(handles.size());
   for(const auto& handle : handles)
      {
      result.emplace_back(T(session, handle));
      }
   return result;
   }

References Botan::PKCS11::ObjectFinder::find(), handle(), session(), and T.

search() [3/5]

template<typename T >

std::vector< T > Botan::PKCS11::Object::search ( Session &  session, const std::vector< uint8_t > &  id  )

static

Searches for all objects of the given type using the id (CKA_ID)

Definition at line 747 of file p11_object.h.

   {
   AttributeContainer search_template(T::Class);
   search_template.add_binary(AttributeType::Id, id);
   return search<T>(session, search_template.attributes());
   }

References Botan::PKCS11::AttributeContainer::add_binary(), Botan::PKCS11::AttributeContainer::attributes(), Botan::PKCS11::Id, and session().

search() [4/5]

template<typename T >

std::vector< T > Botan::PKCS11::Object::search ( Session &  session, std::string_view  label  )

static

Searches for all objects of the given type using the label (CKA_LABEL)

Definition at line 739 of file p11_object.h.

   {
   AttributeContainer search_template(T::Class);
   search_template.add_string(AttributeType::Label, label);
   return search<T>(session, search_template.attributes());
   }

References Botan::PKCS11::AttributeContainer::add_string(), Botan::PKCS11::AttributeContainer::attributes(), Botan::PKCS11::Label, and session().

search() [5/5]

template<typename T >

std::vector< T > Botan::PKCS11::Object::search ( Session &  session, std::string_view  label, const std::vector< uint8_t > &  id  )

static

Searches for all objects of the given type using the label (CKA_LABEL) and id (CKA_ID)

Definition at line 755 of file p11_object.h.

   {
   AttributeContainer search_template(T::Class);
   search_template.add_string(AttributeType::Label, label);
   search_template.add_binary(AttributeType::Id, id);
   return search<T>(session, search_template.attributes());
   }

References Botan::PKCS11::AttributeContainer::add_binary(), Botan::PKCS11::AttributeContainer::add_string(), Botan::PKCS11::AttributeContainer::attributes(), Botan::PKCS11::Id, Botan::PKCS11::Label, and session().

session()

Session & Botan::PKCS11::Object::session ( ) const

inline

Returns

the session this objects belongs to

Definition at line 697 of file p11_object.h.

         {
         return m_session;
         }

Referenced by search().

set_attribute_value()

void Botan::PKCS11::Object::set_attribute_value	(	AttributeType	attribute,
		const secure_vector< uint8_t > &	value
	)		const

Sets the given value for the attribute (using C_SetAttributeValue)

Definition at line 209 of file p11_object.cpp.

   {
   std::map<AttributeType, secure_vector<uint8_t>> attribute_map = { { attribute, value } };
   module()->C_SetAttributeValue(m_session.get().handle(), m_handle, attribute_map);
   }

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

---

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

• src/lib/prov/pkcs11/p11_object.h
• src/lib/prov/pkcs11/p11_object.cpp