Botan::PKCS11::SecretKeyProperties Class Reference

Common attributes of all secret (symmetric) keys. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::SecretKeyProperties:

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<std::integral T>
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
KeyType	key_type () const
ObjectClass	object_class () const
BOTAN_FUTURE_EXPLICIT	SecretKeyProperties (KeyType key_type)
void	set_allowed_mechanisms (const std::vector< MechanismType > &)
void	set_always_authenticate (bool value)
void	set_check_value (const std::vector< uint8_t > &checksum)
void	set_copyable (bool value)
void	set_decrypt (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_extractable (bool value)
void	set_id (const std::vector< uint8_t > &id)
void	set_label (std::string_view label)
void	set_modifiable (bool value)
void	set_private (bool value)
void	set_sensitive (bool value)
void	set_sign (bool value)
void	set_start_date (Date date)
void	set_token (bool value)
void	set_trusted (bool value)
void	set_unwrap (bool value)
void	set_unwrap_template (const AttributeContainer &)
void	set_verify (bool value)
void	set_wrap (bool value)
void	set_wrap_template (const AttributeContainer &)
void	set_wrap_with_trusted (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.

Detailed Description

Common attributes of all secret (symmetric) keys.

Definition at line 390 of file p11_object.h.

Constructor & Destructor Documentation

SecretKeyProperties()

Botan::PKCS11::SecretKeyProperties::SecretKeyProperties

(

KeyType

key_type

)

Parameters

key_type

type of key

Definition at line 139 of file p11_object.cpp.

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

References Botan::PKCS11::KeyProperties::key_type(), and Botan::PKCS11::KeyProperties::KeyProperties().

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<std::integral 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 96 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().

key_type()

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

inlineinherited

Returns

the key type of this key object

Definition at line 287 of file p11_object.h.

{ return m_key_type; }

Referenced by KeyProperties(), Botan::PKCS11::PrivateKeyProperties::PrivateKeyProperties(), Botan::PKCS11::PublicKeyProperties::PublicKeyProperties(), and Botan::PKCS11::SecretKeyProperties::SecretKeyProperties().

object_class()

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

inlineinherited

Returns

the object class of this object

Definition at line 156 of file p11_object.h.

{ return m_object_class; }

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

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 TODO(Botan4) remove this

Definition at line 281 of file p11_object.h.

                                            {  // NOLINT(*-convert-member-functions-to-static)
         throw Not_Implemented("KeyProperties::set_allowed_mechanisms");
      }

set_always_authenticate()

void Botan::PKCS11::SecretKeyProperties::set_always_authenticate ( bool value )

inline

Parameters

value

if true, the user has to supply the PIN for each use (sign or decrypt) with the key

Definition at line 420 of file p11_object.h.

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

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

set_check_value()

void Botan::PKCS11::SecretKeyProperties::set_check_value ( const std::vector< uint8_t > & checksum )

inline

Parameters

checksum

the key check value of this key

Definition at line 432 of file p11_object.h.

                                                                      {
         add_binary(AttributeType::CheckValue, checksum);
      }

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

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

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

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

set_decrypt()

void Botan::PKCS11::SecretKeyProperties::set_decrypt ( bool value )

inline

Parameters

value

true if the key supports decryption

Definition at line 402 of file p11_object.h.

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

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

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

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

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

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

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

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

set_encrypt()

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

inline

Parameters

value

true if the key supports encryption

Definition at line 399 of file p11_object.h.

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

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

set_end_date()

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

inlineinherited

Parameters

date	end date for the key

Definition at line 269 of file p11_object.h.

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

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

set_extractable()

void Botan::PKCS11::SecretKeyProperties::set_extractable ( bool value )

inline

Parameters

value

true if the key is extractable and can be wrapped

Definition at line 414 of file p11_object.h.

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

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

set_id()

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

inlineinherited

Parameters

id	key identifier for key

Definition at line 261 of file p11_object.h.

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

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

set_label()

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

inlineinherited

Parameters

label

description of the object (RFC2279 string)

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

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

References Botan::PKCS11::AttributeContainer::add_bool(), and 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 178 of file p11_object.h.

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

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

set_sensitive()

void Botan::PKCS11::SecretKeyProperties::set_sensitive ( bool value )

inline

Parameters

value

true if the key is sensitive

Definition at line 396 of file p11_object.h.

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

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

set_sign()

void Botan::PKCS11::SecretKeyProperties::set_sign ( bool value )

inline

Parameters

value

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

Definition at line 405 of file p11_object.h.

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

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

set_start_date()

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

inlineinherited

Parameters

date	start date for the key

Definition at line 264 of file p11_object.h.

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

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

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

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

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

set_trusted()

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

inline

Parameters

value

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

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

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

set_unwrap()

void Botan::PKCS11::SecretKeyProperties::set_unwrap ( bool value )

inline

Parameters

value

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

Definition at line 411 of file p11_object.h.

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

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

set_unwrap_template()

void Botan::PKCS11::SecretKeyProperties::set_unwrap_template ( const AttributeContainer & )

inline

For wrapping keys The attribute template to apply to any keys unwrapped using this wrapping key Any user supplied template is applied after this template as if the object has already been created Not Implemented TODO(Botan4) remove this function

Definition at line 455 of file p11_object.h.

                                      {  // NOLINT(*-convert-member-functions-to-static)
         throw Not_Implemented("SecretKeyProperties::set_unwrap_template");
      }

set_verify()

void Botan::PKCS11::SecretKeyProperties::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 408 of file p11_object.h.

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

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

set_wrap()

void Botan::PKCS11::SecretKeyProperties::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 423 of file p11_object.h.

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

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

set_wrap_template()

void Botan::PKCS11::SecretKeyProperties::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 TODO(Botan4) remove this function

Definition at line 443 of file p11_object.h.

                                      {  // NOLINT(*-convert-member-functions-to-static)
         throw Not_Implemented("SecretKeyProperties::set_wrap_template");
      }

set_wrap_with_trusted()

void Botan::PKCS11::SecretKeyProperties::set_wrap_with_trusted ( bool value )

inline

Parameters

value

true if the key can only be wrapped with a wrapping key that has CKA_TRUSTED set to CK_TRUE

Definition at line 417 of file p11_object.h.

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

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

---

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