#include <dyn_engine.h>

Inheritance diagram for Botan::Dynamically_Loaded_Engine:

Public Member Functions
	Dynamically_Loaded_Engine (const std::string &lib_path)
BlockCipher *	find_block_cipher (const SCAN_Name &algo_spec, Algorithm_Factory &af) const
HashFunction *	find_hash (const SCAN_Name &algo_spec, Algorithm_Factory &af) const
MessageAuthenticationCode *	find_mac (const SCAN_Name &algo_spec, Algorithm_Factory &af) const
PBKDF *	find_pbkdf (const SCAN_Name &algo_spec, Algorithm_Factory &af) const
StreamCipher *	find_stream_cipher (const SCAN_Name &algo_spec, Algorithm_Factory &af) const
Keyed_Filter *	get_cipher (const std::string &algo_spec, Cipher_Dir dir, Algorithm_Factory &af)
PK_Ops::Decryption *	get_decryption_op (const Private_Key &key) const
PK_Ops::Encryption *	get_encryption_op (const Public_Key &key) const
PK_Ops::Key_Agreement *	get_key_agreement_op (const Private_Key &key) const
PK_Ops::Signature *	get_signature_op (const Private_Key &key) const
PK_Ops::Verification *	get_verify_op (const Public_Key &key) const
Modular_Exponentiator *	mod_exp (const BigInt &n, Power_Mod::Usage_Hints hints) const
std::string	provider_name () const
	~Dynamically_Loaded_Engine ()

Detailed Description

Dynamically_Loaded_Engine just proxies the requests to the underlying Engine object, and handles load/unload details

Definition at line 19 of file dyn_engine.h.

Constructor & Destructor Documentation

◆ Dynamically_Loaded_Engine()

Botan::Dynamically_Loaded_Engine::Dynamically_Loaded_Engine ( const std::string & lib_path )

Parameters

lib_path full pathname to DLL to load

Definition at line 22 of file dyn_engine.cpp.

                                  :
   engine(0)
   {
   lib = new Dynamically_Loaded_Library(library_path);
 
   try
      {
      module_version_func get_version =
         lib->resolve<module_version_func>("module_version");
 
      const u32bit mod_version = get_version();
 
      if(mod_version != 20101003)
         throw std::runtime_error("Incompatible version in " +
                                  library_path + " of " +
                                  to_string(mod_version));
 
      creator_func creator =
         lib->resolve<creator_func>("create_engine");
 
      engine = creator();
 
      if(!engine)
         throw std::runtime_error("Creator function in " +
                                  library_path + " failed");
      }
   catch(...)
      {
      delete lib;
      lib = 0;
      throw;
      }
   }

References Botan::Dynamically_Loaded_Library::Dynamically_Loaded_Library(), and Botan::to_string().

◆ ~Dynamically_Loaded_Engine()

Botan::Dynamically_Loaded_Engine::~Dynamically_Loaded_Engine ( )

Definition at line 57 of file dyn_engine.cpp.

   {
   delete engine;
   delete lib;
   }

Member Function Documentation

◆ find_block_cipher()

BlockCipher * Botan::Dynamically_Loaded_Engine::find_block_cipher	(	const SCAN_Name &	algo_spec,
		Algorithm_Factory &	af ) const

inlinevirtual

Parameters

algo_spec	the algorithm name/specification
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 31 of file dyn_engine.h.

         {
         return engine->find_block_cipher(algo_spec, af);
         }

◆ find_hash()

HashFunction * Botan::Dynamically_Loaded_Engine::find_hash	(	const SCAN_Name &	algo_spec,
		Algorithm_Factory &	af ) const

inlinevirtual

Parameters

algo_spec	the algorithm name/specification
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 43 of file dyn_engine.h.

         {
         return engine->find_hash(algo_spec, af);
         }

◆ find_mac()

MessageAuthenticationCode * Botan::Dynamically_Loaded_Engine::find_mac	(	const SCAN_Name &	algo_spec,
		Algorithm_Factory &	af ) const

inlinevirtual

Parameters

algo_spec	the algorithm name/specification
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 49 of file dyn_engine.h.

         {
         return engine->find_mac(algo_spec, af);
         }

◆ find_pbkdf()

PBKDF * Botan::Dynamically_Loaded_Engine::find_pbkdf	(	const SCAN_Name &	algo_spec,
		Algorithm_Factory &	af ) const

inlinevirtual

Parameters

algo_spec	the algorithm name/specification
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 55 of file dyn_engine.h.

         {
         return engine->find_pbkdf(algo_spec, af);
         }

◆ find_stream_cipher()

StreamCipher * Botan::Dynamically_Loaded_Engine::find_stream_cipher	(	const SCAN_Name &	algo_spec,
		Algorithm_Factory &	af ) const

inlinevirtual

Parameters

algo_spec	the algorithm name/specification
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 37 of file dyn_engine.h.

         {
         return engine->find_stream_cipher(algo_spec, af);
         }

◆ get_cipher()

Keyed_Filter * Botan::Dynamically_Loaded_Engine::get_cipher	(	const std::string &	algo_spec,
		Cipher_Dir	dir,
		Algorithm_Factory &	af )

inlinevirtual

Return a new cipher object

Parameters

algo_spec	the algorithm name/specification
dir	specifies if encryption or decryption is desired
af	an algorithm factory object

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 67 of file dyn_engine.h.

         {
         return engine->get_cipher(algo_spec, dir, af);
         }

◆ get_decryption_op()

PK_Ops::Decryption * Botan::Dynamically_Loaded_Engine::get_decryption_op ( const Private_Key & key ) const

inlinevirtual

Return a new operator object for this key, if possible

Parameters

key	the key we want an operator for

Returns: newly allocated operator object, or NULL

Reimplemented from Botan::Engine.

Definition at line 99 of file dyn_engine.h.

         {
         return engine->get_decryption_op(key);
         }

◆ get_encryption_op()

PK_Ops::Encryption * Botan::Dynamically_Loaded_Engine::get_encryption_op ( const Public_Key & key ) const

inlinevirtual

Return a new operator object for this key, if possible

Parameters

key	the key we want an operator for

Returns: newly allocated operator object, or NULL

Reimplemented from Botan::Engine.

Definition at line 93 of file dyn_engine.h.

         {
         return engine->get_encryption_op(key);
         }

◆ get_key_agreement_op()

PK_Ops::Key_Agreement * Botan::Dynamically_Loaded_Engine::get_key_agreement_op ( const Private_Key & key ) const

inlinevirtual

Return a new operator object for this key, if possible

Parameters

key	the key we want an operator for

Returns: newly allocated operator object, or NULL

Reimplemented from Botan::Engine.

Definition at line 75 of file dyn_engine.h.

         {
         return engine->get_key_agreement_op(key);
         }

◆ get_signature_op()

PK_Ops::Signature * Botan::Dynamically_Loaded_Engine::get_signature_op ( const Private_Key & key ) const

inlinevirtual

Return a new operator object for this key, if possible

Parameters

key	the key we want an operator for

Returns: newly allocated operator object, or NULL

Reimplemented from Botan::Engine.

Definition at line 81 of file dyn_engine.h.

         {
         return engine->get_signature_op(key);
         }

◆ get_verify_op()

PK_Ops::Verification * Botan::Dynamically_Loaded_Engine::get_verify_op ( const Public_Key & key ) const

inlinevirtual

Return a new operator object for this key, if possible

Parameters

key	the key we want an operator for

Returns: newly allocated operator object, or NULL

Reimplemented from Botan::Engine.

Definition at line 87 of file dyn_engine.h.

         {
         return engine->get_verify_op(key);
         }

◆ mod_exp()

Modular_Exponentiator * Botan::Dynamically_Loaded_Engine::mod_exp	(	const BigInt &	n,
		Power_Mod::Usage_Hints	hints ) const

inlinevirtual

Parameters

n	the modulus
hints	any use hints

Returns: newly allocated object, or NULL

Reimplemented from Botan::Engine.

Definition at line 61 of file dyn_engine.h.

         {
         return engine->mod_exp(n, hints);
         }

◆ provider_name()

std::string Botan::Dynamically_Loaded_Engine::provider_name ( ) const

inlinevirtual

Returns: name of this engine

Implements Botan::Engine.

Definition at line 29 of file dyn_engine.h.

29{ return engine->provider_name(); }

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

src/engine/dyn_engine/dyn_engine.h
src/engine/dyn_engine/dyn_engine.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Dynamically_Loaded_Engine()

◆ ~Dynamically_Loaded_Engine()

Member Function Documentation

◆ find_block_cipher()

◆ find_hash()

◆ find_mac()

◆ find_pbkdf()

◆ find_stream_cipher()

◆ get_cipher()

◆ get_decryption_op()

◆ get_encryption_op()

◆ get_key_agreement_op()

◆ get_signature_op()

◆ get_verify_op()

◆ mod_exp()

◆ provider_name()