Botan::PKCS11::DataObjectProperties Class Reference

Common attributes of all data objects. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::DataObjectProperties:

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)
template<typename T> requires std::is_integral<T>::value
void	add_numeric (AttributeType attribute, T value)
void	add_string (AttributeType attribute, std::string_view value)
const std::vector< Attribute > &	attributes () const
size_t	count () const
Attribute *	data () const
	DataObjectProperties ()
ObjectClass	object_class () const
void	set_application (std::string_view value)
void	set_copyable (bool value)
void	set_destroyable (bool value)
void	set_label (std::string_view label)
void	set_modifiable (bool value)
void	set_object_id (const std::vector< uint8_t > &object_id)
void	set_private (bool value)
void	set_token (bool value)
void	set_value (const secure_vector< uint8_t > &value)

Protected Member Functions
void	add_attribute (AttributeType attribute, const uint8_t *value, Ulong size)
	Add an attribute with the given value and size to the attribute collection m_attributes

Detailed Description

Common attributes of all data objects.

Definition at line 192 of file p11_object.h.

Constructor & Destructor Documentation

DataObjectProperties()

Botan::PKCS11::DataObjectProperties::DataObjectProperties

(

)

Definition at line 113 of file p11_object.cpp.

: StorageObjectProperties(ObjectClass::Data) {}

References Botan::PKCS11::Data, and Botan::PKCS11::StorageObjectProperties::StorageObjectProperties().

Member Function Documentation

add_attribute()

void Botan::PKCS11::AttributeContainer::add_attribute ( AttributeType attribute, const uint8_t * value, Ulong size )

protectedinherited

Add an attribute with the given value and size to the attribute collection m_attributes

Definition at line 40 of file p11_object.cpp.

                                                                                                {
   bool exists = false;
   // check if the attribute has been added already
   for(auto& existing_attribute : m_attributes) {
      if(existing_attribute.type == static_cast<CK_ATTRIBUTE_TYPE>(attribute)) {
         // remove old entries
         m_strings.remove_if(
            [&existing_attribute](std::string_view data) { return data.data() == existing_attribute.pValue; });
 
         m_numerics.remove_if(
            [&existing_attribute](const uint64_t& data) { return &data == existing_attribute.pValue; });
 
         m_vectors.remove_if([&existing_attribute](const secure_vector<uint8_t>& data) {
            return data.data() == existing_attribute.pValue;
         });
 
         existing_attribute.pValue = const_cast<uint8_t*>(value);
         existing_attribute.ulValueLen = size;
         exists = true;
         break;
      }
   }
 
   if(!exists) {
      m_attributes.push_back(Attribute{static_cast<CK_ATTRIBUTE_TYPE>(attribute), const_cast<uint8_t*>(value), size});
   }
}

References data().

Referenced by add_binary(), add_bool(), add_class(), add_numeric(), and add_string().

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

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

References add_binary().

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 30 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));
}

References add_attribute().

Referenced by add_binary(), Botan::PKCS11::Object::search(), Botan::PKCS11::Object::search(), Botan::PKCS11::CertificateProperties::set_check_value(), Botan::PKCS11::SecretKeyProperties::set_check_value(), Botan::PKCS11::CertificateProperties::set_end_date(), Botan::PKCS11::KeyProperties::set_end_date(), Botan::PKCS11::KeyProperties::set_id(), Botan::PKCS11::DataObjectProperties::set_object_id(), Botan::PKCS11::CertificateProperties::set_public_key_info(), Botan::PKCS11::PrivateKeyProperties::set_public_key_info(), Botan::PKCS11::PublicKeyProperties::set_public_key_info(), Botan::PKCS11::CertificateProperties::set_start_date(), Botan::PKCS11::KeyProperties::set_start_date(), Botan::PKCS11::PrivateKeyProperties::set_subject(), Botan::PKCS11::PublicKeyProperties::set_subject(), and Botan::PKCS11::DataObjectProperties::set_value().

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 35 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 add_attribute(), Botan::PKCS11::False, and Botan::PKCS11::True.

Referenced by Botan::PKCS11::PrivateKeyProperties::set_always_authenticate(), Botan::PKCS11::SecretKeyProperties::set_always_authenticate(), Botan::PKCS11::StorageObjectProperties::set_copyable(), Botan::PKCS11::PrivateKeyProperties::set_decrypt(), Botan::PKCS11::SecretKeyProperties::set_decrypt(), Botan::PKCS11::KeyProperties::set_derive(), Botan::PKCS11::StorageObjectProperties::set_destroyable(), Botan::PKCS11::PublicKeyProperties::set_encrypt(), Botan::PKCS11::SecretKeyProperties::set_encrypt(), Botan::PKCS11::PrivateKeyProperties::set_extractable(), Botan::PKCS11::SecretKeyProperties::set_extractable(), Botan::PKCS11::StorageObjectProperties::set_modifiable(), Botan::PKCS11::StorageObjectProperties::set_private(), Botan::PKCS11::PrivateKeyProperties::set_sensitive(), Botan::PKCS11::SecretKeyProperties::set_sensitive(), Botan::PKCS11::PrivateKeyProperties::set_sign(), Botan::PKCS11::SecretKeyProperties::set_sign(), Botan::PKCS11::PrivateKeyProperties::set_sign_recover(), Botan::PKCS11::StorageObjectProperties::set_token(), Botan::PKCS11::CertificateProperties::set_trusted(), Botan::PKCS11::PublicKeyProperties::set_trusted(), Botan::PKCS11::SecretKeyProperties::set_trusted(), Botan::PKCS11::PrivateKeyProperties::set_unwrap(), Botan::PKCS11::SecretKeyProperties::set_unwrap(), Botan::PKCS11::PublicKeyProperties::set_verify(), Botan::PKCS11::SecretKeyProperties::set_verify(), Botan::PKCS11::PublicKeyProperties::set_verify_recover(), Botan::PKCS11::PublicKeyProperties::set_wrap(), Botan::PKCS11::SecretKeyProperties::set_wrap(), Botan::PKCS11::PrivateKeyProperties::set_wrap_with_trusted(), and Botan::PKCS11::SecretKeyProperties::set_wrap_with_trusted().

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 18 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 add_attribute(), and Botan::PKCS11::Class.

Referenced by AttributeContainer().

add_numeric()

template<typename T>
requires std::is_integral<T>::value

void Botan::PKCS11::AttributeContainer::add_numeric ( AttributeType attribute, T value )

inlineinherited

Add a numeric attribute (e.g. CKA_MODULUS_BITS / AttributeType::ModulusBits).

Parameters

attribute	attribute type
value	numeric value to add

Definition at line 97 of file p11_object.h.

                                                         {
         m_numerics.push_back(static_cast<uint64_t>(value));
         add_attribute(attribute, reinterpret_cast<uint8_t*>(&m_numerics.back()), sizeof(T));
      }

References add_attribute().

Referenced by Botan::PKCS11::CertificateProperties::CertificateProperties(), Botan::PKCS11::DomainParameterProperties::DomainParameterProperties(), Botan::PKCS11::KeyProperties::KeyProperties(), and Botan::PKCS11::CertificateProperties::set_category().

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 24 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()));
}

References add_attribute().

Referenced by Botan::PKCS11::Object::search(), Botan::PKCS11::Object::search(), Botan::PKCS11::DataObjectProperties::set_application(), and Botan::PKCS11::StorageObjectProperties::set_label().

attributes()

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

inlineinherited

Returns

the attributes this container contains

Definition at line 44 of file p11_object.h.

{ return m_attributes; }

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

count()

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

inlineinherited

Returns

the number of attributes in this container

Definition at line 50 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 47 of file p11_object.h.

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

Referenced by add_attribute(), 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 157 of file p11_object.h.

{ return m_object_class; }

Referenced by Botan::PKCS11::KeyProperties::KeyProperties(), ObjectProperties(), and Botan::PKCS11::StorageObjectProperties::StorageObjectProperties().

set_application()

void Botan::PKCS11::DataObjectProperties::set_application ( std::string_view value )

inline

Parameters

value

description of the application that manages the object (RFC2279 string)

Definition at line 197 of file p11_object.h.

{ add_string(AttributeType::Application, value); }

References Botan::PKCS11::AttributeContainer::add_string(), and Botan::PKCS11::Application.

set_copyable()

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

inlineinherited

Parameters

value

if true the object can be copied using C_CopyObject

Definition at line 185 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_bool(), and Botan::PKCS11::Copyable.

set_destroyable()

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

inlineinherited

Parameters

value

if true the object can be destroyed using C_DestroyObject

Definition at line 188 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_bool(), and Botan::PKCS11::Destroyable.

set_label()

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

inlineinherited

Parameters

label

description of the object (RFC2279 string)

Definition at line 170 of file p11_object.h.

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

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

set_modifiable()

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

inlineinherited

Parameters

value

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

Definition at line 182 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_bool(), and Botan::PKCS11::Modifiable.

set_object_id()

void Botan::PKCS11::DataObjectProperties::set_object_id ( const std::vector< uint8_t > & object_id )

inline

Parameters

object_id

DER-encoding of the object identifier indicating the data object type

Definition at line 200 of file p11_object.h.

                                                                     {
         add_binary(AttributeType::ObjectId, object_id);
      }

References Botan::PKCS11::AttributeContainer::add_binary(), and Botan::PKCS11::ObjectId.

set_private()

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

inlineinherited

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

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

References Botan::PKCS11::AttributeContainer::add_bool(), and Botan::PKCS11::Private.

set_token()

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

inlineinherited

Parameters

value

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

Definition at line 173 of file p11_object.h.

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

References Botan::PKCS11::AttributeContainer::add_bool(), and Botan::PKCS11::Token.

set_value()

void Botan::PKCS11::DataObjectProperties::set_value ( const secure_vector< uint8_t > & value )

inline

Parameters

value

value of the object

Definition at line 205 of file p11_object.h.

{ add_binary(AttributeType::Value, value); }

References Botan::PKCS11::AttributeContainer::add_binary(), and Botan::PKCS11::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