base16.h 3.03 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* base16.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 33
   
   Hex encoding and decoding, following spki conventions (i.e.
   allowing whitespace between digits).

   Copyright (C) 2002 Niels Möller

   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/.
*/
Niels Möller's avatar
Niels Möller committed
34 35 36 37
 
#ifndef NETTLE_BASE16_H_INCLUDED
#define NETTLE_BASE16_H_INCLUDED

38
#include "nettle-types.h"
Niels Möller's avatar
Niels Möller committed
39

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

44 45 46 47 48 49 50
/* Name mangling */
#define base16_encode_single nettle_base16_encode_single
#define base16_encode_update nettle_base16_encode_update
#define base16_decode_init nettle_base16_decode_init
#define base16_decode_single nettle_base16_decode_single
#define base16_decode_update nettle_base16_decode_update
#define base16_decode_final nettle_base16_decode_final
Niels Möller's avatar
Niels Möller committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64

/* Base16 encoding */

/* Maximum length of output for base16_encode_update. */
#define BASE16_ENCODE_LENGTH(length) ((length) * 2)

/* Encodes a single byte. Always stores two digits in dst[0] and dst[1]. */
void
base16_encode_single(uint8_t *dst,
		     uint8_t src);

/* Always stores BASE16_ENCODE_LENGTH(length) digits in dst. */
void
base16_encode_update(uint8_t *dst,
65
		     size_t length,
Niels Möller's avatar
Niels Möller committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
		     const uint8_t *src);


/* Base16 decoding */

/* Maximum length of output for base16_decode_update. */
/* We have at most 4 buffered bits, and a total of (length + 1) * 4 bits. */
#define BASE16_DECODE_LENGTH(length) (((length) + 1) / 2)

struct base16_decode_ctx
{
  unsigned word;   /* Leftover bits */
  unsigned bits;   /* Number buffered bits */
};

void
base16_decode_init(struct base16_decode_ctx *ctx);

/* Decodes a single byte. Returns amount of output (0 or 1), or -1 on
 * errors. */
int
base16_decode_single(struct base16_decode_ctx *ctx,
		     uint8_t *dst,
		     uint8_t src);

/* Returns 1 on success, 0 on error. DST should point to an area of
92 93
 * size at least BASE16_DECODE_LENGTH(length). The amount of data
 * generated is returned in *DST_LENGTH. */
Niels Möller's avatar
Niels Möller committed
94 95 96

int
base16_decode_update(struct base16_decode_ctx *ctx,
97
		     size_t *dst_length,
Niels Möller's avatar
Niels Möller committed
98
		     uint8_t *dst,
99
		     size_t src_length,
Niels Möller's avatar
Niels Möller committed
100 101 102 103 104 105
		     const uint8_t *src);

/* Returns 1 on success. */
int
base16_decode_final(struct base16_decode_ctx *ctx);

Niels Möller's avatar
Niels Möller committed
106 107 108 109
#ifdef __cplusplus
}
#endif

Niels Möller's avatar
Niels Möller committed
110
#endif /* NETTLE_BASE16_H_INCLUDED */