ChaCha20Poly1305 Class Reference

#include <ChaCha20Poly1305.hpp>

Inheritance diagram for ChaCha20Poly1305:

Public Member Functions
	ChaCha20Poly1305 (const Algorithm::Intent intent) noexcept
	~ChaCha20Poly1305 () noexcept override
std::vector< byte >	Encrypt (const std::string &password, const byte *buffer, const std::size_t buffSize) override
std::vector< byte >	Encrypt (const std::string &password, const std::vector< byte > &buffer) override
std::vector< byte >	Decrypt (const std::string &password, const byte *cipher, const std::size_t cipherSize) override
std::vector< byte >	Decrypt (const std::string &password, const std::vector< byte > &cipher) override
void	Encrypt (const std::string &password, const fs::path &in_filename, const fs::path &out_filename) override
void	Decrypt (const std::string &password, const fs::path &in_filename, const fs::path &out_filename) override
Public Member Functions inherited from Algorithm
	ENIGMA_ENUM_CLASS_BITWISE_OPERATORS (Intent, Enigma::byte)
	Algorithm (const Type type, const Intent intent=Intent::Encrypt|Intent::Decrypt) noexcept
virtual	~Algorithm () noexcept
Type	GetType () const noexcept
void	SetType (const Type type) noexcept
std::string	GetTypeString () const noexcept

Additional Inherited Members
Public Types inherited from Algorithm
enum class	Intent : Enigma::byte { None = 0 << 0 , Encrypt = 1 << 1 , Decrypt = 1 << 2 , All = Encrypt | Decrypt }
enum class	Type : byte {   AES = 0x01 , Twofish , TripleDES , Blowfish ,   IDEA , ChaCha20Poly1305 , RSA , Camellia ,   Serpent }
Static Public Member Functions inherited from Algorithm
static std::unique_ptr< Algorithm >	CreateFromName (const std::string &name, const Intent intent)
static std::unique_ptr< Algorithm >	CreateFromType (const Type type, const Intent intent)
static std::string	AlgoTypeEnumToStr (const Algorithm::Type e) noexcept
static std::string	GetSupportedAlgorithmsStr () noexcept
static std::vector< std::pair< std::string, Algorithm::Type > >	GetSupportedAlgorithms () noexcept
Static Public Attributes inherited from Algorithm
static const std::unordered_map< Type, std::string_view >	ALGORITHM_DESCRIPTIONS
Static Protected Member Functions inherited from Algorithm
static std::vector< byte >	GenerateRandomIV (const std::size_t size)
Protected Attributes inherited from Algorithm
Type	m_type {}
Intent	m_intent {}
Static Protected Attributes inherited from Algorithm
static std::unique_ptr< CryptoPP::AutoSeededRandomPool >	m_auto_seeded_random_pool {nullptr}

Detailed Description

ChaCha20Poly1305 Algorithm Encryptor/Decryptor

ChaCha20Poly1305 is an authenticated encryption scheme that combines ChaChaTLS and Poly1305. The scheme uses the IETF versions of the ciphers because it is defined in RFC 8439, ChaCha20and Poly1305 for IETF Protocols. The scheme is somewhat unique because it pairs a stream cipher with an authenticator(most authenticated encryption modes pair a block cipher).

Definition at line 15 of file ChaCha20Poly1305.hpp.

Constructor & Destructor Documentation

ChaCha20Poly1305()

ChaCha20Poly1305::ChaCha20Poly1305 ( const Algorithm::Intent  intent )

explicitnoexcept

Parameters

intent

Operation, Encrypt or Decrypt

~ChaCha20Poly1305()

ChaCha20Poly1305::~ChaCha20Poly1305 ( )

overridenoexcept

Member Function Documentation

Decrypt() [1/3]

std::vector<byte> ChaCha20Poly1305::Decrypt ( const std::string &  password, const byte *  cipher, const std::size_t  cipherSize  )

overridevirtual

Decrypts cipher with password

Parameters

password	Password used in encryption
cipher	Cipher with Enigma meta data

Returns

Recovered Buffer

Exceptions

throws

CryptoPP::Exception, std::exception on failure

Implements Algorithm.

Decrypt() [2/3]

void ChaCha20Poly1305::Decrypt ( const std::string &  password, const fs::path &  in_filename, const fs::path &  out_filename  )

overridevirtual

Decrypts a file with password

Parameters

password	Password used in encryption
in_filename	Filename to decrypt
out_filename	Filename to recover

Exceptions

throws

CryptoPP::Exception, std::exception on failure

Implements Algorithm.

Decrypt() [3/3]

std::vector<byte> ChaCha20Poly1305::Decrypt ( const std::string &  password, const std::vector< byte > &  cipher  )

overridevirtual

Implements Algorithm.

Encrypt() [1/3]

std::vector<byte> ChaCha20Poly1305::Encrypt ( const std::string &  password, const byte *  buffer, const std::size_t  buffSize  )

overridevirtual

Encrypts buffer with password

Parameters

password	Encryption password
buffer	Buffer to encrypt (text, binary...) an array of bytes

Returns

Cipher with Enigma meta data

Exceptions

throws

CryptoPP::Exception, std::exception on failure

Implements Algorithm.

Encrypt() [2/3]

void ChaCha20Poly1305::Encrypt ( const std::string &  password, const fs::path &  in_filename, const fs::path &  out_filename  )

overridevirtual

Encrypts a file with password

Parameters

password	Encryption password
in_filename	Filename to encrypt
out_filename	Filename to store encrypted cipher

Exceptions

throws

CryptoPP::Exception, std::exception on failure

Implements Algorithm.

Encrypt() [3/3]

std::vector<byte> ChaCha20Poly1305::Encrypt ( const std::string &  password, const std::vector< byte > &  buffer  )

overridevirtual

Implements Algorithm.

---

The documentation for this class was generated from the following file:

• src/Algorithm/ChaCha20Poly1305/ChaCha20Poly1305.hpp