Botan  1.11.15
Public Types | Public Member Functions | Protected Attributes
Botan::GCM_Encryption Class Reference

#include <gcm.h>

Inheritance diagram for Botan::GCM_Encryption:
Botan::GCM_Mode Botan::AEAD_Mode Botan::Cipher_Mode Botan::Keyed_Transform Botan::Transform

List of all members.

Public Types

typedef SCAN_Name Spec

Public Member Functions

bool authenticated () const override
void clear () override
size_t default_nonce_length () const override
void finish (secure_vector< byte > &final_block, size_t offset=0) override
 GCM_Encryption (BlockCipher *cipher, size_t tag_size=16)
Key_Length_Specification key_spec () const override
size_t minimum_final_size () const override
std::string name () const override
size_t output_length (size_t input_length) const override
virtual std::string provider () const
template<typename Alloc >
void set_ad (const std::vector< byte, Alloc > &ad)
void set_associated_data (const byte ad[], size_t ad_len) override
template<typename Alloc >
void set_associated_data_vec (const std::vector< byte, Alloc > &ad)
template<typename Alloc >
void set_key (const std::vector< byte, Alloc > &key)
void set_key (const SymmetricKey &key)
void set_key (const byte key[], size_t length)
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 ()
template<typename Alloc >
secure_vector< bytestart_vec (const std::vector< byte, Alloc > &nonce)
size_t tag_size () const override
void update (secure_vector< byte > &blocks, size_t offset=0) override
size_t update_granularity () const
bool valid_keylength (size_t length) const
bool valid_nonce_length (size_t) const override

Protected Attributes

const size_t BS = 16
const std::string m_cipher_name
std::unique_ptr< StreamCipherm_ctr
std::unique_ptr< GHASHm_ghash
const size_t m_tag_size

Detailed Description

GCM Encryption

Definition at line 58 of file gcm.h.


Member Typedef Documentation

typedef SCAN_Name Botan::Transform::Spec [inherited]

Definition at line 27 of file transform.h.


Constructor & Destructor Documentation

Botan::GCM_Encryption::GCM_Encryption ( BlockCipher cipher,
size_t  tag_size = 16 
) [inline]
Parameters:
cipherthe 128 bit block cipher to use
tag_sizeis how big the auth tag will be

Definition at line 65 of file gcm.h.

                                                                :
         GCM_Mode(cipher, tag_size) {}

Member Function Documentation

bool Botan::AEAD_Mode::authenticated ( ) const [inline, override, virtual, inherited]

Returns true iff this mode provides authentication as well as confidentiality.

Reimplemented from Botan::Cipher_Mode.

Definition at line 25 of file aead.h.

{ return true; }
void Botan::GCM_Mode::clear ( ) [override, virtual, inherited]

Implements Botan::Transform.

Definition at line 172 of file gcm.cpp.

References Botan::GCM_Mode::m_ctr, and Botan::GCM_Mode::m_ghash.

   {
   m_ctr->clear();
   m_ghash->clear();
   }
size_t Botan::AEAD_Mode::default_nonce_length ( ) const [inline, override, virtual, inherited]

Default AEAD nonce size (a commonly supported value among AEAD modes, and large enough that random collisions are unlikely).

Implements Botan::Transform.

Reimplemented in Botan::CCM_Mode.

Definition at line 57 of file aead.h.

{ return 12; }
void Botan::GCM_Encryption::finish ( secure_vector< byte > &  final_block,
size_t  offset = 0 
) [override, virtual]

Complete processing of a message.

Parameters:
final_blockin/out parameter which must be at least minimum_final_size() bytes, and will be set to any final output
offsetan offset into final_block to begin processing

Implements Botan::Transform.

Definition at line 247 of file gcm.cpp.

References Botan::GCM_Mode::m_ghash, mac, Botan::GCM_Mode::tag_size(), and update().

   {
   update(buffer, offset);
   auto mac = m_ghash->final();
   buffer += std::make_pair(&mac[0], tag_size());
   }
Key_Length_Specification Botan::GCM_Mode::key_spec ( ) const [override, virtual, inherited]
Returns:
object describing limits on key size

Implements Botan::Keyed_Transform.

Definition at line 188 of file gcm.cpp.

References Botan::GCM_Mode::m_ctr.

   {
   return m_ctr->key_spec();
   }
size_t Botan::GCM_Encryption::minimum_final_size ( ) const [inline, override, virtual]
Returns:
required minimium size to finalize() - may be any length larger than this.

Implements Botan::Transform.

Definition at line 71 of file gcm.h.

{ return 0; }
std::string Botan::GCM_Mode::name ( ) const [override, virtual, inherited]

Implements Botan::Transform.

Definition at line 178 of file gcm.cpp.

References Botan::GCM_Mode::m_cipher_name.

Referenced by Botan::GCM_Mode::GCM_Mode().

   {
   return (m_cipher_name + "/GCM");
   }
size_t Botan::GCM_Encryption::output_length ( size_t  input_length) const [inline, override, virtual]

Returns the size of the output if this transform is used to process a message with input_length bytes. Will throw if unable to give a precise answer.

Implements Botan::Transform.

Definition at line 68 of file gcm.h.

         { return input_length + tag_size(); }
virtual std::string Botan::Transform::provider ( ) const [inline, virtual, inherited]

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 >
void Botan::AEAD_Mode::set_ad ( const std::vector< byte, Alloc > &  ad) [inline, inherited]

Definition at line 48 of file aead.h.

         {
         set_associated_data(&ad[0], ad.size());
         }
void Botan::GCM_Mode::set_associated_data ( const byte  ad[],
size_t  ad_len 
) [override, virtual, inherited]

Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.

Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.

Parameters:
adthe associated data
ad_lenlength of add in bytes

Implements Botan::AEAD_Mode.

Definition at line 205 of file gcm.cpp.

References Botan::GCM_Mode::m_ghash.

   {
   m_ghash->set_associated_data(ad, ad_len);
   }
template<typename Alloc >
void Botan::AEAD_Mode::set_associated_data_vec ( const std::vector< byte, Alloc > &  ad) [inline, inherited]

Definition at line 42 of file aead.h.

         {
         set_associated_data(&ad[0], ad.size());
         }
template<typename Alloc >
void Botan::Keyed_Transform::set_key ( const std::vector< byte, Alloc > &  key) [inline, inherited]

Definition at line 148 of file transform.h.

Referenced by botan_cipher_set_key().

         {
         set_key(&key[0], key.size());
         }
void Botan::Keyed_Transform::set_key ( const SymmetricKey key) [inline, inherited]

Definition at line 153 of file transform.h.

References Botan::OctetString::begin(), and Botan::OctetString::length().

         {
         set_key(key.begin(), key.length());
         }
void Botan::Keyed_Transform::set_key ( const byte  key[],
size_t  length 
) [inline, inherited]

Set the symmetric key of this transform

Parameters:
keycontains the key material
lengthin bytes of key param

Definition at line 163 of file transform.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }
template<typename Alloc >
secure_vector<byte> Botan::Transform::start ( const std::vector< byte, Alloc > &  nonce) [inline, inherited]

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, inherited]

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, inherited]

Begin processing a message.

Definition at line 63 of file transform.h.

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

Begin processing a message.

Parameters:
noncethe per message nonce

Definition at line 45 of file transform.h.

         {
         return start(&nonce[0], nonce.size());
         }
size_t Botan::GCM_Mode::tag_size ( ) const [inline, override, virtual, inherited]

Return the size of the authentication tag used (in bytes)

Reimplemented from Botan::Cipher_Mode.

Definition at line 36 of file gcm.h.

Referenced by finish(), and Botan::GCM_Decryption::finish().

{ return m_tag_size; }
void Botan::GCM_Encryption::update ( secure_vector< byte > &  blocks,
size_t  offset = 0 
) [override, virtual]

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

Parameters:
blocksin/out paramter which will possibly be resized
offsetan offset into blocks to begin processing

Implements Botan::Transform.

Definition at line 237 of file gcm.cpp.

References BOTAN_ASSERT, Botan::GCM_Mode::m_ctr, and Botan::GCM_Mode::m_ghash.

Referenced by finish().

   {
   BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane");
   const size_t sz = buffer.size() - offset;
   byte* buf = &buffer[offset];

   m_ctr->cipher(buf, buf, sz);
   m_ghash->update(buf, sz);
   }
size_t Botan::GCM_Mode::update_granularity ( ) const [virtual, inherited]
Returns:
size of required blocks to update

Implements Botan::Transform.

Definition at line 183 of file gcm.cpp.

   {
   return 4096; // CTR-BE's internal block size
   }
bool Botan::Keyed_Transform::valid_keylength ( size_t  length) const [inline, inherited]

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 142 of file transform.h.

References Botan::Key_Length_Specification::valid_keylength().

         {
         return key_spec().valid_keylength(length);
         }
bool Botan::GCM_Mode::valid_nonce_length ( size_t  nonce_len) const [inline, override, virtual, inherited]

Return true iff nonce_len is a valid length for the nonce

Implements Botan::Transform.

Definition at line 34 of file gcm.h.

{ return true; }

Member Data Documentation

const size_t Botan::GCM_Mode::BS = 16 [protected, inherited]

Definition at line 42 of file gcm.h.

Referenced by Botan::GCM_Mode::GCM_Mode().

const std::string Botan::GCM_Mode::m_cipher_name [protected, inherited]

Definition at line 45 of file gcm.h.

Referenced by Botan::GCM_Mode::name().

std::unique_ptr<StreamCipher> Botan::GCM_Mode::m_ctr [protected, inherited]
std::unique_ptr<GHASH> Botan::GCM_Mode::m_ghash [protected, inherited]
const size_t Botan::GCM_Mode::m_tag_size [protected, inherited]

Definition at line 44 of file gcm.h.

Referenced by Botan::GCM_Mode::GCM_Mode().


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