1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*
* Library Internal/Global State
* (C) 1999-2008 Jack Lloyd
*
* Distributed under the terms of the Botan license
*/
#ifndef BOTAN_LIB_STATE_H__
#define BOTAN_LIB_STATE_H__
#include <botan/allocate.h>
#include <botan/algo_factory.h>
#include <botan/rng.h>
#include <string>
#include <vector>
#include <map>
namespace Botan {
class Mutex;
/**
* Global state container aka the buritto at the center of it all
*/
class BOTAN_DLL Library_State
{
public:
Library_State();
~Library_State();
/**
* @param thread_safe should a mutex be used for serialization
*/
void initialize(bool thread_safe);
/**
* @return the global Algorithm_Factory
*/
Algorithm_Factory& algorithm_factory() const;
/**
* @return the global RandomNumberGenerator
*/
RandomNumberGenerator& global_rng();
/**
* @param name the name of the allocator
* @return allocator matching this name, or NULL
*/
Allocator* get_allocator(const std::string& name = "") const;
/**
* Add a new allocator to the list of available ones
* @param alloc the allocator to add
*/
void add_allocator(Allocator* alloc);
/**
* Set the default allocator
* @param name the name of the allocator to use as the default
*/
void set_default_allocator(const std::string& name);
/**
* Get a parameter value as std::string.
* @param section the section of the desired key
* @param key the desired keys name
* @result the value of the parameter
*/
std::string get(const std::string& section,
const std::string& key) const;
/**
* Check whether a certain parameter is set or not.
* @param section the section of the desired key
* @param key the desired keys name
* @result true if the parameters value is set,
* false otherwise
*/
bool is_set(const std::string& section,
const std::string& key) const;
/**
* Set a configuration parameter.
* @param section the section of the desired key
* @param key the desired keys name
* @param value the new value
* @param overwrite if set to true, the parameters value
* will be overwritten even if it is already set, otherwise
* no existing values will be overwritten.
*/
void set(const std::string& section,
const std::string& key,
const std::string& value,
bool overwrite = true);
/**
* Add a parameter value to the "alias" section.
* @param key the name of the parameter which shall have a new alias
* @param value the new alias
*/
void add_alias(const std::string& key,
const std::string& value);
/**
* Resolve an alias.
* @param alias the alias to resolve.
* @return what the alias stands for
*/
std::string deref_alias(const std::string& alias) const;
/**
* @return a newly created Mutex (free with delete)
*/
Mutex* get_mutex() const;
private:
static RandomNumberGenerator* make_global_rng(Algorithm_Factory& af,
Mutex* mutex);
void load_default_config();
Library_State(const Library_State&) {}
Library_State& operator=(const Library_State&) { return (*this); }
class Mutex_Factory* mutex_factory;
Mutex* global_rng_lock;
RandomNumberGenerator* global_rng_ptr;
Mutex* config_lock;
std::map<std::string, std::string> config;
Mutex* allocator_lock;
std::string default_allocator_name;
std::map<std::string, Allocator*> alloc_factory;
mutable Allocator* cached_default_allocator;
std::vector<Allocator*> allocators;
Algorithm_Factory* m_algorithm_factory;
};
/**
* Access the global library state
* @return reference to the global library state
*/
BOTAN_DLL Library_State& global_state();
/**
* Set the global state object
* @param state the new global state to use
*/
BOTAN_DLL void set_global_state(Library_State* state);
/**
* Swap the current state for another
* @param new_state the new state object to use
* @return the previous state (or NULL if none)
*/
BOTAN_DLL Library_State* swap_global_state(Library_State* new_state);
}
#endif
|
