Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | List of all members
Botan::SP800_56C Class Referencefinal

#include <sp800_56c.h>

Inheritance diagram for Botan::SP800_56C:
Botan::KDF

Public Member Functions

KDFclone () const override
 
secure_vector< uint8_t > derive_key (size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[]=nullptr, size_t label_len=0) const
 
secure_vector< uint8_t > derive_key (size_t key_len, const secure_vector< uint8_t > &secret, const std::string &salt="", const std::string &label="") const
 
template<typename Alloc , typename Alloc2 , typename Alloc3 >
secure_vector< uint8_t > derive_key (size_t key_len, const std::vector< uint8_t, Alloc > &secret, const std::vector< uint8_t, Alloc2 > &salt, const std::vector< uint8_t, Alloc3 > &label) const
 
secure_vector< uint8_t > derive_key (size_t key_len, const secure_vector< uint8_t > &secret, const uint8_t salt[], size_t salt_len, const std::string &label="") const
 
secure_vector< uint8_t > derive_key (size_t key_len, const uint8_t secret[], size_t secret_len, const std::string &salt="", const std::string &label="") const
 
size_t kdf (uint8_t key[], size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[], size_t label_len) const override
 
std::string name () const override
 
 SP800_56C (MessageAuthenticationCode *mac, KDF *exp)
 

Static Public Member Functions

static std::unique_ptr< KDFcreate (const std::string &algo_spec, const std::string &provider="")
 
static std::unique_ptr< KDFcreate_or_throw (const std::string &algo_spec, const std::string &provider="")
 
static std::vector< std::string > providers (const std::string &algo_spec)
 

Detailed Description

NIST SP 800-56C KDF

Definition at line 19 of file sp800_56c.h.

Constructor & Destructor Documentation

◆ SP800_56C()

Botan::SP800_56C::SP800_56C ( MessageAuthenticationCode mac,
KDF exp 
)
inline
Parameters
macMAC algorithm used for randomness extraction
expKDF used for key expansion

Definition at line 52 of file sp800_56c.h.

52 : m_prf(mac), m_exp(exp) {}

Member Function Documentation

◆ clone()

KDF* Botan::SP800_56C::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::KDF.

Definition at line 24 of file sp800_56c.h.

References salt_len.

24 { return new SP800_56C(m_prf->clone(), m_exp->clone()); }
SP800_56C(MessageAuthenticationCode *mac, KDF *exp)
Definition: sp800_56c.h:52

◆ create()

std::unique_ptr< KDF > Botan::KDF::create ( const std::string &  algo_spec,
const std::string &  provider = "" 
)
staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters
algo_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 68 of file kdf.cpp.

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_count(), BOTAN_UNUSED, Botan::HashFunction::create(), Botan::MessageAuthenticationCode::create(), and hash.

Referenced by Botan::KDF::create_or_throw(), and Botan::get_kdf().

70  {
71  const SCAN_Name req(algo_spec);
72 
73 #if defined(BOTAN_HAS_HKDF)
74  if(req.algo_name() == "HKDF" && req.arg_count() == 1)
75  {
76  if(provider.empty() || provider == "base")
77  {
78  return kdf_create_mac_or_hash<HKDF>(req.arg(0));
79  }
80  }
81 
82  if(req.algo_name() == "HKDF-Extract" && req.arg_count() == 1)
83  {
84  if(provider.empty() || provider == "base")
85  {
86  return kdf_create_mac_or_hash<HKDF_Extract>(req.arg(0));
87  }
88  }
89 
90  if(req.algo_name() == "HKDF-Expand" && req.arg_count() == 1)
91  {
92  if(provider.empty() || provider == "base")
93  {
94  return kdf_create_mac_or_hash<HKDF_Expand>(req.arg(0));
95  }
96  }
97 #endif
98 
99 #if defined(BOTAN_HAS_KDF2)
100  if(req.algo_name() == "KDF2" && req.arg_count() == 1)
101  {
102  if(provider.empty() || provider == "base")
103  {
104  if(auto hash = HashFunction::create(req.arg(0)))
105  return std::unique_ptr<KDF>(new KDF2(hash.release()));
106  }
107  }
108 #endif
109 
110 #if defined(BOTAN_HAS_KDF1_18033)
111  if(req.algo_name() == "KDF1-18033" && req.arg_count() == 1)
112  {
113  if(provider.empty() || provider == "base")
114  {
115  if(auto hash = HashFunction::create(req.arg(0)))
116  return std::unique_ptr<KDF>(new KDF1_18033(hash.release()));
117  }
118  }
119 #endif
120 
121 #if defined(BOTAN_HAS_KDF1)
122  if(req.algo_name() == "KDF1" && req.arg_count() == 1)
123  {
124  if(provider.empty() || provider == "base")
125  {
126  if(auto hash = HashFunction::create(req.arg(0)))
127  return std::unique_ptr<KDF>(new KDF1(hash.release()));
128  }
129  }
130 #endif
131 
132 #if defined(BOTAN_HAS_TLS_V10_PRF)
133  if(req.algo_name() == "TLS-PRF" && req.arg_count() == 0)
134  {
135  if(provider.empty() || provider == "base")
136  {
137  return std::unique_ptr<KDF>(new TLS_PRF);
138  }
139  }
140 #endif
141 
142 #if defined(BOTAN_HAS_TLS_V12_PRF)
143  if(req.algo_name() == "TLS-12-PRF" && req.arg_count() == 1)
144  {
145  if(provider.empty() || provider == "base")
146  {
147  return kdf_create_mac_or_hash<TLS_12_PRF>(req.arg(0));
148  }
149  }
150 #endif
151 
152 #if defined(BOTAN_HAS_X942_PRF)
153  if(req.algo_name() == "X9.42-PRF" && req.arg_count() == 1)
154  {
155  if(provider.empty() || provider == "base")
156  {
157  return std::unique_ptr<KDF>(new X942_PRF(req.arg(0)));
158  }
159  }
160 #endif
161 
162 #if defined(BOTAN_HAS_SP800_108)
163  if(req.algo_name() == "SP800-108-Counter" && req.arg_count() == 1)
164  {
165  if(provider.empty() || provider == "base")
166  {
167  return kdf_create_mac_or_hash<SP800_108_Counter>(req.arg(0));
168  }
169  }
170 
171  if(req.algo_name() == "SP800-108-Feedback" && req.arg_count() == 1)
172  {
173  if(provider.empty() || provider == "base")
174  {
175  return kdf_create_mac_or_hash<SP800_108_Feedback>(req.arg(0));
176  }
177  }
178 
179  if(req.algo_name() == "SP800-108-Pipeline" && req.arg_count() == 1)
180  {
181  if(provider.empty() || provider == "base")
182  {
183  return kdf_create_mac_or_hash<SP800_108_Pipeline>(req.arg(0));
184  }
185  }
186 #endif
187 
188 #if defined(BOTAN_HAS_SP800_56A)
189  if(req.algo_name() == "SP800-56A" && req.arg_count() == 1)
190  {
191  if(auto hash = HashFunction::create(req.arg(0)))
192  return std::unique_ptr<KDF>(new SP800_56A_Hash(hash.release()));
193  if(auto mac = MessageAuthenticationCode::create(req.arg(0)))
194  return std::unique_ptr<KDF>(new SP800_56A_HMAC(mac.release()));
195  }
196 #endif
197 
198 #if defined(BOTAN_HAS_SP800_56C)
199  if(req.algo_name() == "SP800-56C" && req.arg_count() == 1)
200  {
201  std::unique_ptr<KDF> exp(kdf_create_mac_or_hash<SP800_108_Feedback>(req.arg(0)));
202  if(exp)
203  {
204  if(auto mac = MessageAuthenticationCode::create(req.arg(0)))
205  return std::unique_ptr<KDF>(new SP800_56C(mac.release(), exp.release()));
206 
207  if(auto mac = MessageAuthenticationCode::create("HMAC(" + req.arg(0) + ")"))
208  return std::unique_ptr<KDF>(new SP800_56C(mac.release(), exp.release()));
209  }
210  }
211 #endif
212 
213  BOTAN_UNUSED(req);
214  BOTAN_UNUSED(provider);
215 
216  return nullptr;
217  }
static std::unique_ptr< MessageAuthenticationCode > create(const std::string &algo_spec, const std::string &provider="")
Definition: mac.cpp:45
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:106
#define BOTAN_UNUSED(...)
Definition: assert.h:106
MechanismType hash

◆ create_or_throw()

std::unique_ptr< KDF > Botan::KDF::create_or_throw ( const std::string &  algo_spec,
const std::string &  provider = "" 
)
staticinherited

Create an instance based on a name, or throw if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 221 of file kdf.cpp.

References Botan::KDF::create(), and Botan::KDF::kdf().

Referenced by Botan::ECIES_KA_Operation::derive_secret().

223  {
224  if(auto kdf = KDF::create(algo, provider))
225  {
226  return kdf;
227  }
228  throw Lookup_Error("KDF", algo, provider);
229  }
static std::unique_ptr< KDF > create(const std::string &algo_spec, const std::string &provider="")
Definition: kdf.cpp:68
virtual size_t kdf(uint8_t key[], size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[], size_t label_len) const =0

◆ derive_key() [1/5]

secure_vector<uint8_t> Botan::KDF::derive_key ( size_t  key_len,
const uint8_t  secret[],
size_t  secret_len,
const uint8_t  salt[],
size_t  salt_len,
const uint8_t  label[] = nullptr,
size_t  label_len = 0 
) const
inlineinherited

Derive a key

Parameters
key_lenthe desired output length in bytes
secretthe secret input
secret_lensize of secret in bytes
salta diversifier
salt_lensize of salt in bytes
labelpurpose for the derived keying material
label_lensize of label in bytes
Returns
the derived key

Definition at line 83 of file kdf.h.

References salt_len.

90  {
91  secure_vector<uint8_t> key(key_len);
92  key.resize(kdf(key.data(), key.size(), secret, secret_len, salt, salt_len, label, label_len));
93  return key;
94  }
size_t salt_len
Definition: x509_obj.cpp:25
virtual size_t kdf(uint8_t key[], size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[], size_t label_len) const =0

◆ derive_key() [2/5]

secure_vector<uint8_t> Botan::KDF::derive_key ( size_t  key_len,
const secure_vector< uint8_t > &  secret,
const std::string &  salt = "",
const std::string &  label = "" 
) const
inlineinherited

Derive a key

Parameters
key_lenthe desired output length in bytes
secretthe secret input
salta diversifier
labelpurpose for the derived keying material
Returns
the derived key

Definition at line 104 of file kdf.h.

References Botan::cast_char_ptr_to_uint8().

108  {
109  return derive_key(key_len, secret.data(), secret.size(),
110  cast_char_ptr_to_uint8(salt.data()),
111  salt.length(),
112  cast_char_ptr_to_uint8(label.data()),
113  label.length());
114 
115  }
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:120
secure_vector< uint8_t > derive_key(size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[]=nullptr, size_t label_len=0) const
Definition: kdf.h:83

◆ derive_key() [3/5]

template<typename Alloc , typename Alloc2 , typename Alloc3 >
secure_vector<uint8_t> Botan::KDF::derive_key ( size_t  key_len,
const std::vector< uint8_t, Alloc > &  secret,
const std::vector< uint8_t, Alloc2 > &  salt,
const std::vector< uint8_t, Alloc3 > &  label 
) const
inlineinherited

Derive a key

Parameters
key_lenthe desired output length in bytes
secretthe secret input
salta diversifier
labelpurpose for the derived keying material
Returns
the derived key

Definition at line 126 of file kdf.h.

130  {
131  return derive_key(key_len,
132  secret.data(), secret.size(),
133  salt.data(), salt.size(),
134  label.data(), label.size());
135  }
secure_vector< uint8_t > derive_key(size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[]=nullptr, size_t label_len=0) const
Definition: kdf.h:83

◆ derive_key() [4/5]

secure_vector<uint8_t> Botan::KDF::derive_key ( size_t  key_len,
const secure_vector< uint8_t > &  secret,
const uint8_t  salt[],
size_t  salt_len,
const std::string &  label = "" 
) const
inlineinherited

Derive a key

Parameters
key_lenthe desired output length in bytes
secretthe secret input
salta diversifier
salt_lensize of salt in bytes
labelpurpose for the derived keying material
Returns
the derived key

Definition at line 146 of file kdf.h.

References Botan::cast_char_ptr_to_uint8(), and salt_len.

151  {
152  return derive_key(key_len,
153  secret.data(), secret.size(),
154  salt, salt_len,
155  cast_char_ptr_to_uint8(label.data()),
156  label.size());
157  }
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:120
secure_vector< uint8_t > derive_key(size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[]=nullptr, size_t label_len=0) const
Definition: kdf.h:83
size_t salt_len
Definition: x509_obj.cpp:25

◆ derive_key() [5/5]

secure_vector<uint8_t> Botan::KDF::derive_key ( size_t  key_len,
const uint8_t  secret[],
size_t  secret_len,
const std::string &  salt = "",
const std::string &  label = "" 
) const
inlineinherited

Derive a key

Parameters
key_lenthe desired output length in bytes
secretthe secret input
secret_lensize of secret in bytes
salta diversifier
labelpurpose for the derived keying material
Returns
the derived key

Definition at line 168 of file kdf.h.

References BOTAN_PUBLIC_API, Botan::cast_char_ptr_to_uint8(), and Botan::get_kdf().

173  {
174  return derive_key(key_len, secret, secret_len,
175  cast_char_ptr_to_uint8(salt.data()),
176  salt.length(),
177  cast_char_ptr_to_uint8(label.data()),
178  label.length());
179  }
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:120
secure_vector< uint8_t > derive_key(size_t key_len, const uint8_t secret[], size_t secret_len, const uint8_t salt[], size_t salt_len, const uint8_t label[]=nullptr, size_t label_len=0) const
Definition: kdf.h:83

◆ kdf()

size_t Botan::SP800_56C::kdf ( uint8_t  key[],
size_t  key_len,
const uint8_t  secret[],
size_t  secret_len,
const uint8_t  salt[],
size_t  salt_len,
const uint8_t  label[],
size_t  label_len 
) const
overridevirtual

Derive a key using the SP800-56C KDF.

The implementation hard codes the context value for the expansion step to the empty string.

Parameters
keyderived keying material K_M
key_lenthe desired output length in bytes
secretshared secret Z
secret_lensize of Z in bytes
saltsalt s of the extraction step
salt_lensize of s in bytes
labellabel for the expansion step
label_lensize of label in bytes
Exceptions
Invalid_Argumentkey_len > 2^32

Implements Botan::KDF.

Definition at line 12 of file sp800_56c.cpp.

16  {
17  // Randomness Extraction
18  secure_vector< uint8_t > k_dk;
19 
20  m_prf->set_key(salt, salt_len);
21  m_prf->update(secret, secret_len);
22  m_prf->final(k_dk);
23 
24  // Key Expansion
25  m_exp->kdf(key, key_len, k_dk.data(), k_dk.size(), nullptr, 0, label, label_len);
26 
27  return key_len;
28  }
size_t salt_len
Definition: x509_obj.cpp:25

◆ name()

std::string Botan::SP800_56C::name ( ) const
inlineoverridevirtual
Returns
KDF name

Implements Botan::KDF.

Definition at line 22 of file sp800_56c.h.

22 { return "SP800-56C(" + m_prf->name() + ")"; }

◆ providers()

std::vector< std::string > Botan::KDF::providers ( const std::string &  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available

Definition at line 231 of file kdf.cpp.

232  {
233  return probe_providers_of<KDF>(algo_spec, { "base" });
234  }

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