Botan 3.14.1
Crypto and TLS for C&
tls_null.h
Go to the documentation of this file.
1/*
2* TLS Null Cipher Handling
3* (C) 2024 Sebastian Ahrens, Dirk Dobkowitz, André Schomburg (Volkswagen AG)
4* (C) 2024 Lars Dürkop (CARIAD SE)
5*
6* Botan is released under the Simplified BSD License (see license.txt)
7*/
8
9#ifndef BOTAN_TLS_NULL_HMAC_AEAD_H_
10#define BOTAN_TLS_NULL_HMAC_AEAD_H_
11
12#include <botan/aead.h>
13#include <botan/mac.h>
14
15namespace Botan::TLS {
16
17/**
18* TLS NULL+HMAC AEAD base class (GenericStreamCipher in TLS spec)
19*/
21 public:
22 std::string name() const final;
23
24 void set_associated_data_n(size_t idx, std::span<const uint8_t> ad) override;
25
26 size_t update_granularity() const final;
27
28 size_t ideal_granularity() const final;
29
31
32 bool valid_nonce_length(size_t nl) const final;
33
34 size_t tag_size() const final { return m_tag_size; }
35
36 void clear() final;
37
38 void reset() final;
39
40 bool has_keying_material() const final;
41
42 protected:
43 TLS_NULL_HMAC_AEAD_Mode(std::unique_ptr<MessageAuthenticationCode> mac, size_t mac_keylen);
44
45 size_t mac_keylen() const;
46
47 MessageAuthenticationCode& mac() const;
48
49 private:
50 void start_msg(const uint8_t nonce[], size_t nonce_len) final;
51 size_t process_msg(uint8_t buf[], size_t sz) final;
52
53 void key_schedule(std::span<const uint8_t> key) final;
54
55 const std::string m_mac_name;
56 size_t m_mac_keylen;
57 size_t m_tag_size;
58
59 secure_vector<uint8_t> m_key;
60 std::unique_ptr<MessageAuthenticationCode> m_mac;
61
62 // Per the AEAD_Mode contract, associated data set via
63 // set_associated_data persists across messages until reset. finish_msg
64 // calls mac().final() which clears the internal state, so we cache the
65 // AD here and re-feed it at start_msg time.
66 std::vector<uint8_t> m_ad;
67};
68
69/**
70* TLS_NULL_HMAC_AEAD Encryption
71*/
73 public:
74 TLS_NULL_HMAC_AEAD_Encryption(std::unique_ptr<MessageAuthenticationCode> mac, const size_t mac_keylen) :
76
77 void set_associated_data_n(size_t idx, std::span<const uint8_t> ad) override;
78
79 size_t output_length(size_t input_length) const override;
80
81 size_t minimum_final_size() const override { return 0; }
82
83 private:
84 void finish_msg(secure_vector<uint8_t>& final_block, size_t offset = 0) override;
85};
86
87/**
88* TLS_NULL_HMAC_AEAD Decryption
89*/
91 public:
92 TLS_NULL_HMAC_AEAD_Decryption(std::unique_ptr<MessageAuthenticationCode> mac, const size_t mac_keylen) :
94
95 size_t output_length(size_t input_length) const override;
96
97 size_t minimum_final_size() const override { return tag_size(); }
98
99 void finish_msg(secure_vector<uint8_t>& final_block, size_t offset = 0) override;
100};
101
102} // namespace Botan::TLS
103
104#endif
#define BOTAN_TEST_API
Definition api.h:41
TLS_NULL_HMAC_AEAD_Decryption(std::unique_ptr< MessageAuthenticationCode > mac, const size_t mac_keylen)
Definition tls_null.h:92
size_t minimum_final_size() const override
Definition tls_null.h:97
size_t minimum_final_size() const override
Definition tls_null.h:81
TLS_NULL_HMAC_AEAD_Encryption(std::unique_ptr< MessageAuthenticationCode > mac, const size_t mac_keylen)
Definition tls_null.h:74
size_t update_granularity() const final
Definition tls_null.cpp:48
size_t ideal_granularity() const final
Definition tls_null.cpp:52
void set_associated_data_n(size_t idx, std::span< const uint8_t > ad) override
Definition tls_null.cpp:109
MessageAuthenticationCode & mac() const
Definition tls_null.cpp:72
Key_Length_Specification key_spec() const final
Definition tls_null.cpp:60
bool valid_nonce_length(size_t nl) const final
Definition tls_null.cpp:56
TLS_NULL_HMAC_AEAD_Mode(std::unique_ptr< MessageAuthenticationCode > mac, size_t mac_keylen)
Definition tls_null.cpp:23
size_t tag_size() const final
Definition tls_null.h:34
const char * name
Definition ffi_tls.h:59
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128