9#ifndef BOTAN_P11_OBJECT_H_
10#define BOTAN_P11_OBJECT_H_
13#include <botan/p11_types.h>
14#include <botan/secmem.h>
54 return const_cast< Attribute*
>(m_attributes.data());
60 return m_attributes.size();
74 void add_string(
AttributeType attribute, std::string_view value);
82 void add_binary(
AttributeType attribute,
const uint8_t* value,
size_t length);
89 template<
typename TAlloc>
92 add_binary(attribute, binary.data(), binary.size());
109 requires std::is_integral<T>::value
111 m_numerics.push_back(
static_cast< uint64_t
>(value));
112 add_attribute(attribute,
reinterpret_cast< uint8_t*
>(&m_numerics.back()),
sizeof(
T));
117 void add_attribute(AttributeType attribute,
const uint8_t* value, Ulong size);
120 std::vector<Attribute> m_attributes;
121 std::list<uint64_t> m_numerics;
122 std::list<std::string> m_strings;
123 std::list<secure_vector<uint8_t>> m_vectors;
159 return m_session.get().module();
163 const std::reference_wrapper<Session> m_session;
164 bool m_search_terminated;
177 return m_object_class;
194 add_string(AttributeType::Label, label);
200 add_bool(AttributeType::Token, value);
209 add_bool(AttributeType::Private, value);
215 add_bool(AttributeType::Modifiable, value);
221 add_bool(AttributeType::Copyable, value);
227 add_bool(AttributeType::Destroyable, value);
240 add_string(AttributeType::Application, value);
246 add_binary(AttributeType::ObjectId, object_id);
252 add_binary(AttributeType::Value, value);
266 add_bool(AttributeType::Trusted, value);
281 add_binary(AttributeType::CheckValue, checksum);
287 add_binary(AttributeType::StartDate,
reinterpret_cast<uint8_t*
>(&date),
sizeof(
Date));
293 add_binary(AttributeType::EndDate,
reinterpret_cast<uint8_t*
>(&date),
sizeof(
Date));
299 add_binary(AttributeType::PublicKeyInfo, pubkey_info);
323 inline void set_id(
const std::vector<uint8_t>&
id)
325 add_binary(AttributeType::Id,
id);
331 add_binary(AttributeType::StartDate,
reinterpret_cast<uint8_t*
>(&date),
sizeof(
Date));
337 add_binary(AttributeType::EndDate,
reinterpret_cast<uint8_t*
>(&date),
sizeof(
Date));
343 add_bool(AttributeType::Derive, value);
375 add_binary(AttributeType::Subject, subject);
381 add_bool(AttributeType::Encrypt, value);
387 add_bool(AttributeType::Verify, value);
393 add_bool(AttributeType::VerifyRecover, value);
399 add_bool(AttributeType::Wrap, value);
408 add_bool(AttributeType::Trusted, value);
425 add_binary(AttributeType::PublicKeyInfo, pubkey_info);
439 add_binary(AttributeType::Subject, subject);
445 add_bool(AttributeType::Sensitive, value);
451 add_bool(AttributeType::Decrypt, value);
457 add_bool(AttributeType::Sign, value);
463 add_bool(AttributeType::SignRecover, value);
469 add_bool(AttributeType::Unwrap, value);
475 add_bool(AttributeType::Extractable, value);
481 add_bool(AttributeType::WrapWithTrusted, value);
487 add_bool(AttributeType::AlwaysAuthenticate, value);
504 add_binary(AttributeType::PublicKeyInfo, pubkey_info);
518 add_bool(AttributeType::Sensitive, value);
524 add_bool(AttributeType::Encrypt, value);
530 add_bool(AttributeType::Decrypt, value);
536 add_bool(AttributeType::Sign, value);
542 add_bool(AttributeType::Verify, value);
548 add_bool(AttributeType::Unwrap, value);
554 add_bool(AttributeType::Extractable, value);
560 add_bool(AttributeType::WrapWithTrusted, value);
566 add_bool(AttributeType::AlwaysAuthenticate, value);
572 add_bool(AttributeType::Wrap, value);
581 add_bool(AttributeType::Trusted, value);
587 add_binary(AttributeType::CheckValue, checksum);
657 static std::vector<T> search(
Session& session,
const std::vector<Attribute>& search_template);
661 static std::vector<T> search(
Session& session, std::string_view label);
665 static std::vector<T> search(
Session& session,
const std::vector<uint8_t>&
id);
669 static std::vector<T> search(
Session& session, std::string_view label,
const std::vector<uint8_t>&
id);
673 static std::vector<T> search(
Session& session);
682 void destroy()
const;
705 return m_session.get().module();
715 throw Invalid_Argument(
"Cannot reset handle on already valid PKCS11 object");
720 const std::reference_wrapper<Session> m_session;
728 std::vector<ObjectHandle> handles = finder.
find();
729 std::vector<T> result;
730 result.reserve(handles.size());
731 for(
const auto&
handle : handles)
Helper class to build the Attribute / CK_ATTRIBUTE structures.
AttributeContainer & operator=(const AttributeContainer &other)=delete
AttributeContainer & operator=(AttributeContainer &&other)=default
virtual ~AttributeContainer()=default
AttributeContainer()=default
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
Common attributes of all certificate objects.
void set_public_key_info(const std::vector< uint8_t > &pubkey_info)
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)
Common attributes of all data objects.
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)
Common attributes of domain parameter.
Common attributes of all key objects.
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 > &)
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
ObjectFinder & operator=(const ObjectFinder &other)=delete
ObjectFinder(ObjectFinder &&other)=default
Common attributes of all objects.
ObjectClass object_class() const
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
Object(const Object &)=default
Common attributes of all private keys.
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)
Common attributes of all public key objects.
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)
Common attributes of all secret (symmetric) keys.
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 &)
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.
Common attributes of all storage objects.
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)
int(* final)(unsigned char *, CTX *)
#define BOTAN_PUBLIC_API(maj, min)
CK_OBJECT_HANDLE ObjectHandle
std::vector< T, secure_allocator< T > > secure_vector
#define CK_INVALID_HANDLE
CK_ULONG CK_CERTIFICATE_CATEGORY