#include <hash.h>

Inheritance diagram for Botan::HashFunction:

Public Member Functions
virtual void	clear ()=0
virtual HashFunction *	clone () const =0
SecureVector< byte >	final ()
void	final (byte out[])
virtual size_t	hash_block_size () const
virtual std::string	name () const =0
virtual size_t	output_length () const =0
SecureVector< byte >	process (const byte in[], size_t length)
SecureVector< byte >	process (const MemoryRegion< byte > &in)
SecureVector< byte >	process (const std::string &in)
void	update (byte in)
void	update (const byte in[], size_t length)
void	update (const MemoryRegion< byte > &in)
void	update (const std::string &str)
template<typename T>
void	update_be (const T in)

Detailed Description

This class represents hash function (message digest) objects

Definition at line 20 of file hash.h.

Member Function Documentation

◆ clear()

virtual void Botan::Algorithm::clear ( )

pure virtualinherited

Zeroize internal state

Implemented in Botan::Adler32, Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::ANSI_X919_MAC, Botan::ARC4, Botan::Blowfish, Botan::BMW_512, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::CBC_MAC, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::CTR_BE, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::GOST_34_11, Botan::HAS_160, Botan::HMAC, Botan::IDEA, Botan::KASUMI, Botan::KDF, Botan::Keccak_1600, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MD2, Botan::MD4, Botan::MD5, Botan::MDx_HashFunction, Botan::MISTY1, Botan::Noekeon, Botan::OFB, Botan::Parallel, Botan::PBKDF, Botan::RC2, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SAFER_SK, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHA_160, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::Skipjack, Botan::Square, Botan::SSL3_MAC, Botan::TEA, Botan::Tiger, Botan::TripleDES, Botan::Turing, Botan::Twofish, Botan::Whirlpool, Botan::WiderWake_41_BE, and Botan::XTEA.

◆ clone()

virtual HashFunction * Botan::HashFunction::clone ( ) const

pure virtual

Get a new object representing the same algorithm as *this

Implemented in Botan::Adler32, Botan::BMW_512, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::GOST_34_11, Botan::HAS_160, Botan::Keccak_1600, Botan::MD2, Botan::MD4, Botan::MD4_X86_32, Botan::MD5, Botan::MD5_X86_32, Botan::Parallel, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SHA_160, Botan::SHA_160_SSE2, Botan::SHA_160_X86_32, Botan::SHA_160_X86_64, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::Tiger, and Botan::Whirlpool.

Referenced by Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::find_hash(), Botan::get_pbe(), Botan::get_pbe(), and Botan::Algorithm_Factory::make_hash_function().

◆ final() [1/2]

SecureVector< byte > Botan::Buffered_Computation::final ( )

inlineinherited

Complete the computation and retrieve the final result.

Returns: SecureVector holding the result

Definition at line 87 of file buf_comp.h.

         {
         SecureVector<byte> output(output_length());
         final_result(&output[0]);
         return output;
         }

References output_length().

◆ final() [2/2]

void Botan::Buffered_Computation::final ( byte out[] )

inlineinherited

Complete the computation and retrieve the final result.

Parameters

out	The byte array to be filled with the result. Must be of length output_length()

Definition at line 80 of file buf_comp.h.

80{ final_result(out); }

Referenced by Botan::X942_PRF::derive(), Botan::HandshakeHash::final(), and Botan::HandshakeHash::final_ssl3().

◆ hash_block_size()

virtual size_t Botan::HashFunction::hash_block_size ( ) const

inlinevirtual

The hash block size as defined for this algorithm

Reimplemented in Botan::Comb4P, Botan::GOST_34_11, Botan::Keccak_1600, Botan::MD2, Botan::MDx_HashFunction, and Botan::Skein_512.

Definition at line 32 of file hash.h.

32{ return 0; }

◆ name()

virtual std::string Botan::Algorithm::name ( ) const

pure virtualinherited

Returns: name of this algorithm

Implemented in Botan::Adler32, Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::ANSI_X919_MAC, Botan::ARC4, Botan::Blowfish, Botan::BMW_512, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::CBC_MAC, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::CTR_BE, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::GOST_34_11, Botan::HAS_160, Botan::HMAC, Botan::IDEA, Botan::KASUMI, Botan::KDF1, Botan::KDF2, Botan::Keccak_1600, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MD2, Botan::MD4, Botan::MD5, Botan::MessageAuthenticationCode, Botan::MISTY1, Botan::Noekeon, Botan::OFB, Botan::OpenPGP_S2K, Botan::Parallel, Botan::PKCS5_PBKDF1, Botan::PKCS5_PBKDF2, Botan::RC2, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SAFER_SK, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHA_160, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::Skipjack, Botan::Square, Botan::SSL3_MAC, Botan::SSL3_PRF, Botan::TEA, Botan::Tiger, Botan::TLS_12_PRF, Botan::TLS_PRF, Botan::TripleDES, Botan::Turing, Botan::Twofish, Botan::Whirlpool, Botan::WiderWake_41_BE, Botan::X942_PRF, and Botan::XTEA.

Referenced by Botan::Algorithm_Factory::add_block_cipher(), Botan::Algorithm_Factory::add_hash_function(), Botan::Algorithm_Factory::add_pbkdf(), Botan::Algorithm_Factory::add_stream_cipher(), Botan::choose_sig_format(), Botan::PBE_PKCS5v15::PBE_PKCS5v15(), Botan::PBE_PKCS5v20::PBE_PKCS5v20(), Botan::StreamCipher::set_iv(), and Botan::SymmetricAlgorithm::set_key().

◆ output_length()

virtual size_t Botan::Buffered_Computation::output_length ( ) const

pure virtualinherited

Returns: length of the output of this function in bytes

Implemented in Botan::Adler32, Botan::ANSI_X919_MAC, Botan::BMW_512, Botan::CBC_MAC, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::GOST_34_11, Botan::HAS_160, Botan::HMAC, Botan::Keccak_1600, Botan::MD2, Botan::MD4, Botan::MD5, Botan::Parallel, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SHA_160, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::SSL3_MAC, Botan::Tiger, and Botan::Whirlpool.

Referenced by Botan::choose_sig_format(), Botan::EAX_Base::EAX_Base(), final(), and Botan::MDx_HashFunction::write_count().

◆ process() [1/3]

SecureVector< byte > Botan::Buffered_Computation::process	(	const byte	in[],
		size_t	length )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a byte array
length	the length of the byte array

Returns: the result of the call to final()

Definition at line 101 of file buf_comp.h.

         {
         add_data(in, length);
         return final();
         }

Referenced by Botan::EME1::EME1(), Botan::RTSS_Share::split(), and Botan::Cert_Extension::Subject_Key_ID::Subject_Key_ID().

◆ process() [2/3]

SecureVector< byte > Botan::Buffered_Computation::process ( const MemoryRegion< byte > & in )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process

Returns: the result of the call to final()

Definition at line 113 of file buf_comp.h.

         {
         add_data(&in[0], in.size());
         return final();
         }

References Botan::MemoryRegion< T >::size().

◆ process() [3/3]

SecureVector< byte > Botan::Buffered_Computation::process ( const std::string & in )

inlineinherited

Update and finalize computation. Does the same as calling update() and final() consecutively.

Parameters

in	the input to process as a string

Returns: the result of the call to final()

Definition at line 125 of file buf_comp.h.

         {
         update(in);
         return final();
         }

References update().

◆ update() [1/4]

void Botan::Buffered_Computation::update ( byte in )

inlineinherited

Process a single byte.

Parameters

in	the byte to process

Definition at line 72 of file buf_comp.h.

72{ add_data(&in, 1); }

◆ update() [2/4]

void Botan::Buffered_Computation::update	(	const byte	in[],
		size_t	length )

inlineinherited

Add new input to process.

Parameters

in	the input to process as a byte array
length	of param in in bytes

Definition at line 33 of file buf_comp.h.

33{ add_data(in, length); }

Referenced by Botan::X942_PRF::derive(), Botan::HandshakeHash::final(), Botan::HandshakeHash::final_ssl3(), process(), and Botan::EAX_Base::start_msg().

◆ update() [3/4]

void Botan::Buffered_Computation::update ( const MemoryRegion< byte > & in )

inlineinherited

Add new input to process.

Parameters

in	the input to process as a MemoryRegion

Definition at line 39 of file buf_comp.h.

         {
         add_data(&in[0], in.size());
         }

References Botan::MemoryRegion< T >::size().

◆ update() [4/4]

void Botan::Buffered_Computation::update ( const std::string & str )

inlineinherited

Add new input to process.

Parameters

str	the input to process as a std::string. Will be interpreted as a byte array based on the strings encoding.

Definition at line 63 of file buf_comp.h.

         {
         add_data(reinterpret_cast<const byte*>(str.data()), str.size());
         }

◆ update_be()

template<typename T>

void Botan::Buffered_Computation::update_be ( const T in )

inlineinherited

Add an integer in big-endian order

Parameters

in the value

Definition at line 48 of file buf_comp.h.

         {
         for(size_t i = 0; i != sizeof(T); ++i)
            {
            byte b = get_byte(i, in);
            add_data(&b, 1);
            }
         }

References Botan::get_byte().

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

src/hash/hash.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ clear()

◆ clone()

◆ final() [1/2]

◆ final() [2/2]

◆ hash_block_size()

◆ name()

◆ output_length()

◆ process() [1/3]

◆ process() [2/3]

◆ process() [3/3]

◆ update() [1/4]

◆ update() [2/4]

◆ update() [3/4]

◆ update() [4/4]

◆ update_be()