Botan  1.11.15
Public Types | Public Member Functions
Botan::Transform Class Reference

#include <transform.h>

Inheritance diagram for Botan::Transform:
Botan::Compressor_Transform Botan::Keyed_Transform Botan::Stream_Compression Botan::Stream_Decompression Botan::Cipher_Mode Botan::Bzip2_Compression Botan::Deflate_Compression Botan::Gzip_Compression Botan::Gzip_Decompression Botan::LZMA_Compression Botan::Zlib_Compression Botan::Bzip2_Decompression Botan::Deflate_Decompression Botan::LZMA_Decompression Botan::Zlib_Decompression Botan::AEAD_Mode Botan::CBC_Mode Botan::CFB_Mode Botan::ECB_Mode Botan::Stream_Cipher_Mode Botan::XTS_Mode

List of all members.

Public Types

typedef SCAN_Name Spec

Public Member Functions

virtual void clear ()=0
virtual size_t default_nonce_length () const =0
virtual void finish (secure_vector< byte > &final_block, size_t offset=0)=0
virtual size_t minimum_final_size () const =0
virtual std::string name () const =0
virtual size_t output_length (size_t input_length) const =0
virtual std::string provider () const
template<typename Alloc >
secure_vector< bytestart (const std::vector< byte, Alloc > &nonce)
secure_vector< bytestart (const byte nonce[], size_t nonce_len)
secure_vector< bytestart ()
virtual secure_vector< bytestart_raw (const byte nonce[], size_t nonce_len)=0
template<typename Alloc >
secure_vector< bytestart_vec (const std::vector< byte, Alloc > &nonce)
virtual void update (secure_vector< byte > &blocks, size_t offset=0)=0
virtual size_t update_granularity () const =0
virtual bool valid_nonce_length (size_t nonce_len) const =0
virtual ~Transform ()

Detailed Description

Interface for general transformations on data

Definition at line 24 of file transform.h.


Member Typedef Documentation

Definition at line 27 of file transform.h.


Constructor & Destructor Documentation

virtual Botan::Transform::~Transform ( ) [inline, virtual]

Definition at line 126 of file transform.h.

{}

Member Function Documentation

virtual void Botan::Transform::clear ( ) [pure virtual]
virtual size_t Botan::Transform::default_nonce_length ( ) const [pure virtual]
virtual void Botan::Transform::finish ( secure_vector< byte > &  final_block,
size_t  offset = 0 
) [pure virtual]
virtual size_t Botan::Transform::minimum_final_size ( ) const [pure virtual]
virtual std::string Botan::Transform::name ( ) const [pure virtual]
virtual size_t Botan::Transform::output_length ( size_t  input_length) const [pure virtual]
virtual std::string Botan::Transform::provider ( ) const [inline, virtual]

Return some short name describing the provider of this tranformation. Useful in cases where multiple implementations are available (eg, different implementations of AES). Default "core" is used for the 'standard' implementation included in the library.

Definition at line 120 of file transform.h.

{ return "core"; }
template<typename Alloc >
secure_vector<byte> Botan::Transform::start ( const std::vector< byte, Alloc > &  nonce) [inline]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 34 of file transform.h.

Referenced by botan_cipher_start().

         {
         return start(&nonce[0], nonce.size());
         }
secure_vector<byte> Botan::Transform::start ( const byte  nonce[],
size_t  nonce_len 
) [inline]

Begin processing a message.

Parameters:
noncethe per message nonce
nonce_lenlength of nonce

Definition at line 55 of file transform.h.

         {
         return start_raw(nonce, nonce_len);
         }
secure_vector<byte> Botan::Transform::start ( ) [inline]

Begin processing a message.

Definition at line 63 of file transform.h.

         {
         return start_raw(nullptr, 0);
         }
virtual secure_vector<byte> Botan::Transform::start_raw ( const byte  nonce[],
size_t  nonce_len 
) [pure virtual]
template<typename Alloc >
secure_vector<byte> Botan::Transform::start_vec ( const std::vector< byte, Alloc > &  nonce) [inline]

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 45 of file transform.h.

         {
         return start(&nonce[0], nonce.size());
         }
virtual void Botan::Transform::update ( secure_vector< byte > &  blocks,
size_t  offset = 0 
) [pure virtual]
virtual size_t Botan::Transform::update_granularity ( ) const [pure virtual]
virtual bool Botan::Transform::valid_nonce_length ( size_t  nonce_len) const [pure virtual]

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