From 58cc988fbc7bfa196ea91a0d6c9be9238bc9a4e9 Mon Sep 17 00:00:00 2001 From: Nimetu Date: Fri, 24 Jan 2020 15:50:00 +0200 Subject: [PATCH] Added: base64 encode/decode --- code/nel/include/nel/misc/base64.h | 154 ++++++++++++++++++ code/nel/tools/nel_unit_test/ut_misc.h | 2 + code/nel/tools/nel_unit_test/ut_misc_base64.h | 82 ++++++++++ 3 files changed, 238 insertions(+) create mode 100644 code/nel/include/nel/misc/base64.h create mode 100644 code/nel/tools/nel_unit_test/ut_misc_base64.h diff --git a/code/nel/include/nel/misc/base64.h b/code/nel/include/nel/misc/base64.h new file mode 100644 index 000000000..4c5c2babd --- /dev/null +++ b/code/nel/include/nel/misc/base64.h @@ -0,0 +1,154 @@ +// NeL - MMORPG Framework +// Copyright (C) 2010 Winch Gate Property Limited +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + + +#ifndef NL_BASE64_H +#define NL_BASE64_h + +namespace NLMISC +{ + +/** + * \brief base64 encode/decode + * \date 2020-01-23 12:39GMT + * \author Meelis Mägi (Nimetu) + */ + +struct base64 { + static std::string encode(const std::string &data) + { + /* Conversion table. for base 64 */ + static const char tbl[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz" + "0123456789+/"; + static const char padChar = '='; + + size_t inLength = data.size(); + size_t outLength = 4 * ((inLength + 2) / 3); + + std::string out; + out.resize(outLength); + + size_t iRead=0, oWrite=0; + for (size_t iLoop = 0; iLoop < inLength/3; iLoop++) + { + out[oWrite+0] = tbl[ (data[iRead+0] >> 2) & 0x3F]; + out[oWrite+1] = tbl[((data[iRead+0] << 4) & 0x30) + ((data[iRead+1] >> 4) & 0x0F)]; + out[oWrite+2] = tbl[((data[iRead+1] << 2) & 0x3C) + ((data[iRead+2] >> 6) & 0x03)]; + out[oWrite+3] = tbl[ data[iRead+2] & 0x3F]; + iRead += 3; + oWrite += 4; + } + + // remaining bytes + switch(inLength % 3) + { + case 2: + out[oWrite+0] = tbl[ (data[iRead+0] >> 2) & 0x3F]; + out[oWrite+1] = tbl[((data[iRead+0] << 4) & 0x30) + ((data[iRead+1] >> 4) & 0x0F)]; + out[oWrite+2] = tbl[((data[iRead+1] << 2) & 0x3C)]; + out[oWrite+3] = padChar; + break; + case 1: + out[oWrite+0] = tbl[ (data[iRead+0] >> 2) & 0x3F]; + out[oWrite+1] = tbl[((data[iRead+0] << 4) & 0x30)]; + out[oWrite+2] = padChar; + out[oWrite+3] = padChar; + break; + default: + break; + } + + return out; + } + + static std::string decode(const std::string &in) + { + static sint8 tbl[] = { + // 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 00 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 10 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63, // 20 + / + 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, 0, -1, -1, // 30 0..9 = + -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, // 40 A.. + 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1, // 50 ..Z + -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, // 60 a.. + 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1, // 70 ..z + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 80 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // 90 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // A0 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // B0 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // C0 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // D0 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // E0 + -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, // F0 + }; + static char padChar = '='; + + size_t inLength = in.size(); + // add optional padding if its missing from input + size_t outLength = (inLength + inLength % 4) / 4 * 3; + + std::string out; + if (inLength > 0) + { + uint8 buf[4]; + size_t iBuf = 0; + size_t iRead = 0; + size_t oWrite = 0; + + out.resize(outLength); + while(iRead < inLength && in[iRead] != padChar) + { + buf[iBuf] = (uint8)tbl[in[iRead]]; + // invalid byte in input + if (buf[iBuf] == 0xFF) + break; + + iRead++; + iBuf++; + if (iBuf == 4) + { + out[oWrite+0] = ((buf[0] << 2) & 0xFC) + ((buf[1] >> 4) & 0x0F); + out[oWrite+1] = ((buf[1] << 4) & 0xF0) + ((buf[2] >> 2) & 0x0F); + out[oWrite+2] = ((buf[2] << 6) & 0xC0) + (buf[3] & 0x3F); + oWrite += 3; + iBuf = 0; + } + } + + if (iBuf > 0) + { + uint8 tmp[3]; + tmp[0] = ((buf[0] << 2) & 0xFC) + ((buf[1] >> 4) & 0x0F); + tmp[1] = ((buf[1] << 4) & 0xF0) + ((buf[2] >> 2) & 0x0F); + tmp[2] = ((buf[2] << 6) & 0xC0) + (buf[3] & 0x3F); + for(uint i = 0; i < iBuf-1; i++, oWrite++) + out[oWrite] = tmp[i]; + } + + if (out.size() != oWrite) + out.resize(oWrite); + } + + return out; + } +}; + +}//namespace NLMISC + +#endif // NL_BASE64_H + diff --git a/code/nel/tools/nel_unit_test/ut_misc.h b/code/nel/tools/nel_unit_test/ut_misc.h index 7f125f2f3..aef1e4c90 100644 --- a/code/nel/tools/nel_unit_test/ut_misc.h +++ b/code/nel/tools/nel_unit_test/ut_misc.h @@ -31,6 +31,7 @@ #include "ut_misc_variable.h" #include "ut_misc_types.h" #include "ut_misc_string_common.h" +#include "ut_misc_base64.h" // Add a line here when adding a new test CLASS struct CUTMisc : public Test::Suite @@ -51,6 +52,7 @@ struct CUTMisc : public Test::Suite add(std::auto_ptr(new CUTMiscVariable)); add(std::auto_ptr(new CUTMiscTypes)); add(std::auto_ptr(new CUTMiscStringCommon)); + add(std::auto_ptr(new CUTMiscBase64)); // Add a line here when adding a new test CLASS } }; diff --git a/code/nel/tools/nel_unit_test/ut_misc_base64.h b/code/nel/tools/nel_unit_test/ut_misc_base64.h new file mode 100644 index 000000000..84ddfcefc --- /dev/null +++ b/code/nel/tools/nel_unit_test/ut_misc_base64.h @@ -0,0 +1,82 @@ +// NeL - MMORPG Framework +// Copyright (C) 2010 Winch Gate Property Limited +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +#ifndef UT_MISC_BASE64 +#define UT_MISC_BASE64 + +#include + +struct CUTMiscBase64 : public Test::Suite +{ + CUTMiscBase64() + { + TEST_ADD(CUTMiscBase64::testEncode); + TEST_ADD(CUTMiscBase64::testDecode); + TEST_ADD(CUTMiscBase64::testDecodeNoPadding); + TEST_ADD(CUTMiscBase64::testDecodeInvalid); + } + + void testEncode() + { + TEST_ASSERT("" == NLMISC::base64::encode("")); + + TEST_ASSERT("AA==" == NLMISC::base64::encode(std::string(1, '\0'))); + TEST_ASSERT("YQ==" == NLMISC::base64::encode("a")); + TEST_ASSERT("YWI=" == NLMISC::base64::encode("ab")); + TEST_ASSERT("YWJj" == NLMISC::base64::encode("abc")); + + std::string expect = "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0NTY3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ=="; + std::string encoded = NLMISC::base64::encode("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#0^&*();:<>,. []{}"); + TEST_ASSERT(expect == encoded); + } + + void testDecode() + { + TEST_ASSERT("" == NLMISC::base64::decode("")); + TEST_ASSERT("" == NLMISC::base64::decode("=")); + TEST_ASSERT("" == NLMISC::base64::decode("==")); + TEST_ASSERT("" == NLMISC::base64::decode("===")); + TEST_ASSERT("" == NLMISC::base64::decode("====")); + + TEST_ASSERT(std::string(1, '\0') == NLMISC::base64::decode("AA==")); + TEST_ASSERT("a" == NLMISC::base64::decode("YQ==")); + TEST_ASSERT("ab" == NLMISC::base64::decode("YWI=")); + TEST_ASSERT("abc" == NLMISC::base64::decode("YWJj")); + + std::string expect = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#0^&*();:<>,. []{}"; + std::string decoded = NLMISC::base64::decode("YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0NTY3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ=="); + TEST_ASSERT(expect == decoded); + } + + void testDecodeNoPadding() + { + TEST_ASSERT(std::string(1, '\0') == NLMISC::base64::decode("AA")); + TEST_ASSERT("a" == NLMISC::base64::decode("YQ")); + TEST_ASSERT("ab" == NLMISC::base64::decode("YWI")); + + std::string expect = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#0^&*();:<>,. []{}"; + std::string decoded = NLMISC::base64::decode("YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0NTY3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ"); + TEST_ASSERT(expect == decoded); + } + + void testDecodeInvalid() + { + TEST_ASSERT("" == NLMISC::base64::decode("A")); + TEST_ASSERT("" == NLMISC::base64::decode("A===")); + } +}; + +#endif