Botan 2.19.3
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::Cipher_Mode Class Referenceabstract

#include <cipher_mode.h>

Inheritance diagram for Botan::Cipher_Mode:
Botan::SymmetricAlgorithm Botan::AEAD_Mode Botan::CBC_Mode Botan::CFB_Mode Botan::XTS_Mode Botan::CCM_Mode Botan::ChaCha20Poly1305_Mode Botan::EAX_Mode Botan::GCM_Mode Botan::OCB_Mode Botan::SIV_Mode Botan::TLS::TLS_CBC_HMAC_AEAD_Mode Botan::CBC_Decryption Botan::CBC_Encryption Botan::CFB_Decryption Botan::CFB_Encryption Botan::XTS_Decryption Botan::XTS_Encryption

Public Member Functions

virtual bool authenticated () const
 
virtual void clear ()=0
 
virtual size_t default_nonce_length () const =0
 
virtual void finish (secure_vector< uint8_t > &final_block, size_t offset=0)=0
 
virtual Key_Length_Specification key_spec () const =0
 
size_t maximum_keylength () const
 
virtual size_t minimum_final_size () const =0
 
size_t minimum_keylength () const
 
virtual std::string name () const =0
 
virtual size_t output_length (size_t input_length) const =0
 
virtual size_t process (uint8_t msg[], size_t msg_len)=0
 
virtual std::string provider () const
 
virtual void reset ()=0
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const SymmetricKey &key)
 
void set_key (const uint8_t key[], size_t length)
 
void start ()
 
template<typename Alloc >
void start (const std::vector< uint8_t, Alloc > &nonce)
 
void start (const uint8_t nonce[], size_t nonce_len)
 
virtual void start_msg (const uint8_t nonce[], size_t nonce_len)=0
 
virtual size_t tag_size () const
 
void update (secure_vector< uint8_t > &buffer, size_t offset=0)
 
virtual size_t update_granularity () const =0
 
bool valid_keylength (size_t length) const
 
virtual bool valid_nonce_length (size_t nonce_len) const =0
 

Static Public Member Functions

static std::unique_ptr< Cipher_Modecreate (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::unique_ptr< Cipher_Modecreate_or_throw (const std::string &algo, Cipher_Dir direction, const std::string &provider="")
 
static std::vector< std::string > providers (const std::string &algo_spec)
 

Protected Member Functions

void verify_key_set (bool cond) const
 

Detailed Description

Interface for cipher modes

Definition at line 28 of file cipher_mode.h.

Member Function Documentation

◆ authenticated()

virtual bool Botan::Cipher_Mode::authenticated ( ) const
inlinevirtual
Returns
true iff this mode provides authentication as well as confidentiality.

Reimplemented in Botan::AEAD_Mode.

Definition at line 169 of file cipher_mode.h.

169{ return false; }

◆ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )
pure virtualinherited

◆ create()

std::unique_ptr< Cipher_Mode > Botan::Cipher_Mode::create ( const std::string &  algo,
Cipher_Dir  direction,
const std::string &  provider = "" 
)
static

Create an AEAD mode

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode or a null pointer if not available

Definition at line 50 of file cipher_mode.cpp.

53 {
54#if defined(BOTAN_HAS_COMMONCRYPTO)
55 if(provider.empty() || provider == "commoncrypto")
56 {
57 std::unique_ptr<Cipher_Mode> commoncrypto_cipher(make_commoncrypto_cipher_mode(algo, direction));
58
59 if(commoncrypto_cipher)
60 return commoncrypto_cipher;
61
62 if(!provider.empty())
63 return std::unique_ptr<Cipher_Mode>();
64 }
65#endif
66
67#if defined(BOTAN_HAS_STREAM_CIPHER)
68 if(auto sc = StreamCipher::create(algo))
69 {
70 return std::unique_ptr<Cipher_Mode>(new Stream_Cipher_Mode(sc.release()));
71 }
72#endif
73
74#if defined(BOTAN_HAS_AEAD_MODES)
75 if(auto aead = AEAD_Mode::create(algo, direction))
76 {
77 return std::unique_ptr<Cipher_Mode>(aead.release());
78 }
79#endif
80
81 if(algo.find('/') != std::string::npos)
82 {
83 const std::vector<std::string> algo_parts = split_on(algo, '/');
84 const std::string cipher_name = algo_parts[0];
85 const std::vector<std::string> mode_info = parse_algorithm_name(algo_parts[1]);
86
87 if(mode_info.empty())
88 return std::unique_ptr<Cipher_Mode>();
89
90 std::ostringstream alg_args;
91
92 alg_args << '(' << cipher_name;
93 for(size_t i = 1; i < mode_info.size(); ++i)
94 alg_args << ',' << mode_info[i];
95 for(size_t i = 2; i < algo_parts.size(); ++i)
96 alg_args << ',' << algo_parts[i];
97 alg_args << ')';
98
99 const std::string mode_name = mode_info[0] + alg_args.str();
100 return Cipher_Mode::create(mode_name, direction, provider);
101 }
102
103#if defined(BOTAN_HAS_BLOCK_CIPHER)
104
105 SCAN_Name spec(algo);
106
107 if(spec.arg_count() == 0)
108 {
109 return std::unique_ptr<Cipher_Mode>();
110 }
111
112 std::unique_ptr<BlockCipher> bc(BlockCipher::create(spec.arg(0), provider));
113
114 if(!bc)
115 {
116 return std::unique_ptr<Cipher_Mode>();
117 }
118
119#if defined(BOTAN_HAS_MODE_CBC)
120 if(spec.algo_name() == "CBC")
121 {
122 const std::string padding = spec.arg(1, "PKCS7");
123
124 if(padding == "CTS")
125 {
126 if(direction == ENCRYPTION)
127 return std::unique_ptr<Cipher_Mode>(new CTS_Encryption(bc.release()));
128 else
129 return std::unique_ptr<Cipher_Mode>(new CTS_Decryption(bc.release()));
130 }
131 else
132 {
133 std::unique_ptr<BlockCipherModePaddingMethod> pad(get_bc_pad(padding));
134
135 if(pad)
136 {
137 if(direction == ENCRYPTION)
138 return std::unique_ptr<Cipher_Mode>(new CBC_Encryption(bc.release(), pad.release()));
139 else
140 return std::unique_ptr<Cipher_Mode>(new CBC_Decryption(bc.release(), pad.release()));
141 }
142 }
143 }
144#endif
145
146#if defined(BOTAN_HAS_MODE_XTS)
147 if(spec.algo_name() == "XTS")
148 {
149 if(direction == ENCRYPTION)
150 return std::unique_ptr<Cipher_Mode>(new XTS_Encryption(bc.release()));
151 else
152 return std::unique_ptr<Cipher_Mode>(new XTS_Decryption(bc.release()));
153 }
154#endif
155
156#if defined(BOTAN_HAS_MODE_CFB)
157 if(spec.algo_name() == "CFB")
158 {
159 const size_t feedback_bits = spec.arg_as_integer(1, 8*bc->block_size());
160 if(direction == ENCRYPTION)
161 return std::unique_ptr<Cipher_Mode>(new CFB_Encryption(bc.release(), feedback_bits));
162 else
163 return std::unique_ptr<Cipher_Mode>(new CFB_Decryption(bc.release(), feedback_bits));
164 }
165#endif
166
167#endif
168
169 return std::unique_ptr<Cipher_Mode>();
170 }
static std::unique_ptr< AEAD_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
Definition aead.cpp:60
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
static std::unique_ptr< Cipher_Mode > create(const std::string &algo, Cipher_Dir direction, const std::string &provider="")
static std::unique_ptr< StreamCipher > create(const std::string &algo_spec, const std::string &provider="")
std::vector< std::string > split_on(const std::string &str, char delim)
Definition parsing.cpp:148
BlockCipherModePaddingMethod * get_bc_pad(const std::string &algo_spec)
Definition mode_pad.cpp:18
@ ENCRYPTION
Definition cipher_mode.h:23
Cipher_Mode * make_commoncrypto_cipher_mode(const std::string &name, Cipher_Dir direction)
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition parsing.cpp:95

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::AEAD_Mode::create(), create(), Botan::BlockCipher::create(), Botan::StreamCipher::create(), Botan::ENCRYPTION, Botan::get_bc_pad(), Botan::make_commoncrypto_cipher_mode(), Botan::parse_algorithm_name(), provider(), and Botan::split_on().

Referenced by botan_cipher_init(), create(), create_or_throw(), Botan::get_cipher_mode(), Botan::pbes2_decrypt(), and providers().

◆ create_or_throw()

std::unique_ptr< Cipher_Mode > Botan::Cipher_Mode::create_or_throw ( const std::string &  algo,
Cipher_Dir  direction,
const std::string &  provider = "" 
)
static

Create an AEAD mode, or throw

Parameters
algothe algorithm to create
directionspecify if this should be an encryption or decryption AEAD
provideroptional specification for provider to use
Returns
an AEAD mode, or throw an exception

Definition at line 40 of file cipher_mode.cpp.

43 {
44 if(auto mode = Cipher_Mode::create(algo, direction, provider))
45 return mode;
46
47 throw Lookup_Error("Cipher mode", algo, provider);
48 }

References create(), and provider().

Referenced by Botan::ECIES_System_Params::create_cipher(), Botan::CryptoBox::decrypt_bin(), Botan::CryptoBox::encrypt(), and Botan::get_cipher().

◆ default_nonce_length()

virtual size_t Botan::Cipher_Mode::default_nonce_length ( ) const
pure virtual

◆ finish()

virtual void Botan::Cipher_Mode::finish ( secure_vector< uint8_t > &  final_block,
size_t  offset = 0 
)
pure virtual

◆ key_spec()

virtual Key_Length_Specification Botan::SymmetricAlgorithm::key_spec ( ) const
pure virtualinherited

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
maximum allowed key length

Definition at line 120 of file sym_algo.h.

121 {
122 return key_spec().maximum_keylength();
123 }
size_t maximum_keylength() const
Definition sym_algo.h:70
virtual Key_Length_Specification key_spec() const =0

◆ minimum_final_size()

virtual size_t Botan::Cipher_Mode::minimum_final_size ( ) const
pure virtual

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 128 of file sym_algo.h.

129 {
130 return key_spec().minimum_keylength();
131 }
size_t minimum_keylength() const
Definition sym_algo.h:62

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

◆ name()

virtual std::string Botan::SymmetricAlgorithm::name ( ) const
pure virtualinherited

◆ output_length()

virtual size_t Botan::Cipher_Mode::output_length ( size_t  input_length) const
pure virtual

◆ process()

virtual size_t Botan::Cipher_Mode::process ( uint8_t  msg[],
size_t  msg_len 
)
pure virtual

Process message blocks

Input must be a multiple of update_granularity

Processes msg in place and returns bytes written. Normally this will be either msg_len (indicating the entire message was processed) or for certain AEAD modes zero (indicating that the mode requires the entire message be processed in one pass).

Parameters
msgthe message to be processed
msg_lenlength of the message in bytes

Implemented in Botan::ChaCha20Poly1305_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::EAX_Encryption, Botan::EAX_Decryption, Botan::GCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::OCB_Decryption, Botan::SIV_Mode, Botan::CBC_Encryption, Botan::CBC_Decryption, Botan::CFB_Encryption, Botan::CFB_Decryption, Botan::XTS_Encryption, Botan::XTS_Decryption, Botan::CCM_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.

◆ provider()

virtual std::string Botan::Cipher_Mode::provider ( ) const
inlinevirtual
Returns
provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::GCM_Mode.

Definition at line 180 of file cipher_mode.h.

180{ return "base"; }

Referenced by Botan::AEAD_Mode::create(), create(), Botan::AEAD_Mode::create_or_throw(), and create_or_throw().

◆ providers()

std::vector< std::string > Botan::Cipher_Mode::providers ( const std::string &  algo_spec)
static
Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 173 of file cipher_mode.cpp.

174 {
175 const std::vector<std::string>& possible = { "base", "openssl", "commoncrypto" };
176 std::vector<std::string> providers;
177 for(auto&& prov : possible)
178 {
179 std::unique_ptr<Cipher_Mode> mode = Cipher_Mode::create(algo_spec, ENCRYPTION, prov);
180 if(mode)
181 {
182 providers.push_back(prov); // available
183 }
184 }
185 return providers;
186 }
static std::vector< std::string > providers(const std::string &algo_spec)

References create(), Botan::ENCRYPTION, and providers().

Referenced by providers().

◆ reset()

virtual void Botan::Cipher_Mode::reset ( )
pure virtual

◆ set_key() [1/3]

template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key)
inlineinherited

Definition at line 153 of file sym_algo.h.

154 {
155 set_key(key.data(), key.size());
156 }
void set_key(const SymmetricKey &key)
Definition sym_algo.h:147

◆ set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

◆ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( const uint8_t  key[],
size_t  length 
)
inherited

Set the symmetric key of this object.

Parameters
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 17 of file sym_algo.cpp.

18 {
19 if(!valid_keylength(length))
20 throw Invalid_Key_Length(name(), length);
21 key_schedule(key, length);
22 }
bool valid_keylength(size_t length) const
Definition sym_algo.h:138
virtual std::string name() const =0

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().

◆ start() [1/3]

void Botan::Cipher_Mode::start ( )
inline

Begin processing a message.

Definition at line 87 of file cipher_mode.h.

88 {
89 return start_msg(nullptr, 0);
90 }
virtual void start_msg(const uint8_t nonce[], size_t nonce_len)=0

◆ start() [2/3]

template<typename Alloc >
void Botan::Cipher_Mode::start ( const std::vector< uint8_t, Alloc > &  nonce)
inline

Begin processing a message.

Parameters
noncethe per message nonce

Definition at line 69 of file cipher_mode.h.

70 {
71 start_msg(nonce.data(), nonce.size());
72 }

Referenced by botan_cipher_start(), and Botan::TLS::write_record().

◆ start() [3/3]

void Botan::Cipher_Mode::start ( const uint8_t  nonce[],
size_t  nonce_len 
)
inline

Begin processing a message.

Parameters
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 79 of file cipher_mode.h.

80 {
81 start_msg(nonce, nonce_len);
82 }

◆ start_msg()

virtual void Botan::Cipher_Mode::start_msg ( const uint8_t  nonce[],
size_t  nonce_len 
)
pure virtual

◆ tag_size()

virtual size_t Botan::Cipher_Mode::tag_size ( ) const
inlinevirtual

◆ update()

void Botan::Cipher_Mode::update ( secure_vector< uint8_t > &  buffer,
size_t  offset = 0 
)
inline

Process some data. Input must be in size update_granularity() uint8_t blocks.

Parameters
bufferin/out parameter which will possibly be resized
offsetan offset into blocks to begin processing

Definition at line 112 of file cipher_mode.h.

113 {
114 BOTAN_ASSERT(buffer.size() >= offset, "Offset ok");
115 uint8_t* buf = buffer.data() + offset;
116 const size_t buf_size = buffer.size() - offset;
117
118 const size_t written = process(buf, buf_size);
119 buffer.resize(offset + written);
120 }
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:55
virtual size_t process(uint8_t msg[], size_t msg_len)=0

References BOTAN_ASSERT.

Referenced by botan_cipher_update().

◆ update_granularity()

virtual size_t Botan::Cipher_Mode::update_granularity ( ) const
pure virtual

◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t  length) const
inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters
lengththe key length to be checked.
Returns
true if the key length is valid.

Definition at line 138 of file sym_algo.h.

139 {
140 return key_spec().valid_keylength(length);
141 }
bool valid_keylength(size_t length) const
Definition sym_algo.h:52

Referenced by Botan::aont_package(), Botan::aont_unpackage(), and Botan::SymmetricAlgorithm::set_key().

◆ valid_nonce_length()

virtual bool Botan::Cipher_Mode::valid_nonce_length ( size_t  nonce_len) const
pure virtual

◆ verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond) const
inlineprotectedinherited

Definition at line 171 of file sym_algo.h.

172 {
173 if(cond == false)
174 throw_key_not_set_error();
175 }

Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::DESX::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Lion::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::DESX::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::Lion::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().


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