Botan::KDF2 Class Reference

#include <kdf2.h>

Inheritance diagram for Botan::KDF2:

Public Member Functions
void	clear ()
KDF *	clone () const
SecureVector< byte >	derive (size_t, const byte[], size_t, const byte[], size_t) const
SecureVector< byte >	derive_key (size_t key_len, const byte secret[], size_t secret_len, const byte salt[], size_t salt_len) const
SecureVector< byte >	derive_key (size_t key_len, const byte secret[], size_t secret_len, const std::string &salt="") const
SecureVector< byte >	derive_key (size_t key_len, const MemoryRegion< byte > &secret, const byte salt[], size_t salt_len) const
SecureVector< byte >	derive_key (size_t key_len, const MemoryRegion< byte > &secret, const MemoryRegion< byte > &salt) const
SecureVector< byte >	derive_key (size_t key_len, const MemoryRegion< byte > &secret, const std::string &salt="") const
	KDF2 (const KDF2 &other)
	KDF2 (HashFunction *h)
std::string	name () const
	~KDF2 ()

Detailed Description

KDF2, from IEEE 1363

Definition at line 19 of file kdf2.h.

Constructor & Destructor Documentation

KDF2() [1/2]

Botan::KDF2::KDF2 ( HashFunction * h )

inline

Definition at line 28 of file kdf2.h.

: hash(h) {}

Referenced by clone(), Botan::get_kdf(), and KDF2().

KDF2() [2/2]

Botan::KDF2::KDF2 ( const KDF2 & other )

inline

Definition at line 29 of file kdf2.h.

: KDF(), hash(other.hash->clone()) {}

References clone(), and KDF2().

~KDF2()

Botan::KDF2::~KDF2 ( )

inline

Definition at line 30 of file kdf2.h.

{ delete hash; }

Member Function Documentation

clear()

void Botan::KDF::clear ( )

inlinevirtualinherited

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 81 of file kdf.h.

{}

clone()

KDF * Botan::KDF2::clone ( ) const

inlinevirtual

Implements Botan::KDF.

Definition at line 26 of file kdf2.h.

{ return new KDF2(hash->clone()); }

References KDF2().

Referenced by KDF2().

derive()

SecureVector< byte > Botan::KDF2::derive ( size_t out_len, const byte secret[], size_t secret_len, const byte P[], size_t P_len ) const

virtual

Implements Botan::KDF.

Definition at line 15 of file kdf2.cpp.

   {
   SecureVector<byte> output;
   u32bit counter = 1;
 
   while(out_len && counter)
      {
      hash->update(secret, secret_len);
      hash->update_be(counter);
      hash->update(P, P_len);
 
      SecureVector<byte> hash_result = hash->final();
 
      size_t added = std::min(hash_result.size(), out_len);
      output += std::make_pair(&hash_result[0], added);
      out_len -= added;
 
      ++counter;
      }
 
   return output;
   }

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

derive_key() [1/5]

SecureVector< byte > Botan::KDF::derive_key ( size_t key_len, const byte secret[], size_t secret_len, const byte salt[], size_t salt_len ) const

inherited

Derive a key

Parameters

key_len	the desired output length in bytes
secret	the secret input
secret_len	size of secret in bytes
salt	a diversifier
salt_len	size of salt in bytes

Definition at line 61 of file kdf.cpp.

   {
   return derive(key_len, secret, secret_len, salt, salt_len);
   }

derive_key() [2/5]

SecureVector< byte > Botan::KDF::derive_key ( size_t key_len, const byte secret[], size_t secret_len, const std::string & salt = "" ) const

inherited

Derive a key

Parameters

key_len	the desired output length in bytes
secret	the secret input
secret_len	size of secret in bytes
salt	a diversifier

Definition at line 49 of file kdf.cpp.

   {
   return derive_key(key_len, secret, secret_len,
                     reinterpret_cast<const byte*>(salt.data()),
                     salt.length());
   }

References derive_key().

derive_key() [3/5]

SecureVector< byte > Botan::KDF::derive_key ( size_t key_len, const MemoryRegion< byte > & secret, const byte salt[], size_t salt_len ) const

inherited

Derive a key

Parameters

key_len	the desired output length in bytes
secret	the secret input
salt	a diversifier
salt_len	size of salt in bytes

Definition at line 27 of file kdf.cpp.

   {
   return derive_key(key_len, &secret[0], secret.size(),
                     salt, salt_len);
   }

References derive_key(), and Botan::MemoryRegion< T >::size().

derive_key() [4/5]

SecureVector< byte > Botan::KDF::derive_key ( size_t key_len, const MemoryRegion< byte > & secret, const MemoryRegion< byte > & salt ) const

inherited

Derive a key

Parameters

key_len	the desired output length in bytes
secret	the secret input
salt	a diversifier

Definition at line 38 of file kdf.cpp.

   {
   return derive_key(key_len, &secret[0], secret.size(),
                     &salt[0], salt.size());
   }

References derive_key(), and Botan::MemoryRegion< T >::size().

derive_key() [5/5]

SecureVector< byte > Botan::KDF::derive_key ( size_t key_len, const MemoryRegion< byte > & secret, const std::string & salt = "" ) const

inherited

Derive a key

Parameters

key_len	the desired output length in bytes
secret	the secret input
salt	a diversifier

Definition at line 15 of file kdf.cpp.

   {
   return derive_key(key_len, &secret[0], secret.size(),
                     reinterpret_cast<const byte*>(salt.data()),
                     salt.length());
   }

References derive_key(), and Botan::MemoryRegion< T >::size().

Referenced by derive_key(), derive_key(), derive_key(), and derive_key().

name()

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

inlinevirtual

Returns

name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file kdf2.h.

{ return "KDF2(" + hash->name() + ")"; }

---

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

• src/kdf/kdf2/kdf2.h
• src/kdf/kdf2/kdf2.cpp