base64.h 5.22 KB
Newer Older
1
/* base64.h
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
   
   Base-64 encoding and decoding.

   Copyright (C) 2002 Niels Möller, Dan Egnor

   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.

   or both in parallel, as here.

   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.

   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/.
*/
Dan Egnor's avatar
Dan Egnor committed
33
 
34 35
#ifndef NETTLE_BASE64_H_INCLUDED
#define NETTLE_BASE64_H_INCLUDED
Dan Egnor's avatar
Dan Egnor committed
36

37
#include "nettle-types.h"
Dan Egnor's avatar
Dan Egnor committed
38

Niels Möller's avatar
Niels Möller committed
39 40 41 42
#ifdef __cplusplus
extern "C" {
#endif

43 44
/* Name mangling */
#define base64_encode_init nettle_base64_encode_init
45
#define base64url_encode_init nettle_base64url_encode_init
46 47 48 49 50 51
#define base64_encode_single nettle_base64_encode_single
#define base64_encode_update nettle_base64_encode_update
#define base64_encode_final nettle_base64_encode_final
#define base64_encode_raw nettle_base64_encode_raw
#define base64_encode_group nettle_base64_encode_group
#define base64_decode_init nettle_base64_decode_init
52
#define base64url_decode_init nettle_base64url_decode_init
53 54 55
#define base64_decode_single nettle_base64_decode_single
#define base64_decode_update nettle_base64_decode_update
#define base64_decode_final nettle_base64_decode_final
Dan Egnor's avatar
Dan Egnor committed
56

57 58
#define BASE64_BINARY_BLOCK_SIZE 3
#define BASE64_TEXT_BLOCK_SIZE 4
Dan Egnor's avatar
Dan Egnor committed
59

Niels Möller's avatar
Niels Möller committed
60 61 62
/* Base64 encoding */

/* Maximum length of output for base64_encode_update. NOTE: Doesn't
63 64 65
 * include any padding that base64_encode_final may add. */
/* We have at most 4 buffered bits, and a total of (4 + length * 8) bits. */
#define BASE64_ENCODE_LENGTH(length) (((length) * 8 + 4)/6)
Dan Egnor's avatar
Dan Egnor committed
66

Niels Möller's avatar
Niels Möller committed
67
/* Maximum length of output generated by base64_encode_final. */
Niels Möller's avatar
Niels Möller committed
68 69 70 71 72 73 74 75
#define BASE64_ENCODE_FINAL_LENGTH 3

/* Exact length of output generated by base64_encode_raw, including
 * padding. */
#define BASE64_ENCODE_RAW_LENGTH(length) ((((length) + 2)/3)*4)

struct base64_encode_ctx
{
76
  const char *alphabet;    /* Alphabet to use for encoding */
77 78
  unsigned short word;     /* Leftover bits */
  unsigned char bits;      /* Number of bits, always 0, 2, or 4. */
Niels Möller's avatar
Niels Möller committed
79 80
};

81
/* Initialize encoding context for base-64 */
Niels Möller's avatar
Niels Möller committed
82 83 84
void
base64_encode_init(struct base64_encode_ctx *ctx);

85 86 87 88
/* Initialize encoding context for URL safe alphabet, RFC 4648. */
void
base64url_encode_init(struct base64_encode_ctx *ctx);

89
/* Encodes a single byte. Returns amount of output (always 1 or 2). */
90
size_t
Niels Möller's avatar
Niels Möller committed
91
base64_encode_single(struct base64_encode_ctx *ctx,
92
		     char *dst,
Niels Möller's avatar
Niels Möller committed
93 94 95 96
		     uint8_t src);

/* Returns the number of output characters. DST should point to an
 * area of size at least BASE64_ENCODE_LENGTH(length). */
97
size_t
Niels Möller's avatar
Niels Möller committed
98
base64_encode_update(struct base64_encode_ctx *ctx,
99
		     char *dst,
100
		     size_t length,
Niels Möller's avatar
Niels Möller committed
101 102 103
		     const uint8_t *src);

/* DST should point to an area of size at least
104
 * BASE64_ENCODE_FINAL_LENGTH */
105
size_t
Niels Möller's avatar
Niels Möller committed
106
base64_encode_final(struct base64_encode_ctx *ctx,
107
		    char *dst);
Niels Möller's avatar
Niels Möller committed
108 109 110 111 112

/* Lower level functions */

/* Encodes a string in one go, including any padding at the end.
 * Generates exactly BASE64_ENCODE_RAW_LENGTH(length) bytes of output.
113 114 115
 * Supports overlapped operation, if src <= dst. FIXME: Use of overlap
 * is deprecated, if needed there should be a separate public fucntion
 * to do that.*/
Niels Möller's avatar
Niels Möller committed
116
void
117
base64_encode_raw(char *dst, size_t length, const uint8_t *src);
118

119
void
120
base64_encode_group(char *dst, uint32_t group);
121

Niels Möller's avatar
Niels Möller committed
122 123 124

/* Base64 decoding */

125 126 127
/* Maximum length of output for base64_decode_update. */
/* We have at most 6 buffered bits, and a total of (length + 1) * 6 bits. */
#define BASE64_DECODE_LENGTH(length) ((((length) + 1) * 6) / 8)
Niels Möller's avatar
Niels Möller committed
128 129

struct base64_decode_ctx
130
{
131 132 133
  const signed char *table; /* Decoding table */
  unsigned short word;      /* Leftover bits */
  unsigned char bits;       /* Number buffered bits */
134 135

  /* Number of padding characters encountered */
136
  unsigned char padding;
137 138
};

139
/* Initialize decoding context for base-64 */
140
void
Niels Möller's avatar
Niels Möller committed
141 142
base64_decode_init(struct base64_decode_ctx *ctx);

143 144 145 146
/* Initialize encoding context for URL safe alphabet, RFC 4648. */
void
base64url_decode_init(struct base64_decode_ctx *ctx);

147 148 149
/* Decodes a single byte. Returns amount of output (0 or 1), or -1 on
 * errors. */
int
150 151
base64_decode_single(struct base64_decode_ctx *ctx,
		     uint8_t *dst,
152
		     char src);
153

154
/* Returns 1 on success, 0 on error. DST should point to an area of
155 156
 * size at least BASE64_DECODE_LENGTH(length). The amount of data
 * generated is returned in *DST_LENGTH. */
157
int
Niels Möller's avatar
Niels Möller committed
158
base64_decode_update(struct base64_decode_ctx *ctx,
159
		     size_t *dst_length,
Niels Möller's avatar
Niels Möller committed
160
		     uint8_t *dst,
161
		     size_t src_length,
162
		     const char *src);
Niels Möller's avatar
Niels Möller committed
163 164 165

/* Returns 1 on success. */
int
166
base64_decode_final(struct base64_decode_ctx *ctx);
Dan Egnor's avatar
Dan Egnor committed
167

Niels Möller's avatar
Niels Möller committed
168 169 170 171
#ifdef __cplusplus
}
#endif

172
#endif /* NETTLE_BASE64_H_INCLUDED */