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)

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

	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)

Detailed Description

Common attributes of all secret (symmetric) keys.

Definition at line 386 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.

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

Botan::PKCS11::KeyProperties::KeyProperties

KeyProperties(ObjectClass object_class, KeyType key_type)

Definition p11_object.cpp:124

Botan::PKCS11::KeyProperties::key_type

KeyType key_type() const

Definition p11_object.h:287

Botan::PKCS11::ObjectClass::SecretKey

@ SecretKey

Member Function Documentation

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

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

Referenced by Botan::PKCS11::Object::search(), and 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 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 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 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 Botan::PKCS11::Class.

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

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

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

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

44{ 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.

50{ 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.

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

Botan::PKCS11::Attribute

CK_ATTRIBUTE Attribute

Definition p11.h:823

Referenced by 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.

287{ return m_key_type; }

◆ object_class()

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

inlineinherited

Returns: the object class of this object

Definition at line 158 of file p11_object.h.

158{ 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 282 of file p11_object.h.

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

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

Botan::PKCS11::AttributeContainer::add_bool

void add_bool(AttributeType attribute, bool value)

Definition p11_object.cpp:35

Botan::PKCS11::AttributeType::AlwaysAuthenticate

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

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

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

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

Botan::PKCS11::AttributeType::Copyable

@ Copyable

◆ set_decrypt()

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

inline

Parameters

value true if the key supports decryption

Definition at line 398 of file p11_object.h.

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

Botan::PKCS11::AttributeType::Decrypt

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

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

Botan::PKCS11::AttributeType::Derive

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

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

Botan::PKCS11::AttributeType::Destroyable

@ Destroyable

◆ set_encrypt()

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

inline

Parameters

value true if the key supports encryption

Definition at line 395 of file p11_object.h.

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

Botan::PKCS11::AttributeType::Encrypt

@ Encrypt

◆ set_end_date()

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

inlineinherited

Parameters

date	end date for the key

Definition at line 271 of file p11_object.h.

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

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

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

Botan::PKCS11::AttributeType::Extractable

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

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

Botan::PKCS11::AttributeType::Id

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

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

Botan::PKCS11::AttributeContainer::add_string

void add_string(AttributeType attribute, std::string_view value)

Definition p11_object.cpp:24

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

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

Botan::PKCS11::AttributeType::Modifiable

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

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

Botan::PKCS11::AttributeType::Private

@ Private

◆ set_sensitive()

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

inline

Parameters

value true if the key is sensitive

Definition at line 392 of file p11_object.h.

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

Botan::PKCS11::AttributeType::Sensitive

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

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

Botan::PKCS11::AttributeType::Sign

@ Sign

◆ set_start_date()

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

inlineinherited

Parameters

date	start date for the key

Definition at line 266 of file p11_object.h.

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

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

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

Botan::PKCS11::AttributeType::Token

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

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

Botan::PKCS11::AttributeType::Trusted

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

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

Botan::PKCS11::AttributeType::Unwrap

@ 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

Definition at line 448 of file p11_object.h.

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

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

Botan::PKCS11::AttributeType::Verify

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

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

Botan::PKCS11::AttributeType::Wrap

@ 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

Definition at line 438 of file p11_object.h.

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

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

Botan::PKCS11::AttributeType::WrapWithTrusted

@ 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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SecretKeyProperties()

Member Function Documentation

◆ add_binary() [1/2]

◆ add_binary() [2/2]

◆ add_bool()

◆ add_class()

◆ add_string()

◆ attributes()

◆ count()

◆ data()

◆ key_type()

◆ object_class()

◆ set_allowed_mechanisms()

◆ set_always_authenticate()

◆ set_check_value()

◆ set_copyable()

◆ set_decrypt()

◆ set_derive()

◆ set_destroyable()

◆ set_encrypt()

◆ set_end_date()

◆ set_extractable()

◆ set_id()

◆ set_label()

◆ set_modifiable()

◆ set_private()

◆ set_sensitive()

◆ set_sign()

◆ set_start_date()

◆ set_token()

◆ set_trusted()

◆ set_unwrap()

◆ set_unwrap_template()

◆ set_verify()

◆ set_wrap()

◆ set_wrap_template()

◆ set_wrap_with_trusted()