- License
- Botan is released under the Simplified BSD License (see LICENSE.md)
Algorithm Factory
class AlgorithmFactory;
Algorithm Factory
void addEngine(Engine engine);
- Parameters
Engine engine the engine to add to AlgorithmFactory and gives ownership of it.
void clearCaches();
Clear out any cached objects
Vector!string providersOf(in string algo_spec);
- Parameters
string algo_spec the algorithm we are querying - Returns
- list of providers of this algorithm
Possible providers of a request assuming you don't have different types by the same name
void setPreferredProvider(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we are setting a provider for string provider the provider we would like to use
Set the preferred provider for an algorithm
const(BlockCipher) prototypeBlockCipher(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to const prototype object, ready to clone(), or NULL
Prototypical block cipher retrieval by name, it must be cloned to be used
BlockCipher makeBlockCipher(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to freshly created instance of the request algorithm
Makes a ready-to-use block cipher according to its name
void addBlockCipher(BlockCipher block_cipher, in string provider = "");
- Parameters
BlockCipher block_cipher the algorithm to add string provider the provider of this algorithm
Add a new block cipher
const(StreamCipher) prototypeStreamCipher(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- Pointer to const prototype object, ready to clone(), or NULL
Return the prototypical stream cipher corresponding to this request
StreamCipher makeStreamCipher(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- Pointer to freshly created instance of the request algorithm
Return a new stream cipher corresponding to this request
void addStreamCipher(StreamCipher stream_cipher, in string provider = "");
- Parameters
StreamCipher stream_cipher the algorithm to add string provider the provider of this algorithm
Add a new stream cipher
const(HashFunction) prototypeHashFunction(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to const prototype object, ready to clone(), or NULL
Return the prototypical object corresponding to this request (if found)
HashFunction makeHashFunction(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to freshly created instance of the request algorithm
Return a new object corresponding to this request
void addHashFunction(HashFunction hash, in string provider = "");
- Parameters
HashFunction hash the algorithm to add string provider the provider of this algorithm
Add a new hash
const(MessageAuthenticationCode) prototypeMac(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to const prototype object, ready to clone(), or NULL
Return the prototypical object corresponding to this request
MessageAuthenticationCode makeMac(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to freshly created instance of the request algorithm
Return a new object corresponding to this request
void addMac(MessageAuthenticationCode mac, in string provider = "");
- Parameters
MessageAuthenticationCode mac the algorithm to add string provider the provider of this algorithm
const(PBKDF) prototypePbkdf(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to const prototype object, ready to clone(), or NULL
Return the prototypical object corresponding to this request
PBKDF makePbkdf(in string algo_spec, in string provider = "");
- Parameters
string algo_spec the algorithm we want string provider the provider we would like to use - Returns
- pointer to freshly created instance of the request algorithm
Returns a new Pbkdf object corresponding to this request
void addPbkdf(PBKDF pbkdf, in string provider = "");
- Parameters
PBKDF pbkdf the algorithm to add string provider the provider of this algorithm
Add a new Pbkdf
@property ref Vector!Engine engines();
List of engines available