lib/silccrypt/silccipher.h

   1 /*
   2
   3   silccipher.h
   4
   5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 #ifndef SILCCIPHER_H
  22 #define SILCCIPHER_H
  23
  24 /*
  25    SILC Cipher object.
  26
  27    Default SILC cipher object to represent any cipher. The function
  28    pointers are the stub functions for each implemented cipher. Following
  29    short description of the fields:
  30
  31    char *name
  32
  33        Logical name of the cipher.
  34
  35    uint32 block_len
  36
  37        Block size of the cipher.
  38
  39    uint32 key_len
  40
  41        Length of the key of the cipher (in bits).
  42
  43 */
  44 typedef struct {
  45   char *name;
  46   uint32 block_len;
  47   uint32 key_len;
  48
  49   bool (*set_key)(void *, const unsigned char *, uint32);
  50   bool (*set_key_with_string)(void *, const unsigned char *, uint32);
  51   bool (*encrypt)(void *, const unsigned char *, unsigned char *,
  52                   uint32, unsigned char *);
  53   bool (*decrypt)(void *, const unsigned char *, unsigned char *,
  54                   uint32, unsigned char *);
  55   uint32 (*context_len)();
  56 } SilcCipherObject;
  57
  58 #define SILC_CIPHER_MAX_IV_SIZE 16
  59
  60 /* The main SilcCipher structure. Use SilcCipher instead of SilcCipherStruct.
  61    Also remember that SilcCipher is a pointer. */
  62 typedef struct SilcCipherStruct {
  63   SilcCipherObject *cipher;
  64   void *context;
  65   unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
  66
  67   void (*set_iv)(struct SilcCipherStruct *, const unsigned char *);
  68   void (*get_iv)(struct SilcCipherStruct *, unsigned char *);
  69   uint32 (*get_key_len)(struct SilcCipherStruct *);
  70   uint32 (*get_block_len)(struct SilcCipherStruct *);
  71 } *SilcCipher;
  72
  73 /* Marks for all ciphers in silc. This can be used in silc_cipher_unregister
  74    to unregister all ciphers at once. */
  75 #define SILC_ALL_CIPHERS ((SilcCipherObject *)1)
  76
  77 /* Static list of ciphers for silc_cipher_register_default(). */
  78 extern SilcCipherObject silc_default_ciphers[];
  79
  80 /* Macros */
  81
  82 /* Function names in SILC Crypto modules. The name of the cipher
  83    is appended into these names and used to the get correct symbol out
  84    of the module. All SILC Crypto API compliant modules must support
  85    these function names (use macros below to assure this). */
  86 #define SILC_CIPHER_SIM_SET_KEY "set_key"
  87 #define SILC_CIPHER_SIM_SET_KEY_WITH_STRING "set_key_with_string"
  88 #define SILC_CIPHER_SIM_ENCRYPT_CBC "encrypt_cbc"
  89 #define SILC_CIPHER_SIM_DECRYPT_CBC "decrypt_cbc"
  90 #define SILC_CIPHER_SIM_CONTEXT_LEN "context_len"
  91
  92 /* These macros can be used to implement the SILC Crypto API and to avoid
  93    errors in the API these macros should be used always. */
  94 #define SILC_CIPHER_API_SET_KEY(cipher)                 \
  95 bool silc_##cipher##_set_key(void *context,             \
  96                              const unsigned char *key,  \
  97                              uint32 keylen)
  98 #define SILC_CIPHER_API_SET_KEY_WITH_STRING(cipher)                     \
  99 bool silc_##cipher##_set_key_with_string(void *context,                 \
 100                                          const unsigned char *string,   \
 101                                          uint32 stringlen)
 102 #define SILC_CIPHER_API_ENCRYPT_CBC(cipher)                     \
 103 bool silc_##cipher##_encrypt_cbc(void *context,                 \
 104                                  const unsigned char *src,      \
 105                                  unsigned char *dst,            \
 106                                  uint32 len,            \
 107                                  unsigned char *iv)
 108 #define SILC_CIPHER_API_DECRYPT_CBC(cipher)                     \
 109 bool silc_##cipher##_decrypt_cbc(void *context,                 \
 110                                  const unsigned char *src,      \
 111                                  unsigned char *dst,            \
 112                                  uint32 len,            \
 113                                  unsigned char *iv)
 114 #define SILC_CIPHER_API_CONTEXT_LEN(cipher)                     \
 115 uint32 silc_##cipher##_context_len()
 116
 117 /* Prototypes */
 118 bool silc_cipher_register(SilcCipherObject *cipher);
 119 bool silc_cipher_unregister(SilcCipherObject *cipher);
 120 bool silc_cipher_register_default(void);
 121 bool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher);
 122 void silc_cipher_free(SilcCipher cipher);
 123 bool silc_cipher_is_supported(const unsigned char *name);
 124 char *silc_cipher_get_supported(void);
 125 bool silc_cipher_encrypt(SilcCipher cipher, const unsigned char *src,
 126                          unsigned char *dst, uint32 len,
 127                          unsigned char *iv);
 128 bool silc_cipher_decrypt(SilcCipher cipher, const unsigned char *src,
 129                          unsigned char *dst, uint32 len,
 130                          unsigned char *iv);
 131 bool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
 132                          uint32 keylen);
 133 void silc_cipher_set_iv(SilcCipher cipher, const unsigned char *iv);
 134 void silc_cipher_get_iv(SilcCipher cipher, unsigned char *iv);
 135 uint32 silc_cipher_get_key_len(SilcCipher cipher);
 136 uint32 silc_cipher_get_block_len(SilcCipher cipher);
 137
 138 #endif