base64.h 3.57 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 31

#include <inttypes.h>


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

Niels Möller's avatar
Niels Möller committed
35 36 37
/* Base64 encoding */

/* Maximum length of output for base64_encode_update. NOTE: Doesn't
38 39 40
 * 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
41

Niels Möller's avatar
Niels Möller committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
/* 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);

/* Encodes a single byte. Returns amoutn of output (always 1 or 2). */
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);
85

86 87 88
void
base64_encode_group(uint8_t *dst, uint32_t group);

Niels Möller's avatar
Niels Möller committed
89 90 91

/* Base64 decoding */

92 93 94
/* 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
95 96

struct base64_decode_ctx
97
{
Niels Möller's avatar
Niels Möller committed
98 99 100 101 102 103 104 105
  enum
    {
      BASE64_DECODE_OK,
      BASE64_DECODE_ERROR,
      BASE64_DECODE_END
    } status; 
  unsigned word;   /* Leftover bits */
  unsigned bits;   /* Number buffered bits */
106 107 108
};

void
Niels Möller's avatar
Niels Möller committed
109 110 111 112 113 114 115 116 117 118 119 120 121
base64_decode_init(struct base64_decode_ctx *ctx);

/* Returns the number of output characters. DST should point to an
 * area of size at least BASE64_DECODE_LENGTH(length). */
unsigned
base64_decode_update(struct base64_decode_ctx *ctx,
		     uint8_t *dst,
		     unsigned length,
		     const uint8_t *src);

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

123
#endif /* NETTLE_BASE64_H_INCLUDED */