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
|
/*
* Key Derivation Function interfaces
* (C) 1999-2007 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#ifndef BOTAN_KDF_BASE_H__
#define BOTAN_KDF_BASE_H__
#include <botan/scan_name.h>
#include <botan/secmem.h>
#include <botan/types.h>
#include <string>
namespace Botan {
/**
* Key Derivation Function
*/
class BOTAN_DLL KDF
{
public:
virtual ~KDF();
/**
* Create an instance based on a name
* Will return a null pointer if the algo/provider combination cannot
* be found. If providers is empty then best available is chosen.
*/
static std::unique_ptr<KDF> create(const std::string& algo_spec,
const std::string& provider = "");
/**
* Returns the list of available providers for this algorithm, empty if not available
*/
static std::vector<std::string> providers(const std::string& algo_spec);
virtual std::string name() const = 0;
virtual size_t kdf(byte key[], size_t key_len,
const byte secret[], size_t secret_len,
const byte salt[], size_t salt_len) const = 0;
/**
* Derive a key
* @param key_len the desired output length in bytes
* @param secret the secret input
* @param secret_len size of secret in bytes
* @param salt a diversifier
* @param salt_len size of salt in bytes
*/
secure_vector<byte> derive_key(size_t key_len,
const byte secret[],
size_t secret_len,
const byte salt[],
size_t salt_len) const
{
secure_vector<byte> key(key_len);
key.resize(kdf(key.data(), key.size(), secret, secret_len, salt, salt_len));
return key;
}
/**
* Derive a key
* @param key_len the desired output length in bytes
* @param secret the secret input
* @param salt a diversifier
*/
secure_vector<byte> derive_key(size_t key_len,
const secure_vector<byte>& secret,
const std::string& salt = "") const
{
return derive_key(key_len, secret.data(), secret.size(),
reinterpret_cast<const byte*>(salt.data()),
salt.length());
}
/**
* Derive a key
* @param key_len the desired output length in bytes
* @param secret the secret input
* @param salt a diversifier
*/
template<typename Alloc, typename Alloc2>
secure_vector<byte> derive_key(size_t key_len,
const std::vector<byte, Alloc>& secret,
const std::vector<byte, Alloc2>& salt) const
{
return derive_key(key_len,
secret.data(), secret.size(),
salt.data(), salt.size());
}
/**
* Derive a key
* @param key_len the desired output length in bytes
* @param secret the secret input
* @param salt a diversifier
* @param salt_len size of salt in bytes
*/
secure_vector<byte> derive_key(size_t key_len,
const secure_vector<byte>& secret,
const byte salt[],
size_t salt_len) const
{
return derive_key(key_len,
secret.data(), secret.size(),
salt, salt_len);
}
/**
* Derive a key
* @param key_len the desired output length in bytes
* @param secret the secret input
* @param secret_len size of secret in bytes
* @param salt a diversifier
*/
secure_vector<byte> derive_key(size_t key_len,
const byte secret[],
size_t secret_len,
const std::string& salt = "") const
{
return derive_key(key_len, secret, secret_len,
reinterpret_cast<const byte*>(salt.data()),
salt.length());
}
virtual KDF* clone() const = 0;
typedef SCAN_Name Spec;
};
/**
* Factory method for KDF (key derivation function)
* @param algo_spec the name of the KDF to create
* @return pointer to newly allocated object of that type
*/
BOTAN_DLL KDF* get_kdf(const std::string& algo_spec);
}
#endif
|
