Botan 3.14.1
Crypto and TLS for C&
chacha20poly1305.h
Go to the documentation of this file.
1/*
2* ChaCha20Poly1305 AEAD
3* (C) 2014 Jack Lloyd
4* (C) 2016 Daniel Neus, Rohde & Schwarz Cybersecurity
5*
6* Botan is released under the Simplified BSD License (see license.txt)
7*/
8
9#ifndef BOTAN_AEAD_CHACHA20_POLY1305_H_
10#define BOTAN_AEAD_CHACHA20_POLY1305_H_
11
12#include <botan/aead.h>
13
14#include <botan/mac.h>
15#include <botan/stream_cipher.h>
16
17namespace Botan {
18
19/**
20* Base class
21* See draft-irtf-cfrg-chacha20-poly1305-03 for specification
22* If a nonce of 64 bits is used the older version described in
23* draft-agl-tls-chacha20poly1305-04 is used instead.
24* If a nonce of 192 bits is used, XChaCha20Poly1305 is selected.
25*/
27 public:
28 void set_associated_data_n(size_t idx, std::span<const uint8_t> ad) final;
29
30 bool associated_data_requires_key() const override { return false; }
31
32 std::string name() const override { return "ChaCha20Poly1305"; }
33
34 size_t update_granularity() const override;
35
36 size_t ideal_granularity() const override;
37
39
40 bool valid_nonce_length(size_t n) const override;
41
42 size_t tag_size() const override { return 16; }
43
44 void clear() override;
45
46 void reset() override;
47
48 bool has_keying_material() const final;
49
50 protected:
51 std::unique_ptr<StreamCipher> m_chacha; // NOLINT(*non-private-member-variable*)
52 std::unique_ptr<MessageAuthenticationCode> m_poly1305; // NOLINT(*non-private-member-variable*)
53
55
56 secure_vector<uint8_t> m_ad; // NOLINT(*non-private-member-variable*)
57 size_t m_nonce_len = 0; // NOLINT(*non-private-member-variable*)
58 uint64_t m_ctext_len = 0; // NOLINT(*non-private-member-variable*)
59
60 bool cfrg_version() const { return m_nonce_len == 12 || m_nonce_len == 24; }
61
62 void update_len(uint64_t len);
63
64 private:
65 void start_msg(const uint8_t nonce[], size_t nonce_len) override;
66
67 void key_schedule(std::span<const uint8_t> key) override;
68};
69
70/**
71* ChaCha20Poly1305 Encryption
72*/
74 public:
75 size_t output_length(size_t input_length) const override;
76
77 size_t minimum_final_size() const override { return 0; }
78
79 private:
80 size_t process_msg(uint8_t buf[], size_t size) override;
81 void finish_msg(secure_vector<uint8_t>& final_block, size_t offset = 0) override;
82};
83
84/**
85* ChaCha20Poly1305 Decryption
86*/
88 public:
89 size_t output_length(size_t input_length) const override;
90
91 size_t minimum_final_size() const override { return tag_size(); }
92
93 private:
94 size_t process_msg(uint8_t buf[], size_t size) override;
95 void finish_msg(secure_vector<uint8_t>& final_block, size_t offset = 0) override;
96};
97
98} // namespace Botan
99
100#endif
size_t output_length(size_t input_length) const override
size_t minimum_final_size() const override
size_t minimum_final_size() const override
size_t output_length(size_t input_length) const override
bool has_keying_material() const final
void set_associated_data_n(size_t idx, std::span< const uint8_t > ad) final
bool valid_nonce_length(size_t n) const override
secure_vector< uint8_t > m_ad
size_t ideal_granularity() const override
std::string name() const override
std::unique_ptr< StreamCipher > m_chacha
size_t update_granularity() const override
size_t tag_size() const override
bool associated_data_requires_key() const override
Key_Length_Specification key_spec() const override
std::unique_ptr< MessageAuthenticationCode > m_poly1305
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128