nettle-types.h

   1 /* nettle-types.h */
   2
   3 /* nettle, low-level cryptographics library
   4  *
   5  * Copyright (C) 2005 Niels Möller
   6  *
   7  * The nettle library is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU Lesser General Public License as published by
   9  * the Free Software Foundation; either version 2.1 of the License, or (at your
  10  * option) any later version.
  11  *
  12  * The nettle library is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  15  * License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with the nettle library; see the file COPYING.LIB.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA 02111-1307, USA.
  21  */
  22
  23 #ifndef NETTLE_TYPES_H
  24 #define NETTLE_TYPES_H
  25
  26 #include "nettle-stdint.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* Randomness. Used by key generation and dsa signature creation. */
  33 typedef void nettle_random_func(void *ctx,
  34                                 unsigned length, uint8_t *dst);
  35
  36 /* Progress report function, mainly for key generation. */
  37 typedef void nettle_progress_func(void *ctx, int c);
  38
  39 /* Realloc function, used by struct nettle_buffer. */
  40 typedef void *nettle_realloc_func(void *ctx, void *p, unsigned length);
  41
  42 /* Ciphers */
  43 typedef void nettle_set_key_func(void *ctx,
  44                                  unsigned length,
  45                                  const uint8_t *key);
  46
  47 /* Uses a void * for cipher contexts.
  48
  49    For block ciphers it would make sense with a const void * for the
  50    context, but we use the same typedef for stream ciphers where the
  51    internal state changes during the encryption. */
  52
  53 typedef void nettle_crypt_func(void *ctx,
  54                                unsigned length, uint8_t *dst,
  55                                const uint8_t *src);
  56
  57 /* Hash algorithms */
  58 typedef void nettle_hash_init_func(void *ctx);
  59 typedef void nettle_hash_update_func(void *ctx,
  60                                      unsigned length,
  61                                      const uint8_t *src);
  62 typedef void nettle_hash_digest_func(void *ctx,
  63                                      unsigned length, uint8_t *dst);
  64
  65 /* ASCII armor codecs. NOTE: Experimental and subject to change. */
  66
  67 typedef unsigned nettle_armor_length_func(unsigned length);
  68 typedef void nettle_armor_init_func(void *ctx);
  69
  70 typedef unsigned nettle_armor_encode_update_func(void *ctx,
  71                                                  uint8_t *dst,
  72                                                  unsigned src_length,
  73                                                  const uint8_t *src);
  74
  75 typedef unsigned nettle_armor_encode_final_func(void *ctx, uint8_t *dst);
  76
  77 typedef int nettle_armor_decode_update_func(void *ctx,
  78                                             unsigned *dst_length,
  79                                             uint8_t *dst,
  80                                             unsigned src_length,
  81                                             const uint8_t *src);
  82
  83 typedef int nettle_armor_decode_final_func(void *ctx);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif /* NETTLE_TYPES_H */