9#ifndef BOTAN_P11_OBJECT_H_
10#define BOTAN_P11_OBJECT_H_
13#include <botan/p11_types.h>
14#include <botan/secmem.h>
44 inline const std::vector<Attribute>&
attributes()
const {
return m_attributes; }
50 inline size_t count()
const {
return m_attributes.size(); }
63 void add_string(
AttributeType attribute, std::string_view value);
71 void add_binary(
AttributeType attribute,
const uint8_t* value,
size_t length);
78 template <
typename TAlloc>
80 add_binary(attribute, binary.data(), binary.size());
96 requires std::is_integral<T>::value
98 m_numerics.push_back(
static_cast<uint64_t
>(value));
99 add_attribute(attribute,
reinterpret_cast<uint8_t*
>(&m_numerics.back()),
sizeof(T));
107 std::vector<Attribute> m_attributes;
108 std::list<uint64_t> m_numerics;
109 std::list<std::string> m_strings;
110 std::list<secure_vector<uint8_t>> m_vectors;
146 const std::reference_wrapper<Session> m_session;
147 bool m_search_terminated;
490 template <
typename T>
494 template <
typename T>
498 template <
typename T>
502 template <
typename T>
503 static std::vector<T>
search(
Session&
session, std::string_view label,
const std::vector<uint8_t>&
id);
506 template <
typename T>
538 throw Invalid_Argument(
"Cannot reset handle on already valid PKCS11 object");
544 const std::reference_wrapper<Session> m_session;
551 std::vector<ObjectHandle> handles = finder.
find();
552 std::vector<T> result;
553 result.reserve(handles.size());
554 for(
const auto&
handle : handles) {
#define BOTAN_PUBLIC_API(maj, min)
Helper class to build the Attribute / CK_ATTRIBUTE structures.
void add_numeric(AttributeType attribute, T value)
AttributeContainer & operator=(const AttributeContainer &other)=delete
AttributeContainer & operator=(AttributeContainer &&other)=default
virtual ~AttributeContainer()=default
AttributeContainer()=default
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
void add_bool(AttributeType attribute, bool value)
AttributeContainer(AttributeContainer &&other)=default
const std::vector< Attribute > & attributes() const
void add_binary(AttributeType attribute, const std::vector< uint8_t, TAlloc > &binary)
void add_string(AttributeType attribute, std::string_view value)
void add_binary(AttributeType attribute, const uint8_t *value, size_t length)
AttributeContainer(const AttributeContainer &other)=delete
void set_public_key_info(const std::vector< uint8_t > &pubkey_info)
CertificateProperties(CertificateType cert_type)
void set_check_value(const std::vector< uint8_t > &checksum)
void set_start_date(Date date)
void set_end_date(Date date)
void set_trusted(bool value)
CertificateType cert_type() const
void set_category(CertificateCategory category)
void set_application(std::string_view value)
void set_value(const secure_vector< uint8_t > &value)
void set_object_id(const std::vector< uint8_t > &object_id)
DomainParameterProperties(KeyType key_type)
void set_derive(bool value)
void set_id(const std::vector< uint8_t > &id)
void set_start_date(Date date)
void set_end_date(Date date)
void set_allowed_mechanisms(const std::vector< MechanismType > &)
KeyProperties(ObjectClass object_class, KeyType key_type)
Manages calls to C_FindObjects* functions (C_FindObjectsInit -> C_FindObjects -> C_FindObjectsFinal)
ObjectFinder(const ObjectFinder &other)=default
std::vector< ObjectHandle > find(std::uint32_t max_count=100) const
ObjectFinder & operator=(ObjectFinder &&other)=delete
void finish()
Finishes the search operation manually to allow a new ObjectFinder to exist.
ObjectFinder & operator=(const ObjectFinder &other)=delete
ObjectFinder(ObjectFinder &&other)=default
ObjectFinder(Session &session, const std::vector< Attribute > &search_template)
Common attributes of all objects.
ObjectClass object_class() const
ObjectProperties(ObjectClass object_class)
void reset_handle(ObjectHandle handle)
static std::vector< T > search(Session &session, const std::vector< Attribute > &search_template)
Searches for all objects of the given type that match search_template
Object & operator=(const Object &)=delete
ObjectHandle handle() const
virtual ~Object()=default
Session & session() const
secure_vector< uint8_t > get_attribute_value(AttributeType attribute) const
void destroy() const
Destroys the object.
Object(Session &session, ObjectHandle handle)
void set_attribute_value(AttributeType attribute, const secure_vector< uint8_t > &value) const
Sets the given value for the attribute (using C_SetAttributeValue)
Object(const Object &)=default
ObjectHandle copy(const AttributeContainer &modified_attributes) const
PrivateKeyProperties(KeyType key_type)
void set_decrypt(bool value)
void set_unwrap(bool value)
void set_extractable(bool value)
void set_sign_recover(bool value)
void set_subject(const std::vector< uint8_t > &subject)
void set_always_authenticate(bool value)
void set_wrap_with_trusted(bool value)
void set_sign(bool value)
void set_unwrap_template(const AttributeContainer &)
void set_public_key_info(const std::vector< uint8_t > &pubkey_info)
void set_sensitive(bool value)
PublicKeyProperties(KeyType key_type)
void set_public_key_info(const std::vector< uint8_t > &pubkey_info)
void set_verify(bool value)
void set_wrap(bool value)
void set_subject(const std::vector< uint8_t > &subject)
void set_trusted(bool value)
void set_verify_recover(bool value)
void set_wrap_template(const AttributeContainer &)
void set_encrypt(bool value)
void set_check_value(const std::vector< uint8_t > &checksum)
void set_sensitive(bool value)
void set_encrypt(bool value)
void set_unwrap_template(const AttributeContainer &)
void set_decrypt(bool value)
void set_wrap_template(const AttributeContainer &)
SecretKeyProperties(KeyType key_type)
void set_wrap_with_trusted(bool value)
void set_sign(bool value)
void set_wrap(bool value)
void set_trusted(bool value)
void set_extractable(bool value)
void set_unwrap(bool value)
void set_verify(bool value)
void set_always_authenticate(bool value)
Represents a PKCS#11 session.
void set_modifiable(bool value)
void set_private(bool value)
void set_copyable(bool value)
void set_token(bool value)
void set_destroyable(bool value)
void set_label(std::string_view label)
StorageObjectProperties(ObjectClass object_class)
CK_OBJECT_HANDLE ObjectHandle
std::vector< T, secure_allocator< T > > secure_vector
#define CK_INVALID_HANDLE
CK_ULONG CK_CERTIFICATE_CATEGORY