Botan 3.9.0
Crypto and TLS for C&
|
#include <shake_cipher.h>
Public Member Functions | |
size_t | buffer_size () const final |
void | cipher (const uint8_t in[], uint8_t out[], size_t len) |
void | cipher (std::span< const uint8_t > in, std::span< uint8_t > out) |
void | cipher1 (std::span< uint8_t > buf) |
void | cipher1 (uint8_t buf[], size_t len) |
void | clear () final |
StreamCipher * | clone () const |
void | decrypt (std::span< uint8_t > inout) |
virtual size_t | default_iv_length () const |
void | encipher (std::span< uint8_t > inout) |
void | encrypt (std::span< uint8_t > inout) |
bool | has_keying_material () const final |
Key_Length_Specification | key_spec () const final |
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>> | |
T | keystream_bytes (size_t bytes) |
size_t | maximum_keylength () const |
size_t | minimum_keylength () const |
virtual std::string | name () const =0 |
virtual std::unique_ptr< StreamCipher > | new_object () const =0 |
virtual std::string | provider () const |
void | seek (uint64_t offset) final |
void | set_iv (const uint8_t iv[], size_t iv_len) |
void | set_iv (std::span< const uint8_t > iv) |
void | set_key (const OctetString &key) |
void | set_key (const uint8_t key[], size_t length) |
void | set_key (std::span< const uint8_t > key) |
virtual bool | valid_iv_length (size_t iv_len) const |
bool | valid_keylength (size_t length) const |
void | write_keystream (std::span< uint8_t > out) |
void | write_keystream (uint8_t out[], size_t len) |
Static Public Member Functions | |
static std::unique_ptr< StreamCipher > | create (std::string_view algo_spec, std::string_view provider="") |
static std::unique_ptr< StreamCipher > | create_or_throw (std::string_view algo_spec, std::string_view provider="") |
static std::vector< std::string > | providers (std::string_view algo_spec) |
Protected Member Functions | |
void | assert_key_material_set () const |
void | assert_key_material_set (bool predicate) const |
SHAKE_Cipher (size_t keccak_capacity) |
Base class for SHAKE-based XOFs presented as a stream cipher
Definition at line 20 of file shake_cipher.h.
|
explicitprotected |
Definition at line 16 of file shake_cipher.cpp.
References buffer_size().
Referenced by Botan::SHAKE_128_Cipher::SHAKE_128_Cipher(), and Botan::SHAKE_256_Cipher::SHAKE_256_Cipher().
|
inlineprotectedinherited |
Definition at line 146 of file sym_algo.h.
References assert_key_material_set(), and has_keying_material().
Referenced by assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::Lion::decrypt_n(), Botan::Lion::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::nonce_hash(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::GHASH::set_associated_data(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().
|
inlineprotectedinherited |
Definition at line 148 of file sym_algo.h.
|
inlinefinalvirtual |
Return the optimium buffer size to use with this cipher
Most stream ciphers internally produce blocks of bytes. This function returns that block size. Aligning buffer sizes to a multiple of this size may improve performance by reducing internal buffering overhead.
Note the return value of this function may change for any particular algorithm due to changes in the implementation from release to release, or changes in the runtime environment (such as CPUID indicating availability of an optimized implementation). It is not intrinsic to the algorithm; it is just a suggestion for gaining best performance.
Implements Botan::StreamCipher.
Definition at line 36 of file shake_cipher.h.
Referenced by SHAKE_Cipher().
|
inlineinherited |
Encrypt or decrypt a message
Processes all bytes plain/ciphertext from in
and writes the result to out
.
in | the plaintext |
out | the byte array to hold the output, i.e. the ciphertext |
len | the length of both in and out in bytes |
Definition at line 59 of file stream_cipher.h.
References cipher_bytes().
Referenced by cipher1(), cipher1(), create(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::CTR_BE::CTR_BE(), Botan::CTR_BE::CTR_BE(), decrypt(), encipher(), encrypt(), and Botan::OFB::OFB().
|
inherited |
Encrypt or decrypt a message
in | the plaintext |
out | the byte array to hold the output, i.e. the ciphertext with at least the same size as in |
Definition at line 133 of file stream_cipher.cpp.
References BOTAN_ARG_CHECK, and cipher_bytes().
|
inlineinherited |
Encrypt or decrypt a message The message is encrypted/decrypted in place.
buf | the plaintext / ciphertext |
Definition at line 115 of file stream_cipher.h.
References cipher().
|
inlineinherited |
Encrypt or decrypt a message The message is encrypted/decrypted in place.
buf | the plaintext / ciphertext |
len | the length of buf in bytes |
Definition at line 108 of file stream_cipher.h.
References cipher().
Referenced by generate_keystream().
|
finalvirtual |
Reset the internal state. This includes not just the key, but any partial message that may have been in process.
Implements Botan::SymmetricAlgorithm.
Definition at line 36 of file shake_cipher.cpp.
References Botan::zeroise().
|
inlineinherited |
Definition at line 194 of file stream_cipher.h.
References new_object().
|
staticinherited |
Create an instance based on a name If provider is empty then best available is chosen.
algo_spec | algorithm name |
provider | provider implementation to use |
Definition at line 40 of file stream_cipher.cpp.
References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), BOTAN_UNUSED, cipher(), Botan::BlockCipher::create(), and provider().
Referenced by Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), and create_or_throw().
|
staticinherited |
Create an instance based on a name If provider is empty then best available is chosen.
algo_spec | algorithm name |
provider | provider implementation to use Throws a Lookup_Error if the algo/provider combination cannot be found |
Definition at line 122 of file stream_cipher.cpp.
References create(), and provider().
Referenced by Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::ChaCha_RNG::ChaCha_RNG(), Botan::Sodium::crypto_secretbox_detached(), Botan::Sodium::crypto_secretbox_open_detached(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305(), Botan::Sodium::crypto_secretbox_xsalsa20poly1305_open(), Botan::Sodium::crypto_stream_chacha20(), Botan::Sodium::crypto_stream_chacha20_ietf(), Botan::Sodium::crypto_stream_chacha20_ietf_xor_ic(), Botan::Sodium::crypto_stream_chacha20_xor_ic(), Botan::Sodium::crypto_stream_xchacha20(), and Botan::Sodium::crypto_stream_xchacha20_xor_ic().
|
inlineinherited |
Decrypt a message in place The message is decrypted in place.
inout | the plaintext / ciphertext |
Definition at line 136 of file stream_cipher.h.
References cipher().
|
virtualinherited |
Return the default (preferred) nonce length
If this function returns zero, then this cipher does not support nonces; in this case any call to set_iv with a (non-empty) value will fail.
Default implementation returns 0
Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.
Definition at line 138 of file stream_cipher.cpp.
|
inlineinherited |
Encrypt a message The message is encrypted/decrypted in place.
inout | the plaintext / ciphertext |
Definition at line 122 of file stream_cipher.h.
References cipher().
|
inlineinherited |
Encrypt a message The message is encrypted in place.
inout | the plaintext / ciphertext |
Definition at line 129 of file stream_cipher.h.
References cipher().
|
inlinefinalvirtual |
Implements Botan::SymmetricAlgorithm.
Definition at line 34 of file shake_cipher.h.
|
finalvirtual |
Implements Botan::SymmetricAlgorithm.
Definition at line 92 of file shake_cipher.cpp.
|
inlineinherited |
Get bytes
from the keystream
The bytes are written into a continous byte buffer of your choosing.
bytes | The number of bytes to be produced |
Definition at line 96 of file stream_cipher.h.
References write_keystream().
|
inlineinherited |
Definition at line 102 of file sym_algo.h.
References key_spec().
|
inlineinherited |
Definition at line 107 of file sym_algo.h.
References key_spec().
|
pure virtualinherited |
Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ANSI_X919_MAC, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CBC_Mode, Botan::CCM_Mode, Botan::CFB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::ChaCha, Botan::CMAC, Botan::CTR_BE, Botan::DES, Botan::EAX_Mode, Botan::FPE_FE1, Botan::GCM_Mode, Botan::GHASH, Botan::GMAC, Botan::GOST_28147_89, Botan::HMAC, Botan::IDEA, Botan::KMAC128, Botan::KMAC256, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::OCB_Mode, Botan::OFB, Botan::Poly1305, Botan::RC4, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SHAKE_128_Cipher, Botan::SHAKE_256_Cipher, Botan::SipHash, Botan::SIV_Mode, Botan::SM4, Botan::Threefish_512, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::TLS::TLS_NULL_HMAC_AEAD_Mode, Botan::TripleDES, Botan::Twofish, and Botan::XTS_Mode.
Referenced by Botan::XTS_Mode::name(), set_key(), and Botan::MessageAuthenticationCode::start_msg().
|
pure virtualinherited |
Implemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, and Botan::SHAKE_256_Cipher.
Referenced by clone().
|
inlinevirtualinherited |
Reimplemented in Botan::ChaCha.
Definition at line 220 of file stream_cipher.h.
Referenced by create(), and create_or_throw().
|
staticinherited |
Definition at line 129 of file stream_cipher.cpp.
References Botan::probe_providers_of().
|
finalvirtual |
Seeking is not supported, this function will throw
Implements Botan::StreamCipher.
Definition at line 32 of file shake_cipher.cpp.
|
inlineinherited |
Resync the cipher using the IV
Load IV
into the stream cipher state. This should happen after the key is set (set_key()) and before any operation (encrypt(), decrypt() or seek()) is called.
If the cipher does not support IVs, then a call with an empty IV will be accepted and any other length will cause an Invalid_IV_Length exception.
iv | the initialization vector |
iv_len | the length of the IV in bytes |
Definition at line 166 of file stream_cipher.h.
References set_iv_bytes().
Referenced by Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::Sodium::randombytes_buf_deterministic(), and Botan::SIV_Mode::set_ctr_iv().
|
inlineinherited |
Resync the cipher using the IV
iv | the initialization vector |
Invalid_IV_Length | if an incompatible IV was passed. |
Definition at line 173 of file stream_cipher.h.
References set_iv_bytes().
|
inherited |
Set the symmetric key of this object.
key | the SymmetricKey to be set. |
Definition at line 14 of file sym_algo.cpp.
References Botan::OctetString::begin(), Botan::OctetString::length(), and set_key().
Referenced by Botan::create_aes_row_generator(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), Botan::TLS::TLS_NULL_HMAC_AEAD_Mode::reset(), and set_key().
|
inlineinherited |
Set the symmetric key of this object.
key | the to be set as a byte array. |
length | in bytes of key param |
Definition at line 133 of file sym_algo.h.
References set_key().
Referenced by set_key().
|
inherited |
Set the symmetric key of this object.
key | the contiguous byte range to be set. |
Definition at line 22 of file sym_algo.cpp.
References name(), and valid_keylength().
|
inlinevirtualinherited |
iv_len | the length of the IV in bytes |
Reimplemented in Botan::ChaCha, Botan::CTR_BE, Botan::OFB, and Botan::Salsa20.
Definition at line 189 of file stream_cipher.h.
|
inlineinherited |
Check whether a given key length is valid for this algorithm.
length | the key length to be checked. |
Definition at line 114 of file sym_algo.h.
References key_spec().
Referenced by set_key().
|
inlineinherited |
Fill a given buffer with keystream bytes
The contents of out
are ignored/overwritten
out | the byte array to hold the keystream |
Definition at line 86 of file stream_cipher.h.
References generate_keystream().
|
inlineinherited |
Write keystream bytes to a buffer
The contents of out
are ignored/overwritten
out | the byte array to hold the keystream |
len | the length of out in bytes |
Definition at line 77 of file stream_cipher.h.
References generate_keystream().
Referenced by Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_xsalsa20(), keystream_bytes(), and Botan::Sodium::randombytes_buf_deterministic().