Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | Protected Member Functions | List of all members
Botan::PKCS11::CertificateProperties Class Reference

Common attributes of all certificate objects. More...

#include <p11_object.h>

Inheritance diagram for Botan::PKCS11::CertificateProperties:
Botan::PKCS11::StorageObjectProperties Botan::PKCS11::ObjectProperties Botan::PKCS11::AttributeContainer

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
 
CertificateType cert_type () const
 
 CertificateProperties (CertificateType cert_type)
 
size_t count () const
 
Attributedata () const
 
ObjectClass object_class () const
 
void set_category (CertificateCategory category)
 
void set_check_value (const std::vector< uint8_t > &checksum)
 
void set_copyable (bool value)
 
void set_destroyable (bool value)
 
void set_end_date (Date date)
 
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_token (bool value)
 
void set_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 More...
 

Detailed Description

Common attributes of all certificate objects.

Definition at line 257 of file p11_object.h.

Constructor & Destructor Documentation

◆ CertificateProperties()

Botan::PKCS11::CertificateProperties::CertificateProperties ( CertificateType  cert_type)
Parameters
cert_typetype of certificate

Definition at line 151 of file p11_object.cpp.

153 {
155 }
void add_numeric(AttributeType attribute, T value)
Definition: p11_object.h:108
CertificateType cert_type() const
Definition: p11_object.h:303
StorageObjectProperties(ObjectClass object_class)
Definition: p11_object.cpp:139
CK_ULONG CK_CERTIFICATE_TYPE
Definition: pkcs11t.h:393

References Botan::PKCS11::AttributeContainer::add_numeric(), Botan::PKCS11::Certificate, and Botan::PKCS11::CertificateType.

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.

46 {
47 bool exists = false;
48 // check if the attribute has been added already
49 for(auto& existing_attribute : m_attributes)
50 {
51 if(existing_attribute.type == static_cast< CK_ATTRIBUTE_TYPE >(attribute))
52 {
53 // remove old entries
54 m_strings.erase(std::remove_if(m_strings.begin(), m_strings.end(), [ &existing_attribute ](const std::string& data)
55 {
56 return data.data() == existing_attribute.pValue;
57 }), m_strings.end());
58
59 m_numerics.erase(std::remove_if(m_numerics.begin(), m_numerics.end(), [ &existing_attribute ](const uint64_t& data)
60 {
61 return &data == existing_attribute.pValue;
62 }), m_numerics.end());
63
64 m_vectors.erase(std::remove_if(m_vectors.begin(),
65 m_vectors.end(), [ &existing_attribute ](const secure_vector<uint8_t>& data)
66 {
67 return data.data() == existing_attribute.pValue;
68 }), m_vectors.end());
69
70 existing_attribute.pValue = const_cast<uint8_t*>(value);
71 existing_attribute.ulValueLen = size;
72 exists = true;
73 break;
74 }
75 }
76
77 if(!exists)
78 {
79 m_attributes.push_back(
80 Attribute {
81 static_cast<CK_ATTRIBUTE_TYPE>(attribute),
82 const_cast<uint8_t*>(value),
83 size }
84 );
85 }
86 }
Attribute * data() const
Definition: p11_object.h:52
CK_ATTRIBUTE Attribute
Definition: p11.h:847
CK_ULONG CK_ATTRIBUTE_TYPE
Definition: pkcs11t.h:416

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
attributeattribute type
binarybinary attribute value to add

Definition at line 90 of file p11_object.h.

91 {
92 add_binary(attribute, binary.data(), binary.size());
93 }
void add_binary(AttributeType attribute, const uint8_t *value, size_t length)
Definition: p11_object.cpp:33

◆ 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
attributeattribute type
valuebinary attribute value to add
lengthsize of the binary attribute value in bytes

Definition at line 33 of file p11_object.cpp.

34 {
35 m_vectors.push_back(secure_vector<uint8_t>(value, value + length));
36 add_attribute(attribute, reinterpret_cast< const uint8_t* >(m_vectors.back().data()), static_cast<Ulong>(length));
37 }
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
Definition: p11_object.cpp:45
CK_ULONG Ulong
Definition: p11.h:838

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
attributeattribute type
valueboolean value to add

Definition at line 39 of file p11_object.cpp.

40 {
41 m_numerics.push_back(value ? True : False);
42 add_attribute(attribute, reinterpret_cast< uint8_t* >(&m_numerics.back()), sizeof(Bbool));
43 }
CK_BBOOL Bbool
Definition: p11.h:836
const Bbool True
Definition: p11.h:857
const Bbool False
Definition: p11.h:858

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_classclass attribute to add

Definition at line 19 of file p11_object.cpp.

20 {
21 m_numerics.emplace_back(static_cast< uint64_t >(object_class));
23 reinterpret_cast< uint8_t* >(&m_numerics.back()),
24 static_cast<Ulong>(sizeof(ObjectClass)));
25 }

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
attributeattribute type
valuenumeric value to add

Definition at line 108 of file p11_object.h.

109 {
110 static_assert(std::is_integral<T>::value, "Numeric value required.");
111 m_numerics.push_back(static_cast< uint64_t >(value));
112 add_attribute(attribute, reinterpret_cast< uint8_t* >(&m_numerics.back()), sizeof(T));
113 }
fe T
Definition: ge.cpp:36

References T.

Referenced by CertificateProperties(), Botan::PKCS11::DomainParameterProperties::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
attributeattribute type
valuestring value to add

Definition at line 27 of file p11_object.cpp.

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

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.

47 {
48 return m_attributes;
49 }

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

◆ cert_type()

CertificateType Botan::PKCS11::CertificateProperties::cert_type ( ) const
inline
Returns
the certificate type of this certificate object

Definition at line 303 of file p11_object.h.

304 {
305 return m_cert_type;
306 }

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

59 {
60 return m_attributes.size();
61 }

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.

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

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

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

176 {
177 return m_object_class;
178 }

◆ set_category()

void Botan::PKCS11::CertificateProperties::set_category ( CertificateCategory  category)
inline
Parameters
categoryone of CertificateCategory

Definition at line 270 of file p11_object.h.

271 {
273 }
CK_ULONG CK_CERTIFICATE_CATEGORY
Definition: pkcs11t.h:1923

References Botan::PKCS11::CertificateCategory.

◆ set_check_value()

void Botan::PKCS11::CertificateProperties::set_check_value ( const std::vector< uint8_t > &  checksum)
inline
Parameters
checksumthe value of this attribute is derived from the certificate by taking the first three bytes of the SHA - 1 hash of the certificate object's CKA_VALUE attribute

Definition at line 279 of file p11_object.h.

References Botan::PKCS11::CheckValue.

◆ set_copyable()

void Botan::PKCS11::StorageObjectProperties::set_copyable ( bool  value)
inlineinherited
Parameters
valueif true the object can be copied using C_CopyObject

Definition at line 219 of file p11_object.h.

220 {
222 }
void add_bool(AttributeType attribute, bool value)
Definition: p11_object.cpp:39

References Botan::PKCS11::Copyable.

◆ set_destroyable()

void Botan::PKCS11::StorageObjectProperties::set_destroyable ( bool  value)
inlineinherited
Parameters
valueif true the object can be destroyed using C_DestroyObject

Definition at line 225 of file p11_object.h.

References Botan::PKCS11::Destroyable.

◆ set_end_date()

void Botan::PKCS11::CertificateProperties::set_end_date ( Date  date)
inline
Parameters
dateend date for the certificate

Definition at line 291 of file p11_object.h.

292 {
293 add_binary(AttributeType::EndDate, reinterpret_cast<uint8_t*>(&date), sizeof(Date));
294 }
CK_DATE Date
Definition: p11.h:853

References Botan::PKCS11::EndDate.

◆ set_label()

void Botan::PKCS11::StorageObjectProperties::set_label ( const std::string &  label)
inlineinherited
Parameters
labeldescription of the object (RFC2279 string)

Definition at line 192 of file p11_object.h.

193 {
195 }
void add_string(AttributeType attribute, const std::string &value)
Definition: p11_object.cpp:27

References Botan::PKCS11::Label.

◆ set_modifiable()

void Botan::PKCS11::StorageObjectProperties::set_modifiable ( bool  value)
inlineinherited
Parameters
valueif true the object can be modified, otherwise it is read-only

Definition at line 213 of file p11_object.h.

References Botan::PKCS11::Modifiable.

◆ set_private()

void Botan::PKCS11::StorageObjectProperties::set_private ( bool  value)
inlineinherited
Parameters
valueif 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.

◆ set_public_key_info()

void Botan::PKCS11::CertificateProperties::set_public_key_info ( const std::vector< uint8_t > &  pubkey_info)
inline
Parameters
pubkey_infoDER-encoding of the SubjectPublicKeyInfo for the public key contained in this certificate

Definition at line 297 of file p11_object.h.

References Botan::PKCS11::PublicKeyInfo.

◆ set_start_date()

void Botan::PKCS11::CertificateProperties::set_start_date ( Date  date)
inline
Parameters
datestart date for the certificate

Definition at line 285 of file p11_object.h.

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

References Botan::PKCS11::StartDate.

◆ set_token()

void Botan::PKCS11::StorageObjectProperties::set_token ( bool  value)
inlineinherited
Parameters
valueif 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.

◆ set_trusted()

void Botan::PKCS11::CertificateProperties::set_trusted ( bool  value)
inline
Parameters
valuethe certificate can be trusted for the application that it was created (can only be set to true by SO user)

Definition at line 264 of file p11_object.h.

References Botan::PKCS11::Trusted.


The documentation for this class was generated from the following files: