git.sesse.net Git - ffmpeg/blob - libavutil/base64.c

   1 /*
   2  * Copyright (c) 2006 Ryan Martell. (rdm4@martellventures.com)
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * @brief Base64 encode/decode
  24  * @author Ryan Martell <rdm4@martellventures.com> (with lots of Michael)
  25  */
  26
  27 #include "common.h"
  28 #include "base64.h"
  29 #include "intreadwrite.h"
  30
  31 /* ---------------- private code */
  32 static const uint8_t map2[256] =
  33 {
  34     0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  35     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  36     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  37     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  38     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  39     0xff, 0xff, 0xff,
  40
  41     0x3e, 0xff, 0xff, 0xff, 0x3f, 0x34, 0x35, 0x36,
  42     0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0xff,
  43     0xff, 0xff, 0xfe, 0xff, 0xff, 0xff, 0x00, 0x01,
  44     0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09,
  45     0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11,
  46     0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19,
  47     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1a, 0x1b,
  48     0x1c, 0x1d, 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23,
  49     0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b,
  50     0x2c, 0x2d, 0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33,
  51
  52                       0xff, 0xff, 0xff, 0xff, 0xff,
  53     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  54     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  55     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  56     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  57     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  58     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  59     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  60     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  61     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  62     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  63     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  64     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  65     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  66     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  67     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  68     0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  69 };
  70
  71 #define BASE64_DEC_STEP(i) \
  72     bits = map2[in[i]]; \
  73     if (bits & 0x80) \
  74         goto out; \
  75     v = (v << 6) + bits; \
  76     if (i & 3) \
  77         *dst++ = v >> (6 - 2 * (i & 3)); \
  78
  79 int av_base64_decode(uint8_t *out, const char *in_str, int out_size)
  80 {
  81     int v;
  82     uint8_t *dst = out;
  83     uint8_t *end = out + out_size;
  84     // no sign extension
  85     const uint8_t *in = in_str;
  86     unsigned bits = 0xff;
  87
  88     v = 0;
  89     while (end - dst > 2) {
  90         BASE64_DEC_STEP(0)
  91         BASE64_DEC_STEP(1)
  92         BASE64_DEC_STEP(2)
  93         BASE64_DEC_STEP(3)
  94         in += 4;
  95     }
  96     if (end - dst) {
  97         BASE64_DEC_STEP(0)
  98         BASE64_DEC_STEP(1)
  99         if (end - dst) {
 100             BASE64_DEC_STEP(2)
 101             in++;
 102         }
 103         in += 2;
 104     }
 105     while (1) {
 106         BASE64_DEC_STEP(0)
 107         in++;
 108         BASE64_DEC_STEP(0)
 109         in++;
 110         BASE64_DEC_STEP(0)
 111         in++;
 112         BASE64_DEC_STEP(0)
 113         in++;
 114     }
 115
 116 out:
 117     return bits & 1 ? -1 : dst - out;
 118 }
 119
 120 /*****************************************************************************
 121 * b64_encode: Stolen from VLC's http.c.
 122 * Simplified by Michael.
 123 * Fixed edge cases and made it work from data (vs. strings) by Ryan.
 124 *****************************************************************************/
 125
 126 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size)
 127 {
 128     static const char b64[] =
 129         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 130     char *ret, *dst;
 131     unsigned i_bits = 0;
 132     int i_shift = 0;
 133     int bytes_remaining = in_size;
 134
 135     if (in_size >= UINT_MAX / 4 ||
 136         out_size < AV_BASE64_SIZE(in_size))
 137         return NULL;
 138     ret = dst = out;
 139     while (bytes_remaining > 3) {
 140         i_bits = AV_RB32(in);
 141         in += 3; bytes_remaining -= 3;
 142         *dst++ = b64[ i_bits>>26        ];
 143         *dst++ = b64[(i_bits>>20) & 0x3F];
 144         *dst++ = b64[(i_bits>>14) & 0x3F];
 145         *dst++ = b64[(i_bits>>8 ) & 0x3F];
 146     }
 147     i_bits = 0;
 148     while (bytes_remaining) {
 149         i_bits = (i_bits << 8) + *in++;
 150         bytes_remaining--;
 151         i_shift += 8;
 152     }
 153     while (i_shift > 0) {
 154         *dst++ = b64[(i_bits << 6 >> i_shift) & 0x3f];
 155         i_shift -= 6;
 156     }
 157     while ((dst - ret) & 3)
 158         *dst++ = '=';
 159     *dst = '\0';
 160
 161     return ret;
 162 }
 163
 164 #ifdef TEST
 165 // LCOV_EXCL_START
 166
 167 #undef printf
 168
 169 #define MAX_DATA_SIZE    1024
 170 #define MAX_ENCODED_SIZE 2048
 171
 172 static int test_encode_decode(const uint8_t *data, unsigned int data_size,
 173                               const char *encoded_ref)
 174 {
 175     char  encoded[MAX_ENCODED_SIZE];
 176     uint8_t data2[MAX_DATA_SIZE];
 177     int data2_size, max_data2_size = MAX_DATA_SIZE;
 178
 179     if (!av_base64_encode(encoded, MAX_ENCODED_SIZE, data, data_size)) {
 180         printf("Failed: cannot encode the input data\n");
 181         return 1;
 182     }
 183     if (encoded_ref && strcmp(encoded, encoded_ref)) {
 184         printf("Failed: encoded string differs from reference\n"
 185                "Encoded:\n%s\nReference:\n%s\n", encoded, encoded_ref);
 186         return 1;
 187     }
 188
 189     if ((data2_size = av_base64_decode(data2, encoded, max_data2_size)) != data_size) {
 190         printf("Failed: cannot decode the encoded string\n"
 191                "Encoded:\n%s\n", encoded);
 192         return 1;
 193     }
 194     if ((data2_size = av_base64_decode(data2, encoded, data_size)) != data_size) {
 195         printf("Failed: cannot decode with minimal buffer\n"
 196                "Encoded:\n%s\n", encoded);
 197         return 1;
 198     }
 199     if (memcmp(data2, data, data_size)) {
 200         printf("Failed: encoded/decoded data differs from original data\n");
 201         return 1;
 202     }
 203     if (av_base64_decode(NULL, encoded, 0) != 0) {
 204         printf("Failed: decode to NULL buffer\n");
 205         return 1;
 206     }
 207     if (strlen(encoded)) {
 208         char *end = strchr(encoded, '=');
 209         if (!end)
 210             end = encoded + strlen(encoded) - 1;
 211         *end = '%';
 212         if (av_base64_decode(NULL, encoded, 0) >= 0) {
 213             printf("Failed: error detection\n");
 214             return 1;
 215         }
 216     }
 217
 218     printf("Passed!\n");
 219     return 0;
 220 }
 221
 222 int main(int argc, char ** argv)
 223 {
 224     int i, error_count = 0;
 225     struct test {
 226         const uint8_t *data;
 227         const char *encoded_ref;
 228     } tests[] = {
 229         { "",        ""},
 230         { "1",       "MQ=="},
 231         { "22",      "MjI="},
 232         { "333",     "MzMz"},
 233         { "4444",    "NDQ0NA=="},
 234         { "55555",   "NTU1NTU="},
 235         { "666666",  "NjY2NjY2"},
 236         { "abc:def", "YWJjOmRlZg=="},
 237     };
 238     char in[1024], out[2048];
 239
 240     printf("Encoding/decoding tests\n");
 241     for (i = 0; i < FF_ARRAY_ELEMS(tests); i++)
 242         error_count += test_encode_decode(tests[i].data, strlen(tests[i].data), tests[i].encoded_ref);
 243
 244     if (argc>1 && !strcmp(argv[1], "-t")) {
 245         memset(in, 123, sizeof(in));
 246         for(i=0; i<10000; i++){
 247             START_TIMER
 248             av_base64_encode(out, sizeof(out), in, sizeof(in));
 249             STOP_TIMER("encode")
 250         }
 251         for(i=0; i<10000; i++){
 252             START_TIMER
 253             av_base64_decode(in, out, sizeof(in));
 254             STOP_TIMER("decode")
 255         }
 256
 257         for(i=0; i<10000; i++){
 258             START_TIMER
 259             av_base64_decode(NULL, out, 0);
 260             STOP_TIMER("syntax check")
 261         }
 262     }
 263
 264     return error_count;
 265 }
 266
 267 // LCOV_EXCL_STOP
 268 #endif