Botan  1.10.9
Public Member Functions | List of all members
Botan::CRC24 Class Reference

#include <crc24.h>

Inheritance diagram for Botan::CRC24:
Botan::HashFunction Botan::Buffered_Computation Botan::Algorithm

Public Member Functions

void clear ()
 
HashFunctionclone () const
 
 CRC24 ()
 
void final (byte out[])
 
SecureVector< bytefinal ()
 
virtual size_t hash_block_size () const
 
std::string name () const
 
size_t output_length () const
 
SecureVector< byteprocess (const byte in[], size_t length)
 
SecureVector< byteprocess (const MemoryRegion< byte > &in)
 
SecureVector< byteprocess (const std::string &in)
 
void update (const byte in[], size_t length)
 
void update (const MemoryRegion< byte > &in)
 
void update (const std::string &str)
 
void update (byte in)
 
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

Botan::CRC24::CRC24 ( )
inline

Definition at line 27 of file crc24.h.

27 { clear(); }
void clear()
Definition: crc24.h:25
Botan::CRC24::~CRC24 ( )
inline

Definition at line 28 of file crc24.h.

28 { clear(); }
void clear()
Definition: crc24.h:25

Member Function Documentation

void Botan::CRC24::clear ( )
inlinevirtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 25 of file crc24.h.

25 { crc = 0xB704CE; }
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.

23 { return new CRC24; }
void Botan::Buffered_Computation::final ( byte  out[])
inlineinherited
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.

88  {
89  SecureVector<byte> output(output_length());
90  final_result(&output[0]);
91  return output;
92  }
virtual size_t output_length() const =0
virtual size_t Botan::HashFunction::hash_block_size ( ) const
inlinevirtualinherited

The hash block size as defined for this algorithm

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

Definition at line 32 of file hash.h.

Referenced by Botan::Comb4P::hash_block_size(), Botan::HMAC::HMAC(), and Botan::SSL3_MAC::SSL3_MAC().

32 { return 0; }
std::string Botan::CRC24::name ( ) const
inlinevirtual
Returns
name of this algorithm

Implements Botan::Algorithm.

Definition at line 21 of file crc24.h.

21 { return "CRC24"; }
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.

22 { return 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
inthe input to process as a byte array
lengththe length of the byte array
Returns
the result of the call to final()

Definition at line 101 of file buf_comp.h.

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

102  {
103  add_data(in, length);
104  return final();
105  }
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
inthe input to process
Returns
the result of the call to final()

Definition at line 113 of file buf_comp.h.

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

114  {
115  add_data(&in[0], in.size());
116  return final();
117  }
size_t size() const
Definition: secmem.h:29
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
inthe input to process as a string
Returns
the result of the call to final()

Definition at line 125 of file buf_comp.h.

126  {
127  update(in);
128  return final();
129  }
void update(const byte in[], size_t length)
Definition: buf_comp.h:33
void Botan::Buffered_Computation::update ( const byte  in[],
size_t  length 
)
inlineinherited
void Botan::Buffered_Computation::update ( const MemoryRegion< byte > &  in)
inlineinherited

Add new input to process.

Parameters
inthe input to process as a MemoryRegion

Definition at line 39 of file buf_comp.h.

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

40  {
41  add_data(&in[0], in.size());
42  }
size_t size() const
Definition: secmem.h:29
void Botan::Buffered_Computation::update ( const std::string &  str)
inlineinherited

Add new input to process.

Parameters
strthe 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.

64  {
65  add_data(reinterpret_cast<const byte*>(str.data()), str.size());
66  }
void Botan::Buffered_Computation::update ( byte  in)
inlineinherited

Process a single byte.

Parameters
inthe byte to process

Definition at line 72 of file buf_comp.h.

72 { add_data(&in, 1); }
template<typename T >
void Botan::Buffered_Computation::update_be ( const T  in)
inlineinherited

Add an integer in big-endian order

Parameters
inthe value

Definition at line 48 of file buf_comp.h.

References Botan::get_byte().

Referenced by Botan::KDF2::derive(), Botan::PKCS5_PBKDF2::derive_key(), Botan::Record_Reader::get_record(), and Botan::MGF1::mask().

49  {
50  for(size_t i = 0; i != sizeof(T); ++i)
51  {
52  byte b = get_byte(i, in);
53  add_data(&b, 1);
54  }
55  }
byte get_byte(size_t byte_num, T input)
Definition: get_byte.h:21
unsigned char byte
Definition: types.h:22

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