Coverage Report

Created: 2020-11-21 08:34

/src/botan/src/lib/kdf/hkdf/hkdf.cpp
Line
Count
Source (jump to first uncovered line)
1
/*
2
* HKDF
3
* (C) 2013,2015,2017 Jack Lloyd
4
* (C) 2016 René Korthaus, Rohde & Schwarz Cybersecurity
5
*
6
* Botan is released under the Simplified BSD License (see license.txt)
7
*/
8
9
#include <botan/internal/hkdf.h>
10
#include <botan/internal/loadstor.h>
11
12
namespace Botan {
13
14
size_t HKDF::kdf(uint8_t key[], size_t key_len,
15
                 const uint8_t secret[], size_t secret_len,
16
                 const uint8_t salt[], size_t salt_len,
17
                 const uint8_t label[], size_t label_len) const
18
0
   {
19
0
   HKDF_Extract extract(m_prf->clone());
20
0
   HKDF_Expand expand(m_prf->clone());
21
0
   secure_vector<uint8_t> prk(m_prf->output_length());
22
23
0
   extract.kdf(prk.data(), prk.size(), secret, secret_len, salt, salt_len, nullptr, 0);
24
0
   return expand.kdf(key, key_len, prk.data(), prk.size(), nullptr, 0, label, label_len);
25
0
   }
26
27
size_t HKDF_Extract::kdf(uint8_t key[], size_t key_len,
28
                         const uint8_t secret[], size_t secret_len,
29
                         const uint8_t salt[], size_t salt_len,
30
                         const uint8_t[], size_t) const
31
0
   {
32
0
   secure_vector<uint8_t> prk;
33
0
   if(salt_len == 0)
34
0
      {
35
0
      m_prf->set_key(std::vector<uint8_t>(m_prf->output_length()));
36
0
      }
37
0
   else
38
0
      {
39
0
      m_prf->set_key(salt, salt_len);
40
0
      }
41
42
0
   m_prf->update(secret, secret_len);
43
0
   m_prf->final(prk);
44
45
0
   const size_t written = std::min(prk.size(), key_len);
46
0
   copy_mem(&key[0], prk.data(), written);
47
   // FIXME: returns truncated output
48
0
   return written;
49
0
   }
50
51
size_t HKDF_Expand::kdf(uint8_t key[], size_t key_len,
52
                        const uint8_t secret[], size_t secret_len,
53
                        const uint8_t salt[], size_t salt_len,
54
                        const uint8_t label[], size_t label_len) const
55
0
   {
56
0
   m_prf->set_key(secret, secret_len);
57
58
0
   uint8_t counter = 1;
59
0
   secure_vector<uint8_t> h;
60
0
   size_t offset = 0;
61
62
0
   while(offset != key_len && counter != 0)
63
0
      {
64
0
      m_prf->update(h);
65
0
      m_prf->update(label, label_len);
66
0
      m_prf->update(salt, salt_len);
67
0
      m_prf->update(counter++);
68
0
      m_prf->final(h);
69
70
0
      const size_t written = std::min(h.size(), key_len - offset);
71
0
      copy_mem(&key[offset], h.data(), written);
72
0
      offset += written;
73
0
      }
74
75
   // FIXME: returns truncated output
76
0
   return offset;
77
0
   }
78
79
secure_vector<uint8_t>
80
hkdf_expand_label(const std::string& hash_fn,
81
                  const uint8_t secret[], size_t secret_len,
82
                  const std::string& label,
83
                  const uint8_t hash_val[], size_t hash_val_len,
84
                  size_t length)
85
0
   {
86
0
   BOTAN_ARG_CHECK(length <= 0xFFFF, "HKDF-Expand-Label requested output too large");
87
0
   BOTAN_ARG_CHECK(label.size() <= 0xFF, "HKDF-Expand-Label label too long");
88
0
   BOTAN_ARG_CHECK(hash_val_len <= 0xFF, "HKDF-Expand-Label hash too long");
89
90
0
   const uint16_t length16 = static_cast<uint16_t>(length);
91
92
0
   auto mac = MessageAuthenticationCode::create_or_throw("HMAC(" + hash_fn + ")");
93
94
0
   HKDF_Expand hkdf(mac.release());
95
96
0
   secure_vector<uint8_t> output(length16);
97
0
   std::vector<uint8_t> prefix(3 + label.size() + 1);
98
99
0
   prefix[0] = get_byte(0, length16);
100
0
   prefix[1] = get_byte(1, length16);
101
0
   prefix[2] = static_cast<uint8_t>(label.size());
102
103
0
   copy_mem(prefix.data() + 3,
104
0
            cast_char_ptr_to_uint8(label.data()),
105
0
            label.size());
106
107
0
   prefix[3 + label.size()] = static_cast<uint8_t>(hash_val_len);
108
109
   /*
110
   * We do something a little dirty here to avoid copying the hash_val,
111
   * making use of the fact that Botan's KDF interface supports label+salt,
112
   * and knowing that our HKDF hashes first param label then param salt.
113
   */
114
0
   hkdf.kdf(output.data(), output.size(),
115
0
            secret, secret_len,
116
0
            hash_val, hash_val_len,
117
0
            prefix.data(), prefix.size());
118
119
0
   return output;
120
0
   }
121
122
}