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

#include <prf_tls.h>

Inheritance diagram for Botan::TLS_PRF:
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
 
 TLS_PRF ()
 

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

PRF used in TLS 1.0/1.1

Definition at line 19 of file prf_tls.h.

Constructor & Destructor Documentation

§ TLS_PRF()

Botan::TLS_PRF::TLS_PRF ( )

Definition at line 13 of file prf_tls.cpp.

References Botan::Buffered_Computation::final(), Botan::CT::min(), Botan::Buffered_Computation::process(), Botan::SymmetricAlgorithm::set_key(), Botan::ASN1::to_string(), Botan::Buffered_Computation::update(), and Botan::xor_buf().

13  :
14  m_hmac_md5(MessageAuthenticationCode::create_or_throw("HMAC(MD5)")),
15  m_hmac_sha1(MessageAuthenticationCode::create_or_throw("HMAC(SHA-1)"))
16  {
17  }
static std::unique_ptr< MessageAuthenticationCode > create_or_throw(const std::string &algo_spec, const std::string &provider="")
Definition: mac.cpp:135

Member Function Documentation

§ clone()

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

Implements Botan::KDF.

Definition at line 24 of file prf_tls.h.

24 { return new TLS_PRF; }

§ 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::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_56C)
189  if(req.algo_name() == "SP800-56C" && req.arg_count() == 1)
190  {
191  std::unique_ptr<KDF> exp(kdf_create_mac_or_hash<SP800_108_Feedback>(req.arg(0)));
192  if(exp)
193  {
194  if(auto mac = MessageAuthenticationCode::create(req.arg(0)))
195  return std::unique_ptr<KDF>(new SP800_56C(mac.release(), exp.release()));
196 
197  if(auto mac = MessageAuthenticationCode::create("HMAC(" + req.arg(0) + ")"))
198  return std::unique_ptr<KDF>(new SP800_56C(mac.release(), exp.release()));
199  }
200  }
201 #endif
202 
203  return nullptr;
204  }
static std::unique_ptr< MessageAuthenticationCode > create(const std::string &algo_spec, const std::string &provider="")
Definition: mac.cpp:43
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:93
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 208 of file kdf.cpp.

References Botan::KDF::create().

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

210  {
211  if(auto bc = KDF::create(algo, provider))
212  {
213  return bc;
214  }
215  throw Lookup_Error("KDF", algo, provider);
216  }
static std::unique_ptr< KDF > create(const std::string &algo_spec, const std::string &provider="")
Definition: kdf.cpp:68

§ 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.

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  }
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.

108  {
109  return derive_key(key_len, secret.data(), secret.size(),
110  reinterpret_cast<const uint8_t*>(salt.data()),
111  salt.length(),
112  reinterpret_cast<const uint8_t*>(label.data()),
113  label.length());
114 
115  }
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.

151  {
152  return derive_key(key_len,
153  secret.data(), secret.size(),
154  salt, salt_len,
155  reinterpret_cast<const uint8_t*>(label.data()),
156  label.size());
157  }
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() [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::get_kdf().

173  {
174  return derive_key(key_len, secret, secret_len,
175  reinterpret_cast<const uint8_t*>(salt.data()),
176  salt.length(),
177  reinterpret_cast<const uint8_t*>(label.data()),
178  label.length());
179  }
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::TLS_PRF::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

Parameters
keybuffer holding the derived key, must be of length key_len
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

Implements Botan::KDF.

Definition at line 61 of file prf_tls.cpp.

65  {
66  const size_t S1_len = (secret_len + 1) / 2,
67  S2_len = (secret_len + 1) / 2;
68  const uint8_t* S1 = secret;
69  const uint8_t* S2 = secret + (secret_len - S2_len);
70  secure_vector<uint8_t> msg;
71 
72  msg.reserve(label_len + salt_len);
73  msg += std::make_pair(label, label_len);
74  msg += std::make_pair(salt, salt_len);
75 
76  P_hash(key, key_len, *m_hmac_md5, S1, S1_len, msg.data(), msg.size());
77  P_hash(key, key_len, *m_hmac_sha1, S2, S2_len, msg.data(), msg.size());
78  return key_len;
79  }

§ name()

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

Implements Botan::KDF.

Definition at line 22 of file prf_tls.h.

22 { return "TLS-PRF"; }

§ 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 218 of file kdf.cpp.

219  {
220  return probe_providers_of<KDF>(algo_spec, { "base" });
221  }

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