7#ifndef BOTAN_PK_OPTIONS_READERS_H_
8#define BOTAN_PK_OPTIONS_READERS_H_
10#include <botan/pk_options.h>
47 std::string
to_string()
const {
return m_options.to_string(); }
52 const std::string& hash_function_name()
const;
55 note_examined(Option::Hash);
56 return m_options.m_hash_fn;
60 note_examined(Option::Prehash);
61 return m_options.m_prehash;
65 note_examined(Option::ExternalPrehash);
66 return m_options.m_external_prehash;
69 const std::optional<std::string>&
padding()
const {
70 note_examined(Option::Padding);
71 return m_options.m_padding;
74 const std::optional<std::vector<uint8_t>>&
context()
const {
75 note_examined(Option::Context);
76 return m_options.m_context;
79 const std::optional<std::string>&
provider()
const {
80 note_examined(Option::Provider);
81 return m_options.m_provider;
85 note_examined(Option::SaltSize);
86 return m_options.m_salt_size;
90 note_examined(Option::DerEncoded);
91 return m_options.m_use_der;
95 note_examined(Option::Deterministic);
96 return m_options.m_deterministic_sig && m_usage == Usage::Signing;
100 note_examined(Option::ExplicitTrailer);
101 return m_options.m_explicit_trailer_field;
109 note_examined(Option::Prehash);
110 return m_options.m_using_prehash;
114 note_examined(Option::ExternalPrehash);
115 return m_options.m_using_external_prehash;
122 bool using_provider()
const;
134 enum class Usage : uint8_t {
140 m_options(options), m_usage(usage) {}
142 enum class Option : uint32_t {
149 DerEncoded = (1 << 6),
150 Deterministic = (1 << 7),
151 ExplicitTrailer = (1 << 8),
152 ExternalPrehash = (1 << 9),
155 void note_examined(Option option)
const { m_examined |=
static_cast<uint32_t
>(option); }
158 uint32_t options_in_use()
const;
161 void throw_if_unexamined(std::string_view algo_name)
const;
163 const PK_Signature_Options& m_options;
165 mutable uint32_t m_examined = 0;
187 std::string
to_string()
const {
return m_options.to_string(); }
192 const std::string& hash_function_name()
const;
194 const std::optional<std::string>&
padding()
const {
195 note_examined(Option::Padding);
196 return m_options.m_padding;
200 note_examined(Option::Hash);
201 return m_options.m_hash_fn;
205 note_examined(Option::Mgf1Hash);
206 return m_options.m_mgf1_hash_fn;
209 const std::optional<std::vector<uint8_t>>&
context()
const {
210 note_examined(Option::Context);
211 return m_options.m_context;
214 const std::optional<std::string>&
provider()
const {
215 note_examined(Option::Provider);
216 return m_options.m_provider;
227 bool using_provider()
const;
236 enum class Option : uint32_t {
244 void note_examined(Option option)
const { m_examined |=
static_cast<uint32_t
>(option); }
246 uint32_t options_in_use()
const;
248 void throw_if_unexamined(std::string_view algo_name)
const;
250 const PK_Encryption_Options& m_options;
251 mutable uint32_t m_examined = 0;
273 std::string
to_string()
const {
return m_options.to_string(); }
275 const std::optional<std::string>&
kdf()
const {
276 note_examined(Option::Kdf);
277 return m_options.m_kdf;
283 note_examined(Option::RawSharedKey);
284 return m_options.m_raw_shared_key;
287 const std::optional<std::string>&
provider()
const {
288 note_examined(Option::Provider);
289 return m_options.m_provider;
292 bool using_provider()
const;
301 enum class Option : uint32_t {
303 RawSharedKey = (1 << 1),
307 void note_examined(Option option)
const { m_examined |=
static_cast<uint32_t
>(option); }
309 uint32_t options_in_use()
const;
311 void throw_if_unexamined(std::string_view algo_name)
const;
313 const PK_KEM_Options& m_options;
314 mutable uint32_t m_examined = 0;
336 std::string
to_string()
const {
return m_options.to_string(); }
338 const std::optional<std::string>&
kdf()
const {
339 note_examined(Option::Kdf);
340 return m_options.m_kdf;
346 note_examined(Option::RawSharedKey);
347 return m_options.m_raw_shared_key;
350 const std::optional<std::string>&
provider()
const {
351 note_examined(Option::Provider);
352 return m_options.m_provider;
355 bool using_provider()
const;
363 enum class Option : uint32_t {
365 RawSharedKey = (1 << 1),
369 void note_examined(Option option)
const { m_examined |=
static_cast<uint32_t
>(option); }
371 uint32_t options_in_use()
const;
373 void throw_if_unexamined(std::string_view algo_name)
const;
375 const PK_Key_Agreement_Options& m_options;
376 mutable uint32_t m_examined = 0;
#define BOTAN_UNSTABLE_API
friend class PK_Decryptor_EME
bool using_padding() const
bool using_mgf1_hash() const
PK_Encryption_Options_Reader(PK_Encryption_Options_Reader &&)=delete
bool using_context() const
std::string to_string() const
Format the options as a string, for error messages.
PK_Encryption_Options_Reader(const PK_Encryption_Options_Reader &)=delete
const std::optional< std::string > & hash_function() const
const std::optional< std::vector< uint8_t > > & context() const
~PK_Encryption_Options_Reader()=default
const std::optional< std::string > & provider() const
const std::optional< std::string > & padding() const
const std::optional< std::string > & mgf1_hash_function() const
PK_Encryption_Options_Reader & operator=(PK_Encryption_Options_Reader &&)=delete
friend class PK_Encryptor_EME
friend class PK_Options_Reader_Access
PK_Encryption_Options_Reader & operator=(const PK_Encryption_Options_Reader &)=delete
PK_KEM_Options_Reader(PK_KEM_Options_Reader &&)=delete
friend class PK_KEM_Decryptor
PK_KEM_Options_Reader & operator=(const PK_KEM_Options_Reader &)=delete
bool using_raw_shared_key() const
std::string to_string() const
Format the options as a string, for error messages.
friend class PK_KEM_Encryptor
const std::optional< std::string > & kdf() const
const std::optional< std::string > & provider() const
PK_KEM_Options_Reader & operator=(PK_KEM_Options_Reader &&)=delete
PK_KEM_Options_Reader(const PK_KEM_Options_Reader &)=delete
~PK_KEM_Options_Reader()=default
friend class PK_Options_Reader_Access
PK_Key_Agreement_Options_Reader(const PK_Key_Agreement_Options_Reader &)=delete
const std::optional< std::string > & provider() const
PK_Key_Agreement_Options_Reader(PK_Key_Agreement_Options_Reader &&)=delete
std::string to_string() const
Format the options as a string, for error messages.
bool using_raw_shared_key() const
friend class PK_Key_Agreement
~PK_Key_Agreement_Options_Reader()=default
PK_Key_Agreement_Options_Reader & operator=(const PK_Key_Agreement_Options_Reader &)=delete
const std::optional< std::string > & kdf() const
friend class PK_Options_Reader_Access
PK_Key_Agreement_Options_Reader & operator=(PK_Key_Agreement_Options_Reader &&)=delete
~PK_Signature_Options_Reader()=default
bool using_der_encoded_signature() const
const std::optional< std::string > & hash_function() const
const std::optional< std::string > & provider() const
bool using_explicit_trailer_field() const
PK_Signature_Options_Reader(PK_Signature_Options_Reader &&)=delete
const std::optional< std::string > & padding() const
bool using_context() const
const std::optional< std::vector< uint8_t > > & context() const
bool using_externally_computed_prehash() const
bool using_padding() const
const std::optional< std::string > & externally_computed_prehash_function() const
PK_Signature_Options_Reader(const PK_Signature_Options_Reader &)=delete
PK_Signature_Options_Reader & operator=(const PK_Signature_Options_Reader &)=delete
PK_Signature_Options_Reader & operator=(PK_Signature_Options_Reader &&)=delete
const std::optional< std::string > & prehash_function() const
bool using_salt_size() const
std::string to_string() const
Format the options as a string, for error messages.
friend class PK_Options_Reader_Access
bool using_prehash() const
bool using_deterministic_signature() const
const std::optional< size_t > & salt_size() const