Botan::Algorithm_Factory Class Reference

#include <algo_factory.h>

Classes
class	Engine_Iterator

Public Member Functions
void	add_block_cipher (BlockCipher *algo, const std::string &provider)
void	add_engine (Engine *engine)
void	add_hash_function (HashFunction *algo, const std::string &provider)
void	add_mac (MessageAuthenticationCode *algo, const std::string &provider)
void	add_pbkdf (PBKDF *algo, const std::string &provider)
void	add_stream_cipher (StreamCipher *algo, const std::string &provider)
	Algorithm_Factory (Mutex_Factory &mf)
void	clear_caches ()
BlockCipher *	make_block_cipher (const std::string &algo_spec, const std::string &provider="")
HashFunction *	make_hash_function (const std::string &algo_spec, const std::string &provider="")
MessageAuthenticationCode *	make_mac (const std::string &algo_spec, const std::string &provider="")
PBKDF *	make_pbkdf (const std::string &algo_spec, const std::string &provider="")
StreamCipher *	make_stream_cipher (const std::string &algo_spec, const std::string &provider="")
const BlockCipher *	prototype_block_cipher (const std::string &algo_spec, const std::string &provider="")
const HashFunction *	prototype_hash_function (const std::string &algo_spec, const std::string &provider="")
const MessageAuthenticationCode *	prototype_mac (const std::string &algo_spec, const std::string &provider="")
const PBKDF *	prototype_pbkdf (const std::string &algo_spec, const std::string &provider="")
const StreamCipher *	prototype_stream_cipher (const std::string &algo_spec, const std::string &provider="")
std::vector< std::string >	providers_of (const std::string &algo_spec)
void	set_preferred_provider (const std::string &algo_spec, const std::string &provider)
	~Algorithm_Factory ()

Friends
class	Engine_Iterator

Detailed Description

Algorithm Factory

Definition at line 34 of file algo_factory.h.

Constructor & Destructor Documentation

Algorithm_Factory()

Botan::Algorithm_Factory::Algorithm_Factory

(

Mutex_Factory &

mf

)

Constructor

Parameters

mf	a mutex factory

Definition at line 97 of file algo_factory.cpp.

   {
   block_cipher_cache = new Algorithm_Cache<BlockCipher>(mf.make());
   stream_cipher_cache = new Algorithm_Cache<StreamCipher>(mf.make());
   hash_cache = new Algorithm_Cache<HashFunction>(mf.make());
   mac_cache = new Algorithm_Cache<MessageAuthenticationCode>(mf.make());
   pbkdf_cache = new Algorithm_Cache<PBKDF>(mf.make());
   }

References Botan::Algorithm_Cache< T >::Algorithm_Cache(), and Botan::Mutex_Factory::make().

Referenced by Engine_Iterator, Botan::Algorithm_Factory::Engine_Iterator::Engine_Iterator(), and Botan::Library_State::initialize().

~Algorithm_Factory()

Botan::Algorithm_Factory::~Algorithm_Factory

(

)

Destructor

Definition at line 109 of file algo_factory.cpp.

   {
   delete block_cipher_cache;
   delete stream_cipher_cache;
   delete hash_cache;
   delete mac_cache;
   delete pbkdf_cache;
 
   std::for_each(engines.begin(), engines.end(), del_fun<Engine>());
   }

Member Function Documentation

add_block_cipher()

void Botan::Algorithm_Factory::add_block_cipher	(	BlockCipher *	algo,
		const std::string &	provider )

Parameters

algo	the algorithm to add
provider	the provider of this algorithm

Definition at line 309 of file algo_factory.cpp.

   {
   block_cipher_cache->add(block_cipher, block_cipher->name(), provider);
   }

References Botan::Algorithm::name().

add_engine()

void Botan::Algorithm_Factory::add_engine

(

Engine *

engine

)

Parameters

engine

to add (Algorithm_Factory takes ownership)

Definition at line 129 of file algo_factory.cpp.

   {
   clear_caches();
   engines.push_back(engine);
   }

References clear_caches().

Referenced by Botan::Library_State::initialize().

add_hash_function()

void Botan::Algorithm_Factory::add_hash_function	(	HashFunction *	algo,
		const std::string &	provider )

Parameters

algo	the algorithm to add
provider	the provider of this algorithm

Definition at line 327 of file algo_factory.cpp.

   {
   hash_cache->add(hash, hash->name(), provider);
   }

References Botan::Algorithm::name().

add_mac()

void Botan::Algorithm_Factory::add_mac	(	MessageAuthenticationCode *	algo,
		const std::string &	provider )

Parameters

algo	the algorithm to add
provider	the provider of this algorithm

Definition at line 336 of file algo_factory.cpp.

   {
   mac_cache->add(mac, mac->name(), provider);
   }

References Botan::MessageAuthenticationCode::name().

add_pbkdf()

void Botan::Algorithm_Factory::add_pbkdf	(	PBKDF *	algo,
		const std::string &	provider )

Parameters

algo	the algorithm to add
provider	the provider of this algorithm

Definition at line 345 of file algo_factory.cpp.

   {
   pbkdf_cache->add(pbkdf, pbkdf->name(), provider);
   }

References Botan::Algorithm::name().

add_stream_cipher()

void Botan::Algorithm_Factory::add_stream_cipher	(	StreamCipher *	algo,
		const std::string &	provider )

Parameters

algo	the algorithm to add
provider	the provider of this algorithm

Definition at line 318 of file algo_factory.cpp.

   {
   stream_cipher_cache->add(stream_cipher, stream_cipher->name(), provider);
   }

References Botan::Algorithm::name().

clear_caches()

void Botan::Algorithm_Factory::clear_caches

(

)

Clear out any cached objects

Definition at line 120 of file algo_factory.cpp.

   {
   block_cipher_cache->clear_cache();
   stream_cipher_cache->clear_cache();
   hash_cache->clear_cache();
   mac_cache->clear_cache();
   pbkdf_cache->clear_cache();
   }

Referenced by add_engine().

make_block_cipher()

BlockCipher * Botan::Algorithm_Factory::make_block_cipher	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to freshly created instance of the request algorithm

Definition at line 250 of file algo_factory.cpp.

   {
   if(const BlockCipher* proto = prototype_block_cipher(algo_spec, provider))
      return proto->clone();
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), Botan::BlockCipher::clone(), and prototype_block_cipher().

Referenced by Botan::Core_Engine::find_mac(), and Botan::get_block_cipher().

make_hash_function()

HashFunction * Botan::Algorithm_Factory::make_hash_function	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to freshly created instance of the request algorithm

Definition at line 274 of file algo_factory.cpp.

   {
   if(const HashFunction* proto = prototype_hash_function(algo_spec, provider))
      return proto->clone();
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), Botan::HashFunction::clone(), and prototype_hash_function().

Referenced by Botan::Core_Engine::find_mac(), Botan::Core_Engine::find_pbkdf(), Botan::generate_dsa_primes(), Botan::get_eme(), Botan::get_emsa(), Botan::get_hash(), Botan::get_kdf(), and Botan::Hash_Filter::Hash_Filter().

make_mac()

MessageAuthenticationCode * Botan::Algorithm_Factory::make_mac	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to freshly created instance of the request algorithm

Definition at line 286 of file algo_factory.cpp.

   {
   if(const MessageAuthenticationCode* proto = prototype_mac(algo_spec, provider))
      return proto->clone();
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), Botan::MessageAuthenticationCode::clone(), and prototype_mac().

Referenced by Botan::Core_Engine::find_pbkdf(), Botan::get_mac(), Botan::MAC_Filter::MAC_Filter(), Botan::MAC_Filter::MAC_Filter(), Botan::Record_Reader::set_keys(), and Botan::Record_Writer::set_keys().

make_pbkdf()

PBKDF * Botan::Algorithm_Factory::make_pbkdf	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to freshly created instance of the request algorithm

Definition at line 298 of file algo_factory.cpp.

   {
   if(const PBKDF* proto = prototype_pbkdf(algo_spec, provider))
      return proto->clone();
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), Botan::PBKDF::clone(), and prototype_pbkdf().

Referenced by Botan::get_pbkdf().

make_stream_cipher()

StreamCipher * Botan::Algorithm_Factory::make_stream_cipher	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to freshly created instance of the request algorithm

Definition at line 262 of file algo_factory.cpp.

   {
   if(const StreamCipher* proto = prototype_stream_cipher(algo_spec, provider))
      return proto->clone();
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::Algorithm_Not_Found::Algorithm_Not_Found(), Botan::StreamCipher::clone(), and prototype_stream_cipher().

Referenced by Botan::get_stream_cipher(), Botan::StreamCipher_Filter::StreamCipher_Filter(), and Botan::StreamCipher_Filter::StreamCipher_Filter().

prototype_block_cipher()

const BlockCipher * Botan::Algorithm_Factory::prototype_block_cipher	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to const prototype object, ready to clone(), or NULL

Definition at line 193 of file algo_factory.cpp.

   {
   return factory_prototype<BlockCipher>(algo_spec, provider, engines,
                                          *this, block_cipher_cache);
   }

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::block_size_of(), Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::get_cipher(), Botan::get_pbe(), Botan::get_pbe(), Botan::have_algorithm(), Botan::have_block_cipher(), Botan::keylength_multiple_of(), make_block_cipher(), Botan::max_keylength_of(), Botan::min_keylength_of(), providers_of(), Botan::retrieve_block_cipher(), and set_preferred_provider().

prototype_hash_function()

const HashFunction * Botan::Algorithm_Factory::prototype_hash_function	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to const prototype object, ready to clone(), or NULL

Definition at line 215 of file algo_factory.cpp.

   {
   return factory_prototype<HashFunction>(algo_spec, provider, engines,
                                          *this, hash_cache);
   }

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::block_size_of(), Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::find_hash(), Botan::get_pbe(), Botan::get_pbe(), Botan::have_algorithm(), Botan::have_hash(), make_hash_function(), Botan::output_length_of(), providers_of(), Botan::retrieve_hash(), and set_preferred_provider().

prototype_mac()

const MessageAuthenticationCode * Botan::Algorithm_Factory::prototype_mac	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to const prototype object, ready to clone(), or NULL

Definition at line 226 of file algo_factory.cpp.

   {
   return factory_prototype<MessageAuthenticationCode>(algo_spec, provider,
                                                       engines,
                                                       *this, mac_cache);
   }

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::Core_Engine::find_pbkdf(), Botan::have_algorithm(), Botan::have_mac(), Botan::keylength_multiple_of(), make_mac(), Botan::max_keylength_of(), Botan::min_keylength_of(), Botan::output_length_of(), providers_of(), Botan::retrieve_mac(), and set_preferred_provider().

prototype_pbkdf()

const PBKDF * Botan::Algorithm_Factory::prototype_pbkdf	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to const prototype object, ready to clone(), or NULL

Definition at line 238 of file algo_factory.cpp.

   {
   return factory_prototype<PBKDF>(algo_spec, provider,
                                   engines,
                                   *this, pbkdf_cache);
   }

Referenced by make_pbkdf(), providers_of(), and set_preferred_provider().

prototype_stream_cipher()

const StreamCipher * Botan::Algorithm_Factory::prototype_stream_cipher	(	const std::string &	algo_spec,
		const std::string &	provider = "" )

Parameters

algo_spec	the algorithm we want
provider	the provider we would like to use

Returns

pointer to const prototype object, ready to clone(), or NULL

Definition at line 204 of file algo_factory.cpp.

   {
   return factory_prototype<StreamCipher>(algo_spec, provider, engines,
                                          *this, stream_cipher_cache);
   }

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::Core_Engine::find_block_cipher(), Botan::Core_Engine::get_cipher(), Botan::have_algorithm(), Botan::have_stream_cipher(), Botan::keylength_multiple_of(), make_stream_cipher(), Botan::max_keylength_of(), Botan::min_keylength_of(), providers_of(), Botan::retrieve_stream_cipher(), and set_preferred_provider().

providers_of()

std::vector< std::string > Botan::Algorithm_Factory::providers_of

(

const std::string &

algo_spec

)

Parameters

algo_spec

the algorithm we are querying

Returns

list of providers of this algorithm

Definition at line 168 of file algo_factory.cpp.

   {
   /* The checks with if(prototype_X(algo_spec)) have the effect of
      forcing a full search, since otherwise there might not be any
      providers at all in the cache.
   */
 
   if(prototype_block_cipher(algo_spec))
      return block_cipher_cache->providers_of(algo_spec);
   else if(prototype_stream_cipher(algo_spec))
      return stream_cipher_cache->providers_of(algo_spec);
   else if(prototype_hash_function(algo_spec))
      return hash_cache->providers_of(algo_spec);
   else if(prototype_mac(algo_spec))
      return mac_cache->providers_of(algo_spec);
   else if(prototype_pbkdf(algo_spec))
      return pbkdf_cache->providers_of(algo_spec);
   else
      return std::vector<std::string>();
   }

References prototype_block_cipher(), prototype_hash_function(), prototype_mac(), prototype_pbkdf(), and prototype_stream_cipher().

Referenced by Botan::algorithm_benchmark(), and Botan::algorithm_kat().

set_preferred_provider()

void Botan::Algorithm_Factory::set_preferred_provider	(	const std::string &	algo_spec,
		const std::string &	provider )

Parameters

algo_spec	the algorithm we are setting a provider for
provider	the provider we would like to use

Definition at line 138 of file algo_factory.cpp.

   {
   if(prototype_block_cipher(algo_spec))
      block_cipher_cache->set_preferred_provider(algo_spec, provider);
   else if(prototype_stream_cipher(algo_spec))
      stream_cipher_cache->set_preferred_provider(algo_spec, provider);
   else if(prototype_hash_function(algo_spec))
      hash_cache->set_preferred_provider(algo_spec, provider);
   else if(prototype_mac(algo_spec))
      mac_cache->set_preferred_provider(algo_spec, provider);
   else if(prototype_pbkdf(algo_spec))
      pbkdf_cache->set_preferred_provider(algo_spec, provider);
   }

References prototype_block_cipher(), prototype_hash_function(), prototype_mac(), prototype_pbkdf(), and prototype_stream_cipher().

Friends And Related Symbol Documentation

Engine_Iterator

friend class Engine_Iterator

friend

Definition at line 207 of file algo_factory.h.

References Algorithm_Factory().

---

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

• src/algo_factory/algo_factory.h
• src/algo_factory/algo_factory.cpp