• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

randombit / botan / 25269902277

02 May 2026 12:07PM UTC coverage: 89.376% (-0.003%) from 89.379%
25269902277

push

github

web-flow
Merge pull request #5561 from randombit/jack/add-missing-verify-end

Add some missing calls to BER_Decoder::verify_end

107164 of 119903 relevant lines covered (89.38%)

11239526.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.57
/src/lib/pubkey/pkcs8.cpp
1
/*
2
* PKCS #8
3
* (C) 1999-2010,2014,2018 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/pkcs8.h>
9

10
#include <botan/asn1_obj.h>
11
#include <botan/assert.h>
12
#include <botan/ber_dec.h>
13
#include <botan/der_enc.h>
14
#include <botan/pem.h>
15
#include <botan/pk_algs.h>
16
#include <botan/rng.h>
17
#include <botan/internal/fmt.h>
18
#include <botan/internal/scan_name.h>
19

20
#if defined(BOTAN_HAS_PKCS5_PBES2)
21
   #include <botan/internal/pbes2.h>
22
#endif
23

24
namespace Botan::PKCS8 {
25

26
namespace {
27

28
/*
29
* Get info from an EncryptedPrivateKeyInfo
30
*/
31
secure_vector<uint8_t> PKCS8_extract(DataSource& source, AlgorithmIdentifier& pbe_alg_id) {
501✔
32
   secure_vector<uint8_t> key_data;
501✔
33

34
   BER_Decoder(source, BER_Decoder::Limits::DER())
1,002✔
35
      .start_sequence()
501✔
36
      .decode(pbe_alg_id)
501✔
37
      .decode(key_data, ASN1_Type::OctetString)
501✔
38
      .verify_end();
501✔
39

40
   return key_data;
501✔
41
}
×
42

43
/*
44
* PEM decode and/or decrypt a private key
45
*/
46
secure_vector<uint8_t> PKCS8_decode(DataSource& source,
4,947✔
47
                                    const std::function<std::string()>& get_passphrase,
48
                                    AlgorithmIdentifier& pk_alg_id,
49
                                    bool is_encrypted) {
50
   AlgorithmIdentifier pbe_alg_id;
4,947✔
51
   secure_vector<uint8_t> key_data;
4,947✔
52
   secure_vector<uint8_t> key;
4,947✔
53

54
   try {
4,947✔
55
      if(ASN1::maybe_BER(source) && !PEM_Code::matches(source)) {
4,947✔
56
         if(is_encrypted) {
2,173✔
57
            key_data = PKCS8_extract(source, pbe_alg_id);
510✔
58
         } else {
59
            // todo read more efficiently
60
            while(auto b = source.read_byte()) {
1,205,860✔
61
               key_data.push_back(*b);
1,203,942✔
62
            }
1,203,942✔
63
         }
64
      } else {
65
         std::string label;
2,773✔
66
         key_data = PEM_Code::decode(source, label);
5,484✔
67

68
         // todo remove autodetect for pem as well?
69
         if(label == "PRIVATE KEY") {
2,711✔
70
            is_encrypted = false;
71
         } else if(label == "ENCRYPTED PRIVATE KEY") {
274✔
72
            DataSource_Memory key_source(key_data);
336✔
73
            key_data = PKCS8_extract(key_source, pbe_alg_id);
492✔
74
         } else {
246✔
75
            throw PKCS8_Exception(fmt("Unknown PEM label '{}'", label));
28✔
76
         }
77
      }
2,773✔
78

79
      if(key_data.empty()) {
4,856✔
80
         throw PKCS8_Exception("No key data found");
×
81
      }
82
   } catch(Decoding_Error& e) {
91✔
83
      throw Decoding_Error("PKCS #8 private key decoding", e);
83✔
84
   }
83✔
85

86
   try {
4,856✔
87
      if(is_encrypted) {
4,856✔
88
         if(pbe_alg_id.oid().to_formatted_string() != "PBE-PKCS5v20") {
501✔
89
            throw PKCS8_Exception(fmt("Unknown PBE type {}", pbe_alg_id.oid()));
×
90
         }
91

92
#if defined(BOTAN_HAS_PKCS5_PBES2)
93
         key = pbes2_decrypt(key_data, get_passphrase(), pbe_alg_id.parameters());
1,503✔
94
#else
95
         BOTAN_UNUSED(get_passphrase);
96
         throw Decoding_Error("Private key is encrypted but PBES2 was disabled in build");
97
#endif
98
      } else {
99
         key = key_data;
4,355✔
100
      }
101

102
      BER_Decoder(key, BER_Decoder::Limits::DER())
11,268✔
103
         .start_sequence()
3,709✔
104
         .decode_and_check<size_t>(0, "Unknown PKCS #8 version number")
7,352✔
105
         .decode(pk_alg_id)
3,643✔
106
         .decode(key, ASN1_Type::OctetString)
3,638✔
107
         .discard_remaining()
3,638✔
108
         .end_cons()
3,638✔
109
         .verify_end();
3,638✔
110
   } catch(std::exception& e) {
1,556✔
111
      throw Decoding_Error("PKCS #8 private key decoding", e);
1,556✔
112
   }
1,556✔
113
   return key;
6,600✔
114
}
6,594✔
115

116
}  // namespace
117

118
/*
119
* PEM encode a PKCS #8 private key, unencrypted
120
*/
121
std::string PEM_encode(const Private_Key& key) {
60✔
122
   return PEM_Code::encode(key.private_key_info(), "PRIVATE KEY");
180✔
123
}
124

125
#if defined(BOTAN_HAS_PKCS5_PBES2)
126

127
namespace {
128

129
std::pair<std::string, std::string> choose_pbe_params(std::string_view pbe_algo, std::string_view key_algo) {
470✔
130
   if(pbe_algo.empty()) {
470✔
131
      /*
132
      * For algorithms where we are using a non-RFC format anyway, default to
133
      * SIV or GCM. For others (RSA, ECDSA, ...) default to something widely
134
      * compatible.
135
      */
136
      const bool nonstandard_pk = (key_algo == "McEliece" || key_algo == "XMSS");
26✔
137

138
      if(nonstandard_pk) {
26✔
139
   #if defined(BOTAN_HAS_AEAD_SIV) && defined(BOTAN_HAS_SHA2_64)
140
         return std::make_pair("AES-256/SIV", "SHA-512");
×
141
   #elif defined(BOTAN_HAS_AEAD_GCM) && defined(BOTAN_HAS_SHA2_64)
142
         return std::make_pair("AES-256/GCM", "SHA-512");
143
   #endif
144
      }
145

146
      // Default is something compatible with everyone else
147
      return std::make_pair("AES-256/CBC", "SHA-256");
26✔
148
   }
149

150
   const SCAN_Name request(pbe_algo);
444✔
151

152
   if(request.arg_count() != 2 || (request.algo_name() != "PBE-PKCS5v20" && request.algo_name() != "PBES2")) {
444✔
153
      throw Invalid_Argument(fmt("Unsupported PBE '{}'", pbe_algo));
×
154
   }
155

156
   return std::make_pair(request.arg(0), request.arg(1));
888✔
157
}
444✔
158

159
}  // namespace
160

161
#endif
162

163
/*
164
* BER encode a PKCS #8 private key, encrypted
165
*/
166
std::vector<uint8_t> BER_encode(const Private_Key& key,
470✔
167
                                RandomNumberGenerator& rng,
168
                                std::string_view pass,
169
                                std::chrono::milliseconds msec,
170
                                std::string_view pbe_algo) {
171
#if defined(BOTAN_HAS_PKCS5_PBES2)
172
   const auto pbe_params = choose_pbe_params(pbe_algo, key.algo_name());
470✔
173

174
   const std::pair<AlgorithmIdentifier, std::vector<uint8_t>> pbe_info =
470✔
175
      pbes2_encrypt_msec(PKCS8::BER_encode(key), pass, msec, nullptr, pbe_params.first, pbe_params.second, rng);
470✔
176

177
   std::vector<uint8_t> output;
470✔
178
   DER_Encoder der(output);
470✔
179
   der.start_sequence().encode(pbe_info.first).encode(pbe_info.second, ASN1_Type::OctetString).end_cons();
470✔
180

181
   return output;
940✔
182
#else
183
   BOTAN_UNUSED(key, rng, pass, msec, pbe_algo);
184
   throw Encoding_Error("PKCS8::BER_encode cannot encrypt because PBES2 was disabled in build");
185
#endif
186
}
940✔
187

188
/*
189
* PEM encode a PKCS #8 private key, encrypted
190
*/
191
std::string PEM_encode(const Private_Key& key,
242✔
192
                       RandomNumberGenerator& rng,
193
                       std::string_view pass,
194
                       std::chrono::milliseconds msec,
195
                       std::string_view pbe_algo) {
196
   if(pass.empty()) {
242✔
197
      return PEM_encode(key);
×
198
   }
199

200
   return PEM_Code::encode(PKCS8::BER_encode(key, rng, pass, msec, pbe_algo), "ENCRYPTED PRIVATE KEY");
726✔
201
}
202

203
/*
204
* BER encode a PKCS #8 private key, encrypted
205
*/
206
std::vector<uint8_t> BER_encode_encrypted_pbkdf_iter(const Private_Key& key,
48✔
207
                                                     RandomNumberGenerator& rng,
208
                                                     std::string_view pass,
209
                                                     size_t pbkdf_iterations,
210
                                                     std::string_view cipher,
211
                                                     std::string_view pbkdf_hash) {
212
#if defined(BOTAN_HAS_PKCS5_PBES2)
213
   const std::pair<AlgorithmIdentifier, std::vector<uint8_t>> pbe_info =
48✔
214
      pbes2_encrypt_iter(key.private_key_info(),
48✔
215
                         pass,
216
                         pbkdf_iterations,
217
                         cipher.empty() ? "AES-256/CBC" : cipher,
48✔
218
                         pbkdf_hash.empty() ? "SHA-256" : pbkdf_hash,
48✔
219
                         rng);
96✔
220

221
   std::vector<uint8_t> output;
48✔
222
   DER_Encoder der(output);
48✔
223
   der.start_sequence().encode(pbe_info.first).encode(pbe_info.second, ASN1_Type::OctetString).end_cons();
48✔
224

225
   return output;
48✔
226

227
#else
228
   BOTAN_UNUSED(key, rng, pass, pbkdf_iterations, cipher, pbkdf_hash);
229
   throw Encoding_Error("PKCS8::BER_encode_encrypted_pbkdf_iter cannot encrypt because PBES2 disabled in build");
230
#endif
231
}
48✔
232

233
/*
234
* PEM encode a PKCS #8 private key, encrypted
235
*/
236
std::string PEM_encode_encrypted_pbkdf_iter(const Private_Key& key,
24✔
237
                                            RandomNumberGenerator& rng,
238
                                            std::string_view pass,
239
                                            size_t pbkdf_iterations,
240
                                            std::string_view cipher,
241
                                            std::string_view pbkdf_hash) {
242
   return PEM_Code::encode(PKCS8::BER_encode_encrypted_pbkdf_iter(key, rng, pass, pbkdf_iterations, cipher, pbkdf_hash),
24✔
243
                           "ENCRYPTED PRIVATE KEY");
48✔
244
}
245

246
/*
247
* BER encode a PKCS #8 private key, encrypted
248
*/
249
std::vector<uint8_t> BER_encode_encrypted_pbkdf_msec(const Private_Key& key,
20✔
250
                                                     RandomNumberGenerator& rng,
251
                                                     std::string_view pass,
252
                                                     std::chrono::milliseconds pbkdf_msec,
253
                                                     size_t* pbkdf_iterations,
254
                                                     std::string_view cipher,
255
                                                     std::string_view pbkdf_hash) {
256
#if defined(BOTAN_HAS_PKCS5_PBES2)
257
   const std::pair<AlgorithmIdentifier, std::vector<uint8_t>> pbe_info =
20✔
258
      pbes2_encrypt_msec(key.private_key_info(),
20✔
259
                         pass,
260
                         pbkdf_msec,
261
                         pbkdf_iterations,
262
                         cipher.empty() ? "AES-256/CBC" : cipher,
20✔
263
                         pbkdf_hash.empty() ? "SHA-256" : pbkdf_hash,
20✔
264
                         rng);
40✔
265

266
   std::vector<uint8_t> output;
20✔
267
   DER_Encoder(output)
40✔
268
      .start_sequence()
20✔
269
      .encode(pbe_info.first)
20✔
270
      .encode(pbe_info.second, ASN1_Type::OctetString)
20✔
271
      .end_cons();
20✔
272

273
   return output;
20✔
274
#else
275
   BOTAN_UNUSED(key, rng, pass, pbkdf_msec, pbkdf_iterations, cipher, pbkdf_hash);
276
   throw Encoding_Error("BER_encode_encrypted_pbkdf_msec cannot encrypt because PBES2 disabled in build");
277
#endif
278
}
20✔
279

280
/*
281
* PEM encode a PKCS #8 private key, encrypted
282
*/
283
std::string PEM_encode_encrypted_pbkdf_msec(const Private_Key& key,
4✔
284
                                            RandomNumberGenerator& rng,
285
                                            std::string_view pass,
286
                                            std::chrono::milliseconds pbkdf_msec,
287
                                            size_t* pbkdf_iterations,
288
                                            std::string_view cipher,
289
                                            std::string_view pbkdf_hash) {
290
   return PEM_Code::encode(
4✔
291
      PKCS8::BER_encode_encrypted_pbkdf_msec(key, rng, pass, pbkdf_msec, pbkdf_iterations, cipher, pbkdf_hash),
4✔
292
      "ENCRYPTED PRIVATE KEY");
8✔
293
}
294

295
namespace {
296

297
/*
298
* Extract a private key (encrypted/unencrypted) and return it
299
*/
300
std::unique_ptr<Private_Key> load_key(DataSource& source,
4,947✔
301
                                      const std::function<std::string()>& get_pass,
302
                                      bool is_encrypted) {
303
   AlgorithmIdentifier alg_id;
4,947✔
304
   secure_vector<uint8_t> pkcs8_key = PKCS8_decode(source, get_pass, alg_id, is_encrypted);
4,947✔
305

306
   const std::string alg_name = alg_id.oid().human_name_or_empty();
3,300✔
307
   if(alg_name.empty()) {
3,300✔
308
      throw PKCS8_Exception(fmt("Unknown algorithm OID {}", alg_id.oid()));
×
309
   }
310

311
   return load_private_key(alg_id, pkcs8_key);
6,511✔
312
}
8,247✔
313

314
}  // namespace
315

316
/*
317
* Extract an encrypted private key and return it
318
*/
319
std::unique_ptr<Private_Key> load_key(DataSource& source, const std::function<std::string()>& get_pass) {
11✔
320
   return load_key(source, get_pass, true);
11✔
321
}
322

323
std::unique_ptr<Private_Key> load_key(std::span<const uint8_t> source,
×
324
                                      const std::function<std::string()>& get_passphrase) {
325
   Botan::DataSource_Memory ds(source);
×
326
   return load_key(ds, get_passphrase);
×
327
}
×
328

329
std::unique_ptr<Private_Key> load_key(std::span<const uint8_t> source, std::string_view pass) {
×
330
   Botan::DataSource_Memory ds(source);
×
331
   return load_key(ds, pass);
×
332
}
×
333

334
std::unique_ptr<Private_Key> load_key(std::span<const uint8_t> source) {
14✔
335
   Botan::DataSource_Memory ds(source);
14✔
336
   return load_key(ds);
14✔
337
}
14✔
338

339
/*
340
* Extract an encrypted private key and return it
341
*/
342
std::unique_ptr<Private_Key> load_key(DataSource& source, std::string_view pass) {
524✔
343
   return load_key(
524✔
344
      source, [pass]() { return std::string(pass); }, true);
1,539✔
345
}
346

347
/*
348
* Extract an unencrypted private key and return it
349
*/
350
std::unique_ptr<Private_Key> load_key(DataSource& source) {
4,412✔
351
   auto fail_fn = []() -> std::string {
4,412✔
352
      throw PKCS8_Exception("Internal error: Attempt to read password for unencrypted key");
×
353
   };
354

355
   return load_key(source, fail_fn, false);
7,088✔
356
}
357

358
}  // namespace Botan::PKCS8
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc