/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 | | #include <botan/exceptn.h> |
12 | | |
13 | | namespace Botan { |
14 | | |
15 | | void HKDF::kdf(uint8_t key[], size_t key_len, |
16 | | const uint8_t secret[], size_t secret_len, |
17 | | const uint8_t salt[], size_t salt_len, |
18 | | const uint8_t label[], size_t label_len) const |
19 | 0 | { |
20 | 0 | HKDF_Extract extract(m_prf->new_object()); |
21 | 0 | HKDF_Expand expand(m_prf->new_object()); |
22 | 0 | secure_vector<uint8_t> prk(m_prf->output_length()); |
23 | |
|
24 | 0 | extract.kdf(prk.data(), prk.size(), secret, secret_len, salt, salt_len, nullptr, 0); |
25 | 0 | expand.kdf(key, key_len, prk.data(), prk.size(), nullptr, 0, label, label_len); |
26 | 0 | } |
27 | | |
28 | | void HKDF_Extract::kdf(uint8_t key[], size_t key_len, |
29 | | const uint8_t secret[], size_t secret_len, |
30 | | const uint8_t salt[], size_t salt_len, |
31 | | const uint8_t /*label*/[], size_t label_len) const |
32 | 0 | { |
33 | 0 | if(key_len == 0) |
34 | 0 | return; |
35 | | |
36 | 0 | const size_t prf_output_len = m_prf->output_length(); |
37 | |
|
38 | 0 | if(key_len > prf_output_len) |
39 | 0 | throw Invalid_Argument("HKDF-Extract maximum output length exceeeded"); |
40 | | |
41 | 0 | if(label_len > 0) |
42 | 0 | throw Invalid_Argument("HKDF-Extract does not support a label input"); |
43 | | |
44 | 0 | if(salt_len == 0) |
45 | 0 | { |
46 | 0 | m_prf->set_key(std::vector<uint8_t>(prf_output_len)); |
47 | 0 | } |
48 | 0 | else |
49 | 0 | { |
50 | 0 | m_prf->set_key(salt, salt_len); |
51 | 0 | } |
52 | |
|
53 | 0 | m_prf->update(secret, secret_len); |
54 | |
|
55 | 0 | if(key_len == prf_output_len) |
56 | 0 | { |
57 | 0 | m_prf->final(key); |
58 | 0 | } |
59 | 0 | else |
60 | 0 | { |
61 | 0 | secure_vector<uint8_t> prk; |
62 | 0 | m_prf->final(prk); |
63 | 0 | copy_mem(&key[0], prk.data(), key_len); |
64 | 0 | } |
65 | 0 | } |
66 | | |
67 | | void HKDF_Expand::kdf(uint8_t key[], size_t key_len, |
68 | | const uint8_t secret[], size_t secret_len, |
69 | | const uint8_t salt[], size_t salt_len, |
70 | | const uint8_t label[], size_t label_len) const |
71 | 0 | { |
72 | 0 | if(key_len == 0) |
73 | 0 | return; |
74 | | |
75 | 0 | const size_t blocks_required = key_len / m_prf->output_length(); |
76 | |
|
77 | 0 | if(blocks_required >= 0xFF) |
78 | 0 | throw Invalid_Argument("HKDF-Expand maximum output length exceeeded"); |
79 | | |
80 | 0 | m_prf->set_key(secret, secret_len); |
81 | |
|
82 | 0 | uint8_t counter = 1; |
83 | 0 | secure_vector<uint8_t> h; |
84 | 0 | size_t offset = 0; |
85 | |
|
86 | 0 | while(offset != key_len) |
87 | 0 | { |
88 | 0 | m_prf->update(h); |
89 | 0 | m_prf->update(label, label_len); |
90 | 0 | m_prf->update(salt, salt_len); |
91 | 0 | m_prf->update(counter++); |
92 | 0 | m_prf->final(h); |
93 | |
|
94 | 0 | const size_t written = std::min(h.size(), key_len - offset); |
95 | 0 | copy_mem(&key[offset], h.data(), written); |
96 | 0 | offset += written; |
97 | 0 | } |
98 | 0 | } |
99 | | |
100 | | secure_vector<uint8_t> |
101 | | hkdf_expand_label(const std::string& hash_fn, |
102 | | const uint8_t secret[], size_t secret_len, |
103 | | const std::string& label, |
104 | | const uint8_t hash_val[], size_t hash_val_len, |
105 | | size_t length) |
106 | 0 | { |
107 | 0 | BOTAN_ARG_CHECK(length <= 0xFFFF, "HKDF-Expand-Label requested output too large"); |
108 | 0 | BOTAN_ARG_CHECK(label.size() <= 0xFF, "HKDF-Expand-Label label too long"); |
109 | 0 | BOTAN_ARG_CHECK(hash_val_len <= 0xFF, "HKDF-Expand-Label hash too long"); |
110 | |
|
111 | 0 | const uint16_t length16 = static_cast<uint16_t>(length); |
112 | |
|
113 | 0 | HKDF_Expand hkdf(MessageAuthenticationCode::create_or_throw("HMAC(" + hash_fn + ")")); |
114 | |
|
115 | 0 | secure_vector<uint8_t> output(length16); |
116 | 0 | std::vector<uint8_t> prefix(3 + label.size() + 1); |
117 | |
|
118 | 0 | prefix[0] = get_byte<0>(length16); |
119 | 0 | prefix[1] = get_byte<1>(length16); |
120 | 0 | prefix[2] = static_cast<uint8_t>(label.size()); |
121 | |
|
122 | 0 | copy_mem(prefix.data() + 3, |
123 | 0 | cast_char_ptr_to_uint8(label.data()), |
124 | 0 | label.size()); |
125 | |
|
126 | 0 | prefix[3 + label.size()] = static_cast<uint8_t>(hash_val_len); |
127 | | |
128 | | /* |
129 | | * We do something a little dirty here to avoid copying the hash_val, |
130 | | * making use of the fact that Botan's KDF interface supports label+salt, |
131 | | * and knowing that our HKDF hashes first param label then param salt. |
132 | | */ |
133 | 0 | hkdf.kdf(output.data(), output.size(), |
134 | 0 | secret, secret_len, |
135 | 0 | hash_val, hash_val_len, |
136 | 0 | prefix.data(), prefix.size()); |
137 | |
|
138 | 0 | return output; |
139 | 0 | } |
140 | | |
141 | | } |