Common attributes of domain parameter. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::DomainParameterProperties:

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

	DomainParameterProperties (KeyType key_type)

KeyType	key_type () const

ObjectClass	object_class () const

void	set_copyable (bool value)

void	set_destroyable (bool value)

void	set_label (const std::string &label)

void	set_modifiable (bool value)

void	set_private (bool value)

void	set_token (bool 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` More...

Detailed Description

Common attributes of domain parameter.

Definition at line 614 of file p11_object.h.

Constructor & Destructor Documentation

◆ DomainParameterProperties()

Botan::PKCS11::DomainParameterProperties::DomainParameterProperties ( KeyType key_type )

Parameters

key_type type of key the domain parameters can be used to generate

Definition at line 185 of file p11_object.cpp.

   : StorageObjectProperties(ObjectClass::DomainParameters), m_key_type(key_type)
   {
   add_numeric(AttributeType::KeyType, static_cast< CK_ULONG >(m_key_type));
   }

References Botan::PKCS11::AttributeContainer::add_numeric(), Botan::PKCS11::DomainParameters, and Botan::PKCS11::KeyType.

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 45 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.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 }
         );
      }
   }

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

Referenced by Botan::PKCS11::AttributeContainer::add_binary(), Botan::PKCS11::AttributeContainer::add_bool(), Botan::PKCS11::AttributeContainer::add_class(), and Botan::PKCS11::AttributeContainer::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 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));
   }

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

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

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

◆ add_numeric()

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.

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

References T.

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

◆ add_string()

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

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

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

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::AttributeContainer::add_attribute(), Botan::PKCS11::Object::copy(), and Botan::PKCS11::Object::Object().

◆ key_type()

KeyType Botan::PKCS11::DomainParameterProperties::key_type ( ) const

inline

Returns: the key type

Definition at line 621 of file p11_object.h.

         {
         return m_key_type;
         }

◆ 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 )

inlineinherited

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

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

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

References Botan::PKCS11::Destroyable.

◆ set_label()

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.

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

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

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

References Botan::PKCS11::Modifiable.

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

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

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

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

References Botan::PKCS11::Token.

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

◆ DomainParameterProperties()

Member Function Documentation

◆ add_attribute()

◆ add_binary() [1/2]

◆ add_binary() [2/2]

◆ add_bool()

◆ add_class()

◆ add_numeric()

◆ add_string()

◆ attributes()

◆ count()

◆ data()

◆ key_type()

◆ object_class()

◆ set_copyable()

◆ set_destroyable()

◆ set_label()

◆ set_modifiable()

◆ set_private()

◆ set_token()