From 28a4f4173d0304bd1f56131eca966b89352afd7e Mon Sep 17 00:00:00 2001 From: EinMByte Date: Wed, 22 Jul 2015 16:43:11 +0200 Subject: [PATCH] Tests and documentation for base64. --- base64.cpp | 36 +++------------------------------- base64.h | 19 ++++++++++++++++++ filelist.mk | 2 +- tests/Data.cpp | 49 ++++++++++++++++++++++++++++++++++++++++++++++ tests/Identity.cpp | 1 - 5 files changed, 72 insertions(+), 35 deletions(-) create mode 100644 tests/Data.cpp diff --git a/base64.cpp b/base64.cpp index f5eac89b..28165365 100644 --- a/base64.cpp +++ b/base64.cpp @@ -45,23 +45,8 @@ namespace data static char P64 = '='; - /* - * - * ByteStreamToBase64 - * ------------------ - * - * Converts binary encoded data to BASE64 format. - * - */ - - size_t /* Number of bytes in the encoded buffer */ - ByteStreamToBase64 ( - const uint8_t * InBuffer, /* Input buffer, binary data */ - size_t InCount, /* Number of bytes in the input buffer */ - char * OutBuffer, /* output buffer */ - size_t len /* length of output buffer */ - ) + size_t ByteStreamToBase64(const uint8_t* InBuffer, size_t InCount, char* OutBuffer, size_t len) { unsigned char * ps; unsigned char * pd; @@ -124,23 +109,8 @@ namespace data return outCount; } - /* - * - * Base64ToByteStream - * ------------------ - * - * Converts BASE64 encoded data to binary format. If input buffer is - * not properly padded, buffer of negative length is returned - * - */ - size_t /* Number of output bytes */ - Base64ToByteStream ( - const char * InBuffer, /* BASE64 encoded buffer */ - size_t InCount, /* Number of input bytes */ - uint8_t * OutBuffer, /* output buffer length */ - size_t len /* length of output buffer */ - ) + size_t Base64ToByteStream(const char * InBuffer, size_t InCount, uint8_t* OutBuffer, size_t len) { unsigned char * ps; unsigned char * pd; @@ -154,7 +124,7 @@ namespace data if (isFirstTime) iT64Build(); n = InCount/4; m = InCount%4; - if (!m) + if(InCount && !m) outCount = 3*n; else { outCount = 0; diff --git a/base64.h b/base64.h index 027d62ba..74b9f7cf 100644 --- a/base64.h +++ b/base64.h @@ -9,7 +9,26 @@ namespace i2p namespace data { + + /* + * Base64 encodes an array of bytes. + * @return the number of characters in the output buffer + * @param InBuffer array of input bytes to be encoded + * @param InCount length of the input array + * @param OutBuffer array of output characters + * @param len length of the output buffer + */ size_t ByteStreamToBase64 (const uint8_t * InBuffer, size_t InCount, char * OutBuffer, size_t len); + + /** + * Decodes base 64 encoded data to an array of bytes. + * @return the number of bytes in the output buffer + * @param InBuffer array of input characters to be decoded + * @param InCount length of the input array + * @param OutBuffer array of output bytes + * @param len length of the output buffer + * @todo Do not return a negative value on failure, size_t could be unsigned. + */ size_t Base64ToByteStream (const char * InBuffer, size_t InCount, uint8_t * OutBuffer, size_t len ); const char * GetBase64SubstitutionTable (); diff --git a/filelist.mk b/filelist.mk index f2aae727..5602970c 100644 --- a/filelist.mk +++ b/filelist.mk @@ -25,4 +25,4 @@ LIB_SRC := $(COMMON_SRC) \ api.cpp TESTS_SRC := $(COMMON_SRC) \ - tests/Utility.cpp tests/Identity.cpp + tests/Utility.cpp tests/Identity.cpp tests/Data.cpp diff --git a/tests/Data.cpp b/tests/Data.cpp new file mode 100644 index 00000000..cb9dd7bc --- /dev/null +++ b/tests/Data.cpp @@ -0,0 +1,49 @@ +#define BOOST_TEST_DYN_LINK + +#include +#include "../Identity.h" + +BOOST_AUTO_TEST_SUITE(DataTests) + +using namespace i2p::data; + +BOOST_AUTO_TEST_CASE(Base64EncodeEmpty) +{ + ByteStreamToBase64(nullptr, 0, nullptr, 0); +} + +BOOST_AUTO_TEST_CASE(Base64DecodeEmpty) +{ + Base64ToByteStream(nullptr, 0, nullptr, 0); +} + +BOOST_AUTO_TEST_CASE(Base64Encode) +{ + const uint8_t input[] = { + 0x53, 0xd3, 0x60, 0xfa, 0xf9, 0x58, 0xd0, 0x5e, 0x41, 0xa9, 0x6c, + 0xf1, 0x9f, 0xc4, 0xe, 0x23, 0x9b, 0xca, 0xb1, 0x61, 0xa7, 0x33, 0xcf, + 0x1f, 0x30 + }; + const char* output = "U9Ng-vlY0F5BqWzxn8QOI5vKsWGnM88fMA=="; + char result[36]; + ByteStreamToBase64(input, 25, result, 36); + BOOST_CHECK_EQUAL_COLLECTIONS(result, result + 36, output, output + 36); +} + +BOOST_AUTO_TEST_CASE(Base64Decode) +{ + const char* input = "U9Ng-vlY0F5BqWzxn8QOI5vKsWGnM88fMA=="; + const uint8_t output[] = { + 0x53, 0xd3, 0x60, 0xfa, 0xf9, 0x58, 0xd0, 0x5e, 0x41, 0xa9, 0x6c, + 0xf1, 0x9f, 0xc4, 0xe, 0x23, 0x9b, 0xca, 0xb1, 0x61, 0xa7, 0x33, 0xcf, + 0x1f, 0x30 + }; + uint8_t result[25]; + Base64ToByteStream(input, 36, result, 25); + BOOST_CHECK_EQUAL_COLLECTIONS(result, result + 25, output, output + 25); +} + + + + +BOOST_AUTO_TEST_SUITE_END() diff --git a/tests/Identity.cpp b/tests/Identity.cpp index 597a2ba0..d74369a9 100644 --- a/tests/Identity.cpp +++ b/tests/Identity.cpp @@ -8,5 +8,4 @@ BOOST_AUTO_TEST_SUITE(IdentityTests) - BOOST_AUTO_TEST_SUITE_END()