diff options
| -rw-r--r-- | src/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | src/supplemental/base64/CMakeLists.txt | 12 | ||||
| -rw-r--r-- | src/supplemental/base64/base64.c | 146 | ||||
| -rw-r--r-- | src/supplemental/base64/base64.h | 40 | ||||
| -rw-r--r-- | tests/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | tests/base64.c | 88 |
6 files changed, 288 insertions, 0 deletions
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 291769f0..2ab202d9 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -119,6 +119,7 @@ if (NNG_PLATFORM_WINDOWS) ) endif() +add_subdirectory(supplemental/base64) add_subdirectory(supplemental/mbedtls) add_subdirectory(protocol/bus0) diff --git a/src/supplemental/base64/CMakeLists.txt b/src/supplemental/base64/CMakeLists.txt new file mode 100644 index 00000000..3ccac7ff --- /dev/null +++ b/src/supplemental/base64/CMakeLists.txt @@ -0,0 +1,12 @@ +# +# Copyright 2017 Capitar IT Group BV <info@capitar.com> +# Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> +# +# This software is supplied under the terms of the MIT License, a +# copy of which should be located in the distribution where this +# file was obtained (LICENSE.txt). A copy of the license may also be +# found online at https://opensource.org/licenses/MIT. +# + +set(BASE64_SOURCES supplemental/base64/base64.c supplemental/base64/base64.h) +set(NNG_SOURCES ${NNG_SOURCES} ${BASE64_SOURCES} PARENT_SCOPE) diff --git a/src/supplemental/base64/base64.c b/src/supplemental/base64/base64.c new file mode 100644 index 00000000..95a4a491 --- /dev/null +++ b/src/supplemental/base64/base64.c @@ -0,0 +1,146 @@ +// +// Copyright (c) 2014 Wirebird Labs LLC. All rights reserved. +// Copyright 2017 Staysail Systems, Inc. +// +// 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. +// + +#include "base64.h" + +#include <ctype.h> + +int +nni_base64_decode(const char *in, size_t in_len, uint8_t *out, size_t out_len) +{ + unsigned ii; + unsigned io; + unsigned rem; + uint32_t v; + uint8_t ch; + + // Unrolled lookup of ASCII code points. + // 0xFF represents a non-base64 valid character. + const uint8_t DECODEMAP[256] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, + 0xFF, 0x3F, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x3B, + 0x3C, 0x3D, 0xFF, 0xFF, 0xFF, 0x3E, 0xFF, 0xFF, 0xFF, 0x00, + 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, + 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, + 0x15, 0x16, 0x17, 0x18, 0x19, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, + 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, + 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, + 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }; + + for (io = 0, ii = 0, v = 0, rem = 0; ii < in_len; ii++) { + if (isspace(in[ii])) { + continue; + } + + if (in[ii] == '=') { + break; + } + + ch = DECODEMAP[(int) (in[ii])]; + + // Discard invalid characters as per RFC 2045. + if (ch == 0xFF) { + break; + } + + v = (v << 6) | ch; + rem += 6; + + if (rem >= 8) { + rem -= 8; + if (io >= out_len) + return (-1); + out[io++] = (v >> rem) & 255; + } + } + if (rem >= 8) { + rem -= 8; + if (io >= out_len) + return (-1); + out[io++] = (v >> rem) & 255; + } + return (io); +} + +int +nni_base64_encode(const uint8_t *in, size_t in_len, char *out, size_t out_len) +{ + unsigned ii; + unsigned io; + unsigned rem; + uint32_t v; + uint8_t ch; + + const uint8_t ENCODEMAP[64] = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz" + "0123456789+/"; + + for (io = 0, ii = 0, v = 0, rem = 0; ii < in_len; ii++) { + ch = in[ii]; + v = (v << 8) | ch; + rem += 8; + while (rem >= 6) { + rem -= 6; + if (io >= out_len) + return (-1); + out[io++] = ENCODEMAP[(v >> rem) & 63]; + } + } + + if (rem) { + v <<= (6 - rem); + if (io >= out_len) + return (-1); + out[io++] = ENCODEMAP[v & 63]; + } + + // Pad to a multiple of 3. + while (io & 3) { + if (io >= out_len) + return (-1); + out[io++] = '='; + } + + if (io >= out_len) + return (-1); + + out[io] = '\0'; + + return (io); +} diff --git a/src/supplemental/base64/base64.h b/src/supplemental/base64/base64.h new file mode 100644 index 00000000..eb186ae0 --- /dev/null +++ b/src/supplemental/base64/base64.h @@ -0,0 +1,40 @@ +// +// Copyright (c) 2014 Wirebird Labs LLC. All rights reserved. +// Copyright 2017 Staysail Systems, Inc. +// +// 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 NNI_BASE64_INCLUDED +#define NNI_BASE64_INCLUDED + +#include <stddef.h> +#include <stdint.h> + +// Based on base64.c (Public Domain) by Jon Mayo. +// Base64 is defined in RFC 2045, section 6.8. + +// This function encodes an arbitrary byte array into base64 +// null-terminated string. +int nni_base64_encode(const uint8_t *, size_t, char *, size_t); + +// This function decodes a base64 string into supplied buffer. +int nni_base64_decode(const char *, size_t, uint8_t *, size_t); + +#endif diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 30f76a1d..aa6905f2 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -122,6 +122,7 @@ else () endif () add_nng_test(aio 5) +add_nng_test(base64 5) add_nng_test(bus 5) add_nng_test(files 5) add_nng_test(idhash 5) diff --git a/tests/base64.c b/tests/base64.c new file mode 100644 index 00000000..9682475c --- /dev/null +++ b/tests/base64.c @@ -0,0 +1,88 @@ +// +// Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2017 Capitar IT Group BV <info@capitar.com> +// +// This software is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +#include <strings.h> + +#include "convey.h" + +#include "nng.h" + +#include "supplemental/base64/base64.h" + +typedef struct testcase { + char *decoded; + char *encoded; +} testcase; + +static struct testcase cases[] = { + // clang-format off + { "", "" }, + { "f", "Zg==" }, + { "fo", "Zm8=" }, + { "foo", "Zm9v" }, + { "foob", "Zm9vYg==" }, + { "fooba", "Zm9vYmE=" }, + { "foobar", "Zm9vYmFy" }, + { NULL, NULL } + // clang-format on +}; + +TestMain("Base64 Verification", { + + Convey("Encode Works", { + int rv; + char buf[1024]; + int i; + void *dec; + + for (i = 0; (dec = cases[i].decoded) != NULL; i++) { + rv = nni_base64_encode(dec, strlen(dec), buf, 1024); + So(rv >= 0); + So(rv == strlen(cases[i].encoded)); + buf[rv] = 0; + So(strcmp(buf, cases[i].encoded) == 0); + } + }); + + Convey("Decode Works", { + int rv; + char buf[1024]; + int i; + void *enc; + + for (i = 0; (enc = cases[i].encoded) != NULL; i++) { + rv = nni_base64_decode( + enc, strlen(enc), (void *) buf, 1024); + So(rv >= 0); + So(rv == strlen(cases[i].decoded)); + buf[rv] = 0; + So(strcmp(buf, cases[i].decoded) == 0); + } + }); + + Convey("Overflow Works", { + char tmp[1024]; + for (int i = 1; cases[i].decoded != NULL; i++) { + void *enc = cases[i].encoded; + void *dec = cases[i].decoded; + void *buf = tmp; + + So(nni_base64_encode( + dec, strlen(dec), buf, strlen(enc) - 1) == -1); + So(nni_base64_encode(dec, strlen(dec), buf, 0) == -1); + + So(nni_base64_decode( + enc, strlen(enc), buf, strlen(dec) - 1) == -1); + So(nni_base64_encode(enc, strlen(enc), buf, 0) == -1); + } + + }) + +}); |
