Botan::Library_State Class Reference

#include <libstate.h>

Public Member Functions
void	add_alias (const std::string &key, const std::string &value)
void	add_allocator (Allocator *alloc)
Algorithm_Factory &	algorithm_factory () const
std::string	deref_alias (const std::string &alias) const
std::string	get (const std::string &section, const std::string &key) const
Allocator *	get_allocator (const std::string &name="") const
Mutex *	get_mutex () const
RandomNumberGenerator &	global_rng ()
void	initialize (bool thread_safe)
bool	is_set (const std::string &section, const std::string &key) const
	Library_State ()
void	set (const std::string &section, const std::string &key, const std::string &value, bool overwrite=true)
void	set_default_allocator (const std::string &name)
	~Library_State ()

Detailed Description

Global state container aka the buritto at the center of it all

Definition at line 27 of file libstate.h.

Constructor & Destructor Documentation

Library_State()

Botan::Library_State::Library_State

(

)

Definition at line 266 of file libstate.cpp.

   {
   mutex_factory = 0;
   allocator_lock = config_lock = 0;
   cached_default_allocator = 0;
   m_algorithm_factory = 0;
 
   global_rng_lock = 0;
   global_rng_ptr = 0;
   }

~Library_State()

Botan::Library_State::~Library_State

(

)

Definition at line 280 of file libstate.cpp.

   {
   delete m_algorithm_factory;
   delete global_rng_ptr;
 
   cached_default_allocator = 0;
 
   for(size_t i = 0; i != allocators.size(); ++i)
      {
      allocators[i]->destroy();
      delete allocators[i];
      }
 
   delete global_rng_lock;
   delete allocator_lock;
   delete mutex_factory;
   delete config_lock;
   }

Member Function Documentation

add_alias()

void Botan::Library_State::add_alias	(	const std::string &	key,
		const std::string &	value )

Add a parameter value to the "alias" section.

Parameters

key	the name of the parameter which shall have a new alias
value	the new alias

Definition at line 154 of file libstate.cpp.

   {
   set("alias", key, value);
   }

References set().

add_allocator()

void Botan::Library_State::add_allocator

(

Allocator *

alloc

)

Add a new allocator to the list of available ones

Parameters

alloc

the allocator to add

Definition at line 87 of file libstate.cpp.

   {
   Mutex_Holder lock(allocator_lock);
 
   allocator->init();
 
   allocators.push_back(allocator);
   alloc_factory[allocator->type()] = allocator;
   }

References Botan::Allocator::init(), and Botan::Allocator::type().

Referenced by initialize().

algorithm_factory()

Algorithm_Factory & Botan::Library_State::algorithm_factory

(

)

const

Returns

global Algorithm_Factory

Definition at line 173 of file libstate.cpp.

   {
   if(!m_algorithm_factory)
      throw Invalid_State("Uninitialized in Library_State::algorithm_factory");
   return *m_algorithm_factory;
   }

References Botan::Invalid_State::Invalid_State().

Referenced by Botan::block_size_of(), Botan::get_block_cipher(), Botan::get_cipher(), Botan::get_eme(), Botan::get_emsa(), Botan::get_hash(), Botan::get_kdf(), Botan::get_mac(), Botan::get_pbe(), Botan::get_pbe(), Botan::get_pbkdf(), Botan::get_stream_cipher(), global_rng(), Botan::Hash_Filter::Hash_Filter(), Botan::have_algorithm(), Botan::have_block_cipher(), Botan::have_hash(), Botan::have_mac(), Botan::have_stream_cipher(), initialize(), Botan::keylength_multiple_of(), Botan::MAC_Filter::MAC_Filter(), Botan::MAC_Filter::MAC_Filter(), Botan::max_keylength_of(), Botan::min_keylength_of(), Botan::output_length_of(), Botan::retrieve_block_cipher(), Botan::retrieve_hash(), Botan::retrieve_mac(), Botan::retrieve_stream_cipher(), Botan::Record_Reader::set_keys(), Botan::Record_Writer::set_keys(), Botan::StreamCipher_Filter::StreamCipher_Filter(), and Botan::StreamCipher_Filter::StreamCipher_Filter().

deref_alias()

std::string Botan::Library_State::deref_alias

(

const std::string &

alias

)

const

Resolve an alias.

Parameters

alias

the alias to resolve.

Returns

what the alias stands for

Definition at line 162 of file libstate.cpp.

   {
   std::string result = key;
   while(is_set("alias", result))
      result = get("alias", result);
   return result;
   }

References get(), and is_set().

Referenced by Botan::get_pbe(), Botan::get_pbe(), and Botan::SCAN_Name::SCAN_Name().

get()

std::string Botan::Library_State::get	(	const std::string &	section,
		const std::string &	key ) const

Get a parameter value as std::string.

Parameters

section	the section of the desired key
key	the desired keys name

Returns

the value of the parameter

Definition at line 114 of file libstate.cpp.

   {
   Mutex_Holder lock(config_lock);
 
   return search_map<std::string, std::string>(config,
                                               section + "/" + key, "");
   }

References Botan::search_map().

Referenced by deref_alias(), Botan::DL_Group::DL_Group(), Botan::EC_Group::EC_Group(), Botan::OIDS::lookup(), and Botan::OIDS::lookup().

get_allocator()

Allocator * Botan::Library_State::get_allocator

(

const std::string &

name = ""

)

const

Parameters

name	the name of the allocator

Returns

allocator matching this name, or NULL

Definition at line 67 of file libstate.cpp.

   {
   Mutex_Holder lock(allocator_lock);
 
   if(type != "")
      return search_map<std::string, Allocator*>(alloc_factory, type, 0);
 
   if(!cached_default_allocator)
      {
      cached_default_allocator =
         search_map<std::string, Allocator*>(alloc_factory,
                                             default_allocator_name, 0);
      }
 
   return cached_default_allocator;
   }

References Botan::search_map().

Referenced by Botan::Allocator::get().

get_mutex()

Mutex * Botan::Library_State::get_mutex

(

)

const

Returns

newly created Mutex (free with delete)

Definition at line 59 of file libstate.cpp.

   {
   return mutex_factory->make();
   }

Referenced by initialize().

global_rng()

RandomNumberGenerator & Botan::Library_State::global_rng

(

)

Returns

global RandomNumberGenerator

Definition at line 183 of file libstate.cpp.

   {
   Mutex_Holder lock(global_rng_lock);
 
   if(!global_rng_ptr)
      global_rng_ptr = make_global_rng(algorithm_factory(),
                                       global_rng_lock);
 
   return *global_rng_ptr;
   }

References algorithm_factory().

Referenced by Botan::AutoSeeded_RNG::AutoSeeded_RNG().

initialize()

void Botan::Library_State::initialize

(

bool

thread_safe

)

Parameters

thread_safe

should a mutex be used for serialization

Definition at line 197 of file libstate.cpp.

   {
   CPUID::initialize();
 
   if(mutex_factory)
      throw Invalid_State("Library_State has already been initialized");
 
   if(!thread_safe)
      {
      mutex_factory = new Noop_Mutex_Factory;
      }
   else
      {
#if defined(BOTAN_HAS_MUTEX_PTHREAD)
      mutex_factory = new Pthread_Mutex_Factory;
#elif defined(BOTAN_HAS_MUTEX_WIN32)
      mutex_factory = new Win32_Mutex_Factory;
#else
      throw Invalid_State("Could not find a thread-safe mutex object to use");
#endif
      }
 
   allocator_lock = get_mutex();
   config_lock = get_mutex();
   global_rng_lock = get_mutex();
 
   default_allocator_name = has_mlock() ? "locking" : "malloc";
 
   add_allocator(new Malloc_Allocator);
   add_allocator(new Locking_Allocator(get_mutex()));
 
#if defined(BOTAN_HAS_ALLOC_MMAP)
   add_allocator(new MemoryMapping_Allocator(get_mutex()));
#endif
 
   load_default_config();
 
   m_algorithm_factory = new Algorithm_Factory(*mutex_factory);
 
#if defined(BOTAN_HAS_ENGINE_GNU_MP)
   algorithm_factory().add_engine(new GMP_Engine);
#endif
 
#if defined(BOTAN_HAS_ENGINE_OPENSSL)
   algorithm_factory().add_engine(new OpenSSL_Engine);
#endif
 
#if defined(BOTAN_HAS_ENGINE_AES_ISA)
   algorithm_factory().add_engine(new AES_ISA_Engine);
#endif
 
#if defined(BOTAN_HAS_ENGINE_SIMD)
   algorithm_factory().add_engine(new SIMD_Engine);
#endif
 
#if defined(BOTAN_HAS_ENGINE_ASSEMBLER)
   algorithm_factory().add_engine(new Assembler_Engine);
#endif
 
   algorithm_factory().add_engine(new Core_Engine);
 
#if defined(BOTAN_HAS_SELFTESTS)
   confirm_startup_self_tests(algorithm_factory());
#endif
   }

References add_allocator(), Botan::Algorithm_Factory::add_engine(), Botan::Algorithm_Factory::Algorithm_Factory(), algorithm_factory(), Botan::confirm_startup_self_tests(), get_mutex(), Botan::has_mlock(), Botan::CPUID::initialize(), Botan::Invalid_State::Invalid_State(), Botan::Locking_Allocator::Locking_Allocator(), and Botan::MemoryMapping_Allocator::MemoryMapping_Allocator().

Referenced by Botan::Global_State_Management::global_state(), and Botan::LibraryInitializer::initialize().

is_set()

bool Botan::Library_State::is_set	(	const std::string &	section,
		const std::string &	key ) const

Check whether a certain parameter is set or not.

Parameters

section	the section of the desired key
key	the desired keys name

Returns

true if the parameters value is set, false otherwise

Definition at line 126 of file libstate.cpp.

   {
   Mutex_Holder lock(config_lock);
 
   return config.count(section + "/" + key) != 0;
   }

Referenced by deref_alias(), and Botan::OIDS::have_oid().

set()

void Botan::Library_State::set	(	const std::string &	section,
		const std::string &	key,
		const std::string &	value,
		bool	overwrite = true )

Set a configuration parameter.

Parameters

section	the section of the desired key
key	the desired keys name
value	the new value
overwrite	if set to true, the parameters value will be overwritten even if it is already set, otherwise no existing values will be overwritten.

Definition at line 137 of file libstate.cpp.

   {
   Mutex_Holder lock(config_lock);
 
   std::string full_key = section + "/" + key;
 
   std::map<std::string, std::string>::const_iterator i =
      config.find(full_key);
 
   if(overwrite || i == config.end() || i->second == "")
      config[full_key] = value;
   }

Referenced by add_alias(), and Botan::OIDS::add_oid().

set_default_allocator()

void Botan::Library_State::set_default_allocator

(

const std::string &

name

)

Set the default allocator

Parameters

name	the name of the allocator to use as the default

Definition at line 100 of file libstate.cpp.

   {
   Mutex_Holder lock(allocator_lock);
 
   if(type == "")
      return;
 
   default_allocator_name = type;
   cached_default_allocator = 0;
   }

---

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

• src/libstate/libstate.h
• src/libstate/global_rng.cpp
• src/libstate/libstate.cpp
• src/libstate/policy.cpp