Botan::PKCS11::PublicKeyProperties Class Reference

Common attributes of all public key objects. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::PublicKeyProperties:

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
KeyType	key_type () const
ObjectClass	object_class () const
	PublicKeyProperties (KeyType key_type)
void	set_allowed_mechanisms (const std::vector< MechanismType > &)
void	set_copyable (bool value)
void	set_derive (bool value)
void	set_destroyable (bool value)
void	set_encrypt (bool value)
void	set_end_date (Date date)
void	set_id (const std::vector< uint8_t > &id)
void	set_label (const std::string &label)
void	set_modifiable (bool value)
void	set_private (bool value)
void	set_public_key_info (const std::vector< uint8_t > &pubkey_info)
void	set_start_date (Date date)
void	set_subject (const std::vector< uint8_t > &subject)
void	set_token (bool value)
void	set_trusted (bool value)
void	set_verify (bool value)
void	set_verify_recover (bool value)
void	set_wrap (bool value)
void	set_wrap_template (const AttributeContainer &)

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 public key objects.

Definition at line 374 of file p11_object.h.

Constructor & Destructor Documentation

PublicKeyProperties()

Botan::PKCS11::PublicKeyProperties::PublicKeyProperties

(

KeyType

key_type

)

Parameters

key_type

type of key

Definition at line 162 of file p11_object.cpp.

References Botan::PKCS11::PublicKey.

   : KeyProperties(ObjectClass::PublicKey, key_type)
   {}

Member Function Documentation

add_attribute()

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

add_binary() [1/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 34 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()), length);
   }

add_binary() [2/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 94 of file p11_object.h.

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

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

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

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

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

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

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

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 28 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()), value.size());
   }

attributes()

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

inlineinherited

Returns

the attributes this container contains

Definition at line 50 of file p11_object.h.

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

         {
         return m_attributes;
         }

count()

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

inlineinherited

Returns

the number of attributes in this container

Definition at line 62 of file p11_object.h.

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

         {
         return m_attributes.size();
         }

data()

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

inlineinherited

Returns

raw attribute data

Definition at line 56 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());
         }

key_type()

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

inlineinherited

Returns

the key type of this key object

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

         {
         return m_object_class;
         }

set_allowed_mechanisms()

void Botan::PKCS11::KeyProperties::set_allowed_mechanisms ( const std::vector< MechanismType > &  )

inlineinherited

Sets a list of mechanisms allowed to be used with this key Not implemented

Definition at line 358 of file p11_object.h.

         {
         throw Exception("Not implemented (KeyProperties::set_allowed_mechanisms)");
         }

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

References Botan::PKCS11::Copyable.

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

set_derive()

void Botan::PKCS11::KeyProperties::set_derive ( bool  value )

inlineinherited

Parameters

value

true if key supports key derivation (i.e., if other keys can be derived from this one)

Definition at line 349 of file p11_object.h.

References Botan::PKCS11::Derive.

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

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

References Botan::PKCS11::Destroyable.

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

set_encrypt()

void Botan::PKCS11::PublicKeyProperties::set_encrypt ( bool  value )

inline

Parameters

value

true if the key supports encryption

Definition at line 387 of file p11_object.h.

References Botan::PKCS11::Encrypt.

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

set_end_date()

void Botan::PKCS11::KeyProperties::set_end_date ( Date  date )

inlineinherited

Parameters

date	end date for the key

Definition at line 343 of file p11_object.h.

References Botan::PKCS11::EndDate.

         {
         add_binary(AttributeType::EndDate, reinterpret_cast<uint8_t*>(&date), sizeof(Date));
         }

set_id()

void Botan::PKCS11::KeyProperties::set_id ( const std::vector< uint8_t > &  id )

inlineinherited

Parameters

id	key identifier for key

Definition at line 331 of file p11_object.h.

References Botan::PKCS11::Id.

         {
         add_binary(AttributeType::Id, id);
         }

set_label()

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

inlineinherited

Parameters

label

description of the object (RFC2279 string)

Definition at line 200 of file p11_object.h.

References Botan::PKCS11::Label.

         {
         add_string(AttributeType::Label, 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 221 of file p11_object.h.

References Botan::PKCS11::Modifiable.

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

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

References Botan::PKCS11::Private.

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

set_public_key_info()

void Botan::PKCS11::PublicKeyProperties::set_public_key_info ( const std::vector< uint8_t > &  pubkey_info )

inline

Parameters

pubkey_info

DER-encoding of the SubjectPublicKeyInfo for this public key

Definition at line 431 of file p11_object.h.

References Botan::PKCS11::PublicKeyInfo.

         {
         add_binary(AttributeType::PublicKeyInfo, pubkey_info);
         }

set_start_date()

void Botan::PKCS11::KeyProperties::set_start_date ( Date  date )

inlineinherited

Parameters

date	start date for the key

Definition at line 337 of file p11_object.h.

References Botan::PKCS11::StartDate.

         {
         add_binary(AttributeType::StartDate, reinterpret_cast<uint8_t*>(&date), sizeof(Date));
         }

set_subject()

void Botan::PKCS11::PublicKeyProperties::set_subject ( const std::vector< uint8_t > &  subject )

inline

Parameters

subject

DER-encoding of the key subject name

Definition at line 381 of file p11_object.h.

References Botan::PKCS11::Subject.

         {
         add_binary(AttributeType::Subject, subject);
         }

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

References Botan::PKCS11::Token.

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

set_trusted()

void Botan::PKCS11::PublicKeyProperties::set_trusted ( bool  value )

inline

Parameters

value

true if the key can be trusted for the application that it was created. The wrapping key can be used to wrap keys with CKA_WRAP_WITH_TRUSTED set to CK_TRUE

Definition at line 414 of file p11_object.h.

References Botan::PKCS11::Trusted.

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

set_verify()

void Botan::PKCS11::PublicKeyProperties::set_verify ( bool  value )

inline

Parameters

value

true if the key supports verification where the signature is an appendix to the data

Definition at line 393 of file p11_object.h.

References Botan::PKCS11::Verify.

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

set_verify_recover()

void Botan::PKCS11::PublicKeyProperties::set_verify_recover ( bool  value )

inline

Parameters

value

true if the key supports verification where the data is recovered from the signature

Definition at line 399 of file p11_object.h.

References Botan::PKCS11::VerifyRecover.

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

set_wrap()

void Botan::PKCS11::PublicKeyProperties::set_wrap ( bool  value )

inline

Parameters

value

true if the key supports wrapping (i.e., can be used to wrap other keys)

Definition at line 405 of file p11_object.h.

References Botan::PKCS11::Wrap.

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

set_wrap_template()

void Botan::PKCS11::PublicKeyProperties::set_wrap_template ( const AttributeContainer &  )

inline

For wrapping keys The attribute template to match against any keys wrapped using this wrapping key. Keys that do not match cannot be wrapped Not implemented

Definition at line 425 of file p11_object.h.

         {
         throw Exception("Not implemented (PublicKeyProperties::set_wrap_template)");
         }

---

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