path: root/src/tests/test_ffi.cpp

/*
* (C) 2015 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include "catchy/catchy_tests.h"

#if defined(BOTAN_HAS_FFI)

#include <botan/version.h>

#include <botan/hex.h>
#include <botan/ffi.h>

using Botan::hex_encode;
using Botan::hex_decode;

TEST_CASE("FFI versioning", "[ffi]")
   {
   CHECK_THAT(botan_ffi_api_version(), Equals(BOTAN_HAS_FFI));
   CHECK_THAT(botan_version_major(),   Equals(Botan::version_major()));
   CHECK_THAT(botan_version_minor(),   Equals(Botan::version_minor()));
   CHECK_THAT(botan_version_patch(),   Equals(Botan::version_patch()));
   }

TEST_CASE("FFI hex", "[ffi]")
   {
   const std::vector<uint8_t> bin = { 0xAA, 0xDE, 0x01 };
   std::string out;
   out.resize(2*bin.size());

   CHECK_THAT(botan_hex_encode(bin.data(), bin.size(), &out[0], 0), Equals(0));
   CHECK_THAT(out, Equals("AADE01"));

   CHECK_THAT(botan_hex_encode(bin.data(), bin.size(), &out[0], BOTAN_FFI_HEX_LOWER_CASE), Equals(0));
   CHECK_THAT(out, Equals("aade01"));
   }

TEST_CASE("FFI RNG", "[ffi]")
   {
   botan_rng_t rng;
   unsigned char buf[512];

   CHECK(botan_rng_init(&rng, "bad_type") < 0);

   const std::vector<std::string> types = { "system", "user" };

   for(const auto type : types)
      {
      REQUIRE_THAT(botan_rng_init(&rng, type.c_str()), Equals(0));
      CHECK_THAT(botan_rng_get(rng, buf, sizeof(buf)), Equals(0));
      CHECK_THAT(botan_rng_reseed(rng, 256), Equals(0));

      int ret = botan_rng_destroy(rng); // Catch evalues expresstion multiple times
      CHECK_THAT(ret, Equals(0));
      }
   }

TEST_CASE("FFI hash", "[ffi]")
   {
   botan_hash_t hash;
   CHECK(botan_hash_init(&hash, "SHA-256", 1) < 0);
   REQUIRE_THAT(botan_hash_init(&hash, "SHA-256", 0), Equals(0));

   /*
   char namebuf[32];
   CHECK(botan_hash_name(hash, namebuf, 5) < 0);
   CHECK_THAT(botan_hash_name(hash, namebuf, 31));
   CHECK(std::string(namebuf) == "SHA-256");
   */

   size_t ol;
   CHECK_THAT(botan_hash_output_length(hash, &ol), Equals(0));
   CHECK_THAT(ol, Equals(32));

   const char* s = "ABC";

   std::vector<uint8_t> outbuf(ol);

   int retUpdate = botan_hash_update(hash, reinterpret_cast<const uint8_t*>(s), 3);
   CHECK_THAT(retUpdate, Equals(0));

   int retFinal = botan_hash_final(hash, outbuf.data());
   CHECK_THAT(retFinal, Equals(0));

   //CHECK_ARRAY(outbuf, "B5D4045C3F466FA91FE2CC6ABE79232A1A57CDF104F7A26E716E0A1E2789DF78");
   CHECK_THAT(hex_encode(outbuf), Equals("B5D4045C3F466FA91FE2CC6ABE79232A1A57CDF104F7A26E716E0A1E2789DF78"));

   CHECK_THAT(botan_hash_clear(hash), Equals(0));
   int ret = botan_hash_destroy(hash);
   CHECK_THAT(ret, Equals(0));
   }

TEST_CASE("FFI mac", "[ffi]")
   {
   botan_mac_t mac;
   CHECK_THAT(botan_mac_init(&mac, "HMAC(SHA-256)", 1), Equals(-1)); // bad flag
   CHECK_THAT(botan_mac_init(&mac, "HMAC(SHA-259)", 0), Equals(-2)); // bad name
   CHECK_THAT(botan_mac_init(&mac, "HMAC(SHA-256)", 0), Equals(0));

   //char namebuf[32];
   //CHECK(botan_mac_name(mac, namebuf, 10) < 0);
   //CHECK_THAT(botan_mac_name(mac, namebuf, 31), Equals(0));
   //CHECK(std::string(namebuf) == "HMAC(SHA-256)");

   size_t ol;
   CHECK_THAT(botan_mac_output_length(mac, &ol), Equals(0));
   CHECK_THAT(ol, Equals(32));

   const uint8_t key[] = { 0xAA, 0xBB, 0xCC, 0xDD };

   CHECK_THAT(botan_mac_set_key(mac, key, 4), Equals(0));
   const char* s = "ABC";

   std::vector<uint8_t> outbuf(ol);

   int retUpdate = botan_mac_update(mac, reinterpret_cast<const uint8_t*>(s), 3);
   CHECK_THAT(retUpdate, Equals(0));

   int retFinal = botan_mac_final(mac, outbuf.data());
   CHECK_THAT(retFinal, Equals(0));

   CHECK_THAT(hex_encode(outbuf), Equals("1A82EEA984BC4A7285617CC0D05F1FE1D6C96675924A81BC965EE8FF7B0697A7"));

   CHECK_THAT(botan_mac_clear(mac), Equals(0));

   int retDestroy = botan_mac_destroy(mac);
   CHECK_THAT(retDestroy, Equals(0));
   }

TEST_CASE("FFI PBKDF", "[ffi]")
   {
   const std::vector<uint8_t> salt = hex_decode("ED1F39A0A7F3889AAF7E60743B3BC1CC2C738E60");
   const std::string passphrase = "ltexmfeyylmlbrsyikaw";
   const size_t out_len = 10;
   const size_t iterations = 1000;

   std::vector<uint8_t> outbuf(out_len);

   CHECK_THAT(botan_pbkdf("PBKDF2(SHA-1)", outbuf.data(), outbuf.size(),
                          passphrase.c_str(), salt.data(), salt.size(), iterations),
              Equals(0));

   CHECK_THAT(hex_encode(outbuf), Equals("027AFADD48F4BE8DCC4F"));

   size_t iters_10ms, iters_100ms;
   CHECK_THAT(botan_pbkdf_timed("PBKDF2(SHA-1)", outbuf.data(), outbuf.size(),
                                passphrase.c_str(), salt.data(), salt.size(), 10, &iters_10ms),
              Equals(0));
   CHECK_THAT(botan_pbkdf_timed("PBKDF2(SHA-1)", outbuf.data(), outbuf.size(),
                                passphrase.c_str(), salt.data(), salt.size(), 100, &iters_100ms),
              Equals(0));

   CHECK(iters_10ms >= 10000);

   /*
    * Tests deactivated due to consistetly failing in debug mode where -W0 is set
    * (./configure.py --build-mode=debug).
    * See also: https://github.com/randombit/botan/commit/30b0e3c88e94ba04c1843798f7ac74a008e01d9b
    */
   /*
   INFO("Iterations " << iters_10ms << " " << iters_100ms);
   const double ratio = static_cast<double>(iters_100ms) / iters_10ms;
   // Loose timing to avoid false positives on CI
   CHECK(ratio >= 3);
   CHECK(ratio <= 15);
   */
   }

TEST_CASE("FFI KDF", "[ffi]")
   {
   const std::vector<uint8_t> secret = hex_decode("92167440112E");
   const std::vector<uint8_t> salt = hex_decode("45A9BEDED69163123D0348F5185F61ABFB1BF18D6AEA454F");
   const size_t out_len = 18;
   std::vector<uint8_t> out_buf(out_len);

   REQUIRE_THAT(botan_kdf("KDF2(SHA-1)", out_buf.data(), out_len,
                     secret.data(), secret.size(), salt.data(), salt.size()),
                Equals(0));

   CHECK_THAT(hex_encode(out_buf), Equals("3A5DC9AA1C872B4744515AC2702D6396FC2A"));
   }

TEST_CASE("FFI bcrypt", "[ffi]")
   {
   botan_rng_t rng;
   botan_rng_init(&rng, "system");

   std::vector<uint8_t> outbuf(62);
   size_t ol = outbuf.size();

   CHECK_THAT(botan_bcrypt_generate(outbuf.data(), &ol, "password", rng, 10, 0), Equals(0));
   botan_rng_destroy(rng);

   CHECK_THAT(botan_bcrypt_is_valid("wrong", reinterpret_cast<const char*>(outbuf.data())), Equals(1));
   CHECK_THAT(botan_bcrypt_is_valid("password", reinterpret_cast<const char*>(outbuf.data())), Equals(0));
   }

TEST_CASE("FFI RSA", "[ffi]")
   {
   botan_rng_t rng;
   botan_rng_init(&rng, "system");

   botan_privkey_t priv;
   REQUIRE_THAT(botan_privkey_create_rsa(&priv, rng, 2048), Equals(0));

   botan_pubkey_t pub;
   CHECK_THAT(botan_privkey_export_pubkey(&pub, priv), Equals(0));

   std::string name(64, '\x00');
   size_t name_len = name.size();
   CHECK_THAT(botan_pubkey_algo_name(pub, &name[0], &name_len), Equals(0));
   name.resize(name_len - 1);

   CHECK_THAT(name, Equals("RSA"));

   botan_pk_op_encrypt_t encrypt;
   CHECK_THAT(botan_pk_op_encrypt_create(&encrypt, pub, "OAEP(SHA-256)", 0), Equals(0));

   std::vector<uint8_t> plaintext(32);
   CHECK_THAT(botan_rng_get(rng, plaintext.data(), plaintext.size()), Equals(0));

   std::vector<uint8_t> ciphertext(256); // TODO: no way to know this size from API
   size_t ctext_len = ciphertext.size();
   CHECK_THAT(botan_pk_op_encrypt(encrypt, rng, ciphertext.data(), &ctext_len,
                             plaintext.data(), plaintext.size()),
              Equals(0));
   ciphertext.resize(ctext_len);

   int retEncryptDestroy = botan_pk_op_encrypt_destroy(encrypt);
   CHECK_THAT(retEncryptDestroy, Equals(0));
   //CHECK(botan_pk_op_encrypt_destroy(encrypt) < 0);

   botan_pk_op_decrypt_t decrypt;
   CHECK_THAT(botan_pk_op_decrypt_create(&decrypt, priv, "OAEP(SHA-256)", 0), Equals(0));

   std::vector<uint8_t> decrypted(256); // TODO as with above
   size_t decrypted_len = decrypted.size();
   CHECK_THAT(botan_pk_op_decrypt(decrypt, decrypted.data(), &decrypted_len,
                             ciphertext.data(), ciphertext.size()),
              Equals(0));
   decrypted.resize(decrypted_len);

   CHECK_THAT(hex_encode(plaintext), Equals(hex_encode(decrypted)));

   int retDecryptDestroy = botan_pk_op_decrypt_destroy(decrypt);
   CHECK_THAT(retDecryptDestroy, Equals(0));
   //CHECK(botan_pk_op_decrypt_destroy(decrypt) < 0);

   botan_rng_destroy(rng);
   }

TEST_CASE("FFI ECDSA", "[ffi]")
   {
   botan_rng_t rng;
   botan_rng_init(&rng, "system");

   botan_privkey_t priv;
   int rc = botan_privkey_create_ecdsa(&priv, rng, "secp384r1");

   botan_pubkey_t pub;
   CHECK_THAT(botan_privkey_export_pubkey(&pub, priv), Equals(0));

   std::string name(64, '\x00');
   size_t name_len = name.size();
   CHECK_THAT(botan_pubkey_algo_name(pub, &name[0], &name_len), Equals(0));
   name.resize(name_len - 1);

   CHECK_THAT(name, Equals("ECDSA"));

   botan_pk_op_sign_t signer;
   CHECK_THAT(botan_pk_op_sign_create(&signer, priv, "EMSA1(SHA-384)", 0), Equals(0));

   std::vector<uint8_t> message(1280);
   CHECK_THAT(botan_rng_get(rng, message.data(), message.size()), Equals(0));

   // TODO: break input into multiple calls to update
   int retSignUpdate = botan_pk_op_sign_update(signer, message.data(), message.size());
   CHECK_THAT(retSignUpdate, Equals(0));

   std::vector<uint8_t> signature(96); // TODO: no way to derive this from API
   size_t sig_len = signature.size();

   int retSignFinish = botan_pk_op_sign_finish(signer, rng, signature.data(), &sig_len);
   CHECK_THAT(retSignFinish, Equals(0));

   signature.resize(sig_len);

   int retSignDestroy = botan_pk_op_sign_destroy(signer);
   CHECK_THAT(retSignDestroy, Equals(0));

   botan_pk_op_verify_t verifier;
   int retVerifyCreate = botan_pk_op_verify_create(&verifier, pub, "EMSA1(SHA-384)", 0);
   CHECK_THAT(retVerifyCreate, Equals(0));

      {
      int retVerifyUpdate = botan_pk_op_verify_update(verifier, message.data(), message.size());
      CHECK_THAT(retVerifyUpdate, Equals(0));
      int retVerifyFinish = botan_pk_op_verify_finish(verifier, signature.data(), signature.size());
      CHECK_THAT(retVerifyFinish, Equals(0));
      }

   // TODO: randomize this
   signature[0] ^= 1;
      {
      int retVerifyUpdate = botan_pk_op_verify_update(verifier, message.data(), message.size());
      CHECK_THAT(retVerifyUpdate, Equals(0));
      int retVerifyFinish = botan_pk_op_verify_finish(verifier, signature.data(), signature.size());
      CHECK_THAT(retVerifyFinish, Equals(1));
      }

   message[0] ^= 1;
      {
      int retVerifyUpdate = botan_pk_op_verify_update(verifier, message.data(), message.size());
      CHECK_THAT(retVerifyUpdate, Equals(0));
      int retVerifyFinish = botan_pk_op_verify_finish(verifier, signature.data(), signature.size());
      CHECK_THAT(retVerifyFinish, Equals(1));
      }

   signature[0] ^= 1;
      {
      int retVerifyUpdate = botan_pk_op_verify_update(verifier, message.data(), message.size());
      CHECK_THAT(retVerifyUpdate, Equals(0));
      int retVerifyFinish = botan_pk_op_verify_finish(verifier, signature.data(), signature.size());
      CHECK_THAT(retVerifyFinish, Equals(1));
      }

   message[0] ^= 1;
      {
      int retVerifyUpdate = botan_pk_op_verify_update(verifier, message.data(), message.size());
      CHECK_THAT(retVerifyUpdate, Equals(0));
      int retVerifyFinish = botan_pk_op_verify_finish(verifier, signature.data(), signature.size());
      CHECK_THAT(retVerifyFinish, Equals(0));
      }

   int retVerifyDestroy = botan_pk_op_verify_destroy(verifier);
   CHECK_THAT(retVerifyDestroy, Equals(0));

   botan_rng_destroy(rng);
   }

TEST_CASE("FFI ECDH", "[ffi]")
   {
   botan_rng_t rng;
   botan_rng_init(&rng, "system");

   botan_privkey_t priv1;
   REQUIRE_THAT(botan_privkey_create_ecdh(&priv1, rng, "secp256r1"), Equals(0));
   botan_privkey_t priv2;
   REQUIRE_THAT(botan_privkey_create_ecdh(&priv2, rng, "secp256r1"), Equals(0));

   botan_pubkey_t pub1;
   CHECK_THAT(botan_privkey_export_pubkey(&pub1, priv1), Equals(0));
   botan_pubkey_t pub2;
   CHECK_THAT(botan_privkey_export_pubkey(&pub2, priv2), Equals(0));

   botan_pk_op_ka_t ka1;
   REQUIRE_THAT(botan_pk_op_key_agreement_create(&ka1, priv1, "KDF2(SHA-256)", 0), Equals(0));
   botan_pk_op_ka_t ka2;
   REQUIRE_THAT(botan_pk_op_key_agreement_create(&ka2, priv2, "KDF2(SHA-256)", 0), Equals(0));

   std::vector<uint8_t> pubkey1(256); // length problem again
   size_t pubkey1_len = pubkey1.size();
   CHECK_THAT(botan_pk_op_key_agreement_export_public(priv1, pubkey1.data(), &pubkey1_len), Equals(0));
   pubkey1.resize(pubkey1_len);

   std::vector<uint8_t> pubkey2(256); // length problem again
   size_t pubkey2_len = pubkey2.size();
   CHECK_THAT(botan_pk_op_key_agreement_export_public(priv2, pubkey2.data(), &pubkey2_len), Equals(0));
   pubkey2.resize(pubkey2_len);

   std::vector<uint8_t> salt(32);
   REQUIRE_THAT(botan_rng_get(rng, salt.data(), salt.size()), Equals(0));

   const size_t shared_key_len = 64;

   std::vector<uint8_t> key1(shared_key_len);
   size_t key1_len = key1.size();
   CHECK_THAT(botan_pk_op_key_agreement(ka1, key1.data(), &key1_len,
                                        pubkey2.data(), pubkey2.size(),
                                        salt.data(), salt.size()),
              Equals(0));

   std::vector<uint8_t> key2(shared_key_len);
   size_t key2_len = key2.size();
   CHECK_THAT(botan_pk_op_key_agreement(ka2, key2.data(), &key2_len,
                                        pubkey1.data(), pubkey1.size(),
                                        salt.data(), salt.size()),
              Equals(0));

   CHECK_THAT(hex_encode(key1), Equals(hex_encode(key2)));

   botan_rng_destroy(rng);
   }

#endif