Botan::CRC24 Class Reference

#include <crc24.h>

Inheritance diagram for Botan::CRC24:

Public Member Functions
void	clear ()
HashFunction *	clone () const
	CRC24 ()
SecureVector< byte >	final ()
void	final (byte out[])
virtual size_t	hash_block_size () const
std::string	name () const
size_t	output_length () const
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)
	~CRC24 ()

Detailed Description

24-bit cyclic redundancy check

Definition at line 18 of file crc24.h.

Constructor & Destructor Documentation

CRC24()

Botan::CRC24::CRC24 ( )

inline

Definition at line 27 of file crc24.h.

{ clear(); }

References clear().

Referenced by clone().

~CRC24()

Botan::CRC24::~CRC24 ( )

inline

Definition at line 28 of file crc24.h.

{ clear(); }

References clear().

Member Function Documentation

clear()

void Botan::CRC24::clear ( )

inlinevirtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 25 of file crc24.h.

{ crc = 0xB704CE; }

Referenced by CRC24(), and ~CRC24().

clone()

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

inlinevirtual

Get a new object representing the same algorithm as *this

Implements Botan::HashFunction.

Definition at line 23 of file crc24.h.

{ return new CRC24; }

References CRC24().

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.

{ 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

inlinevirtualinherited

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.

{ return 0; }

name()

std::string Botan::CRC24::name ( ) const

inlinevirtual

Returns

name of this algorithm

Implements Botan::Algorithm.

Definition at line 21 of file crc24.h.

{ return "CRC24"; }

output_length()

size_t Botan::CRC24::output_length ( ) const

inlinevirtual

Returns

length of the output of this function in bytes

Implements Botan::Buffered_Computation.

Definition at line 22 of file crc24.h.

{ return 3; }

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.

{ 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.

{ 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 files:

• src/checksum/crc24/crc24.h
• src/checksum/crc24/crc24.cpp