nettle-types.h 2.96 KB
Newer Older
1 2 3 4
/* nettle-types.h */

/* nettle, low-level cryptographics library
 *
5
 * Copyright (C) 2005, 2014 Niels Möller
6 7 8 9 10 11 12 13 14 15 16 17 18
 *  
 * 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
19 20
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02111-1301, USA.
21 22 23 24 25
 */

#ifndef NETTLE_TYPES_H
#define NETTLE_TYPES_H

26 27 28
/* For size_t */
#include <stddef.h>

29 30
/* Pretend these types always exists. Nettle doesn't use them. */
#define _STDINT_HAVE_INT_FAST32_T 1
31 32
#include "nettle-stdint.h"

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

Niels Möller's avatar
Niels Möller committed
37 38 39 40 41 42 43
/* An aligned 16-byte block. */
union nettle_block16
{
  uint8_t b[16];
  unsigned long w[16 / sizeof(unsigned long)];
};

44
/* Randomness. Used by key generation and dsa signature creation. */
45
typedef void nettle_random_func(void *ctx,
46
				size_t length, uint8_t *dst);
47 48

/* Progress report function, mainly for key generation. */
49 50 51
typedef void nettle_progress_func(void *ctx, int c);

/* Realloc function, used by struct nettle_buffer. */
52
typedef void *nettle_realloc_func(void *ctx, void *p, size_t length);
53 54

/* Ciphers */
55
typedef void nettle_set_key_func(void *ctx, const uint8_t *key);
56

57 58 59 60 61 62
/* Uses a void * for cipher contexts.

   For block ciphers it would make sense with a const void * for the
   context, but we use the same typedef for stream ciphers where the
   internal state changes during the encryption. */

63
typedef void nettle_crypt_func(void *ctx,
64
			       size_t length, uint8_t *dst,
65
			       const uint8_t *src);
66 67

/* Hash algorithms */
68 69
typedef void nettle_hash_init_func(void *ctx);
typedef void nettle_hash_update_func(void *ctx,
70
				     size_t length,
71 72
				     const uint8_t *src);
typedef void nettle_hash_digest_func(void *ctx,
73
				     size_t length, uint8_t *dst);
74 75 76

/* ASCII armor codecs. NOTE: Experimental and subject to change. */

77
typedef size_t nettle_armor_length_func(size_t length);
78
typedef void nettle_armor_init_func(void *ctx);
79

80 81 82 83
typedef size_t nettle_armor_encode_update_func(void *ctx,
					       uint8_t *dst,
					       size_t src_length,
					       const uint8_t *src);
84

85
typedef size_t nettle_armor_encode_final_func(void *ctx, uint8_t *dst);
86

87
typedef int nettle_armor_decode_update_func(void *ctx,
88
					    size_t *dst_length,
89
					    uint8_t *dst,
90
					    size_t src_length,
91
					    const uint8_t *src);
92

93
typedef int nettle_armor_decode_final_func(void *ctx);
94

Niels Möller's avatar
Niels Möller committed
95 96 97
#ifdef __cplusplus
}
#endif
98

Niels Möller's avatar
Niels Möller committed
99
#endif /* NETTLE_TYPES_H */