Z-Botan-0.1.1.0: third_party/botan/src/tests/test_pubkey.cpp
/*
* (C) 2009,2015 Jack Lloyd
* (C) 2017 Ribose Inc
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#include "test_pubkey.h"
#if defined(BOTAN_HAS_PUBLIC_KEY_CRYPTO)
#include "test_rng.h"
#include <botan/pubkey.h>
#include <botan/pk_algs.h>
#include <botan/x509_key.h>
#include <botan/pkcs8.h>
#include <botan/hex.h>
#include <botan/data_src.h>
namespace Botan_Tests {
void check_invalid_signatures(Test::Result& result,
Botan::PK_Verifier& verifier,
const std::vector<uint8_t>& message,
const std::vector<uint8_t>& signature)
{
const size_t tests_to_run = (Test::run_long_tests() ? 20 : 5);
const std::vector<uint8_t> zero_sig(signature.size());
result.test_eq("all zero signature invalid", verifier.verify_message(message, zero_sig), false);
for(size_t i = 0; i < tests_to_run; ++i)
{
const std::vector<uint8_t> bad_sig = Test::mutate_vec(signature);
try
{
if(!result.test_eq("incorrect signature invalid",
verifier.verify_message(message, bad_sig), false))
{
result.test_note("Accepted invalid signature " + Botan::hex_encode(bad_sig));
}
}
catch(std::exception& e)
{
result.test_note("Accepted invalid signature " + Botan::hex_encode(bad_sig));
result.test_failure("Modified signature rejected with exception", e.what());
}
}
}
void check_invalid_ciphertexts(Test::Result& result,
Botan::PK_Decryptor& decryptor,
const std::vector<uint8_t>& plaintext,
const std::vector<uint8_t>& ciphertext)
{
const size_t tests_to_run = (Test::run_long_tests() ? 20 : 5);
size_t ciphertext_accepted = 0, ciphertext_rejected = 0;
for(size_t i = 0; i < tests_to_run; ++i)
{
const std::vector<uint8_t> bad_ctext = Test::mutate_vec(ciphertext);
try
{
const Botan::secure_vector<uint8_t> decrypted = decryptor.decrypt(bad_ctext);
++ciphertext_accepted;
if(!result.test_ne("incorrect ciphertext different", decrypted, plaintext))
{
result.test_eq("used corrupted ciphertext", bad_ctext, ciphertext);
}
}
catch(std::exception&)
{
++ciphertext_rejected;
}
}
result.test_note("Accepted " + std::to_string(ciphertext_accepted) +
" invalid ciphertexts, rejected " + std::to_string(ciphertext_rejected));
}
std::string PK_Test::choose_padding(const VarMap& vars,
const std::string& pad_hdr)
{
if(pad_hdr != "")
return pad_hdr;
return vars.get_opt_str("Padding", this->default_padding(vars));
}
std::vector<std::string> PK_Test::possible_providers(const std::string& /*params*/)
{
return Test::provider_filter({ "base", "commoncrypto", "openssl", "tpm" });
}
Test::Result
PK_Signature_Generation_Test::run_one_test(const std::string& pad_hdr, const VarMap& vars)
{
const std::vector<uint8_t> message = vars.get_req_bin("Msg");
const std::vector<uint8_t> signature = vars.get_req_bin("Signature");
const std::string padding = choose_padding(vars, pad_hdr);
Test::Result result(algo_name() + "/" + padding + " signature generation");
std::unique_ptr<Botan::Private_Key> privkey;
try
{
privkey = load_private_key(vars);
}
catch(Botan::Lookup_Error& e)
{
result.note_missing(e.what());
return result;
}
std::unique_ptr<Botan::Public_Key> pubkey(Botan::X509::load_key(Botan::X509::BER_encode(*privkey)));
std::vector<std::unique_ptr<Botan::PK_Verifier>> verifiers;
for(auto const& verify_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Verifier> verifier;
try
{
verifier.reset(new Botan::PK_Verifier(*pubkey, padding, Botan::IEEE_1363, verify_provider));
}
catch(Botan::Lookup_Error&)
{
//result.test_note("Skipping verifying with " + verify_provider);
continue;
}
result.test_eq("KAT signature valid", verifier->verify_message(message, signature), true);
check_invalid_signatures(result, *verifier, message, signature);
verifiers.push_back(std::move(verifier));
}
for(auto const& sign_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Signer> signer;
std::vector<uint8_t> generated_signature;
try
{
signer.reset(new Botan::PK_Signer(*privkey, Test::rng(), padding, Botan::IEEE_1363, sign_provider));
if(vars.has_key("Nonce"))
{
std::unique_ptr<Botan::RandomNumberGenerator> rng(test_rng(vars.get_req_bin("Nonce")));
generated_signature = signer->sign_message(message, *rng);
}
else
{
generated_signature = signer->sign_message(message, Test::rng());
}
result.test_lte("Generated signature within announced bound",
generated_signature.size(), signer->signature_length());
}
catch(Botan::Lookup_Error&)
{
//result.test_note("Skipping signing with " + sign_provider);
continue;
}
if(sign_provider == "base")
{
result.test_eq("generated signature matches KAT", generated_signature, signature);
}
else if(generated_signature != signature)
{
for(std::unique_ptr<Botan::PK_Verifier>& verifier : verifiers)
{
if(!result.test_eq("generated signature valid",
verifier->verify_message(message, generated_signature), true))
{
result.test_failure("generated signature", generated_signature);
}
}
}
}
return result;
}
Botan::Signature_Format
PK_Signature_Verification_Test::sig_format() const
{
return Botan::IEEE_1363;
}
Test::Result
PK_Signature_Verification_Test::run_one_test(const std::string& pad_hdr, const VarMap& vars)
{
const std::vector<uint8_t> message = vars.get_req_bin("Msg");
const std::vector<uint8_t> signature = vars.get_req_bin("Signature");
const std::string padding = choose_padding(vars, pad_hdr);
const bool expected_valid = (vars.get_opt_sz("Valid", 1) == 1);
std::unique_ptr<Botan::Public_Key> pubkey = load_public_key(vars);
Test::Result result(algo_name() + "/" + padding + " signature verification");
for(auto const& verify_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Verifier> verifier;
try
{
verifier.reset(new Botan::PK_Verifier(*pubkey, padding, sig_format(), verify_provider));
}
catch(Botan::Lookup_Error&)
{
//result.test_note("Skipping verifying with " + verify_provider);
}
if(verifier)
{
try
{
const bool verified = verifier->verify_message(message, signature);
if(expected_valid)
{
result.test_eq("correct signature valid with " + verify_provider, verified, true);
if(test_random_invalid_sigs())
{
check_invalid_signatures(result, *verifier, message, signature);
}
}
else
result.test_eq("incorrect signature invalid", verified, false);
}
catch(std::exception& e)
{
result.test_failure("verification threw exception", e.what());
}
}
}
return result;
}
Test::Result
PK_Signature_NonVerification_Test::run_one_test(const std::string& pad_hdr, const VarMap& vars)
{
const std::string padding = choose_padding(vars, pad_hdr);
const std::vector<uint8_t> message = vars.get_req_bin("Msg");
std::unique_ptr<Botan::Public_Key> pubkey = load_public_key(vars);
const std::vector<uint8_t> invalid_signature = vars.get_req_bin("InvalidSignature");
Test::Result result(algo_name() + "/" + padding + " verify invalid signature");
for(auto const& verify_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Verifier> verifier;
try
{
verifier.reset(new Botan::PK_Verifier(*pubkey, padding, Botan::IEEE_1363, verify_provider));
result.test_eq("incorrect signature rejected", verifier->verify_message(message, invalid_signature), false);
}
catch(Botan::Lookup_Error&)
{
result.test_note("Skipping verifying with " + verify_provider);
}
}
return result;
}
std::vector<Test::Result>
PK_Sign_Verify_DER_Test::run()
{
const std::vector<uint8_t> message = {'f', 'o', 'o', 'b', 'a', 'r'};
const std::string padding = m_padding;
std::unique_ptr<Botan::Private_Key> privkey = key();
Test::Result result(algo_name() + "/" + padding + " signature sign/verify using DER format");
for(auto const& provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Signer> signer;
std::unique_ptr<Botan::PK_Verifier> verifier;
try
{
signer.reset(new Botan::PK_Signer(*privkey, Test::rng(), padding, Botan::DER_SEQUENCE, provider));
verifier.reset(new Botan::PK_Verifier(*privkey, padding, Botan::DER_SEQUENCE, provider));
}
catch(Botan::Lookup_Error& e)
{
result.test_note("Skipping sign/verify with " + provider, e.what());
}
if(signer && verifier)
{
try
{
std::vector<uint8_t> generated_signature = signer->sign_message(message, Test::rng());
const bool verified = verifier->verify_message(message, generated_signature);
result.test_eq("correct signature valid with " + provider, verified, true);
if(test_random_invalid_sigs())
{
check_invalid_signatures(result, *verifier, message, generated_signature);
}
}
catch(std::exception& e)
{
result.test_failure("verification threw exception", e.what());
}
}
}
return {result};
}
std::vector<std::string> PK_Sign_Verify_DER_Test::possible_providers(
const std::string& algo)
{
std::vector<std::string> pk_provider =
Botan::probe_provider_private_key(algo, { "base", "commoncrypto", "openssl", "tpm" });
return Test::provider_filter(pk_provider);
}
Test::Result
PK_Encryption_Decryption_Test::run_one_test(const std::string& pad_hdr, const VarMap& vars)
{
const std::vector<uint8_t> plaintext = vars.get_req_bin("Msg");
const std::vector<uint8_t> ciphertext = vars.get_req_bin("Ciphertext");
const std::string padding = choose_padding(vars, pad_hdr);
Test::Result result(algo_name() + (padding.empty() ? padding : "/" + padding) + " encryption");
std::unique_ptr<Botan::Private_Key> privkey = load_private_key(vars);
// instead slice the private key to work around elgamal test inputs
//std::unique_ptr<Botan::Public_Key> pubkey(Botan::X509::load_key(Botan::X509::BER_encode(*privkey)));
Botan::Public_Key* pubkey = privkey.get();
std::vector<std::unique_ptr<Botan::PK_Decryptor>> decryptors;
for(auto const& dec_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Decryptor> decryptor;
try
{
decryptor.reset(new Botan::PK_Decryptor_EME(*privkey, Test::rng(), padding, dec_provider));
}
catch(Botan::Lookup_Error&)
{
continue;
}
Botan::secure_vector<uint8_t> decrypted;
try
{
decrypted = decryptor->decrypt(ciphertext);
result.test_lte("Plaintext within length",
decrypted.size(),
decryptor->plaintext_length(ciphertext.size()));
}
catch(Botan::Exception& e)
{
result.test_failure("Failed to decrypt KAT ciphertext", e.what());
}
result.test_eq(dec_provider, "decryption of KAT", decrypted, plaintext);
check_invalid_ciphertexts(result, *decryptor, plaintext, ciphertext);
}
for(auto const& enc_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Encryptor> encryptor;
try
{
encryptor.reset(new Botan::PK_Encryptor_EME(*pubkey, Test::rng(), padding, enc_provider));
}
catch(Botan::Lookup_Error&)
{
continue;
}
std::unique_ptr<Botan::RandomNumberGenerator> kat_rng;
if(vars.has_key("Nonce"))
{
kat_rng.reset(test_rng(vars.get_req_bin("Nonce")));
}
if(padding == "Raw")
{
/*
Hack for RSA with no padding since sometimes one more bit will fit in but maximum_input_size
rounds down to nearest byte
*/
result.test_lte("Input within accepted bounds",
plaintext.size(), encryptor->maximum_input_size() + 1);
}
else
{
result.test_lte("Input within accepted bounds",
plaintext.size(), encryptor->maximum_input_size());
}
const std::vector<uint8_t> generated_ciphertext =
encryptor->encrypt(plaintext, kat_rng ? *kat_rng : Test::rng());
result.test_lte("Ciphertext within length",
generated_ciphertext.size(),
encryptor->ciphertext_length(plaintext.size()));
if(enc_provider == "base")
{
result.test_eq(enc_provider, "generated ciphertext matches KAT",
generated_ciphertext, ciphertext);
}
else if(generated_ciphertext != ciphertext)
{
for(std::unique_ptr<Botan::PK_Decryptor>& dec : decryptors)
{
result.test_eq("decryption of generated ciphertext",
dec->decrypt(generated_ciphertext), plaintext);
}
}
}
return result;
}
Test::Result
PK_Decryption_Test::run_one_test(const std::string& pad_hdr, const VarMap& vars)
{
const std::vector<uint8_t> plaintext = vars.get_req_bin("Msg");
const std::vector<uint8_t> ciphertext = vars.get_req_bin("Ciphertext");
const std::string padding = choose_padding(vars, pad_hdr);
Test::Result result(algo_name() + (padding.empty() ? padding : "/" + padding) + " decryption");
std::unique_ptr<Botan::Private_Key> privkey = load_private_key(vars);
for(auto const& dec_provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Decryptor> decryptor;
try
{
decryptor.reset(new Botan::PK_Decryptor_EME(*privkey, Test::rng(), padding, dec_provider));
}
catch(Botan::Lookup_Error&)
{
continue;
}
Botan::secure_vector<uint8_t> decrypted;
try
{
decrypted = decryptor->decrypt(ciphertext);
}
catch(Botan::Exception& e)
{
result.test_failure("Failed to decrypt KAT ciphertext", e.what());
}
result.test_eq(dec_provider, "decryption of KAT", decrypted, plaintext);
check_invalid_ciphertexts(result, *decryptor, plaintext, ciphertext);
}
return result;
}
Test::Result PK_KEM_Test::run_one_test(const std::string&, const VarMap& vars)
{
const std::vector<uint8_t> K = vars.get_req_bin("K");
const std::vector<uint8_t> C0 = vars.get_req_bin("C0");
const std::vector<uint8_t> salt = vars.get_opt_bin("Salt");
const std::string kdf = vars.get_req_str("KDF");
Test::Result result(algo_name() + "/" + kdf + " KEM");
std::unique_ptr<Botan::Private_Key> privkey = load_private_key(vars);
const Botan::Public_Key& pubkey = *privkey;
const size_t desired_key_len = K.size();
std::unique_ptr<Botan::PK_KEM_Encryptor> enc;
try
{
enc.reset(new Botan::PK_KEM_Encryptor(pubkey, Test::rng(), kdf));
}
catch(Botan::Lookup_Error&)
{
result.test_note("Skipping due to missing KDF: " + kdf);
return result;
}
Fixed_Output_RNG fixed_output_rng(vars.get_req_bin("R"));
Botan::secure_vector<uint8_t> produced_encap_key, shared_key;
enc->encrypt(produced_encap_key,
shared_key,
desired_key_len,
fixed_output_rng,
salt);
result.test_eq("C0 matches", produced_encap_key, C0);
result.test_eq("K matches", shared_key, K);
std::unique_ptr<Botan::PK_KEM_Decryptor> dec;
try
{
dec.reset(new Botan::PK_KEM_Decryptor(*privkey, Test::rng(), kdf));
}
catch(Botan::Lookup_Error& e)
{
result.test_note("Skipping test", e.what());
return result;
}
const Botan::secure_vector<uint8_t> decr_shared_key =
dec->decrypt(C0.data(), C0.size(),
desired_key_len,
salt.data(),
salt.size());
result.test_eq("decrypted K matches", decr_shared_key, K);
return result;
}
Test::Result PK_Key_Agreement_Test::run_one_test(const std::string& header, const VarMap& vars)
{
const std::vector<uint8_t> shared = vars.get_req_bin("K");
const std::string kdf = vars.get_opt_str("KDF", default_kdf(vars));
Test::Result result(algo_name() + "/" + kdf +
(header.empty() ? header : " " + header) +
" key agreement");
std::unique_ptr<Botan::Private_Key> privkey = load_our_key(header, vars);
const std::vector<uint8_t> pubkey = load_their_key(header, vars);
const size_t key_len = vars.get_opt_sz("OutLen", 0);
for(auto const& provider : possible_providers(algo_name()))
{
std::unique_ptr<Botan::PK_Key_Agreement> kas;
try
{
kas.reset(new Botan::PK_Key_Agreement(*privkey, Test::rng(), kdf, provider));
auto derived_key = kas->derive_key(key_len, pubkey).bits_of();
result.test_eq(provider, "agreement", derived_key, shared);
if(key_len == 0 && kdf == "Raw")
{
result.test_eq("Expected size", derived_key.size(), kas->agreed_value_size());
}
}
catch(Botan::Lookup_Error&)
{
//result.test_note("Skipping key agreement with with " + provider);
}
}
return result;
}
std::vector<std::string> PK_Key_Generation_Test::possible_providers(
const std::string& algo)
{
std::vector<std::string> pk_provider =
Botan::probe_provider_private_key(algo, { "base", "commoncrypto", "openssl", "tpm" });
return Test::provider_filter(pk_provider);
}
namespace {
#if defined(BOTAN_HAS_PKCS5_PBES2) && defined(BOTAN_HAS_AES) && (defined(BOTAN_HAS_SHA2_32) || defined(BOTAN_HAS_SCRYPT))
void test_pbe_roundtrip(Test::Result& result,
const Botan::Private_Key& key,
const std::string& pbe_algo,
const std::string& passphrase)
{
const auto pkcs8 = key.private_key_info();
try
{
Botan::DataSource_Memory data_src(
Botan::PKCS8::PEM_encode(key, Test::rng(), passphrase,
std::chrono::milliseconds(10),
pbe_algo));
std::unique_ptr<Botan::Private_Key> loaded(
Botan::PKCS8::load_key(data_src, Test::rng(), passphrase));
result.confirm("recovered private key from encrypted blob", loaded.get() != nullptr);
result.test_eq("reloaded key has same type", loaded->algo_name(), key.algo_name());
result.test_eq("reloaded key has same encoding", loaded->private_key_info(), pkcs8);
}
catch(std::exception& e)
{
result.test_failure("roundtrip encrypted PEM private key", e.what());
}
try
{
Botan::DataSource_Memory data_src(
Botan::PKCS8::BER_encode(key, Test::rng(), passphrase,
std::chrono::milliseconds(10),
pbe_algo));
std::unique_ptr<Botan::Private_Key> loaded(
Botan::PKCS8::load_key(data_src, Test::rng(), passphrase));
result.confirm("recovered private key from BER blob", loaded.get() != nullptr);
result.test_eq("reloaded key has same type", loaded->algo_name(), key.algo_name());
result.test_eq("reloaded key has same encoding", loaded->private_key_info(), pkcs8);
}
catch(std::exception& e)
{
result.test_failure("roundtrip encrypted BER private key", e.what());
}
}
#endif
}
std::vector<Test::Result> PK_Key_Generation_Test::run()
{
std::vector<Test::Result> results;
for(auto const& param : keygen_params())
{
const std::string report_name = algo_name() + (param.empty() ? param : " " + param);
Test::Result result(report_name + " keygen");
const std::vector<std::string> providers = possible_providers(algo_name());
if(providers.empty())
{
result.note_missing("provider key generation " + algo_name());
}
result.start_timer();
for(auto&& prov : providers)
{
std::unique_ptr<Botan::Private_Key> key_p =
Botan::create_private_key(algo_name(), Test::rng(), param, prov);
const Botan::Private_Key& key = *key_p;
try
{
result.confirm("Key passes self tests", key.check_key(Test::rng(), true));
}
catch(Botan::Lookup_Error&) {}
result.test_gte("Key has reasonable estimated strength (lower)", key.estimated_strength(), 64);
result.test_lt("Key has reasonable estimated strength (upper)", key.estimated_strength(), 512);
// Test PEM public key round trips OK
try
{
Botan::DataSource_Memory data_src(Botan::X509::PEM_encode(key));
std::unique_ptr<Botan::Public_Key> loaded(Botan::X509::load_key(data_src));
result.confirm("recovered public key from private", loaded.get() != nullptr);
result.test_eq("public key has same type", loaded->algo_name(), key.algo_name());
try
{
result.test_eq("public key passes checks", loaded->check_key(Test::rng(), false), true);
}
catch(Botan::Lookup_Error&) {}
}
catch(std::exception& e)
{
result.test_failure("roundtrip PEM public key", e.what());
}
// Test DER public key round trips OK
try
{
const auto ber = key.subject_public_key();
Botan::DataSource_Memory data_src(ber);
std::unique_ptr<Botan::Public_Key> loaded(Botan::X509::load_key(data_src));
result.confirm("recovered public key from private", loaded.get() != nullptr);
result.test_eq("public key has same type", loaded->algo_name(), key.algo_name());
result.test_eq("public key has same encoding", loaded->subject_public_key(), ber);
}
catch(std::exception& e)
{
result.test_failure("roundtrip BER public key", e.what());
}
// Test PEM private key round trips OK
try
{
const auto ber = key.private_key_info();
Botan::DataSource_Memory data_src(ber);
std::unique_ptr<Botan::Private_Key> loaded(
Botan::PKCS8::load_key(data_src, Test::rng()));
result.confirm("recovered private key from PEM blob", loaded.get() != nullptr);
result.test_eq("reloaded key has same type", loaded->algo_name(), key.algo_name());
result.test_eq("reloaded key has same encoding", loaded->private_key_info(), ber);
}
catch(std::exception& e)
{
result.test_failure("roundtrip PEM private key", e.what());
}
try
{
Botan::DataSource_Memory data_src(Botan::PKCS8::BER_encode(key));
std::unique_ptr<Botan::Public_Key> loaded(Botan::PKCS8::load_key(data_src, Test::rng()));
result.confirm("recovered public key from private", loaded.get() != nullptr);
result.test_eq("public key has same type", loaded->algo_name(), key.algo_name());
}
catch(std::exception& e)
{
result.test_failure("roundtrip BER private key", e.what());
}
#if defined(BOTAN_HAS_PKCS5_PBES2) && defined(BOTAN_HAS_AES) && defined(BOTAN_HAS_SHA2_32)
test_pbe_roundtrip(result, key, "PBE-PKCS5v20(AES-128/CBC,SHA-256)", Test::random_password());
#endif
#if defined(BOTAN_HAS_PKCS5_PBES2) && defined(BOTAN_HAS_AES) && defined(BOTAN_HAS_SCRYPT)
test_pbe_roundtrip(result, key, "PBES2(AES-128/CBC,Scrypt)", Test::random_password());
#endif
}
result.end_timer();
results.push_back(result);
}
return results;
}
}
#endif