10#include <botan/secmem.h>
11#include <botan/types.h>
85 constexpr uint16_t
wire_code()
const {
return static_cast<uint16_t
>(m_code); }
87 constexpr bool operator==(
const KEM_Id& other)
const {
return m_code == other.m_code; }
105 bool is_available()
const;
118 size_t shared_secret_length()
const;
121 size_t encapsulation_length()
const;
124 size_t public_key_length()
const;
127 size_t private_key_length()
const;
130 std::optional<std::string>
to_string()
const;
152 constexpr uint16_t
wire_code()
const {
return static_cast<uint16_t
>(m_code); }
168 bool is_available()
const;
172 size_t output_length()
const;
174 std::optional<std::string>
to_string()
const;
196 constexpr uint16_t
wire_code()
const {
return static_cast<uint16_t
>(m_code); }
213 bool is_available()
const;
220 size_t key_length()
const;
223 size_t nonce_length()
const;
226 size_t tag_length()
const;
228 std::optional<std::string>
to_string()
const;
252 return m_kem == other.m_kem && m_kdf == other.m_kdf && m_aead == other.m_aead;
255 constexpr bool is_known()
const {
return m_kem.is_known() && m_kdf.is_known() && m_aead.is_known(); }
257 bool is_available()
const {
return m_kem.is_available() && m_kdf.is_available() && m_aead.is_available(); }
266 std::optional<std::string>
to_string()
const;
329 friend bool operator==(
const Public_Key& a,
const Public_Key& b) {
336 explicit Public_Key(std::shared_ptr<const Data> data) : m_data(std::move(data)) {}
342 std::shared_ptr<const Data> m_data;
384 static Private_Key
from_key(
KEM_Id kem, std::unique_ptr<Botan::Private_Key> key);
410 explicit Private_Key(std::shared_ptr<const Data> data) : m_data(std::move(data)) {}
415 std::shared_ptr<const Data> m_data;
428 PSK(std::span<const uint8_t> psk, std::span<const uint8_t> psk_id);
430 std::span<const uint8_t>
secret()
const {
return m_psk; }
432 std::span<const uint8_t>
identity()
const {
return m_psk_id; }
436 std::vector<uint8_t> m_psk_id;
470 std::span<const uint8_t> info = {});
476 std::span<const uint8_t> info = {});
482 std::span<const uint8_t> info = {});
489 std::span<const uint8_t> info = {});
506 std::vector<uint8_t>
seal(std::span<const uint8_t> aad, std::span<const uint8_t> ptext);
531 std::span<const uint8_t> info);
533 std::unique_ptr<
detail::Context_Data> m_data;
551 std::span<const uint8_t> enc,
553 std::span<const uint8_t> info = {});
557 std::span<const uint8_t> enc,
560 std::span<const uint8_t> info = {});
564 std::span<const uint8_t> enc,
567 std::span<const uint8_t> info = {});
571 std::span<const uint8_t> enc,
575 std::span<const uint8_t> info = {});
590 secure_vector<uint8_t>
open(std::span<const uint8_t> aad, std::span<const uint8_t> ctext);
599 std::span<const uint8_t> aad,
600 std::span<const uint8_t> ctext);
624 std::span<const uint8_t> enc,
628 std::span<const uint8_t> info);
630 std::unique_ptr<
detail::Context_Data> m_data;
#define BOTAN_PUBLIC_API(maj, min)
constexpr bool operator==(const AEAD_Id &other) const
constexpr bool is_known() const
constexpr bool operator==(AEAD_Code code) const
constexpr uint16_t wire_code() const
constexpr AEAD_Id(AEAD_Code code)
constexpr AEAD_Id(uint16_t code)
constexpr AEAD_Code code() const
constexpr bool is_export_only() const
constexpr KDF_Id(KDF_Code code)
constexpr bool is_known() const
constexpr KDF_Code code() const
constexpr bool operator==(const KDF_Id &other) const
constexpr bool operator==(KDF_Code code) const
constexpr uint16_t wire_code() const
constexpr KDF_Id(uint16_t code)
constexpr bool operator==(KEM_Code code) const
constexpr bool is_known() const
True if this codepoint is known to this version of the library.
constexpr KEM_Id(KEM_Code code)
constexpr bool supports_auth_modes() const
constexpr KEM_Code code() const
constexpr bool operator==(const KEM_Id &other) const
constexpr bool is_dhkem() const
constexpr uint16_t wire_code() const
constexpr KEM_Id(uint16_t code)
std::span< const uint8_t > identity() const
std::span< const uint8_t > secret() const
PSK(std::span< const uint8_t > psk, std::span< const uint8_t > psk_id)
Public_Key public_key() const
The corresponding public key.
static Private_Key generate(KEM_Id kem, RandomNumberGenerator &rng)
GenerateKeyPair from RFC 9180 Section 4.
const Botan::Private_Key & underlying() const
static Private_Key derive(KEM_Id kem, std::span< const uint8_t > ikm)
static Private_Key deserialize(KEM_Id kem, std::span< const uint8_t > bytes)
static Private_Key from_key(KEM_Id kem, std::unique_ptr< Botan::Private_Key > key)
secure_vector< uint8_t > serialize() const
static Public_Key deserialize(KEM_Id kem, std::span< const uint8_t > bytes)
std::vector< uint8_t > serialize() const
SerializePublicKey from RFC 9180 Section 7.1.1.
friend bool operator==(const Public_Key &a, const Public_Key &b)
static Public_Key from_key(KEM_Id kem, std::unique_ptr< Botan::Public_Key > key)
const Botan::Public_Key & underlying() const
secure_vector< uint8_t > open_at_sequence(uint64_t seq, std::span< const uint8_t > aad, std::span< const uint8_t > ctext)
secure_vector< uint8_t > export_secret(std::span< const uint8_t > exporter_context, size_t length) const
static Recipient_Context setup_auth(const Suite &suite, const Private_Key &recipient_key, std::span< const uint8_t > enc, const Public_Key &sender_identity_key, RandomNumberGenerator &rng, std::span< const uint8_t > info={})
secure_vector< uint8_t > open(std::span< const uint8_t > aad, std::span< const uint8_t > ctext)
uint64_t next_sequence() const
Recipient_Context(const Recipient_Context &)=delete
static Recipient_Context setup_psk(const Suite &suite, const Private_Key &recipient_key, std::span< const uint8_t > enc, RandomNumberGenerator &rng, const PSK &psk, std::span< const uint8_t > info={})
Recipient_Context(Recipient_Context &&) noexcept
Recipient_Context & operator=(const Recipient_Context &)=delete
static Recipient_Context setup_auth_psk(const Suite &suite, const Private_Key &recipient_key, std::span< const uint8_t > enc, const Public_Key &sender_identity_key, RandomNumberGenerator &rng, const PSK &psk, std::span< const uint8_t > info={})
static Recipient_Context setup_base(const Suite &suite, const Private_Key &recipient_key, std::span< const uint8_t > enc, RandomNumberGenerator &rng, std::span< const uint8_t > info={})
static Sender_Context setup_psk(const Suite &suite, const Public_Key &recipient_key, RandomNumberGenerator &rng, const PSK &psk, std::span< const uint8_t > info={})
static Sender_Context setup_auth(const Suite &suite, const Public_Key &recipient_key, const Private_Key &sender_identity_key, RandomNumberGenerator &rng, std::span< const uint8_t > info={})
static Sender_Context setup_base(const Suite &suite, const Public_Key &recipient_key, RandomNumberGenerator &rng, std::span< const uint8_t > info={})
secure_vector< uint8_t > export_secret(std::span< const uint8_t > exporter_context, size_t length) const
std::vector< uint8_t > seal(std::span< const uint8_t > aad, std::span< const uint8_t > ptext)
Sender_Context(const Sender_Context &)=delete
Sender_Context(Sender_Context &&) noexcept
uint64_t next_sequence() const
The sequence number the next call to seal() will use.
const std::vector< uint8_t > & encapsulated_key() const
The KEM encapsulation ("enc") to be transmitted to the recipient.
static Sender_Context setup_auth_psk(const Suite &suite, const Public_Key &recipient_key, const Private_Key &sender_identity_key, RandomNumberGenerator &rng, const PSK &psk, std::span< const uint8_t > info={})
Sender_Context & operator=(const Sender_Context &)=delete
constexpr AEAD_Id aead() const
size_t ciphertext_overhead() const
constexpr KDF_Id kdf() const
constexpr bool is_export_only() const
constexpr KEM_Id kem() const
constexpr bool operator==(const Suite &other) const
constexpr Suite(KEM_Id kem, KDF_Id kdf, AEAD_Id aead)
bool is_available() const
constexpr bool is_known() const
Mode
The four HPKE modes, with their codepoints from RFC 9180 Section 5.
std::vector< T, secure_allocator< T > > secure_vector
std::string to_string(ErrorType type)
Convert an ErrorType to string.