base64.h 4.63 KB
Newer Older
1
/* base64.h
Dan Egnor's avatar
Dan Egnor committed
2
3
4
5
6
7
 *
 * "ASCII armor" codecs.
 */

/* nettle, low-level cryptographics library
 *
Niels Möller's avatar
Niels Möller committed
8
 * Copyright (C) 2002 Niels Möller, Dan Egnor
Dan Egnor's avatar
Dan Egnor committed
9
10
11
12
13
14
15
16
17
18
19
20
21
 *  
 * The nettle library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 * 
 * The nettle library 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 Lesser General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the nettle library; see the file COPYING.LIB.  If not, write to
22
23
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02111-1301, USA.
Dan Egnor's avatar
Dan Egnor committed
24
25
 */
 
26
27
#ifndef NETTLE_BASE64_H_INCLUDED
#define NETTLE_BASE64_H_INCLUDED
Dan Egnor's avatar
Dan Egnor committed
28

29
#include "nettle-types.h"
Dan Egnor's avatar
Dan Egnor committed
30

Niels Möller's avatar
Niels Möller committed
31
32
33
34
#ifdef __cplusplus
extern "C" {
#endif

35
36
37
38
39
40
41
42
43
44
45
/* Name mangling */
#define base64_encode_init nettle_base64_encode_init
#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
#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
46

47
48
#define BASE64_BINARY_BLOCK_SIZE 3
#define BASE64_TEXT_BLOCK_SIZE 4
Dan Egnor's avatar
Dan Egnor committed
49

Niels Möller's avatar
Niels Möller committed
50
51
52
/* Base64 encoding */

/* Maximum length of output for base64_encode_update. NOTE: Doesn't
53
54
55
 * 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
56

Niels Möller's avatar
Niels Möller committed
57
/* Maximum length of output generated by base64_encode_final. */
Niels Möller's avatar
Niels Möller committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#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
{
  unsigned word;   /* Leftover bits */
  unsigned bits;  /* Number of bits, always 0, 2, or 4. */
};

void
base64_encode_init(struct base64_encode_ctx *ctx);

73
/* Encodes a single byte. Returns amount of output (always 1 or 2). */
74
size_t
Niels Möller's avatar
Niels Möller committed
75
76
77
78
79
80
base64_encode_single(struct base64_encode_ctx *ctx,
		     uint8_t *dst,
		     uint8_t src);

/* Returns the number of output characters. DST should point to an
 * area of size at least BASE64_ENCODE_LENGTH(length). */
81
size_t
Niels Möller's avatar
Niels Möller committed
82
83
base64_encode_update(struct base64_encode_ctx *ctx,
		     uint8_t *dst,
84
		     size_t length,
Niels Möller's avatar
Niels Möller committed
85
86
87
		     const uint8_t *src);

/* DST should point to an area of size at least
88
 * BASE64_ENCODE_FINAL_LENGTH */
89
size_t
Niels Möller's avatar
Niels Möller committed
90
91
92
93
94
95
96
97
98
base64_encode_final(struct base64_encode_ctx *ctx,
		    uint8_t *dst);

/* 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.
 * Supports overlapped operation, if src <= dst. */
void
99
base64_encode_raw(uint8_t *dst, size_t length, const uint8_t *src);
100

101
102
103
void
base64_encode_group(uint8_t *dst, uint32_t group);

Niels Möller's avatar
Niels Möller committed
104
105
106

/* Base64 decoding */

107
108
109
/* 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
110
111

struct base64_decode_ctx
112
{
Niels Möller's avatar
Niels Möller committed
113
114
  unsigned word;   /* Leftover bits */
  unsigned bits;   /* Number buffered bits */
115
116
117

  /* Number of padding characters encountered */
  unsigned padding;
118
119
120
};

void
Niels Möller's avatar
Niels Möller committed
121
122
base64_decode_init(struct base64_decode_ctx *ctx);

123
124
125
/* Decodes a single byte. Returns amount of output (0 or 1), or -1 on
 * errors. */
int
126
127
128
129
base64_decode_single(struct base64_decode_ctx *ctx,
		     uint8_t *dst,
		     uint8_t src);

130
131
132
133
134
135
/* Returns 1 on success, 0 on error. DST should point to an area of
 * size at least BASE64_DECODE_LENGTH(length), and for sanity
 * checking, *DST_LENGTH should be initialized to the size of that
 * area before the call. *DST_LENGTH is updated to the amount of
 * decoded output. */

Niels Möller's avatar
Niels Möller committed
136
137
/* Currently results in an assertion failure if *DST_LENGTH is
 * too small. FIXME: Return some error instead? */
138
int
Niels Möller's avatar
Niels Möller committed
139
base64_decode_update(struct base64_decode_ctx *ctx,
140
		     size_t *dst_length,
Niels Möller's avatar
Niels Möller committed
141
		     uint8_t *dst,
142
		     size_t src_length,
Niels Möller's avatar
Niels Möller committed
143
144
145
146
		     const uint8_t *src);

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

Niels Möller's avatar
Niels Möller committed
149
150
151
152
#ifdef __cplusplus
}
#endif

153
#endif /* NETTLE_BASE64_H_INCLUDED */