Botan 3.9.0
Crypto and TLS for C&
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
Modulemodule () const
 Object (const Object &)=default
 Object (Object &&)=default
 Object (Session &session, const ObjectProperties &obj_props)
 Object (Session &session, ObjectHandle handle)
Objectoperator= (const Object &)=delete
Objectoperator= (Object &&)=delete
Sessionsession () 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 478 of file p11_object.h.

Constructor & Destructor Documentation

◆ Object() [1/5]

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

Creates an Object from an existing PKCS#11 object

Parameters
sessionthe session the object belongs to
handlehandle of the object

Definition at line 150 of file p11_object.cpp.

150: m_session(session), m_handle(handle) {}
ObjectHandle handle() const
Definition p11_object.h:538
Session & session() const
Definition p11_object.h:541

References handle(), and session().

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

◆ Object() [2/5]

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

Creates the object

Parameters
sessionthe session in which the object should be created
obj_propsproperties of this object

Definition at line 152 of file p11_object.cpp.

152 : m_session(session), m_handle(0) {
153 m_session.get().module()->C_CreateObject(
154 m_session.get().handle(), obj_props.data(), static_cast<Ulong>(obj_props.count()), &m_handle);
155}
CK_ULONG Ulong
Definition p11.h:825

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

◆ Object() [3/5]

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

References Object().

◆ Object() [4/5]

Botan::PKCS11::Object::Object ( Object && )
default

References Object().

◆ ~Object()

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

◆ Object() [5/5]

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

Definition at line 547 of file p11_object.h.

547: m_session(session) {}

References session().

Member Function Documentation

◆ copy()

ObjectHandle Botan::PKCS11::Object::copy ( const AttributeContainer & modified_attributes) const

Copies the object

Parameters
modified_attributesthe attributes of the copied object

Definition at line 172 of file p11_object.cpp.

172 {
173 ObjectHandle copied_handle = {};
174 module()->C_CopyObject(m_session.get().handle(),
175 m_handle,
176 modified_attributes.data(),
177 static_cast<Ulong>(modified_attributes.count()),
178 &copied_handle);
179 return copied_handle;
180}
bool C_CopyObject(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ObjectHandle *new_object_ptr, ReturnValue *return_value=ThrowException) const
Definition p11.cpp:252
Module & module() const
Definition p11_object.h:544
CK_OBJECT_HANDLE ObjectHandle
Definition p11.h:835

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

Referenced by ~Object().

◆ destroy()

void Botan::PKCS11::Object::destroy ( ) const

Destroys the object.

Definition at line 168 of file p11_object.cpp.

168 {
169 module()->C_DestroyObject(m_session.get().handle(), m_handle);
170}
bool C_DestroyObject(SessionHandle session, ObjectHandle object, ReturnValue *return_value=ThrowException) const
Definition p11.cpp:262

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

Referenced by ~Object().

◆ 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 157 of file p11_object.cpp.

157 {
158 std::map<AttributeType, secure_vector<uint8_t>> attribute_map = {{attribute, secure_vector<uint8_t>()}};
159 module()->C_GetAttributeValue(m_session.get().handle(), m_handle, attribute_map);
160 return attribute_map.at(attribute);
161}
bool C_GetAttributeValue(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ReturnValue *return_value=ThrowException) const
Definition p11.cpp:273
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:69

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

Referenced by ~Object().

◆ handle()

ObjectHandle Botan::PKCS11::Object::handle ( ) const
inline
Returns
the handle of this object.

Definition at line 538 of file p11_object.h.

538{ return m_handle; }

Referenced by Object(), reset_handle(), and search().

◆ module()

Module & Botan::PKCS11::Object::module ( ) const
inline
Returns
the module this object belongs to

Definition at line 544 of file p11_object.h.

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

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

◆ operator=() [1/2]

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

References Object().

◆ operator=() [2/2]

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

References Object().

◆ reset_handle()

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

Definition at line 549 of file p11_object.h.

549 {
550 if(m_handle != CK_INVALID_HANDLE) {
551 throw Invalid_Argument("Cannot reset handle on already valid PKCS11 object");
552 }
553 m_handle = handle;
554 }
#define CK_INVALID_HANDLE
Definition pkcs11t.h:75

References CK_INVALID_HANDLE, and 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 596 of file p11_object.h.

596 {
597 return search<T>(session, AttributeContainer(T::Class).attributes());
598}
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
Definition p11_object.h:562

References search(), and 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 562 of file p11_object.h.

562 {
563 ObjectFinder finder(session, search_template);
564 std::vector<ObjectHandle> handles = finder.find();
565 std::vector<T> result;
566 result.reserve(handles.size());
567 for(const auto& handle : handles) {
568 result.emplace_back(T(session, handle));
569 }
570 return result;
571}

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

Referenced by search(), search(), search(), search(), and ~Object().

◆ 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 581 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_binary(), Botan::PKCS11::AttributeContainer::attributes(), Botan::PKCS11::Id, search(), 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 574 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_string(), Botan::PKCS11::AttributeContainer::attributes(), Botan::PKCS11::Label, search(), 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 588 of file p11_object.h.

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

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

◆ session()

Session & Botan::PKCS11::Object::session ( ) const
inline
Returns
the session this objects belongs to

Definition at line 541 of file p11_object.h.

541{ return m_session; }

Referenced by Object(), Object(), Object(), search(), search(), search(), search(), search(), and ~Object().

◆ 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 163 of file p11_object.cpp.

163 {
164 std::map<AttributeType, secure_vector<uint8_t>> attribute_map = {{attribute, value}};
165 module()->C_SetAttributeValue(m_session.get().handle(), m_handle, attribute_map);
166}
bool C_SetAttributeValue(SessionHandle session, ObjectHandle object, Attribute *attribute_template_ptr, Ulong count, ReturnValue *return_value=ThrowException) const
Definition p11.cpp:282

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

Referenced by ~Object().


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