Botan
2.1.0
Crypto and TLS for C++11
|
Common attributes of all private keys. More...
#include <p11_object.h>
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 |
PrivateKeyProperties (KeyType key_type) | |
void | set_allowed_mechanisms (const std::vector< MechanismType > &) |
void | set_always_authenticate (bool value) |
void | set_copyable (bool value) |
void | set_decrypt (bool value) |
void | set_derive (bool value) |
void | set_destroyable (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 (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_sensitive (bool value) |
void | set_sign (bool value) |
void | set_sign_recover (bool value) |
void | set_start_date (Date date) |
void | set_subject (const std::vector< uint8_t > &subject) |
void | set_token (bool value) |
void | set_unwrap (bool value) |
void | set_unwrap_template (const AttributeContainer &) |
void | set_wrap_with_trusted (bool value) |
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... | |
Common attributes of all private keys.
Definition at line 438 of file p11_object.h.
Botan::PKCS11::PrivateKeyProperties::PrivateKeyProperties | ( | KeyType | key_type | ) |
key_type | type of key |
Definition at line 168 of file p11_object.cpp.
References Botan::PKCS11::PrivateKey.
|
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().
|
inherited |
Add a binary attribute (e.g. CKA_ID / AttributeType::Id).
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().
|
inlineinherited |
Add a binary attribute (e.g. CKA_ID / AttributeType::Id).
attribute | attribute type |
binary | binary attribute value to add |
Definition at line 94 of file p11_object.h.
|
inherited |
Add a bool attribute (e.g. CKA_SENSITIVE / AttributeType::Sensitive).
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.
|
inherited |
Add a class attribute (CKA_CLASS / AttributeType::Class).
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().
|
inlineinherited |
Add a numeric attribute (e.g. CKA_MODULUS_BITS / AttributeType::ModulusBits).
attribute | attribute type |
value | numeric value to add |
Definition at line 112 of file p11_object.h.
Referenced by Botan::PKCS11::CertificateProperties::CertificateProperties(), Botan::PKCS11::DomainParameterProperties::DomainParameterProperties(), and Botan::PKCS11::KeyProperties::KeyProperties().
|
inherited |
Add a string attribute (e.g. CKA_LABEL / AttributeType::Label).
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().
|
inlineinherited |
Definition at line 50 of file p11_object.h.
Referenced by Botan::PKCS11::Object::search().
|
inlineinherited |
Definition at line 62 of file p11_object.h.
Referenced by Botan::PKCS11::Object::copy(), and Botan::PKCS11::Object::Object().
|
inlineinherited |
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().
|
inlineinherited |
Definition at line 364 of file p11_object.h.
|
inlineinherited |
Definition at line 183 of file p11_object.h.
|
inlineinherited |
Sets a list of mechanisms allowed to be used with this key Not implemented
Definition at line 358 of file p11_object.h.
|
inline |
value | If true, the user has to supply the PIN for each use (sign or decrypt) with the key |
Definition at line 493 of file p11_object.h.
References Botan::PKCS11::AlwaysAuthenticate.
|
inlineinherited |
value | if true the object can be copied using C_CopyObject |
Definition at line 227 of file p11_object.h.
References Botan::PKCS11::Copyable.
|
inline |
value | true if the key supports decryption |
Definition at line 457 of file p11_object.h.
References Botan::PKCS11::Decrypt.
|
inlineinherited |
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.
|
inlineinherited |
value | if true the object can be destroyed using C_DestroyObject |
Definition at line 233 of file p11_object.h.
References Botan::PKCS11::Destroyable.
|
inlineinherited |
date | end date for the key |
Definition at line 343 of file p11_object.h.
References Botan::PKCS11::EndDate.
|
inline |
value | true if the key is extractable and can be wrapped |
Definition at line 481 of file p11_object.h.
References Botan::PKCS11::Extractable.
|
inlineinherited |
id | key identifier for key |
Definition at line 331 of file p11_object.h.
References Botan::PKCS11::Id.
|
inlineinherited |
label | description of the object (RFC2279 string) |
Definition at line 200 of file p11_object.h.
References Botan::PKCS11::Label.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inline |
pubkey_info | DER-encoding of the SubjectPublicKeyInfo for this public key |
Definition at line 510 of file p11_object.h.
References Botan::PKCS11::PublicKeyInfo.
|
inline |
value | true if the key is sensitive |
Definition at line 451 of file p11_object.h.
References Botan::PKCS11::Sensitive.
|
inline |
value | true if the key supports signatures where the signature is an appendix to the data |
Definition at line 463 of file p11_object.h.
References Botan::PKCS11::Sign.
|
inline |
value | true if the key supports signatures where the data can be recovered from the signature |
Definition at line 469 of file p11_object.h.
References Botan::PKCS11::SignRecover.
|
inlineinherited |
date | start date for the key |
Definition at line 337 of file p11_object.h.
References Botan::PKCS11::StartDate.
|
inline |
subject | DER-encoding of the key subject name |
Definition at line 445 of file p11_object.h.
References Botan::PKCS11::Subject.
|
inlineinherited |
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.
|
inline |
value | true if the key supports unwrapping (i.e., can be used to unwrap other keys) |
Definition at line 475 of file p11_object.h.
References Botan::PKCS11::Unwrap.
|
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 504 of file p11_object.h.
|
inline |
value | true if the key can only be wrapped with a wrapping key that has CKA_TRUSTED set to CK_TRUE |
Definition at line 487 of file p11_object.h.
References Botan::PKCS11::WrapWithTrusted.