]> git.ipfire.org Git - thirdparty/squid.git/blobdiff - lib/base64.c
Source Format Enforcement (#1234)
[thirdparty/squid.git] / lib / base64.c
index 70e7fb2ae67a9008486757376b0a5eda32fd48d9..2f177820d287124bd58144ab0d594c26107abc5c 100644 (file)
 /*
- * AUTHOR: Markus Moeller
+ * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
  *
- * Encoders adopted from http://ftp.sunet.se/pub2/gnu/vm/base64-encode.c with adjustments.
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
+/*
+ * Copied from Nettle 3.4 under GPLv2, with adjustments
  */
 
 #include "squid.h"
 #include "base64.h"
 
-#if HAVE_STDLIB_H
-#include <stdlib.h>
-#endif
+#if !HAVE_NETTLE_BASE64_H || !HAVE_NETTLE34_BASE64
 
-static void base64_init(void);
+/* base64-encode.c
 
-static int base64_initialized = 0;
-#define BASE64_VALUE_SZ 256
-#define BASE64_RESULT_SZ 8192
-int base64_value[BASE64_VALUE_SZ];
-const char base64_code[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+   Copyright (C) 2002 Niels Möller
 
-static void
-base64_init(void)
-{
-    int i;
+   This file is part of GNU Nettle.
+
+   GNU Nettle is free software: you can redistribute it and/or
+   modify it under the terms of either:
+
+     * the GNU Lesser General Public License as published by the Free
+       Software Foundation; either version 3 of the License, or (at your
+       option) any later version.
+
+   or
+
+     * the GNU General Public License as published by the Free
+       Software Foundation; either version 2 of the License, or (at your
+       option) any later version.
 
-    for (i = 0; i < BASE64_VALUE_SZ; i++)
-        base64_value[i] = -1;
+   or both in parallel, as here.
 
-    for (i = 0; i < 64; i++)
-        base64_value[(int) base64_code[i]] = i;
-    base64_value['='] = 0;
+   GNU Nettle 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
+   General Public License for more details.
 
-    base64_initialized = 1;
+   You should have received copies of the GNU General Public License and
+   the GNU Lesser General Public License along with this program.  If
+   not, see http://www.gnu.org/licenses/.
+*/
+
+#define TABLE_INVALID -1
+#define TABLE_SPACE -2
+#define TABLE_END -3
+
+void
+base64_decode_init(struct base64_decode_ctx *ctx)
+{
+    static const signed char base64_decode_table[0x100] =
+    {
+        /* White space is HT, VT, FF, CR, LF and SPC */
+        -1, -1, -1, -1, -1, -1, -1, -1, -1, -2, -2, -2, -2, -2, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -2, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
+            52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -3, -1, -1,
+            -1,  0,  1,  2,  3,  4,  5,  6,  7,  8,  9, 10, 11, 12, 13, 14,
+            15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1,
+            -1, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
+            41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+            -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
+        };
+
+    ctx->word = ctx->bits = ctx->padding = 0;
+    ctx->table = base64_decode_table;
 }
 
 int
-base64_decode_len(const char *data)
+base64_decode_single(struct base64_decode_ctx *ctx,
+                     uint8_t *dst,
+                     char src)
 {
-    if (!data || !*data)
+    int data = ctx->table[(uint8_t) src];
+
+    switch(data)
+    {
+    default:
+        assert(data >= 0 && data < 0x40);
+
+        if (ctx->padding)
+            return -1;
+
+        ctx->word = ctx->word << 6 | data;
+        ctx->bits += 6;
+
+        if (ctx->bits >= 8)
+        {
+            ctx->bits -= 8;
+            dst[0] = ctx->word >> ctx->bits;
+            return 1;
+        }
+        else return 0;
+
+    case TABLE_INVALID:
+        return -1;
+
+    case TABLE_SPACE:
         return 0;
 
-    int terminatorLen = 0;
-    int dataLen = strlen(data);
-    int i;
+    case TABLE_END:
+        /* There can be at most two padding characters. */
+        if (!ctx->bits || ctx->padding > 2)
+            return -1;
 
-    for (i = dataLen - 1; i >= 0; i--) {
-        if (data[i] == '=')
-            terminatorLen++;
-        if (data[i] != '=')
-            break;
+        if (ctx->word & ( (1<<ctx->bits) - 1))
+            /* We shouldn't have any leftover bits */
+            return -1;
+
+        ctx->padding++;
+        ctx->bits -= 2;
+        return 0;
     }
-    return dataLen / 4 * 3 - terminatorLen;
 }
 
 int
-base64_decode(char *result, unsigned int result_size, const char *p)
+base64_decode_update(struct base64_decode_ctx *ctx,
+                     size_t *dst_length,
+                     uint8_t *dst,
+                     size_t src_length,
+                     const char *src)
 {
-    int j = 0;
-    int c;
-    long val;
-    if (!p || !result || result_size == 0)
-        return j;
-    if (!base64_initialized)
-        base64_init();
-    val = c = 0;
-    for (; *p; p++) {
-        unsigned int k = ((unsigned char) *p) % BASE64_VALUE_SZ;
-        if (base64_value[k] < 0)
-            continue;
-        val <<= 6;
-        val += base64_value[k];
-        if (++c < 4)
-            continue;
-        /* One quantum of four encoding characters/24 bit */
-        if (j+4 <= result_size) {
-            // Speed optimization: plenty of space, avoid some per-byte checks.
-            result[j++] = (val >> 16) & 0xff;  /* High 8 bits */
-            result[j++] = (val >> 8) & 0xff;   /* Mid 8 bits */
-            result[j++] = val & 0xff;          /* Low 8 bits */
-        } else {
-            // part-quantum goes a bit slower with per-byte checks
-            result[j++] = (val >> 16) & 0xff;  /* High 8 bits */
-            if (j == result_size)
-                return j;
-            result[j++] = (val >> 8) & 0xff;   /* Mid 8 bits */
-            if (j == result_size)
-                return j;
-            result[j++] = val & 0xff;          /* Low 8 bits */
+    size_t done;
+    size_t i;
+
+    for (i = 0, done = 0; i<src_length; i++)
+        switch(base64_decode_single(ctx, dst + done, src[i]))
+        {
+        case -1:
+            return 0;
+        case 1:
+            done++;
+        /* Fall through */
+        case 0:
+            break;
+        default:
+            abort();
         }
-        if (j == result_size)
-            return j;
-        val = c = 0;
-    }
-    return j;
+
+    assert(done <= BASE64_DECODE_LENGTH(src_length));
+
+    *dst_length = done;
+    return 1;
 }
 
 int
-base64_encode_len(int len)
+base64_decode_final(struct base64_decode_ctx *ctx)
+{
+    return ctx->bits == 0;
+}
+
+/* base64-encode.c */
+
+#define ENCODE(alphabet,x) ((alphabet)[0x3F & (x)])
+
+static void
+encode_raw(const char *alphabet,
+           char *dst, size_t length, const uint8_t *src)
+{
+    const uint8_t *in = src + length;
+    char *out = dst + BASE64_ENCODE_RAW_LENGTH(length);
+
+    unsigned left_over = length % 3;
+
+    if (left_over)
+    {
+        in -= left_over;
+        *--out = '=';
+        switch(left_over)
+        {
+        case 1:
+            *--out = '=';
+            *--out = ENCODE(alphabet, (in[0] << 4));
+            break;
+
+        case 2:
+            *--out = ENCODE(alphabet, (in[1] << 2));
+            *--out = ENCODE(alphabet, ((in[0] << 4) | (in[1] >> 4)));
+            break;
+
+        default:
+            abort();
+        }
+        *--out = ENCODE(alphabet, (in[0] >> 2));
+    }
+
+    while (in > src)
+    {
+        in -= 3;
+        *--out = ENCODE(alphabet, (in[2]));
+        *--out = ENCODE(alphabet, ((in[1] << 2) | (in[2] >> 6)));
+        *--out = ENCODE(alphabet, ((in[0] << 4) | (in[1] >> 4)));
+        *--out = ENCODE(alphabet, (in[0] >> 2));
+    }
+    assert(in == src);
+    assert(out == dst);
+}
+
+static const char base64_encode_table[64] =
+    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    "abcdefghijklmnopqrstuvwxyz"
+    "0123456789+/";
+
+void
+base64_encode_raw(char *dst, size_t length, const uint8_t *src)
 {
-    // NP: some magic numbers + potential nil-terminator
-    return ((len + 2) / 3 * 4) + 1;
+    encode_raw(base64_encode_table, dst, length, src);
 }
 
-const char *
-old_base64_encode(const char *decoded_str)
+void
+base64_encode_group(char *dst, uint32_t group)
 {
-    static char result[BASE64_RESULT_SZ];
-    base64_encode_str(result, sizeof(result), decoded_str, strlen(decoded_str));
-    return result;
+    *dst++ = ENCODE(base64_encode_table, (group >> 18));
+    *dst++ = ENCODE(base64_encode_table, (group >> 12));
+    *dst++ = ENCODE(base64_encode_table, (group >> 6));
+    *dst++ = ENCODE(base64_encode_table, group);
 }
 
-const char *
-base64_encode_bin(const char *decoded_str, int len)
+void
+base64_encode_init(struct base64_encode_ctx *ctx)
 {
-    static char result[BASE64_RESULT_SZ];
-    base64_encode_str(result, sizeof(result), decoded_str, len);
-    return result;
+    ctx->word = ctx->bits = 0;
+    ctx->alphabet = base64_encode_table;
 }
 
-int
-base64_encode_str(char *result, int result_max_size, const char *data, int data_size)
+/* Encodes a single byte. */
+size_t
+base64_encode_single(struct base64_encode_ctx *ctx,
+                     char *dst,
+                     uint8_t src)
 {
-    if (result_max_size < 1)
-        return 0;
+    unsigned done = 0;
+    unsigned word = ctx->word << 8 | src;
+    unsigned bits = ctx->bits + 8;
 
-    int used = base64_encode(result, result_max_size, data, data_size);
-    /* terminate */
-    if (used >= result_max_size) {
-        result[result_max_size - 1] = '\0';
-        return result_max_size;
-    } else {
-        result[used++] = '\0';
+    while (bits >= 6)
+    {
+        bits -= 6;
+        dst[done++] = ENCODE(ctx->alphabet, (word >> bits));
     }
-    return used;
+
+    ctx->bits = bits;
+    ctx->word = word;
+
+    assert(done <= 2);
+
+    return done;
 }
 
-/* adopted from http://ftp.sunet.se/pub2/gnu/vm/base64-encode.c with adjustments */
-int
-base64_encode(char *result, int result_size, const char *data, int data_size)
+/* Returns the number of output characters. DST should point to an
+ * area of size at least BASE64_ENCODE_LENGTH(length). */
+size_t
+base64_encode_update(struct base64_encode_ctx *ctx,
+                     char *dst,
+                     size_t length,
+                     const uint8_t *src)
 {
-    int bits = 0;
-    int char_count = 0;
-    int out_cnt = 0;
+    size_t done = 0;
+    size_t left = length;
+    unsigned left_over;
+    size_t bulk;
 
-    if (!data || !*data || !result || result_size < 1 || data_size < 1)
-        return 0;
+    while (ctx->bits && left)
+    {
+        left--;
+        done += base64_encode_single(ctx, dst + done, *src++);
+    }
 
-    if (!base64_initialized)
-        base64_init();
-
-    while (data_size--) {
-        int c = (unsigned char) *data++;
-        bits += c;
-        char_count++;
-        if (char_count == 3) {
-            if (out_cnt >= result_size)
-                break;
-            if (out_cnt+4 <= result_size) {
-                result[out_cnt++] = base64_code[bits >> 18];
-                result[out_cnt++] = base64_code[(bits >> 12) & 0x3f];
-                result[out_cnt++] = base64_code[(bits >> 6) & 0x3f];
-                result[out_cnt++] = base64_code[bits & 0x3f];
-            } else {
-                // part-quantum goes a bit slower with per-byte checks
-                result[out_cnt++] = base64_code[bits >> 18];
-                if (out_cnt >= result_size)
-                    break;
-                result[out_cnt++] = base64_code[(bits >> 12) & 0x3f];
-                if (out_cnt >= result_size)
-                    break;
-                result[out_cnt++] = base64_code[(bits >> 6) & 0x3f];
-                if (out_cnt >= result_size)
-                    break;
-                result[out_cnt++] = base64_code[bits & 0x3f];
-            }
-            bits = 0;
-            char_count = 0;
-        } else {
-            bits <<= 8;
-        }
+    left_over = left % 3;
+    bulk = left - left_over;
+
+    if (bulk)
+    {
+        assert(!(bulk % 3));
+
+        encode_raw(ctx->alphabet, dst + done, bulk, src);
+        done += BASE64_ENCODE_RAW_LENGTH(bulk);
+        src += bulk;
+        left = left_over;
     }
-    if (char_count != 0) {
-        bits <<= 16 - (8 * char_count);
-        if (out_cnt >= result_size)
-            return result_size;
-        result[out_cnt++] = base64_code[bits >> 18];
-        if (out_cnt >= result_size)
-            return result_size;
-        result[out_cnt++] = base64_code[(bits >> 12) & 0x3f];
-        if (char_count == 1) {
-            if (out_cnt >= result_size)
-                return result_size;
-            result[out_cnt++] = '=';
-            if (out_cnt >= result_size)
-                return result_size;
-            result[out_cnt++] = '=';
-        } else {
-            if (out_cnt >= result_size)
-                return result_size;
-            result[out_cnt++] = base64_code[(bits >> 6) & 0x3f];
-            if (out_cnt >= result_size)
-                return result_size;
-            result[out_cnt++] = '=';
-        }
+
+    while (left)
+    {
+        left--;
+        done += base64_encode_single(ctx, dst + done, *src++);
+    }
+
+    assert(done <= BASE64_ENCODE_LENGTH(length));
+
+    return done;
+}
+
+/* DST should point to an area of size at least
+ * BASE64_ENCODE_FINAL_SIZE */
+size_t
+base64_encode_final(struct base64_encode_ctx *ctx,
+                    char *dst)
+{
+    unsigned done = 0;
+    unsigned bits = ctx->bits;
+
+    if (bits)
+    {
+        dst[done++] = ENCODE(ctx->alphabet, (ctx->word << (6 - ctx->bits)));
+        for (; bits < 6; bits += 2)
+            dst[done++] = '=';
+
+        ctx->bits = 0;
     }
-    return (out_cnt >= result_size?result_size:out_cnt);
+
+    assert(done <= BASE64_ENCODE_FINAL_LENGTH);
+    return done;
 }
+
+#endif /* !HAVE_NETTLE_BASE64_H || !HAVE_NETTLE34_BASE64 */
+