Botan::PKCS11::StorageObjectProperties Class Reference

Common attributes of all storage objects. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::StorageObjectProperties:

Public Member Functions
template<typename TAlloc >
void	add_binary (AttributeType attribute, const std::vector< uint8_t, TAlloc > &binary)
void	add_binary (AttributeType attribute, const uint8_t *value, size_t length)
void	add_bool (AttributeType attribute, bool value)
void	add_class (ObjectClass object_class)
void	add_string (AttributeType attribute, std::string_view value)
const std::vector< Attribute > &	attributes () const
size_t	count () const
Attribute *	data () const
ObjectClass	object_class () const
void	set_copyable (bool value)
void	set_destroyable (bool value)
void	set_label (std::string_view label)
void	set_modifiable (bool value)
void	set_private (bool value)
void	set_token (bool value)
	StorageObjectProperties (ObjectClass object_class)

Detailed Description

Common attributes of all storage objects.

Definition at line 185 of file p11_object.h.

Constructor & Destructor Documentation

StorageObjectProperties()

Botan::PKCS11::StorageObjectProperties::StorageObjectProperties

(

ObjectClass

object_class

)

Parameters

object_class

the CK_OBJECT_CLASS this storage object belongs to

Definition at line 138 of file p11_object.cpp.

   : ObjectProperties(object_class)
   {}

Member Function Documentation

add_binary() [1/2]

template<typename TAlloc >

void Botan::PKCS11::AttributeContainer::add_binary ( AttributeType  attribute, const std::vector< uint8_t, TAlloc > &  binary  )

inlineinherited

Add a binary attribute (e.g. CKA_ID / AttributeType::Id).

Parameters

attribute	attribute type
binary	binary attribute value to add

Definition at line 90 of file p11_object.h.

         {
         add_binary(attribute, binary.data(), binary.size());
         }

add_binary() [2/2]

void Botan::PKCS11::AttributeContainer::add_binary ( AttributeType  attribute, const uint8_t *  value, size_t  length  )

inherited

Add a binary attribute (e.g. CKA_ID / AttributeType::Id).

Parameters

attribute	attribute type
value	binary attribute value to add
length	size of the binary attribute value in bytes

Definition at line 33 of file p11_object.cpp.

   {
   m_vectors.push_back(secure_vector<uint8_t>(value, value + length));
   add_attribute(attribute, reinterpret_cast< const uint8_t* >(m_vectors.back().data()), static_cast<Ulong>(length));
   }

Referenced by Botan::PKCS11::Object::search().

add_bool()

void Botan::PKCS11::AttributeContainer::add_bool ( AttributeType  attribute, bool  value  )

inherited

Add a bool attribute (e.g. CKA_SENSITIVE / AttributeType::Sensitive).

Parameters

attribute	attribute type
value	boolean value to add

Definition at line 39 of file p11_object.cpp.

   {
   m_numerics.push_back(value ? True : False);
   add_attribute(attribute, reinterpret_cast< uint8_t* >(&m_numerics.back()), sizeof(Bbool));
   }

References Botan::PKCS11::False, and Botan::PKCS11::True.

add_class()

void Botan::PKCS11::AttributeContainer::add_class ( ObjectClass  object_class )

inherited

Add a class attribute (CKA_CLASS / AttributeType::Class).

Parameters

object_class

class attribute to add

Definition at line 19 of file p11_object.cpp.

   {
   m_numerics.emplace_back(static_cast< uint64_t >(object_class));
   add_attribute(AttributeType::Class,
                 reinterpret_cast< uint8_t* >(&m_numerics.back()),
                 static_cast<Ulong>(sizeof(ObjectClass)));
   }

References Botan::PKCS11::Class.

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

add_string()

void Botan::PKCS11::AttributeContainer::add_string ( AttributeType  attribute, std::string_view  value  )

inherited

Add a string attribute (e.g. CKA_LABEL / AttributeType::Label).

Parameters

attribute	attribute type
value	string value to add

Definition at line 27 of file p11_object.cpp.

   {
   m_strings.push_back(std::string(value));
   add_attribute(attribute, reinterpret_cast<const uint8_t*>(m_strings.back().data()), static_cast<Ulong>(value.size()));
   }

Referenced by Botan::PKCS11::Object::search().

attributes()

const std::vector< Attribute > & Botan::PKCS11::AttributeContainer::attributes ( ) const

inlineinherited

Returns

the attributes this container contains

Definition at line 46 of file p11_object.h.

         {
         return m_attributes;
         }

Referenced by Botan::PKCS11::Object::search().

count()

size_t Botan::PKCS11::AttributeContainer::count ( ) const

inlineinherited

Returns

the number of attributes in this container

Definition at line 58 of file p11_object.h.

         {
         return m_attributes.size();
         }

Referenced by Botan::PKCS11::Object::copy(), and Botan::PKCS11::Object::Object().

data()

Attribute * Botan::PKCS11::AttributeContainer::data ( ) const

inlineinherited

Returns

raw attribute data

Definition at line 52 of file p11_object.h.

         {
         return const_cast< Attribute* >(m_attributes.data());
         }

Referenced by Botan::PKCS11::Object::copy(), and Botan::PKCS11::Object::Object().

object_class()

ObjectClass Botan::PKCS11::ObjectProperties::object_class ( ) const

inlineinherited

Returns

the object class of this object

Definition at line 175 of file p11_object.h.

         {
         return m_object_class;
         }

set_copyable()

void Botan::PKCS11::StorageObjectProperties::set_copyable ( bool  value )

inline

Parameters

value

if true the object can be copied using C_CopyObject

Definition at line 219 of file p11_object.h.

         {
         add_bool(AttributeType::Copyable, value);
         }

set_destroyable()

void Botan::PKCS11::StorageObjectProperties::set_destroyable ( bool  value )

inline

Parameters

value

if true the object can be destroyed using C_DestroyObject

Definition at line 225 of file p11_object.h.

         {
         add_bool(AttributeType::Destroyable, value);
         }

set_label()

void Botan::PKCS11::StorageObjectProperties::set_label ( std::string_view  label )

inline

Parameters

label

description of the object (RFC2279 string)

Definition at line 192 of file p11_object.h.

         {
         add_string(AttributeType::Label, label);
         }

set_modifiable()

void Botan::PKCS11::StorageObjectProperties::set_modifiable ( bool  value )

inline

Parameters

value

if true the object can be modified, otherwise it is read-only

Definition at line 213 of file p11_object.h.

         {
         add_bool(AttributeType::Modifiable, value);
         }

set_private()

void Botan::PKCS11::StorageObjectProperties::set_private ( bool  value )

inline

Parameters

value

if true the object is a private object; otherwise the object is a public object When private, a user may not access the object until the user has been authenticated to the token

Definition at line 207 of file p11_object.h.

         {
         add_bool(AttributeType::Private, value);
         }

set_token()

void Botan::PKCS11::StorageObjectProperties::set_token ( bool  value )

inline

Parameters

value

if true the object is a token object; otherwise the object is a session object

Definition at line 198 of file p11_object.h.

         {
         add_bool(AttributeType::Token, value);
         }

---

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