fix(base64): encode: incorrect padding if size % 3 == 2

V1.0.2

.github/workflows/docs.yml

@@ -4,8 +4,6 @@ on:
   push:
     branches: ["main"]
 
-  workflow_dispatch:
-
 permissions:
   contents: read
   pages: write
@@ -24,12 +22,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          submodules: 'true'
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Install Doxygen
-        run: sudo apt install doxygen
+        run: |
+          wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
+          tar -xf doxygen-1.12.0.linux.bin.tar.gz
       - name: Generate docs
-        run: doxygen
+        run: ./doxygen-1.12.0/bin/doxygen
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -43,6 +43,7 @@ bin
 obj
 lib
 doc
+cov
 
 # IDE
 .vscode

AUTHORS

@@ -1,5 +1,5 @@
 libbasen project authors:
 
 commits | username
-     46 | vSEK1RO
+     70 | vSEK1RO
 

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = libbasen
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v1.0.1
+PROJECT_NUMBER         = v1.0.3
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Makefile

@@ -5,7 +5,7 @@ DEBUG ?= false
 USRDIR ?= /usr
 
 .PHONY: build i install uni uninstall\
-		tools library tests docs clean
+		tools library tests docs cov clean
 
 LIB = basen
 OBJS =\
@@ -80,8 +80,19 @@ uninstall:
 docs:
 	doxygen Doxyfile
 
+cover: ${DIRS} ${patsubst %, ${BINDIR}/%${-g}-cov, ${TESTS}}
+	rm -f **/*.gcda
+	${patsubst %, ./${BINDIR}/%${-g}-cov;, ${TESTS}}
+	gcovr --html-nested cov/index.html --txt --exclude-throw-branches
+
+${OBJDIR}/%${-g}-cov.o: ${SRCDIR}/%.cpp ${INCDIR}/${LIB}/%.hpp
+	${CC} -o $@ -c $< -I${INCDIR} ${-l} ${CFLAGS} --coverage
+
+${BINDIR}/%${-g}-cov: ${TESTDIR}/%.cpp ${patsubst %, ${OBJDIR}/%${-g}-cov.o, ${OBJS}}
+	${CC} -o $@ $^ -I${INCDIR} ${-l} -lgtest -lgcov ${CFLAGS}
+
 clean:
-	rm -rf ${OBJDIR}/* ${LIBDIR}/* ${BINDIR}/*
+	rm -rf ${DIRS} doc cov
 
 ifneq (${OBJS},)
 

README.md

@@ -12,6 +12,7 @@ c++ encoding/decoding from arbitrary base
 ## Contents
 
 - [Installation](#installation)
+- [Documentation](#documentation)
 - [Contributing](#contributing)
 
 ## Installation
@@ -29,18 +30,10 @@ Uninstall:
 ```
 sudo make uni USRDIR=(Your installation dir)
 ```
-For build with with debug flags:
-```
-make -j $(nproc) DEBUG=
-```
-For build tests (needed gtest package as dependency):
-```
-make tests -j $(nproc) DEBUG=
-```
-And also flag for dynamic linking (if possible):
-```
-make tools -j $(nproc) SHARED=
-```
+
+## Documentation
+
+Available [here](https://vsek1ro.github.io/libbasen)
 
 ## Contributing
 
@@ -51,4 +44,17 @@ Now we would like to implement the following features:
 - BCH
 - Bech32
 
+For build with with debug flags:
+```
+make -j $(nproc) DEBUG=
+```
+For build tests (needed gtest package as dependency):
+```
+make tests -j $(nproc) DEBUG=
+```
+For generating coverage:
+```
+make cover -j $(nproc) DEBUG=
+```
+
 [⬆️ Contents](#contents)

header.html

@@ -29,11 +29,9 @@ $darkmode
 <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
 $extrastylesheet
   <script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
-  <script type="text/javascript">
-      DoxygenAwesomeDarkModeToggle.init()
-  </script>
   <script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
   <script type="text/javascript">
+      DoxygenAwesomeDarkModeToggle.init()
       DoxygenAwesomeFragmentCopyButton.init()
   </script>
 </head>
@@ -47,6 +45,7 @@ $extrastylesheet
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 
 <!--BEGIN TITLEAREA-->
+<a href="https://github.com/vSEK1RO/libbasen" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill: #4779ac; color:#151513; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>

include/basen/base58.hpp

@@ -7,21 +7,44 @@
 
 namespace base58
 {
+    /**
+     * @brief bitcoin alphabet
+     */
     extern const char digits[59];
     extern const int8_t map[256];
 
     bool isValid(const char *str, uint64_t str_size) noexcept;
     bool isValid(std::string_view str) noexcept;
 
+    /**
+     * @throw std::overflow_error if if there is an overflow
+     */
     uint64_t sizeEncoded(std::span<const uint8_t> data) noexcept;
     uint64_t sizeDecoded(std::string_view str) noexcept;
 
-    void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept;
+    /**
+     * @return number of leading chars, which should be trimmed
+     * @warning contain leading zeros, returns count of them
+     */
+    uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept;
     std::string encode(std::span<const uint8_t> data) noexcept;
 
-    void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept;
+    /**
+     * @return number of leading chars, which should be trimmed
+     * @warning contain leading zeros, returns count of them
+     */
+    uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept;
     std::vector<uint8_t> decode(std::string_view str) noexcept;
 
+    /**
+     * @param data vector or span of data which you want to encode
+     * @return encoded string + 4 first bytes of double sha256
+     */
     std::string encodeCheck(std::span<const uint8_t> data) noexcept;
+    /**
+     * @param str string or string_view which you want to decode
+     * @return decoded data without 4 first bytes of double sha256
+     * @throw std::logic_error checksum incorrect
+     */
     std::vector<uint8_t> decodeCheck(std::string_view str);
 }

include/basen/base64.hpp

@@ -13,12 +13,25 @@ namespace base64
     bool isValid(const char *str, uint64_t str_size) noexcept;
     bool isValid(std::string_view str) noexcept;
 
+    /**
+     * @throw std::overflow_error if if there is an overflow
+     */
     uint64_t sizeEncoded(std::span<const uint8_t> data);
     uint64_t sizeDecoded(std::string_view str) noexcept;
 
+    /**
+     * @throw std::length_error if not enough allocated length
+     * @warning contain leading zeros, returns count of them
+     */
     void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size);
     std::string encode(std::span<const uint8_t> data) noexcept;
 
+    /**
+     * @throw std::length_error if not enough allocated length
+     * @throw std::logic_error if out of digits map
+     * @throw std::logic_error if incorrect padding
+     * @warning contain leading zeros, returns count of them
+     */
     void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size);
     std::vector<uint8_t> decode(std::string_view str) noexcept;
 }

include/basen/baseN.hpp

@@ -32,6 +32,7 @@ namespace baseN
      * @param base from 1 to 255
      * @param digits char[base] array of digits
      * @return estimated size after decoding
+     * @throw std::overflow_error if if there is an overflow
      */
     uint64_t sizeDecoded(std::string_view str, uint8_t base, const char *digits) noexcept;
 

include/basen/hash/sha256.hpp

@@ -4,9 +4,8 @@
 #include <span>
 #include <vector>
 
-#define SHA256_DIGEST_LENGTH 32
-
-namespace hash {
+namespace hash
+{
 	void sha256(const uint8_t *data, uint64_t data_size, uint8_t *hash) noexcept;
 	std::vector<uint8_t> sha256(std::span<const uint8_t> data) noexcept;
 }

include/basen/hex.hpp

@@ -13,12 +13,25 @@ namespace hex
     bool isValid(const char *str, uint64_t str_size) noexcept;
     bool isValid(std::string_view str) noexcept;
 
+    /**
+     * @throw std::overflow_error if if there is an overflow
+     */
     uint64_t sizeEncoded(std::span<const uint8_t> data);
     uint64_t sizeDecoded(std::string_view str) noexcept;
 
+    /**
+     * @throw std::length_error if not enough allocated length
+     * @warning contain leading zeros, returns count of them
+     */
     void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size);
     std::string encode(std::span<const uint8_t> data) noexcept;
 
+    /**
+     * @throw std::length_error if not enough allocated length
+     * @throw std::logic_error if out of digits map
+     * @throw std::logic_error if str_size %2 != 0 (isn't hex)
+     * @warning contain leading zeros, returns count of them
+     */
     void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size);
     std::vector<uint8_t> decode(std::string_view str) noexcept;
 }

src/base58.cpp

@@ -43,17 +43,17 @@ namespace base58
     {
         return baseN::sizeDecoded(str, 58, digits);
     }
-    void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept
+    uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept
     {
-        baseN::encode(data, data_size, str, str_size, 58, digits);
+        return baseN::encode(data, data_size, str, str_size, 58, digits);
     }
     std::string encode(std::span<const uint8_t> data) noexcept
     {
         return baseN::encode(data, 58, digits);
     }
-    void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept
+    uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept
     {
-        baseN::decode(str, str_size, data, data_size, 58, digits, map);
+        return baseN::decode(str, str_size, data, data_size, 58, digits, map);
     }
     std::vector<uint8_t> decode(std::string_view str) noexcept
     {

src/base64.cpp

@@ -64,7 +64,7 @@ namespace base64
     {
         if (str_size < base64::sizeEncoded(std::span<const uint8_t>(data, data_size)))
         {
-            throw std::logic_error("base64::encode: not enough allocated length");
+            throw std::length_error("base64::encode: not enough allocated length");
         }
         for (uint64_t i = 0; i < data_size / 3; i++)
         {
@@ -74,8 +74,6 @@ namespace base64
             str[i * 4 + 3] = digits[data[i * 3 + 2] & 0x3F];
         }
         uint64_t last_idx = data_size / 3 * 4;
-        if (last_idx + 3 < str_size)
-        {
         switch (data_size % 3)
         {
         case 1:
@@ -87,14 +85,13 @@ namespace base64
         case 2:
             str[last_idx] = digits[data[data_size - 2] >> 2];
             str[last_idx + 1] = digits[(data[data_size - 2] << 4 | data[data_size - 1] >> 4) & 0x3F];
-                str[last_idx + 2] = digits[data[data_size - 1] & 0x0F];
+            str[last_idx + 2] = digits[data[data_size - 1] << 2 & 0x3F];
             str[last_idx + 3] = '=';
             break;
         default:
             break;
         }
     }
-    }
     std::string encode(std::span<const uint8_t> data) noexcept
     {
         std::string str(base64::sizeEncoded(data), ' ');
@@ -106,7 +103,7 @@ namespace base64
         std::string_view sv(str, str_size);
         if (data_size < base64::sizeDecoded(sv))
         {
-            throw std::logic_error("base64::decode: not enough allocated length");
+            throw std::length_error("base64::decode: not enough allocated length");
         }
         if (!base64::isValid(sv))
         {

src/hash/sha256.cpp

@@ -174,7 +174,7 @@ namespace hash
 	}
 	std::vector<uint8_t> sha256(std::span<const uint8_t> data) noexcept
 	{
-		std::vector<uint8_t> hash(SHA256_DIGEST_LENGTH);
+		std::vector<uint8_t> hash(32);
 		sha256(data.data(), data.size(), hash.data());
 		return hash;
 	}

src/hex.cpp

@@ -50,7 +50,7 @@ namespace hex
     {
         if (str_size < hex::sizeEncoded(std::span<const uint8_t>(data, data_size)))
         {
-            throw std::logic_error("hex::encode: not enough allocated length");
+            throw std::length_error("hex::encode: not enough allocated length");
         }
         for (uint64_t i = 0; i < data_size; i++)
         {
@@ -72,7 +72,7 @@ namespace hex
         }
         if (data_size < hex::sizeDecoded(std::string_view(str, str_size)))
         {
-            throw std::logic_error("hex::decode: not enough allocated length");
+            throw std::length_error("hex::decode: not enough allocated length");
         }
         if (!hex::isValid(str, str_size))
         {

test/test-base64.cpp

@@ -21,13 +21,19 @@ TEST(base64, isValid)
 std::vector<std::pair<std::string, std::string>> tests = {
     {"", ""},
     {"BKUEpQ==", "04a504a5"},
-    {"BKUEpQA=", "04a504a500"},
-    {"BKUEpQAA", "04a504a50000"},
+    {"aGVsbG8=", "68656c6c6f"},
+    {"aGVsbG9v", "68656c6c6f6f"},
 };
 TEST(base64, encode)
 {
     for (auto it : tests)
         EXPECT_EQ(it.first, encode(hex::decode(it.second)));
+
+    std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
+    std::string str = "";
+    EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
+    EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
+    EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
 }
 TEST(base64, encode_1e7)
 {
@@ -38,6 +44,12 @@ TEST(base64, decode)
 {
     for (auto it : tests)
         EXPECT_EQ(hex::encode(decode(it.first)), it.second);
+
+    std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
+    EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("FF==", 2, data.data(), 0), std::length_error);
+    EXPECT_NO_THROW(decode("", 0, data.data(), 0));
 }
 TEST(base64, decode_1e7)
 {

test/test-hex.cpp

@@ -1,21 +1,28 @@
+#include <utility>
+
 #include <basen/hex.hpp>
 #include <gtest/gtest.h>
 
 using namespace hex;
 
+TEST(hex, isValid)
+{
+    std::vector<std::pair<bool, std::string>> tests = {
+        {true, "1234"},
+        {false, "!@/"},
+    };
+    for (auto it : tests)
+        EXPECT_EQ(it.first, isValid(it.second));
+}
 TEST(hex, encode)
 {
     std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
     EXPECT_EQ("74657374", encode(data));
-    try
-    {
+
     std::string str = "";
-        encode(data.data(), data.size(), str.data(), str.size());
-    }
-    catch (const std::exception &e)
-    {
-        EXPECT_STREQ(e.what(), "hex::encode: not enough allocated length");
-    }
+    EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
+    EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
+    EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
 }
 TEST(hex, encode_1e7)
 {
@@ -26,15 +33,11 @@ TEST(hex, decode)
 {
     std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
     EXPECT_EQ(decode("616e6f"), data);
-    try
-    {
-        std::string str = "";
-        decode("616", 3, data.data(), data.size());
-    }
-    catch (const std::exception &e)
-    {
-        EXPECT_STREQ(e.what(), "hex::decode: isn't hex");
-    }
+
+    EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
+    EXPECT_THROW(decode("FF", 2, data.data(), 0), std::length_error);
+    EXPECT_NO_THROW(decode("", 0, data.data(), 0));
 }
 TEST(hex, decode_1e7)
 {