Botan::Algorithm_Factory Class Reference

#include <algo_factory.h>

List of all members.

Classes
class	Engine_Iterator
Public Member Functions
void	add_block_cipher (BlockCipher *algo, const std::string &provider)
void	add_engine (class Engine *engine)
void	add_hash_function (HashFunction *algo, const std::string &provider)
void	add_mac (MessageAuthenticationCode *algo, const std::string &provider)
void	add_stream_cipher (StreamCipher *algo, const std::string &provider)
	Algorithm_Factory (Mutex_Factory &mf)
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="")
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 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 33 of file algo_factory.h.

---

Constructor & Destructor Documentation

Botan::Algorithm_Factory::Algorithm_Factory

(

Mutex_Factory &

mf

)

Constructor

Parameters:

mf

a mutex factory

Definition at line 90 of file algo_factory.cpp.

References Botan::Mutex_Factory::make().

   {
   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());
   }

Botan::Algorithm_Factory::~Algorithm_Factory

(

)

Destructor

Definition at line 101 of file algo_factory.cpp.

   {
   std::for_each(engines.begin(), engines.end(), del_fun<Engine>());

   delete block_cipher_cache;
   delete stream_cipher_cache;
   delete hash_cache;
   delete mac_cache;
   }

---

Member Function Documentation

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 262 of file algo_factory.cpp.

References Botan::Algorithm_Cache< T >::add(), and Botan::SymmetricAlgorithm::name().

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

void Botan::Algorithm_Factory::add_engine

(

class Engine *

engine

)

Parameters:

engine

to add (Algorithm_Factory takes ownership)

Definition at line 111 of file algo_factory.cpp.

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

   {
   engines.push_back(engine);
   }

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 280 of file algo_factory.cpp.

References Botan::Algorithm_Cache< T >::add(), and Botan::HashFunction::name().

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

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 289 of file algo_factory.cpp.

References Botan::Algorithm_Cache< T >::add(), and Botan::MessageAuthenticationCode::name().

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

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 271 of file algo_factory.cpp.

References Botan::Algorithm_Cache< T >::add(), and Botan::SymmetricAlgorithm::name().

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

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 215 of file algo_factory.cpp.

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

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

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

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 239 of file algo_factory.cpp.

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

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

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

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 251 of file algo_factory.cpp.

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

Referenced by Botan::get_mac(), and Botan::MAC_Filter::MAC_Filter().

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

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 227 of file algo_factory.cpp.

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

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

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

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, readiny for clone(), or NULL

Definition at line 170 of file algo_factory.cpp.

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::block_size_of(), Botan::Default_Engine::find_block_cipher(), Botan::Default_Engine::get_cipher(), 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(), set_preferred_provider(), and Botan::valid_keylength_for().

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

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, readiny for clone(), or NULL

Definition at line 192 of file algo_factory.cpp.

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::block_size_of(), Botan::Default_Engine::find_block_cipher(), Botan::Default_Engine::find_hash(), 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().

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

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, readiny for clone(), or NULL

Definition at line 203 of file algo_factory.cpp.

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), 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(), set_preferred_provider(), and Botan::valid_keylength_for().

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

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, readiny for clone(), or NULL

Definition at line 181 of file algo_factory.cpp.

Referenced by Botan::algorithm_benchmark(), Botan::algorithm_kat(), Botan::Default_Engine::find_block_cipher(), Botan::Default_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(), set_preferred_provider(), and Botan::valid_keylength_for().

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

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 147 of file algo_factory.cpp.

References prototype_block_cipher(), prototype_hash_function(), prototype_mac(), prototype_stream_cipher(), and Botan::Algorithm_Cache< T >::providers_of().

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

   {
   /* 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
      return std::vector<std::string>();
   }

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 119 of file algo_factory.cpp.

References prototype_block_cipher(), prototype_hash_function(), prototype_mac(), prototype_stream_cipher(), and Botan::Algorithm_Cache< T >::set_preferred_provider().

   {
   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);
   }

---

Friends And Related Function Documentation

friend class Engine_Iterator [friend]

Definition at line 178 of file algo_factory.h.

---

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

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