base64.h 2.79 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
22
23
24
25
 *  
 * 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
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */
 
26
27
#ifndef NETTLE_BASE64_H_INCLUDED
#define NETTLE_BASE64_H_INCLUDED
Dan Egnor's avatar
Dan Egnor committed
28
29
30
31
32

#include <inttypes.h>

/* Base64 encoding */

33
34
#define BASE64_BINARY_BLOCK_SIZE 3
#define BASE64_TEXT_BLOCK_SIZE 4
Dan Egnor's avatar
Dan Egnor committed
35

36
37
38
/* Overlapping source and destination is allowed, as long as the start
 * of the source area is not later than the start of the destination
 * area. */
Dan Egnor's avatar
Dan Egnor committed
39
40
41
42
43
unsigned /* Returns the length of encoded data */
base64_encode(uint8_t *dst,
              unsigned src_length,
              const uint8_t *src);

44
45
46
47
48
/* Precise length of encoded data (including padding) */
#define BASE64_ENCODE_LENGTH(src_length)		\
        ((BASE64_BINARY_BLOCK_SIZE - 1 + (src_length))	\
	/ BASE64_BINARY_BLOCK_SIZE * BASE64_TEXT_BLOCK_SIZE)

49
50
51
52
/* Encode a single group */
void
base64_encode_group(uint8_t *dst, uint32_t group);

Niels Möller's avatar
Niels Möller committed
53
/* FIXME: Perhaps rename to base64_decode_ctx? */
54
55
56
57
58
59
60
61
62
struct base64_ctx /* Internal, do not modify */
{
  uint16_t accum; /* Partial byte accumulated so far, filled msb first */
  int16_t shift;  /* Bitshift for the next 6-bit segment added to buffer */
};

void
base64_decode_init(struct base64_ctx *ctx);

63
64
65
/* Overlapping source and destination is allowed, as long as the start
 * of the source area is not before the start of the destination
 * area. */
Dan Egnor's avatar
Dan Egnor committed
66
unsigned /* Returns the length of decoded data */
67
68
69
70
71
base64_decode_update(struct base64_ctx *ctx,
                     uint8_t *dst,
                     unsigned src_length,
                     const uint8_t *src);

72
73
74
75
76
77
78
79
/* Maximum length of decoded data.
 *
 * NOTE: This size should work even for improper base 64 data. For
 * example, consider an (encoded) input string of two bytes. When
 * we'll generate one byte of output before noticing that the input is
 * truncated. And BASE64_DECODE_LENGTH(2) == 2*3/4 == 1, so that is
 * just fine. */

80
81
#define BASE64_DECODE_LENGTH(src_length) \
	((src_length) * BASE64_BINARY_BLOCK_SIZE / BASE64_TEXT_BLOCK_SIZE)
Dan Egnor's avatar
Dan Egnor committed
82

83
#endif /* NETTLE_BASE64_H_INCLUDED */