base64.h 4.56 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 Mller, 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

#include <inttypes.h>

31 32 33 34 35 36 37 38 39 40 41
/* 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
42

43 44
#define BASE64_BINARY_BLOCK_SIZE 3
#define BASE64_TEXT_BLOCK_SIZE 4
Dan Egnor's avatar
Dan Egnor committed
45

Niels Möller's avatar
Niels Möller committed
46 47 48
/* Base64 encoding */

/* Maximum length of output for base64_encode_update. NOTE: Doesn't
49 50 51
 * 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
52

Niels Möller's avatar
Niels Möller committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/* Maximum lengbth of output generated by base64_encode_final. */
#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);

69
/* Encodes a single byte. Returns amount of output (always 1 or 2). */
Niels Möller's avatar
Niels Möller committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
unsigned
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). */
unsigned
base64_encode_update(struct base64_encode_ctx *ctx,
		     uint8_t *dst,
		     unsigned length,
		     const uint8_t *src);

/* DST should point to an area of size at least
 * BASE64_ENCODE_FINAL_SIZE */
unsigned
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
base64_encode_raw(uint8_t *dst, unsigned length, const uint8_t *src);
96

97 98 99
void
base64_encode_group(uint8_t *dst, uint32_t group);

Niels Möller's avatar
Niels Möller committed
100 101 102

/* Base64 decoding */

103 104 105
/* 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
106 107

struct base64_decode_ctx
108
{
Niels Möller's avatar
Niels Möller committed
109 110
  unsigned word;   /* Leftover bits */
  unsigned bits;   /* Number buffered bits */
111 112 113

  /* Number of padding characters encountered */
  unsigned padding;
114 115 116
};

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

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

126 127 128 129 130 131 132 133 134
/* 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. */

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

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

145
#endif /* NETTLE_BASE64_H_INCLUDED */