Common attributes of all data objects. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::DataObjectProperties:

Public Member Functions
void	add_binary (AttributeType attribute, const uint8_t *value, size_t length)

template<typename TAlloc >
void	add_binary (AttributeType attribute, const std::vector< uint8_t, TAlloc > &binary)

void	add_bool (AttributeType attribute, bool value)

void	add_class (ObjectClass object_class)

template<typename T >
void	add_numeric (AttributeType attribute, T value)

void	add_string (AttributeType attribute, const std::string &value)

const std::vector< Attribute > &	attributes () const

size_t	count () const

Attribute *	data () const

	DataObjectProperties ()

ObjectClass	object_class () const

void	set_application (const std::string &value)

void	set_copyable (bool value)

void	set_destroyable (bool value)

void	set_label (const std::string &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, uint32_t size)
	Add an attribute with the given value and size to the attribute collection `m_attributes` More...

Detailed Description

Common attributes of all data objects.

Definition at line 232 of file p11_object.h.

Constructor & Destructor Documentation

Botan::PKCS11::DataObjectProperties::DataObjectProperties ( )

Definition at line 142 of file p11_object.cpp.

References Botan::PKCS11::Data.

143 : StorageObjectProperties(ObjectClass::Data)

144 {}

Botan::PKCS11::StorageObjectProperties::StorageObjectProperties

StorageObjectProperties(ObjectClass object_class)

Definition: p11_object.cpp:136

Botan::PKCS11::ObjectClass::Data

Member Function Documentation

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

protectedinherited

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

Definition at line 47 of file p11_object.cpp.

References Botan::PKCS11::AttributeContainer::data(), and CK_ATTRIBUTE::pValue.

Referenced by Botan::PKCS11::AttributeContainer::add_binary(), Botan::PKCS11::AttributeContainer::add_bool(), Botan::PKCS11::AttributeContainer::add_class(), and Botan::PKCS11::AttributeContainer::add_string().

    {
    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.erase(std::remove_if(m_strings.begin(), m_strings.end(), [ &existing_attribute ](const std::string& data)
             {
             return data.data() == existing_attribute.pValue;
             }), m_strings.end());
 
          m_numerics.erase(std::remove_if(m_numerics.begin(), m_numerics.end(), [ &existing_attribute ](const uint64_t& data)
             {
             return &data == existing_attribute.pValue;
             }), m_numerics.end());
 
          m_vectors.erase(std::remove_if(m_vectors.begin(),
                                         m_vectors.end(), [ &existing_attribute ](const secure_vector<uint8_t>& data)
             {
             return data.data() == existing_attribute.pValue;
             }), m_vectors.end());
 
          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 });
       }
    }

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

References Botan::PKCS11::AttributeContainer::add_attribute().

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

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

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

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

References Botan::PKCS11::AttributeContainer::add_attribute(), Botan::PKCS11::False, and Botan::PKCS11::True.

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

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

References Botan::PKCS11::AttributeContainer::add_attribute(), and Botan::PKCS11::Class.

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

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

template<typename T >

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

References T.

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

          {
          static_assert(std::is_integral<T>::value, "Numeric value required.");
          m_numerics.push_back(static_cast< uint64_t >(value));
          add_attribute(attribute, reinterpret_cast< uint8_t* >(&m_numerics.back()), sizeof(T));
          }

void Botan::PKCS11::AttributeContainer::add_string	(	AttributeType	attribute,
		const std::string &	value
	)

inherited

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

Parameters

attribute	attribute type
value	string value to add

Definition at line 29 of file p11_object.cpp.

References Botan::PKCS11::AttributeContainer::add_attribute().

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

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

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.

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

          {
          return m_attributes;
          }

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.

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

          {
          return m_attributes.size();
          }

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

inlineinherited

Returns: raw attribute data

Definition at line 52 of file p11_object.h.

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

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

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

void Botan::PKCS11::DataObjectProperties::set_application ( const std::string & value )

inline

Parameters

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

Definition at line 238 of file p11_object.h.

References Botan::PKCS11::Application.

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

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

inlineinherited

Parameters

value if true the object can be copied using C_CopyObject

Definition at line 219 of file p11_object.h.

References Botan::PKCS11::Copyable.

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

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

inlineinherited

Parameters

value if true the object can be destroyed using C_DestroyObject

Definition at line 225 of file p11_object.h.

References Botan::PKCS11::Destroyable.

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

void Botan::PKCS11::StorageObjectProperties::set_label ( const std::string & label )

inlineinherited

Parameters

label description of the object (RFC2279 string)

Definition at line 192 of file p11_object.h.

References Botan::PKCS11::Label.

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

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

References Botan::PKCS11::Modifiable.

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

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

References Botan::PKCS11::ObjectId.

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

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

References Botan::PKCS11::Private.

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

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

References Botan::PKCS11::Token.

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

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

inline

Parameters

value value of the object

Definition at line 250 of file p11_object.h.

References Botan::PKCS11::Value.

          {
          add_binary(AttributeType::Value, 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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation