From a22825db9bfc4d5325c56cc63d337c0d15b892dd Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:42:32 +0200 Subject: [PATCH 01/30] README.md: fix some places where "libleap" was used instead of "libantelope" --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b1a33fd..6c22bcc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ ![](https://github.com/eosswedenorg/libantelope/workflows/CI/badge.svg) -[![GitHub release](https://img.shields.io/github/v/release/eosswedenorg/libleap?include_prereleases)](https://github.com/eosswedenorg/libantelope/releases/latest) +[![GitHub release](https://img.shields.io/github/v/release/eosswedenorg/libantelope?include_prereleases)](https://github.com/eosswedenorg/libantelope/releases/latest) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -# libleap +# libantelope Independent C++ library for [Antelope IO](https://antelope.io) (former [libeosio](https://github.com/eosswedenorg/libeosio)) @@ -110,7 +110,7 @@ C:\repo> cmake --build build --config Release ## Security notice Elliptic curve crypthographic operations is done using either `OpenSSL` or `libsecp256k1` libraries. -This library (libleap) will never expose sensitve cryptographic information +This library (libantelope) will never expose sensitve cryptographic information to anything but the computers memory. You are free to inspect the source code and compile yourself to verify. From c06846f7edb03d6a0bbedd9c4a8947ab3a50f9ba Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:47:30 +0200 Subject: [PATCH 02/30] CMakeLists.txt: configure compiler flags for different build types. --- CMakeLists.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 16deb91..c79e705 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -34,6 +34,23 @@ set( CMAKE_CXX_STANDARD 11 ) set( CMAKE_CXX_STANDARD_REQUIRED ON ) set( CMAKE_CXX_EXTENSIONS OFF ) +add_compile_options( + "$<$:-Wall;-Wconversion;-Wno-sign-conversion;-Wextra>" + "$<$:/W3;-D_CRT_SECURE_NO_WARNINGS=1>" + + # Debug + "$<$:$<$:-O0;-g>>" + "$<$:$<$:/Od;/Zi>>" + + # Release + "$<$:$<$:-O3>>" + "$<$:$<$:/O2>>" + + # MinSizeRel + "$<$:$<$:-Os>>" + "$<$:$<$:/O1>>" +) + # OpenSSL 3.0 deprecates some functions we use. # Adding this flag makes the compiler not spam warnings. add_compile_options(-D OPENSSL_API_COMPAT=0x10100000L) From 7fc83991bcb14e5817d24b39be6b50e682ec6b8c Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:47:44 +0200 Subject: [PATCH 03/30] src/WIF.cpp: Remove unused variables. --- src/WIF.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/WIF.cpp b/src/WIF.cpp index e04f8be..c13bdd4 100644 --- a/src/WIF.cpp +++ b/src/WIF.cpp @@ -41,7 +41,6 @@ const wif_codec_t WIF_CODEC_LEG = wif_create_legacy_codec(WIF_PUB_LEG); std::string wif_priv_encode(const ec_privkey_t& priv, const std::string& prefix) { - checksum_t check; // 1 byte extra for legacy prefix prefix. unsigned char buf[1 + EC_PRIVKEY_SIZE + CHECKSUM_SIZE] = { 0 }; size_t len; @@ -131,7 +130,6 @@ void wif_print_key(const struct ec_keypair *key, const wif_codec_t& codec) { bool wif_sig_decode(ec_signature_t& sig, const std::string& data) { - checksum_t checksum; std::vector buf; if (data.substr(0, WIF_SIG_K1.length()) != WIF_SIG_K1) { From ac3facf30b4d22393f97ad74d8777c221dddf745 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:50:23 +0200 Subject: [PATCH 04/30] src/WIF.cpp: fix integer comparison between different sizes warning. --- src/WIF.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/WIF.cpp b/src/WIF.cpp index c13bdd4..64be109 100644 --- a/src/WIF.cpp +++ b/src/WIF.cpp @@ -58,7 +58,7 @@ std::string wif_priv_encode(const ec_privkey_t& priv, const std::string& prefix) bool wif_priv_decode(ec_privkey_t& priv, const std::string& data) { - uint8_t offset; + std::size_t offset; std::vector buf; internal::priv_decoder_t decoder = internal::priv_decoder_legacy; @@ -99,7 +99,7 @@ std::string wif_pub_encode(const ec_pubkey_t& pub, const std::string& prefix) { bool wif_pub_decode(ec_pubkey_t& pub, const std::string& data) { internal::pub_decoder_t decoder = internal::pub_decoder_legacy; - int offset; + std::size_t offset; std::vector buf; // Check prefix From b7063f3f3aa1586a1f43e4d5f570f015b26e3c09 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:22:04 +0200 Subject: [PATCH 05/30] src/libsecp256k1/ecdsa.cpp: don't include "rng.h" here. --- src/libsecp256k1/ecdsa.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/src/libsecp256k1/ecdsa.cpp b/src/libsecp256k1/ecdsa.cpp index 838809a..e667308 100644 --- a/src/libsecp256k1/ecdsa.cpp +++ b/src/libsecp256k1/ecdsa.cpp @@ -24,7 +24,6 @@ #include #include #include -#include "rng.h" namespace libantelope { From fa7d3cb2e9410e310de79aa1f77cac1b5001d857 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:23:42 +0200 Subject: [PATCH 06/30] src/ec.cpp: fix integer size comparison warning. --- src/ec.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ec.cpp b/src/ec.cpp index c6ceca6..86bd3ef 100644 --- a/src/ec.cpp +++ b/src/ec.cpp @@ -25,7 +25,7 @@ std::ostream& _hex(std::ostream& os, const unsigned char *b, std::size_t sz) { os << "[ " << std::hex; - for (int i = 0; i < sz; i++) { + for (std::size_t i = 0; i < sz; i++) { unsigned int v = b[i]; os << "0x"; From 000876176a6fc00b37f6e4aeb9128073fa392ebb Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:25:15 +0200 Subject: [PATCH 07/30] src/base58.cpp: fix integer size comparison warning. --- src/base58.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/base58.cpp b/src/base58.cpp index 3979dc1..bd2da9a 100644 --- a/src/base58.cpp +++ b/src/base58.cpp @@ -120,7 +120,7 @@ bool base58_decode(const char* psz, std::vector& out) { psz++; } // Allocate enough space in big-endian base256 representation. - int size = strlen(psz) * 733 /1000 + 1; // log(58) / log(256), rounded up. + std::size_t size = strlen(psz) * 733 /1000 + 1; // log(58) / log(256), rounded up. std::vector b256(size); // Process the characters. @@ -132,7 +132,7 @@ bool base58_decode(const char* psz, std::vector& out) { int i = 0; for (std::vector::reverse_iterator it = b256.rbegin(); (carry != 0 || i < length) && (it != b256.rend()); ++it, ++i) { carry += 58 * (*it); - *it = carry % 256; + *it = (unsigned char) (carry % 256); carry /= 256; } assert(carry == 0); From 62b677d0e0428dc542f35d7cd43fa83446a30252 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:29:12 +0200 Subject: [PATCH 08/30] tests/base58/is_base58.cpp: fix integer size comparison warning. --- tests/base58/is_base58.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/base58/is_base58.cpp b/tests/base58/is_base58.cpp index e210f10..1dad426 100644 --- a/tests/base58/is_base58.cpp +++ b/tests/base58/is_base58.cpp @@ -35,7 +35,7 @@ TEST_CASE("base58::is_base58 [char]") { SUBCASE("valid") { - for(int i = 0; i < valid_alphabet.length(); i++) { + for(std::size_t i = 0; i < valid_alphabet.length(); i++) { char ch = valid_alphabet[i]; CHECK(libantelope::is_base58(ch)); @@ -43,7 +43,7 @@ TEST_CASE("base58::is_base58 [char]") { } SUBCASE("invalid") { - for(int i = 0; i < invalid_alphabet.length(); i++) { + for(std::size_t i = 0; i < invalid_alphabet.length(); i++) { char ch = invalid_alphabet[i]; CHECK_FALSE(libantelope::is_base58(ch)); From ee4705e8586a075d0903c2b5f22137f057b57a8f Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:31:52 +0200 Subject: [PATCH 09/30] src/libsecp256k1/ecdsa.cpp: fix warning about assigning an int value to unsigned char. --- src/libsecp256k1/ecdsa.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libsecp256k1/ecdsa.cpp b/src/libsecp256k1/ecdsa.cpp index e667308..3aa8a5c 100644 --- a/src/libsecp256k1/ecdsa.cpp +++ b/src/libsecp256k1/ecdsa.cpp @@ -56,7 +56,7 @@ int ecdsa_sign(const ec_privkey_t& key, const sha256_t* digest, ec_signature_t& secp256k1_ecdsa_recoverable_signature_serialize_compact(ctx, sig.data() + 1, &v, &s); if (is_canonical(sig.data())) { - sig[0] = 27 + 4 + v; + sig[0] = (unsigned char) (27 + 4 + v); return 0; } } From b7a1298615a30afec16afea5a336301787404972 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 17:32:22 +0200 Subject: [PATCH 10/30] src/libsecp256k1/ecdsa.cpp: fix unused variable warning in extended_nonce_function() --- src/libsecp256k1/ecdsa.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/libsecp256k1/ecdsa.cpp b/src/libsecp256k1/ecdsa.cpp index 3aa8a5c..8984fe7 100644 --- a/src/libsecp256k1/ecdsa.cpp +++ b/src/libsecp256k1/ecdsa.cpp @@ -39,6 +39,7 @@ int is_canonical(const unsigned char *d) { static int extended_nonce_function( unsigned char *nonce32, const unsigned char *msg32, const unsigned char *key32, const unsigned char* algo16, void* data, unsigned int attempt ) { + (void)attempt; // "use" the variable here to shutup compiler about unsed variable. return secp256k1_nonce_function_rfc6979(nonce32, msg32, key32, algo16, nullptr, *(unsigned int*) data); } From 596cf8c7744b0bac02549fe336e188054de885e5 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:45:35 +0200 Subject: [PATCH 11/30] Adding src/config.in.h --- src/config.in.h | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 src/config.in.h diff --git a/src/config.in.h b/src/config.in.h new file mode 100644 index 0000000..27c830d --- /dev/null +++ b/src/config.in.h @@ -0,0 +1,38 @@ +/* + * MIT License + * + * Copyright (c) 2019-2023 EOS Sw/eden + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef LIBANTELOPE_CONFIG_H +#define LIBANTELOPE_CONFIG_H + +#ifdef __cplusplus +extern "C" { +#endif + +/* Hash implementation */ +#cmakedefine LIBANTELOPE_HASHIMPL_OPENSSL + +#ifdef __cplusplus +} +#endif + +#endif /* LIBANTELOPE_CONFIG_H */ \ No newline at end of file From 682ea069a24ff0603f25a10f5d93b9d97e2e9795 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:46:23 +0200 Subject: [PATCH 12/30] CMakeLists.txt: use src/config.in.h as configuration file. --- CMakeLists.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index c79e705..14c12d6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -79,6 +79,7 @@ add_library( ${LIB_NAME} STATIC target_include_directories( ${LIB_NAME} PUBLIC $ + $ $ ) @@ -124,6 +125,9 @@ endif() message("-- Using Elliptic curve library: ${EC_LIB}") +# Generate config file +configure_file(src/config.in.h ${CMAKE_BINARY_DIR}/include/libantelope/config.h) + # -------------------------------- # Tests # -------------------------------- @@ -160,7 +164,7 @@ install(TARGETS ${LIB_NAME} EXPORT ${PROJECT_NAME}Targets LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ) -install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) +install(DIRECTORY include/ ${CMAKE_BINARY_DIR}/include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) # Readme and license install(FILES README.md LICENSE LICENSE.bitcoin From be8096ed0f860e83c2fc795925244157c26156be Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:46:42 +0200 Subject: [PATCH 13/30] CMakeLists.txt: set LIBANTELOPE_HASHIMPL_OPENSSL --- CMakeLists.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 14c12d6..30ba605 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -92,6 +92,9 @@ endif() include(OpenSSL) target_link_libraries( ${LIB_NAME} PRIVATE OpenSSL::Crypto) +# Hash implementation +set( LIBANTELOPE_HASHIMPL_OPENSSL 1 ) + # EC Implementation if (${EC_LIB} STREQUAL "libsecp256k1") add_subdirectory( vendor/secp256k1 ) From 891d2e970d73b75b40f4854dd0bce83c6e70d188 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:47:02 +0200 Subject: [PATCH 14/30] Adding include/libantelope/internal/hash.hpp --- include/libantelope/internal/hash.hpp | 45 +++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 include/libantelope/internal/hash.hpp diff --git a/include/libantelope/internal/hash.hpp b/include/libantelope/internal/hash.hpp new file mode 100644 index 0000000..d2a889d --- /dev/null +++ b/include/libantelope/internal/hash.hpp @@ -0,0 +1,45 @@ + +/** + * MIT License + * + * Copyright (c) 2019-2023 EOS Sw/eden + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef LIBANTELOPE_INTERNAL_HASH_H +#define LIBANTELOPE_INTERNAL_HASH_H + +#include + +#ifdef LIBANTELOPE_HASHIMPL_OPENSSL + +#include +#include + +namespace libantelope { namespace internal { + + typedef SHA256_CTX sha256_state; + typedef RIPEMD160_CTX ripemd160_state; +} } // namespace libantelope::internal + +#else +#error "Missing hash implementation" +#endif + +#endif /* LIBANTELOPE_INTERNAL_INTERNAL_H */ \ No newline at end of file From 610c32c17110e83cd4eb53def284ea1d6c7d988e Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:47:38 +0200 Subject: [PATCH 15/30] Hash: Define init/update/final functions for sha256 and ripemd160 --- include/libantelope/hash.hpp | 38 ++++++++++++++++++++++++++++++++++++ src/openssl/hash.cpp | 24 +++++++++++++++++++++++ 2 files changed, 62 insertions(+) diff --git a/include/libantelope/hash.hpp b/include/libantelope/hash.hpp index 4ad57d7..67dd698 100644 --- a/include/libantelope/hash.hpp +++ b/include/libantelope/hash.hpp @@ -25,6 +25,7 @@ #define LIBANTELOPE_HASH_H #include +#include namespace libantelope { @@ -34,6 +35,26 @@ namespace libantelope { typedef unsigned char ripemd160_t[20]; typedef unsigned char sha256_t[32]; +typedef internal::sha256_state sha256_ctx_t; +typedef internal::ripemd160_state ripemd160_ctx_t; + +/** + * Initialize a sha256_ctx_t structure + */ +int sha256_init(sha256_ctx_t* ctx); + +/** + * Update the sha256 hash value with the contents in `data` up to `len` bytes. + * This can be called repeatedly to hash chunks of data. + */ +int sha256_update(sha256_ctx_t* ctx, const void *data, std::size_t len); + +/** + * Place the message digest in out variable. + * The ctx's internal state is reset after this operation. + */ +int sha256_final(sha256_ctx_t* ctx, sha256_t* out); + /** * sha256 hashing function. * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. @@ -48,6 +69,23 @@ sha256_t* sha256(const unsigned char *data, std::size_t len, sha256_t* out); */ sha256_t* sha256d(const unsigned char *data, std::size_t len, sha256_t* out); +/** + * Initialize a ripmemd160_ctx_t structure + */ +int ripemd160_init(ripemd160_ctx_t* ctx); + +/** + * Update the RipeMD160 hash value with the contents in `data` up to `len` bytes. + * This can be called repeatedly to hash chunks of data. + */ +int ripemd160_update(ripemd160_ctx_t* ctx, const void *data, std::size_t len); + +/** + * Places the RipeMD160 message digest in out variable. + * The ctx's internal state is reset after this operation. + */ +int ripemd160_final(ripemd160_ctx_t* ctx, ripemd160_t* out); + /** * RipeMD160 hashing function. * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. diff --git a/src/openssl/hash.cpp b/src/openssl/hash.cpp index 492e23a..1fa07b3 100644 --- a/src/openssl/hash.cpp +++ b/src/openssl/hash.cpp @@ -27,6 +27,18 @@ namespace libantelope { +int sha256_init(struct sha256_ctx* ctx) { + return SHA256_Init((SHA256_CTX*)ctx); +} + +int sha256_update(sha256_ctx_t* ctx, const void *data, std::size_t len) { + return SHA256_Update((SHA256_CTX*)ctx, data, len); +} + +int sha256_final(sha256_ctx_t* ctx, sha256_t* out) { + return SHA256_Final((unsigned char*) out, (SHA256_CTX*)ctx); +} + sha256_t* sha256(const unsigned char *data, std::size_t len, sha256_t* out) { return (sha256_t *) SHA256(data, len, (unsigned char*) out); } @@ -36,6 +48,18 @@ sha256_t* sha256d(const unsigned char *data, std::size_t len, sha256_t* out) { return (sha256_t *) SHA256((unsigned char*) out, 32, (unsigned char*) out); } +int ripemd160_init(ripemd160_ctx_t* ctx) { + return RIPEMD160_Init((RIPEMD160_CTX*)ctx); +} + +int ripemd160_update(ripemd160_ctx_t* ctx, const void *data, std::size_t len) { + return RIPEMD160_Update((RIPEMD160_CTX*)ctx, data, len); +} + +int ripemd160_final(ripemd160_ctx_t* ctx, ripemd160_t* out) { + return RIPEMD160_Final((unsigned char*) out, (RIPEMD160_CTX*)ctx); +} + ripemd160_t* ripemd160(const unsigned char *data, std::size_t len, ripemd160_t* out) { return (ripemd160_t *) RIPEMD160(data, len, (unsigned char*) out); } From 225a1947ae4948d5228f2378f6a0e956295248a5 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:55:07 +0200 Subject: [PATCH 16/30] include/libantelope/hash.hpp: split into hash/ripemd160.hpp and hash/sha256.hpp --- include/libantelope/hash.hpp | 72 +------------------------- include/libantelope/hash/ripemd160.hpp | 62 ++++++++++++++++++++++ include/libantelope/hash/sha256.hpp | 69 ++++++++++++++++++++++++ 3 files changed, 133 insertions(+), 70 deletions(-) create mode 100644 include/libantelope/hash/ripemd160.hpp create mode 100644 include/libantelope/hash/sha256.hpp diff --git a/include/libantelope/hash.hpp b/include/libantelope/hash.hpp index 67dd698..a471c67 100644 --- a/include/libantelope/hash.hpp +++ b/include/libantelope/hash.hpp @@ -24,75 +24,7 @@ #ifndef LIBANTELOPE_HASH_H #define LIBANTELOPE_HASH_H -#include -#include - -namespace libantelope { - -/** - * Hashes - */ -typedef unsigned char ripemd160_t[20]; -typedef unsigned char sha256_t[32]; - -typedef internal::sha256_state sha256_ctx_t; -typedef internal::ripemd160_state ripemd160_ctx_t; - -/** - * Initialize a sha256_ctx_t structure - */ -int sha256_init(sha256_ctx_t* ctx); - -/** - * Update the sha256 hash value with the contents in `data` up to `len` bytes. - * This can be called repeatedly to hash chunks of data. - */ -int sha256_update(sha256_ctx_t* ctx, const void *data, std::size_t len); - -/** - * Place the message digest in out variable. - * The ctx's internal state is reset after this operation. - */ -int sha256_final(sha256_ctx_t* ctx, sha256_t* out); - -/** - * sha256 hashing function. - * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. - * Returns the same pointer as `out`. - */ -sha256_t* sha256(const unsigned char *data, std::size_t len, sha256_t* out); - -/** - * sha256 double hashing function. - * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. - * Returns the same pointer as `out`. - */ -sha256_t* sha256d(const unsigned char *data, std::size_t len, sha256_t* out); - -/** - * Initialize a ripmemd160_ctx_t structure - */ -int ripemd160_init(ripemd160_ctx_t* ctx); - -/** - * Update the RipeMD160 hash value with the contents in `data` up to `len` bytes. - * This can be called repeatedly to hash chunks of data. - */ -int ripemd160_update(ripemd160_ctx_t* ctx, const void *data, std::size_t len); - -/** - * Places the RipeMD160 message digest in out variable. - * The ctx's internal state is reset after this operation. - */ -int ripemd160_final(ripemd160_ctx_t* ctx, ripemd160_t* out); - -/** - * RipeMD160 hashing function. - * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. - * Returns the same pointer as `out`. - */ -ripemd160_t* ripemd160(const unsigned char *data, std::size_t len, ripemd160_t* out); - -} // namespace libantelope +#include +#include #endif /* LIBANTELOPE_HASH_H */ diff --git a/include/libantelope/hash/ripemd160.hpp b/include/libantelope/hash/ripemd160.hpp new file mode 100644 index 0000000..45ba4ff --- /dev/null +++ b/include/libantelope/hash/ripemd160.hpp @@ -0,0 +1,62 @@ +/** + * MIT License + * + * Copyright (c) 2019-2023 EOS Sw/eden + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef LIBANTELOPE_HASH_RIPEMD160_H +#define LIBANTELOPE_HASH_RIPEMD160_H + +#include +#include + +namespace libantelope { + +typedef unsigned char ripemd160_t[20]; + +typedef internal::ripemd160_state ripemd160_ctx_t; + +/** + * Initialize a ripmemd160_ctx_t structure + */ +int ripemd160_init(ripemd160_ctx_t* ctx); + +/** + * Update the RipeMD160 hash value with the contents in `data` up to `len` bytes. + * This can be called repeatedly to hash chunks of data. + */ +int ripemd160_update(ripemd160_ctx_t* ctx, const void *data, std::size_t len); + +/** + * Places the RipeMD160 message digest in out variable. + * The ctx's internal state is reset after this operation. + */ +int ripemd160_final(ripemd160_ctx_t* ctx, ripemd160_t* out); + +/** + * RipeMD160 hashing function. + * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. + * Returns the same pointer as `out`. + */ +ripemd160_t* ripemd160(const unsigned char *data, std::size_t len, ripemd160_t* out); + +} // namespace libantelope + +#endif /* LIBANTELOPE_RIPEMD160_H */ diff --git a/include/libantelope/hash/sha256.hpp b/include/libantelope/hash/sha256.hpp new file mode 100644 index 0000000..3f79d4a --- /dev/null +++ b/include/libantelope/hash/sha256.hpp @@ -0,0 +1,69 @@ +/** + * MIT License + * + * Copyright (c) 2019-2023 EOS Sw/eden + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef LIBANTELOPE_HASH_SHA256_H +#define LIBANTELOPE_HASH_SHA256_H + +#include +#include + +namespace libantelope { + +typedef unsigned char sha256_t[32]; + +typedef internal::sha256_state sha256_ctx_t; + +/** + * Initialize a sha256_ctx_t structure + */ +int sha256_init(sha256_ctx_t* ctx); + +/** + * Update the sha256 hash value with the contents in `data` up to `len` bytes. + * This can be called repeatedly to hash chunks of data. + */ +int sha256_update(sha256_ctx_t* ctx, const void *data, std::size_t len); + +/** + * Place the message digest in out variable. + * The ctx's internal state is reset after this operation. + */ +int sha256_final(sha256_ctx_t* ctx, sha256_t* out); + +/** + * sha256 hashing function. + * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. + * Returns the same pointer as `out`. + */ +sha256_t* sha256(const unsigned char *data, std::size_t len, sha256_t* out); + +/** + * sha256 double hashing function. + * Hashes the content in `data` up to `len` bytes. The result is stored in `out`. + * Returns the same pointer as `out`. + */ +sha256_t* sha256d(const unsigned char *data, std::size_t len, sha256_t* out); + +} // namespace libantelope + +#endif /* LIBANTELOPE_HASH_SHA256_H */ From c035a804b229494c3a9c88b92b053becc7de2692 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 30 May 2023 13:59:05 +0200 Subject: [PATCH 17/30] src/wif/k1.cpp: implement _checksum_suffix() using init/update/final ripemd160 functions. --- src/wif/k1.cpp | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/src/wif/k1.cpp b/src/wif/k1.cpp index f7e8af2..881e519 100644 --- a/src/wif/k1.cpp +++ b/src/wif/k1.cpp @@ -23,7 +23,7 @@ */ #include -#include +#include #include "codec.hpp" namespace libantelope { namespace internal { @@ -31,22 +31,23 @@ namespace libantelope { namespace internal { // Just to make it "harder" the calculated checksum for a signature (k1) and pub/priv keys in k1/r1 format. // has a suffix that is not present in the WIF encoded string. // So this function is a quick hack to calculate it. -// -// Should implement and use Init/Update/Finalize hash functions to do it inplace. -void _checksum_suffix(const unsigned char *in, size_t size, const char *suffix, checksum_t check) { - std::vector buf(size + 2); +void _checksum_suffix(const unsigned char *in, size_t size, checksum_t check) { + ripemd160_ctx_t ctx; + ripemd160_t md; - memcpy(buf.data(), in, size); - memcpy(buf.data() + size, suffix, 2); + ripemd160_init(&ctx); + ripemd160_update(&ctx, in, size); + ripemd160_update(&ctx, "K1", 2); + ripemd160_final(&ctx, &md); - return checksum_ripemd160(buf.data(), buf.size(), (unsigned char*) check); + std::memcpy(check, md, CHECKSUM_SIZE); } void pub_encoder_k1(const ec_pubkey_t& key, unsigned char *buf) { checksum_t check; - _checksum_suffix(key.data(), EC_PUBKEY_SIZE, "K1", check); + _checksum_suffix(key.data(), EC_PUBKEY_SIZE, check); memcpy(buf, key.data(), EC_PUBKEY_SIZE); memcpy(buf + EC_PUBKEY_SIZE, check, CHECKSUM_SIZE); @@ -56,7 +57,7 @@ bool pub_decoder_k1(const std::vector& buf, ec_pubkey_t& key) { checksum_t check; - _checksum_suffix(buf.data(), EC_PUBKEY_SIZE, "K1", check); + _checksum_suffix(buf.data(), EC_PUBKEY_SIZE, check); if (memcmp(buf.data() + EC_PUBKEY_SIZE, check, CHECKSUM_SIZE)) { return false; @@ -69,7 +70,7 @@ bool pub_decoder_k1(const std::vector& buf, ec_pubkey_t& key) { size_t priv_encoder_k1(const ec_privkey_t& priv, unsigned char *buf) { checksum_t check; - _checksum_suffix(priv.data(), EC_PRIVKEY_SIZE, "K1", check); + _checksum_suffix(priv.data(), EC_PRIVKEY_SIZE, check); memcpy(buf, priv.data(), priv.size()); memcpy(buf + EC_PRIVKEY_SIZE, check, CHECKSUM_SIZE); @@ -84,7 +85,7 @@ bool priv_decoder_k1(const std::vector& buf, ec_privkey_t& priv) } checksum_t check; - _checksum_suffix(buf.data(), EC_PRIVKEY_SIZE, "K1", check); + _checksum_suffix(buf.data(), EC_PRIVKEY_SIZE, check); if (memcmp(buf.data() + EC_PRIVKEY_SIZE, check, CHECKSUM_SIZE)) { return false; } @@ -97,7 +98,7 @@ void sig_encoder_k1(const ec_signature_t& sig, unsigned char *buf) { checksum_t check; - _checksum_suffix(sig.data(), EC_SIGNATURE_SIZE, "K1", check); + _checksum_suffix(sig.data(), EC_SIGNATURE_SIZE, check); memcpy(buf, sig.data(), sig.size()); memcpy(buf + EC_SIGNATURE_SIZE, check, CHECKSUM_SIZE); @@ -112,7 +113,7 @@ bool sig_decoder_k1(const std::vector& buf, ec_signature_t& sig) } // Calculate checksum - _checksum_suffix(buf.data(), EC_SIGNATURE_SIZE, "K1", check); + _checksum_suffix(buf.data(), EC_SIGNATURE_SIZE, check); // And validate if (memcmp(buf.data() + EC_SIGNATURE_SIZE, check, CHECKSUM_SIZE)) { From ec7a67ad883a9a00612c7f0fd2e85be9c08f01b6 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 10:42:12 +0200 Subject: [PATCH 18/30] src/openssl/hash.cpp: fix sha256_init() signature. --- src/openssl/hash.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/openssl/hash.cpp b/src/openssl/hash.cpp index 1fa07b3..ce86071 100644 --- a/src/openssl/hash.cpp +++ b/src/openssl/hash.cpp @@ -27,7 +27,7 @@ namespace libantelope { -int sha256_init(struct sha256_ctx* ctx) { +int sha256_init(sha256_ctx_t* ctx) { return SHA256_Init((SHA256_CTX*)ctx); } From 93f6b1b0300fb9e3fcea523581535525f3721500 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 10:45:25 +0200 Subject: [PATCH 19/30] Adding tests/include/testing.h --- tests/include/testing.h | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 tests/include/testing.h diff --git a/tests/include/testing.h b/tests/include/testing.h new file mode 100644 index 0000000..6a7206e --- /dev/null +++ b/tests/include/testing.h @@ -0,0 +1,8 @@ +#ifndef LIBANTELOPE_TESTING_H +#define LIBANTELOPE_TESTING_H + +#include + +#define CHECK_PRED(a,b,pred) if (pred) { CHECK_EQ((a), (b)); } else { CHECK_NE((a), (b)); } + +#endif /* LIBANTELOPE_TESTING_H */ \ No newline at end of file From 84645175c1c319b840a4b006a5ab55f07f6f404f Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 10:46:14 +0200 Subject: [PATCH 20/30] tests: Adding tests for sha256 and ripemd160 hashing functions. --- tests/CMakeLists.txt | 4 + tests/hash/ripemd160.cpp | 115 ++++++++++++++++++++++++++ tests/hash/sha256.cpp | 174 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 293 insertions(+) create mode 100644 tests/hash/ripemd160.cpp create mode 100644 tests/hash/sha256.cpp diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index c1a8429..5776caf 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -2,6 +2,10 @@ set(TEST_SRC main.cpp + # hash + hash/sha256.cpp + hash/ripemd160.cpp + # ec ec/generate.cpp ec/pubkey.cpp diff --git a/tests/hash/ripemd160.cpp b/tests/hash/ripemd160.cpp new file mode 100644 index 0000000..086605a --- /dev/null +++ b/tests/hash/ripemd160.cpp @@ -0,0 +1,115 @@ +#include +#include +#include +#include + +TEST_CASE("hash::ripemd160::ripemd160") { + + struct testcase { + const char *name; + std::string input; + libantelope::ripemd160_t expected; + bool valid; + }; + + std::vector tests = { + { + "valid #1", + "Morbi at egestas risus. Praesent blandit pharetra urna, nec porttitor risus sodales eu. Cras et volutpat elit, porta dapibus ipsum. Donec facilisis, eros nec imperdiet tristique, purus eros malesuada neque, quis interdum nisl risus nec leo.", + { + 0xd9, 0x6a, 0x48, 0xf8, 0x2b, 0x39, 0xa9, 0x9f, + 0x22, 0xba, 0x3e, 0x01, 0x58, 0x5b, 0x15, 0xc7, + 0x7b, 0x0e, 0x5f, 0x50, + }, + true + }, + { + "valid #2", + "Donec eget mattis velit, vel vulputate sem. Suspendisse vulputate dolor vel est facilisis congue. Nulla non leo nulla. Proin lorem elit, sagittis eget congue in, pellentesque sed nisi. In pulvinar tortor fermentum suscipit varius.", + { + 0x87, 0x1b, 0x87, 0xde, 0x2e, 0xb6, 0x8b, 0xb6, + 0xdc, 0x29, 0xe7, 0x40, 0xc3, 0xd1, 0x99, 0x42, + 0xad, 0x1a, 0xe3, 0x57 + }, + true + } + }; + + for(auto it = tests.begin(); it != tests.end(); it++) { + SUBCASE(it->name) { + libantelope::ripemd160_t dgst; + + CHECK( libantelope::ripemd160((const unsigned char*) it->input.c_str(), it->input.size(), &dgst) == &dgst ); + + CHECK_PRED(doctest::toString(dgst), doctest::toString(it->expected), it->valid); + } + } +} + +TEST_CASE("hash::ripemd160::init/update/final") { + + struct testcase { + const char *name; + std::vector inputs; + libantelope::ripemd160_t expected; + }; + + std::vector tests = { + { + "valid #1", + { + "tortor in congue luctus, tortor sapien condimentum quam, ac congue enim lacus vitae erat. Mauris dapibus eros bibendum", + "Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae", + }, + { + 0x30, 0x77, 0xaf, 0x6b, 0x43, 0x0b, 0x94, 0x8d, + 0x59, 0x4e, 0xc7, 0xbb, 0x1a, 0x2b, 0xc3, 0x08, + 0xaa, 0xf0, 0x75, 0x3a + } + }, + { + "valid #2", + { + "Cras suscipit, mi sit amet pretium blandit, massa felis aliquet eros", + "Aenean efficitur nibh quis enim mollis blandit", + "Vestibulum posuere tempus mi nec cursus" + }, + { + 0xf1, 0xcf, 0xea, 0xf7, 0xef, 0x3a, 0x0f, 0x80, + 0x26, 0x75, 0x40, 0x75, 0xe0, 0x9d, 0x89, 0x05, + 0xd1, 0x29, 0xe5, 0xf6 + } + }, + { + "valid #3", + { + "Donec nec blandit dui. Nulla et tempus odio, id fermentum neque. Nam vitae nunc leo. Aliquam dictum velit nec neque dignissim maximus nec at tellus", + "Proin elementum porttitor odio, ut ullamcorper justo rutrum in. Proin dignissim nec diam a eleifend. Duis consequat ultrices purus sed finibus", + "Donec eget ante dictum, scelerisque metus eget, mollis velit. Curabitur elementum fermentum lorem, a fringilla velit ultrices non" + }, + { + 0xbb, 0x25, 0x58, 0xa9, 0xd0, 0xc1, 0x23, 0xef, + 0x55, 0xac, 0x2d, 0x8c, 0xd5, 0xd6, 0xe1, 0x49, + 0x00, 0x5d, 0x86, 0xe8 + } + }, + }; + + for(auto it = tests.begin(); it != tests.end(); it++) { + SUBCASE(it->name) { + libantelope::ripemd160_ctx_t ctx; + libantelope::ripemd160_t dgst; + + CHECK_EQ(libantelope::ripemd160_init(&ctx), 1); + + for (auto in_it = it->inputs.begin(); in_it != it->inputs.end(); in_it++ ) { + CHECK_EQ(libantelope::ripemd160_update(&ctx, (const unsigned char*) in_it->c_str(), in_it->size()), 1); + } + + CHECK_EQ(libantelope::ripemd160_final(&ctx, &dgst), 1); + + CHECK( doctest::toString(dgst) == doctest::toString(it->expected) ); + } + } + +} \ No newline at end of file diff --git a/tests/hash/sha256.cpp b/tests/hash/sha256.cpp new file mode 100644 index 0000000..88b2744 --- /dev/null +++ b/tests/hash/sha256.cpp @@ -0,0 +1,174 @@ +#include +#include +#include +#include + +TEST_CASE("hash::sha256::sha256") { + + struct testcase { + const char *name; + std::string input; + libantelope::sha256_t expected; + bool valid; + }; + + std::vector tests = { + { + "valid #1", + "Suspendisse ut tincidunt quam. Praesent scelerisque risus vitae est consectetur, sed facilisis sem luctus. Praesent aliquet eros quis leo sodales, eget blandit diam scelerisque.", + { + 0x1e, 0x54, 0x96, 0x86, 0x2f, 0x39, 0x44, 0xea, + 0x42, 0xa9, 0x0f, 0xad, 0x56, 0x79, 0x4b, 0x77, + 0x8f, 0xcc, 0x54, 0xf7, 0x7a, 0x32, 0x60, 0x37, + 0x4b, 0xac, 0xd5, 0x65, 0x74, 0xf7, 0xcf, 0x6c + }, + true + }, + { + "valid #2", + "Phasellus consectetur augue vitae massa vulputate placerat. Pellentesque nec eros a velit bibendum venenatis sit amet et augue. Morbi malesuada facilisis consequat.", + { + 0x7c, 0x79, 0x4a, 0xf4, 0x9b, 0x5b, 0xb4, 0x0c, + 0xef, 0x4f, 0xaa, 0x65, 0xa4, 0x7c, 0x5f, 0xc5, + 0x95, 0x69, 0x49, 0x99, 0x6b, 0x08, 0x9b, 0xc0, + 0x40, 0x2d, 0x57, 0x8a, 0x90, 0x02, 0x42, 0x32, + }, + true + } + }; + + for(auto it = tests.begin(); it != tests.end(); it++) { + SUBCASE(it->name) { + libantelope::sha256_t dgst; + + CHECK( libantelope::sha256((const unsigned char*) it->input.c_str(), it->input.size(), &dgst) == &dgst ); + + CHECK_PRED(doctest::toString(dgst), doctest::toString(it->expected), it->valid); + } + } +} + +TEST_CASE("hash::sha256::sha256d") { + + struct testcase { + const char *name; + std::string input; + libantelope::sha256_t expected; + }; + + std::vector tests = { + { + "valid #1", + "Suspendisse ut tincidunt quam. Praesent scelerisque risus vitae est consectetur, sed facilisis sem luctus. Praesent aliquet eros quis leo sodales, eget blandit diam scelerisque.", + { + 0x4b, 0x6f, 0xa1, 0xf6, 0x30, 0x1e, 0xbe, 0x4a, + 0xc7, 0xef, 0x1e, 0x55, 0x3e, 0xdb, 0xc1, 0x31, + 0x1f, 0x6b, 0xf5, 0xc8, 0x04, 0xe9, 0x0e, 0xe3, + 0xbe, 0x66, 0x01, 0xbf, 0x70, 0x9f, 0x8e, 0x80, + } + }, + { + "valid #2", + "Vivamus ut elementum justo. Vestibulum lobortis rutrum libero sollicitudin aliquet. Nullam tempor urna non odio iaculis, sed pretium quam porttitor. Pellentesque pretium, justo vitae tristique porttitor, diam massa pulvinar neque, sed lacinia mi nulla sed nisi.", + { + 0x1f, 0x3f, 0x1c, 0x48, 0xf6, 0xee, 0x24, 0x1f, + 0x6c, 0x41, 0x86, 0x69, 0xe3, 0x2f, 0x5e, 0x4d, + 0xa5, 0x51, 0x04, 0x8b, 0x11, 0x35, 0x47, 0xad, + 0x7e, 0xd9, 0xfb, 0x2e, 0x59, 0xee, 0x66, 0x21, + } + }, + { + "valid #3", + "Praesent ultrices consequat risus luctus faucibus.", + { + 0xd5, 0x5f, 0x9c, 0xda, 0x2d, 0x93, 0x32, 0xc2, + 0x9b, 0xb1, 0xbb, 0x14, 0x55, 0x80, 0x72, 0xb7, + 0xba, 0x13, 0xa8, 0xc6, 0xa6, 0xbc, 0x65, 0xfc, + 0x49, 0xe0, 0x3b, 0x23, 0x04, 0x2a, 0x92, 0x8d, + } + } + }; + + for(auto it = tests.begin(); it != tests.end(); it++) { + SUBCASE(it->name) { + libantelope::sha256_t dgst; + + CHECK( libantelope::sha256d((const unsigned char*) it->input.c_str(), it->input.size(), &dgst) == &dgst ); + + CHECK( doctest::toString(dgst) == doctest::toString(it->expected) ); + } + } +} + +TEST_CASE("hash::sha256::init/update/final") { + + struct testcase { + const char *name; + std::vector inputs; + libantelope::sha256_t expected; + }; + + std::vector tests = { + { + "valid #1", + { + "Donec vestibulum enim commodo, faucibus nisi non, mattis quam.", + "Nam sed nunc dapibus, auctor risus placerat, aliquet dolor", + }, + { + 0x48, 0xc2, 0x34, 0x93, 0x3d, 0xae, 0x0d, 0xd0, + 0x28, 0xff, 0x5c, 0xa0, 0xca, 0xb1, 0x0a, 0xa3, + 0xe2, 0xa0, 0xa4, 0x7e, 0xb2, 0x71, 0xa5, 0x28, + 0x41, 0x03, 0x72, 0x20, 0xb5, 0x23, 0xc3, 0x67, + } + }, + { + "valid #2", + { + "In tempus, lectus ac molestie venenatis, enim purus suscipit tortor", + "sed sodales massa condimentum a", + "Integer sit amet pretium magna", + "Aenean non accumsan eros. Donec imperdiet justo tempor magna tincidunt malesuada", + "Duis eu tortor ac massa sagittis elementum" + }, + { + 0xfb, 0x12, 0x31, 0x9c, 0x2c, 0xe4, 0x94, 0x29, + 0xc9, 0xd3, 0xc7, 0x84, 0x0c, 0x58, 0x3d, 0x4c, + 0xde, 0xb5, 0x36, 0x59, 0x46, 0x69, 0xe1, 0x63, + 0xc5, 0x75, 0xb6, 0x94, 0x41, 0x5a, 0xd4, 0x62, + } + }, + { + "valid #3", + { + "Donec tempus pellentesque lobortis. Integer pellentesque feugiat enim ac suscipit. Curabitur urna quam, condimentum sed bibendum eu", + "Nullam lacinia ligula at ex gravida fermentum. Integer scelerisque accumsan iaculis. Suspendisse quis eros ut orci sollicitudin dignissim", + "Nulla ligula tortor, tristique eget feugiat non, vehicula sit amet velit. Proin fermentum sagittis tincidunt. Nullam condimentum dapibus magna", + }, + { + 0x19, 0xfb, 0x71, 0xb1, 0x47, 0x01, 0x7f, 0xf5, + 0xeb, 0xda, 0xc2, 0xd8, 0xe7, 0xab, 0xc9, 0xcb, + 0xea, 0x7d, 0x13, 0xa0, 0x2e, 0xe8, 0x48, 0x94, + 0x67, 0xc5, 0x14, 0xbf, 0x7d, 0x6f, 0x96, 0x83, + } + }, + }; + + for(auto it = tests.begin(); it != tests.end(); it++) { + SUBCASE(it->name) { + libantelope::sha256_ctx_t ctx; + libantelope::sha256_t dgst; + + CHECK_EQ(libantelope::sha256_init(&ctx), 1); + + for (auto in_it = it->inputs.begin(); in_it != it->inputs.end(); in_it++ ) { + CHECK_EQ(libantelope::sha256_update(&ctx, (const unsigned char*) in_it->c_str(), in_it->size()), 1); + } + + CHECK_EQ(libantelope::sha256_final(&ctx, &dgst), 1); + + CHECK( doctest::toString(dgst) == doctest::toString(it->expected) ); + } + } + +} \ No newline at end of file From e0d0bcb0cb7d554b2cc74dcbb8425ccb10bd15ea Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 10:47:44 +0200 Subject: [PATCH 21/30] include/libantelope/internal/hash.hpp: don't include OpenSSL headers here. instead we declare the state variables as plain arrays. --- include/libantelope/internal/hash.hpp | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/include/libantelope/internal/hash.hpp b/include/libantelope/internal/hash.hpp index d2a889d..62107ff 100644 --- a/include/libantelope/internal/hash.hpp +++ b/include/libantelope/internal/hash.hpp @@ -29,13 +29,10 @@ #ifdef LIBANTELOPE_HASHIMPL_OPENSSL -#include -#include - namespace libantelope { namespace internal { - typedef SHA256_CTX sha256_state; - typedef RIPEMD160_CTX ripemd160_state; + typedef unsigned char sha256_state[112]; + typedef unsigned char ripemd160_state[96]; } } // namespace libantelope::internal #else From 7e9bd41a83710b4b68abca1dfa524796b264398d Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 10:48:52 +0200 Subject: [PATCH 22/30] src/libsecp256k1/rng.h: fix C467 warning on MSVC compilers. --- src/libsecp256k1/rng.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/libsecp256k1/rng.h b/src/libsecp256k1/rng.h index 103583f..f476963 100644 --- a/src/libsecp256k1/rng.h +++ b/src/libsecp256k1/rng.h @@ -42,12 +42,17 @@ static int fill_random(unsigned char* data, size_t size) { #if defined(_WIN32) +/* Disable C4267 Warning (dataloss when casting variable to smaller size) temporarily */ +#pragma warning( push ) +#pragma warning( disable: 4267 ) NTSTATUS res = BCryptGenRandom(NULL, data, size, BCRYPT_USE_SYSTEM_PREFERRED_RNG); +#pragma warning( pop ) if (res != STATUS_SUCCESS || size > ULONG_MAX) { return 0; } else { return 1; } + #elif defined(__linux__) || defined(__FreeBSD__) /* If `getrandom(2)` is not available you should fallback to /dev/urandom */ ssize_t res = getrandom(data, size, 0); From e15a5ede18481f28f17b12ebaf318ea2cce82ff6 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 14:41:36 +0200 Subject: [PATCH 23/30] tests/hash: fix bug in MSVC compiler. --- tests/hash/ripemd160.cpp | 3 +++ tests/hash/sha256.cpp | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/tests/hash/ripemd160.cpp b/tests/hash/ripemd160.cpp index 086605a..383a231 100644 --- a/tests/hash/ripemd160.cpp +++ b/tests/hash/ripemd160.cpp @@ -52,6 +52,9 @@ TEST_CASE("hash::ripemd160::init/update/final") { const char *name; std::vector inputs; libantelope::ripemd160_t expected; +#ifdef _MSC_VER + char _; // ripemd160_t can't be last, wierd compiler bug on MSVC +#endif }; std::vector tests = { diff --git a/tests/hash/sha256.cpp b/tests/hash/sha256.cpp index 88b2744..8477cea 100644 --- a/tests/hash/sha256.cpp +++ b/tests/hash/sha256.cpp @@ -54,6 +54,9 @@ TEST_CASE("hash::sha256::sha256d") { const char *name; std::string input; libantelope::sha256_t expected; +#ifdef _MSC_VER + char _; // sha256_t can't be last, wierd compiler bug on MSVC +#endif }; std::vector tests = { @@ -106,6 +109,9 @@ TEST_CASE("hash::sha256::init/update/final") { const char *name; std::vector inputs; libantelope::sha256_t expected; +#ifdef _MSC_VER + char _; // sha256_t can't be last, wierd compiler bug on MSVC +#endif }; std::vector tests = { From 9ad2e3cc007c3aff87a645fcac0eacda9a82a685 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 15:03:07 +0200 Subject: [PATCH 24/30] Adding tests/cmake/doctest.cmake --- tests/cmake/doctest.cmake | 189 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 tests/cmake/doctest.cmake diff --git a/tests/cmake/doctest.cmake b/tests/cmake/doctest.cmake new file mode 100644 index 0000000..f0bc593 --- /dev/null +++ b/tests/cmake/doctest.cmake @@ -0,0 +1,189 @@ +# Distributed under the OSI-approved BSD 3-Clause License. See accompanying +# file Copyright.txt or https://cmake.org/licensing for details. + +#[=======================================================================[.rst: +doctest +----- + +This module defines a function to help use the doctest test framework. + +The :command:`doctest_discover_tests` discovers tests by asking the compiled test +executable to enumerate its tests. This does not require CMake to be re-run +when tests change. However, it may not work in a cross-compiling environment, +and setting test properties is less convenient. + +This command is intended to replace use of :command:`add_test` to register +tests, and will create a separate CTest test for each doctest test case. Note +that this is in some cases less efficient, as common set-up and tear-down logic +cannot be shared by multiple test cases executing in the same instance. +However, it provides more fine-grained pass/fail information to CTest, which is +usually considered as more beneficial. By default, the CTest test name is the +same as the doctest name; see also ``TEST_PREFIX`` and ``TEST_SUFFIX``. + +.. command:: doctest_discover_tests + + Automatically add tests with CTest by querying the compiled test executable + for available tests:: + + doctest_discover_tests(target + [TEST_SPEC arg1...] + [EXTRA_ARGS arg1...] + [WORKING_DIRECTORY dir] + [TEST_PREFIX prefix] + [TEST_SUFFIX suffix] + [PROPERTIES name1 value1...] + [ADD_LABELS value] + [TEST_LIST var] + [JUNIT_OUTPUT_DIR dir] + ) + + ``doctest_discover_tests`` sets up a post-build command on the test executable + that generates the list of tests by parsing the output from running the test + with the ``--list-test-cases`` argument. This ensures that the full + list of tests is obtained. Since test discovery occurs at build time, it is + not necessary to re-run CMake when the list of tests changes. + However, it requires that :prop_tgt:`CROSSCOMPILING_EMULATOR` is properly set + in order to function in a cross-compiling environment. + + Additionally, setting properties on tests is somewhat less convenient, since + the tests are not available at CMake time. Additional test properties may be + assigned to the set of tests as a whole using the ``PROPERTIES`` option. If + more fine-grained test control is needed, custom content may be provided + through an external CTest script using the :prop_dir:`TEST_INCLUDE_FILES` + directory property. The set of discovered tests is made accessible to such a + script via the ``_TESTS`` variable. + + The options are: + + ``target`` + Specifies the doctest executable, which must be a known CMake executable + target. CMake will substitute the location of the built executable when + running the test. + + ``TEST_SPEC arg1...`` + Specifies test cases, wildcarded test cases, tags and tag expressions to + pass to the doctest executable with the ``--list-test-cases`` argument. + + ``EXTRA_ARGS arg1...`` + Any extra arguments to pass on the command line to each test case. + + ``WORKING_DIRECTORY dir`` + Specifies the directory in which to run the discovered test cases. If this + option is not provided, the current binary directory is used. + + ``TEST_PREFIX prefix`` + Specifies a ``prefix`` to be prepended to the name of each discovered test + case. This can be useful when the same test executable is being used in + multiple calls to ``doctest_discover_tests()`` but with different + ``TEST_SPEC`` or ``EXTRA_ARGS``. + + ``TEST_SUFFIX suffix`` + Similar to ``TEST_PREFIX`` except the ``suffix`` is appended to the name of + every discovered test case. Both ``TEST_PREFIX`` and ``TEST_SUFFIX`` may + be specified. + + ``PROPERTIES name1 value1...`` + Specifies additional properties to be set on all tests discovered by this + invocation of ``doctest_discover_tests``. + + ``ADD_LABELS value`` + Specifies if the test labels should be set automatically. + + ``TEST_LIST var`` + Make the list of tests available in the variable ``var``, rather than the + default ``_TESTS``. This can be useful when the same test + executable is being used in multiple calls to ``doctest_discover_tests()``. + Note that this variable is only available in CTest. + + ``JUNIT_OUTPUT_DIR dir`` + If specified, the parameter is passed along with ``--reporters=junit`` + and ``--out=`` to the test executable. The actual file name is the same + as the test target, including prefix and suffix. This should be used + instead of EXTRA_ARGS to avoid race conditions writing the XML result + output when using parallel test execution. + +#]=======================================================================] + +#------------------------------------------------------------------------------ +function(doctest_discover_tests TARGET) + cmake_parse_arguments( + "" + "" + "TEST_PREFIX;TEST_SUFFIX;WORKING_DIRECTORY;TEST_LIST;JUNIT_OUTPUT_DIR" + "TEST_SPEC;EXTRA_ARGS;PROPERTIES;ADD_LABELS" + ${ARGN} + ) + + if(NOT _WORKING_DIRECTORY) + set(_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}") + endif() + if(NOT _TEST_LIST) + set(_TEST_LIST ${TARGET}_TESTS) + endif() + + ## Generate a unique name based on the extra arguments + string(SHA1 args_hash "${_TEST_SPEC} ${_EXTRA_ARGS}") + string(SUBSTRING ${args_hash} 0 7 args_hash) + + # Define rule to generate test list for aforementioned test executable + set(ctest_include_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_include-${args_hash}.cmake") + set(ctest_tests_file "${CMAKE_CURRENT_BINARY_DIR}/${TARGET}_tests-${args_hash}.cmake") + get_property(crosscompiling_emulator + TARGET ${TARGET} + PROPERTY CROSSCOMPILING_EMULATOR + ) + add_custom_command( + TARGET ${TARGET} POST_BUILD + BYPRODUCTS "${ctest_tests_file}" + COMMAND "${CMAKE_COMMAND}" + -D "TEST_TARGET=${TARGET}" + -D "TEST_EXECUTABLE=$" + -D "TEST_EXECUTOR=${crosscompiling_emulator}" + -D "TEST_WORKING_DIR=${_WORKING_DIRECTORY}" + -D "TEST_SPEC=${_TEST_SPEC}" + -D "TEST_EXTRA_ARGS=${_EXTRA_ARGS}" + -D "TEST_PROPERTIES=${_PROPERTIES}" + -D "TEST_ADD_LABELS=${_ADD_LABELS}" + -D "TEST_PREFIX=${_TEST_PREFIX}" + -D "TEST_SUFFIX=${_TEST_SUFFIX}" + -D "TEST_LIST=${_TEST_LIST}" + -D "TEST_JUNIT_OUTPUT_DIR=${_JUNIT_OUTPUT_DIR}" + -D "CTEST_FILE=${ctest_tests_file}" + -P "${_DOCTEST_DISCOVER_TESTS_SCRIPT}" + VERBATIM + ) + + file(WRITE "${ctest_include_file}" + "if(EXISTS \"${ctest_tests_file}\")\n" + " include(\"${ctest_tests_file}\")\n" + "else()\n" + " add_test(${TARGET}_NOT_BUILT-${args_hash} ${TARGET}_NOT_BUILT-${args_hash})\n" + "endif()\n" + ) + + if(NOT CMAKE_VERSION VERSION_LESS 3.10) + # Add discovered tests to directory TEST_INCLUDE_FILES + set_property(DIRECTORY + APPEND PROPERTY TEST_INCLUDE_FILES "${ctest_include_file}" + ) + else() + # Add discovered tests as directory TEST_INCLUDE_FILE if possible + get_property(test_include_file_set DIRECTORY PROPERTY TEST_INCLUDE_FILE SET) + if(NOT ${test_include_file_set}) + set_property(DIRECTORY + PROPERTY TEST_INCLUDE_FILE "${ctest_include_file}" + ) + else() + message(FATAL_ERROR + "Cannot set more than one TEST_INCLUDE_FILE" + ) + endif() + endif() + +endfunction() + +############################################################################### + +set(_DOCTEST_DISCOVER_TESTS_SCRIPT + ${CMAKE_CURRENT_LIST_DIR}/doctestAddTests.cmake +) \ No newline at end of file From 12e779c8cfcb1f6d842a25b11ed7eb2533133e6e Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 15:03:19 +0200 Subject: [PATCH 25/30] Adding tests/cmake/doctestAddTests.cmake --- tests/cmake/doctestAddTests.cmake | 120 ++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 tests/cmake/doctestAddTests.cmake diff --git a/tests/cmake/doctestAddTests.cmake b/tests/cmake/doctestAddTests.cmake new file mode 100644 index 0000000..b9e2b2e --- /dev/null +++ b/tests/cmake/doctestAddTests.cmake @@ -0,0 +1,120 @@ +# Distributed under the OSI-approved BSD 3-Clause License. See accompanying +# file Copyright.txt or https://cmake.org/licensing for details. + +set(prefix "${TEST_PREFIX}") +set(suffix "${TEST_SUFFIX}") +set(spec ${TEST_SPEC}) +set(extra_args ${TEST_EXTRA_ARGS}) +set(properties ${TEST_PROPERTIES}) +set(add_labels ${TEST_ADD_LABELS}) +set(junit_output_dir "${TEST_JUNIT_OUTPUT_DIR}") +set(script) +set(suite) +set(tests) + +function(add_command NAME) + set(_args "") + foreach(_arg ${ARGN}) + if(_arg MATCHES "[^-./:a-zA-Z0-9_]") + set(_args "${_args} [==[${_arg}]==]") # form a bracket_argument + else() + set(_args "${_args} ${_arg}") + endif() + endforeach() + set(script "${script}${NAME}(${_args})\n" PARENT_SCOPE) +endfunction() + +# Run test executable to get list of available tests +if(NOT EXISTS "${TEST_EXECUTABLE}") + message(FATAL_ERROR + "Specified test executable '${TEST_EXECUTABLE}' does not exist" + ) +endif() + +if("${spec}" MATCHES .) + set(spec "--test-case=${spec}") +endif() + +execute_process( + COMMAND ${TEST_EXECUTOR} "${TEST_EXECUTABLE}" ${spec} --list-test-cases + OUTPUT_VARIABLE output + RESULT_VARIABLE result + WORKING_DIRECTORY "${TEST_WORKING_DIR}" +) +if(NOT ${result} EQUAL 0) + message(FATAL_ERROR + "Error running test executable '${TEST_EXECUTABLE}':\n" + " Result: ${result}\n" + " Output: ${output}\n" + ) +endif() + +string(REPLACE "\n" ";" output "${output}") + +# Parse output +foreach(line ${output}) + if("${line}" STREQUAL "===============================================================================" OR "${line}" MATCHES [==[^\[doctest\] ]==]) + continue() + endif() + set(test ${line}) + set(labels "") + if(${add_labels}) + # get test suite that test belongs to + execute_process( + COMMAND ${TEST_EXECUTOR} "${TEST_EXECUTABLE}" --test-case=${test} --list-test-suites + OUTPUT_VARIABLE labeloutput + RESULT_VARIABLE labelresult + WORKING_DIRECTORY "${TEST_WORKING_DIR}" + ) + if(NOT ${labelresult} EQUAL 0) + message(FATAL_ERROR + "Error running test executable '${TEST_EXECUTABLE}':\n" + " Result: ${labelresult}\n" + " Output: ${labeloutput}\n" + ) + endif() + + string(REPLACE "\n" ";" labeloutput "${labeloutput}") + foreach(labelline ${labeloutput}) + if("${labelline}" STREQUAL "===============================================================================" OR "${labelline}" MATCHES [==[^\[doctest\] ]==]) + continue() + endif() + list(APPEND labels ${labelline}) + endforeach() + endif() + + if(NOT "${junit_output_dir}" STREQUAL "") + # turn testname into a valid filename by replacing all special characters with "-" + string(REGEX REPLACE "[/\\:\"|<>]" "-" test_filename "${test}") + set(TEST_JUNIT_OUTPUT_PARAM "--reporters=junit" "--out=${junit_output_dir}/${prefix}${test_filename}${suffix}.xml") + else() + unset(TEST_JUNIT_OUTPUT_PARAM) + endif() + # use escape commas to handle properly test cases with commas inside the name + string(REPLACE "," "\\," test_name ${test}) + # ...and add to script + add_command(add_test + "${prefix}${test}${suffix}" + ${TEST_EXECUTOR} + "${TEST_EXECUTABLE}" + "--test-case=${test_name}" + "${TEST_JUNIT_OUTPUT_PARAM}" + ${extra_args} + ) + add_command(set_tests_properties + "${prefix}${test}${suffix}" + PROPERTIES + WORKING_DIRECTORY "${TEST_WORKING_DIR}" + ${properties} + LABELS ${labels} + ) + unset(labels) + list(APPEND tests "${prefix}${test}${suffix}") +endforeach() + +# Create a list of all discovered tests, which users may use to e.g. set +# properties on the tests +add_command(set ${TEST_LIST} ${tests}) + +# Write CTest script +file(WRITE "${CTEST_FILE}" "${script}") \ No newline at end of file From afc199e739a3f329ca6d51b427446baa3f8f7bfb Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 15:05:35 +0200 Subject: [PATCH 26/30] tests/CMakeLists.txt: use doctest_discover_tests() macro to add all doctest test cases with a separate CTest test. --- tests/CMakeLists.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 5776caf..3360fbe 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -1,4 +1,6 @@ +include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/doctest.cmake) + set(TEST_SRC main.cpp @@ -30,10 +32,7 @@ add_executable(doctest ${TEST_SRC}) target_link_libraries(doctest PRIVATE ${LIB_NAME}) target_include_directories(doctest PRIVATE ${CMAKE_CURRENT_LIST_DIR}/include) -add_test( - NAME doctest - COMMAND $ -ni -fc -) +doctest_discover_tests(doctest) if (WITH_BENCHMARK) add_subdirectory( benchmark ) From 1801c8424a356bf1308e3847e9362151f505c262 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 31 May 2023 15:06:58 +0200 Subject: [PATCH 27/30] Version 0.2.1 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 30ba605..172508b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.15) # Project name and version project(libantelope - VERSION 0.2.0 + VERSION 0.2.1 DESCRIPTION "C++ library for Antelope IO" HOMEPAGE_URL "https://github.com/eosswedenorg/libantelope" LANGUAGES C CXX From cadb1ff984e1907488a591506b04fdfc7d798c49 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Thu, 1 Jun 2023 14:45:00 +0200 Subject: [PATCH 28/30] Rework README.md --- README.md | 109 +++++++++++++++++++++--------------------------------- 1 file changed, 43 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 6c22bcc..93b8c36 100644 --- a/README.md +++ b/README.md @@ -4,130 +4,107 @@ # libantelope -Independent C++ library for [Antelope IO](https://antelope.io) (former [libeosio](https://github.com/eosswedenorg/libeosio)) - -NOTE: This repository has no connection to the official Antelope code. +libantelope is an independent C++ library designed for Antelope IO (formerly known as libeosio). Please note that this repository is not affiliated with the official Antelope code. ## Compiling the library -You will need `openssl` development files (version 1.1 or later) to compile and `cmake 3.15` or later to compile this project. +To compile this project, you will need the following: + +- `openssl` development files (version 1.1 or later) +- `cmake 3.15` or later ### Elliptic curve backend -There is two different backend implementation for the elliptic curve part of the library: +The library offers two different backend implementations for the elliptic curve functionality: -* `OpenSSL` as mentioned before. however you still need to link to openssl even if it is not used as the EC backend - because more of the codebase uses it. +- `libsecp256k1` +- `OpenSSL`: Although the default is to use `libsecp256k1` for optimization, you still need to link to OpenSSL as other parts of the codebase rely on it. -* `libsecp256k1` - -Default is to use `libsecp256k1` as it is more optimized. - -You can switch implementation by modifing the cmake variable `EC_LIB`. +To switch the implementation, modify the `EC_LIB` variable in the cmake. ### CMake -You can install `cmake` by reading the [official guide](https://cmake.org/install). +You can install `cmake` by referring to the [official guide](https://cmake.org/install). ### Linux -**NOTE:** Only Ubuntu `20.04` and `22.04` is officially supported. +**NOTE:** Only Ubuntu versions `20.04` and `22.04` are officially supported. -The project should compile fine on most versions/distros but it is only tested -and distributed for Ubuntu `20.04` and `22.04` by [Sw/eden](https://www.eossweden.org). +While the project should compile fine on most versions/distros, it is only tested and distributed for Ubuntu `20.04` and `22.04` by [Sw/eden](https://www.eossweden.org). #### Dependencies -**Ubuntu (or other debian based distros)** +**Ubuntu (or other Debian-based distros)** -First you need to have a compiler, `openssl` and `cmake`. this can be installed with apt. +To install the necessary dependencies (compiler, `openssl`, and `cmake`), use the following `apt` command: ```sh -$ apt-get install gcc g++ cmake libssl-dev +apt-get install gcc g++ cmake libssl-dev ``` -If you need a newer version of cmake then apt provides. -Checkout the official [CMake APT repository](https://apt.kitware.com/). + +If you require a newer version of `cmake`, you can refer to the [official CMake APT repository](https://apt.kitware.com/). **Other** -Consult your package manager's manual for getting `openssl`,`g++` and `cmake` installed. - -If you need a newer version of cmake then your package manager provides. checkout the [official guide](https://cmake.org/install). +For other distros, please consult your package manager's manual to install `openssl`, `g++`, and `cmake`. If you need a newer version of `cmake`, you can follow the [official installation guide](https://cmake.org/install). ### MacOS #### Dependencies -You must have a compiler installed. This project is known to build with `Xcode 11.0` but other versions should work. +Ensure that you have a compiler installed. This project is known to build with `Xcode 11.0`, but other versions should work as well. + +To install `openssl` and `cmake`, you can use the following `brew` command: -You need to have openssl and cmake installed also, this can be done with this `brew` command: ```sh -$ brew install openssl cmake +brew install openssl cmake ``` -If you need a newer version of cmake then brew provides. checkout the [official guide](https://cmake.org/install) +If you require a newer version of `cmake`, refer to the [official installation guide](https://cmake.org/install). #### Build ```sh -$ mkdir build && cd build -$ cmake .. && make +mkdir build && cd build +cmake .. && make ``` -**MacOS:** You may need to point `cmake` to `openssl` by passing the argument -`-D OPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1` if openssl is not under `/usr/local/opt/openssl@1.1` you need to find the correct path. +**MacOS:** If your `openssl` installation is not located at `/usr/local/opt/openssl@1.1`, you may need to pass the argument `-D OPENSSL_ROOT_DIR=/path/to/openssl` to `cmake` and specify the correct path. ### Windows #### Dependencies -First you will need a compiler. +First, ensure that you have a compiler installed. -[Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) (Selecting C++ during installation) is recommended. +It is recommended to use [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) and select C++ during installation. -By default `cmake` will use the bundled openssl package located at `vendor/openssl-1.1.1e-win-static.zip` +By default, `cmake` will utilize the bundled OpenSSL package located at `vendor/openssl-1.1.1e-win-static.zip`. If you prefer to use a different version of OpenSSL, set the `OPENSSL_ROOT_DIR` to the directory where OpenSSL is located on your system: -If you like to use an other version of OpenSSL then the static one bundled with this repo -you need to set `OPENSSL_ROOT_DIR` to the directory where OpenSSL is located on the system. - -For example: - -``` -C:\repo> cmake -D OPENSSL_ROOT_DIR=C:/path/to/openssl -B build +```sh +cmake -D OPENSSL_ROOT_DIR=C:/path/to/openssl -B build ``` -**NOTE:** `cmake` uses forward slash `/` for path even for windows. so make sure you use that when setting `OPENSSL_ROOT_DIR` +**NOTE:** `cmake` uses forward slashes `/` for paths, even on Windows, so ensure that you use them when setting -#### Build. + `OPENSSL_ROOT_DIR`. -Run cmake +#### Build -``` -C:\repo> cmake -B build -C:\repo> cmake --build build --config Release +Run `cmake`: + +```sh +cmake -B build +cmake --build build --config Release ``` -## Security notice +## Security Notice -Elliptic curve crypthographic operations is done using either `OpenSSL` or `libsecp256k1` libraries. -This library (libantelope) will never expose sensitve cryptographic information -to anything but the computers memory. -You are free to inspect the source code and compile yourself to verify. +The library performs elliptic curve cryptographic operations using either the `OpenSSL` or `libsecp256k1` libraries. The `libantelope` library ensures that sensitive cryptographic information is only stored in computer memory and not exposed to external sources. You are encouraged to inspect the source code and compile it yourself for verification purposes. -However, use this at your own risk. we cannot guarantee that the keys are -cryptographically secure as this depends on the elliptic curve -implementation (alto both OpenSSL and libsecp256k1 are widely used and should be safe) +However, please use this library at your own risk. While both OpenSSL and libsecp256k1 are widely used and considered safe, we cannot guarantee the cryptographic security of the keys as it depends on the elliptic curve implementation. -Please read the `LICENSE` file. - -``` -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, -INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A -PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF -CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE -OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -``` +Please refer to the `LICENSE` file for more information. ## Author From 11e086ee1225b452e6e861b1edacd8912d872a2f Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 16 Aug 2023 15:49:12 +0200 Subject: [PATCH 29/30] src/base58.cpp: need to include cstdint for uint8_t type --- src/base58.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/base58.cpp b/src/base58.cpp index bd2da9a..a63c909 100644 --- a/src/base58.cpp +++ b/src/base58.cpp @@ -25,6 +25,7 @@ * Based on code from https://github.com/bitcoin/bitcoin/blob/f1e2f2a85962c1664e4e55471061af0eaa798d40/src/base58.cpp */ #include +#include #include #include #include From 4787573a760dcdf0ef7c4b39857b61e87e4f3397 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Wed, 16 Aug 2023 15:52:14 +0200 Subject: [PATCH 30/30] Version 0.2.2 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 172508b..d360a31 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.15) # Project name and version project(libantelope - VERSION 0.2.1 + VERSION 0.2.2 DESCRIPTION "C++ library for Antelope IO" HOMEPAGE_URL "https://github.com/eosswedenorg/libantelope" LANGUAGES C CXX