Major restructuring of the internals of SILC Cipher API
[crypto.git] / lib / silccrypt / silccipher.c
index d8b73215e36c90f05814beec80f2db0345a55ee5..229cc22b91bdaf17306fba4dc6c6da7f03ac73ec 100644 (file)
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2006 Pekka Riikonen
+  Copyright (C) 1997 - 2008 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   GNU General Public License for more details.
 
 */
-/* $Id$ */
 
-#include "silc.h"
+#include "silccrypto.h"
 #include "ciphers.h"           /* Includes cipher definitions */
 
-/* The SilcCipher context */
-struct SilcCipherStruct {
-  SilcCipherObject *cipher;
-  void *context;
-  unsigned char iv[SILC_CIPHER_MAX_IV_SIZE];
-};
-
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
 /* Dynamically registered list of ciphers. */
 SilcDList silc_cipher_list = NULL;
-#endif /* SILC_EPOC */
+#endif /* SILC_SYMBIAN */
+
+/* Macro to define cipher to cipher list */
+#define SILC_CDEF(name, alg_name, cipher, keylen, blocklen, ivlen, mode)\
+{ name, alg_name, silc_##cipher##_set_key, silc_##cipher##_set_iv,     \
+  silc_##cipher##_encrypt, silc_##cipher##_decrypt,                    \
+  silc_##cipher##_init, silc_##cipher##_uninit, keylen, blocklen, ivlen, mode }
 
 /* Static list of ciphers for silc_cipher_register_default(). */
 const SilcCipherObject silc_default_ciphers[] =
 {
-  { "aes-256-cbc", 16, 256, silc_aes_set_key,
-    silc_aes_set_key_with_string, silc_aes_encrypt_cbc,
-    silc_aes_decrypt_cbc, silc_aes_context_len },
-  { "aes-192-cbc", 16, 192, silc_aes_set_key,
-    silc_aes_set_key_with_string, silc_aes_encrypt_cbc,
-    silc_aes_decrypt_cbc, silc_aes_context_len },
-  { "aes-128-cbc", 16, 128, silc_aes_set_key,
-    silc_aes_set_key_with_string, silc_aes_encrypt_cbc,
-    silc_aes_decrypt_cbc, silc_aes_context_len },
-  { "twofish-256-cbc", 16, 256, silc_twofish_set_key,
-    silc_twofish_set_key_with_string,
-    silc_twofish_encrypt_cbc, silc_twofish_decrypt_cbc,
-    silc_twofish_context_len },
-  { "twofish-192-cbc", 16, 192, silc_twofish_set_key,
-    silc_twofish_set_key_with_string,
-    silc_twofish_encrypt_cbc, silc_twofish_decrypt_cbc,
-    silc_twofish_context_len },
-  { "twofish-128-cbc", 16, 128, silc_twofish_set_key,
-    silc_twofish_set_key_with_string,
-    silc_twofish_encrypt_cbc, silc_twofish_decrypt_cbc,
-    silc_twofish_context_len },
-  { "cast-256-cbc", 16, 256, silc_cast_set_key, silc_cast_set_key_with_string,
-    silc_cast_encrypt_cbc, silc_cast_decrypt_cbc,
-    silc_cast_context_len },
-  { "cast-192-cbc", 16, 192, silc_cast_set_key, silc_cast_set_key_with_string,
-    silc_cast_encrypt_cbc, silc_cast_decrypt_cbc,
-    silc_cast_context_len },
-  { "cast-128-cbc", 16, 128, silc_cast_set_key, silc_cast_set_key_with_string,
-    silc_cast_encrypt_cbc, silc_cast_decrypt_cbc,
-    silc_cast_context_len },
+  SILC_CDEF("aes-256-ctr", "aes", aes, 256, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("aes-192-ctr", "aes", aes, 192, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("aes-128-ctr", "aes", aes, 128, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("aes-256-cbc", "aes", aes, 256, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("aes-192-cbc", "aes", aes, 192, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("aes-128-cbc", "aes", aes, 128, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("aes-256-cfb", "aes", aes, 256, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("aes-192-cfb", "aes", aes, 192, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("aes-128-cfb", "aes", aes, 128, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("aes-256-ecb", "aes", aes, 256, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("aes-192-ecb", "aes", aes, 192, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("aes-128-ecb", "aes", aes, 128, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("twofish-256-ctr", "twofish", twofish, 256, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("twofish-192-ctr", "twofish", twofish, 192, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("twofish-128-ctr", "twofish", twofish, 128, 16, 16, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("twofish-256-cbc", "twofish", twofish, 256, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("twofish-192-cbc", "twofish", twofish, 192, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("twofish-128-cbc", "twofish", twofish, 128, 16, 16, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("twofish-256-cfb", "twofish", twofish, 256, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("twofish-192-cfb", "twofish", twofish, 192, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("twofish-128-cfb", "twofish", twofish, 128, 16, 16, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("twofish-256-ecb", "twofish", twofish, 256, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("twofish-192-ecb", "twofish", twofish, 192, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("twofish-128-ecb", "twofish", twofish, 128, 16, 16, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("cast5-128-ctr", "cast5", cast5, 128, 8, 8, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("cast5-128-cbc", "cast5", cast5, 128, 8, 8, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("cast5-128-cfb", "cast5", cast5, 128, 8, 8, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("cast5-128-ecb", "cast5", cast5, 128, 8, 8, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("des-56-ctr", "des", des, 56, 8, 8, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("des-56-cbc", "des", des, 56, 8, 8, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("des-56-cfb", "des", des, 56, 8, 8, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("des-56-ecb", "des", des, 56, 8, 8, SILC_CIPHER_MODE_ECB),
+  SILC_CDEF("3des-168-ctr", "3des", 3des, 168, 8, 8, SILC_CIPHER_MODE_CTR),
+  SILC_CDEF("3des-168-cbc", "3des", 3des, 168, 8, 8, SILC_CIPHER_MODE_CBC),
+  SILC_CDEF("3des-168-cfb", "3des", 3des, 168, 8, 8, SILC_CIPHER_MODE_CFB),
+  SILC_CDEF("3des-168-ecb", "3des", 3des, 168, 8, 8, SILC_CIPHER_MODE_ECB),
 #ifdef SILC_DEBUG
-  { "none", 0, 0, silc_none_set_key, silc_none_set_key_with_string,
-    silc_none_encrypt_cbc, silc_none_decrypt_cbc,
-    silc_none_context_len },
+  SILC_CDEF("none", "none", none, 0, 0, 0, 0),
 #endif /* SILC_DEBUG */
-
-  { NULL, 0, 0, NULL, NULL, NULL, NULL, NULL }
+  { NULL, NULL, NULL, 0, 0, 0, 0 }
 };
 
-/* Register a new cipher into SILC. This is used at the initialization of
-   the SILC. This function allocates a new object for the cipher to be
-   registered. Therefore, if memory has been allocated for the object sent
-   as argument it has to be free'd after this function returns succesfully. */
+/* Register new cipher */
 
 SilcBool silc_cipher_register(const SilcCipherObject *cipher)
 {
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
   SilcCipherObject *new;
 
   SILC_LOG_DEBUG(("Registering new cipher `%s'", cipher->name));
@@ -91,36 +89,45 @@ SilcBool silc_cipher_register(const SilcCipherObject *cipher)
   if (silc_cipher_list) {
     SilcCipherObject *entry;
     silc_dlist_start(silc_cipher_list);
-    while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+    while ((entry = silc_dlist_get(silc_cipher_list))) {
       if (!strcmp(entry->name, cipher->name))
        return FALSE;
     }
   }
 
   new = silc_calloc(1, sizeof(*new));
+  if (!new)
+    return FALSE;
   new->name = strdup(cipher->name);
-  new->block_len = cipher->block_len;
+  if (!new->name) {
+    silc_free(new);
+    return FALSE;
+  }
   new->key_len = cipher->key_len;
+  new->block_len = cipher->block_len;
+  new->iv_len = cipher->iv_len;
   new->set_key = cipher->set_key;
-  new->set_key_with_string = cipher->set_key_with_string;
+  new->set_iv = cipher->set_iv;
   new->encrypt = cipher->encrypt;
   new->decrypt = cipher->decrypt;
-  new->context_len = cipher->context_len;
+  new->init = cipher->init;
+  new->uninit = cipher->uninit;
+  new->mode = cipher->mode;
 
   /* Add to list */
   if (silc_cipher_list == NULL)
     silc_cipher_list = silc_dlist_init();
   silc_dlist_add(silc_cipher_list, new);
 
-#endif /* SILC_EPOC */
+#endif /* SILC_SYMBIAN */
   return TRUE;
 }
 
-/* Unregister a cipher from the SILC. */
+/* Unregister a cipher */
 
 SilcBool silc_cipher_unregister(SilcCipherObject *cipher)
 {
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
   SilcCipherObject *entry;
 
   SILC_LOG_DEBUG(("Unregistering cipher"));
@@ -129,7 +136,7 @@ SilcBool silc_cipher_unregister(SilcCipherObject *cipher)
     return FALSE;
 
   silc_dlist_start(silc_cipher_list);
-  while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+  while ((entry = silc_dlist_get(silc_cipher_list))) {
     if (cipher == SILC_ALL_CIPHERS || entry == cipher) {
       silc_dlist_del(silc_cipher_list, entry);
       silc_free(entry->name);
@@ -144,41 +151,35 @@ SilcBool silc_cipher_unregister(SilcCipherObject *cipher)
     }
   }
 
-#endif /* SILC_EPOC */
+#endif /* SILC_SYMBIAN */
   return FALSE;
 }
 
-/* Function that registers all the default ciphers (all builtin ciphers).
-   The application may use this to register the default ciphers if specific
-   ciphers in any specific order is not wanted. */
+/* Register default ciphers */
 
 SilcBool silc_cipher_register_default(void)
 {
-#ifndef SILC_EPOC
-  int i;
-
-  for (i = 0; silc_default_ciphers[i].name; i++)
-    silc_cipher_register(&(silc_default_ciphers[i]));
-
-#endif /* SILC_EPOC */
+  /* We use builtin ciphers */
   return TRUE;
 }
 
+/* Unregister all ciphers */
+
 SilcBool silc_cipher_unregister_all(void)
 {
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
   SilcCipherObject *entry;
 
   if (!silc_cipher_list)
     return FALSE;
 
   silc_dlist_start(silc_cipher_list);
-  while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+  while ((entry = silc_dlist_get(silc_cipher_list))) {
     silc_cipher_unregister(entry);
     if (!silc_cipher_list)
       break;
   }
-#endif /* SILC_EPOC */
+#endif /* SILC_SYMBIAN */
   return TRUE;
 }
 
@@ -187,24 +188,26 @@ SilcBool silc_cipher_unregister_all(void)
    caller must set the key to the cipher after this function has returned
    by calling the ciphers set_key function. */
 
-SilcBool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher)
+SilcBool silc_cipher_alloc(const char *name, SilcCipher *new_cipher)
 {
   SilcCipherObject *entry = NULL;
+  int i;
 
   SILC_LOG_DEBUG(("Allocating new cipher object"));
 
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
+  /* First check registered list of ciphers */
   if (silc_cipher_list) {
     silc_dlist_start(silc_cipher_list);
-    while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+    while ((entry = silc_dlist_get(silc_cipher_list))) {
       if (!strcmp(entry->name, name))
        break;
     }
   }
-#else
-  {
-    /* On EPOC which don't have globals we check our constant cipher list. */
-    int i;
+#endif /* SILC_SYMBIAN */
+
+  if (!entry) {
+    /* Check builtin list of ciphers */
     for (i = 0; silc_default_ciphers[i].name; i++) {
       if (!strcmp(silc_default_ciphers[i].name, name)) {
        entry = (SilcCipherObject *)&(silc_default_ciphers[i]);
@@ -212,65 +215,107 @@ SilcBool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher)
       }
     }
   }
-#endif /* SILC_EPOC */
 
   if (entry) {
     *new_cipher = silc_calloc(1, sizeof(**new_cipher));
+    if (!(*new_cipher))
+      return FALSE;
     (*new_cipher)->cipher = entry;
-    (*new_cipher)->context = silc_calloc(1, entry->context_len());
+    (*new_cipher)->context = entry->init(entry);
+    if (!(*new_cipher)->context) {
+      silc_free(*new_cipher);
+      return FALSE;
+    }
+
     return TRUE;
   }
 
   return FALSE;
 }
 
+/* Allocate cipher */
+
+SilcBool silc_cipher_alloc_full(const char *alg_name, SilcUInt32 key_len,
+                                SilcCipherMode mode, SilcCipher *new_cipher)
+{
+  char name[64];
+  const char *mode_name;
+
+  switch (mode) {
+  case SILC_CIPHER_MODE_ECB:
+    mode_name = "ecb";
+    break;
+  case SILC_CIPHER_MODE_CBC:
+    mode_name = "cbc";
+    break;
+  case SILC_CIPHER_MODE_CTR:
+    mode_name = "ctr";
+    break;
+  case SILC_CIPHER_MODE_CFB:
+    mode_name = "cfb";
+    break;
+  case SILC_CIPHER_MODE_OFB:
+    mode_name = "ofb";
+    break;
+  default:
+    return FALSE;
+    break;
+  }
+
+  silc_snprintf(name, sizeof(name), "%s-%d-%s", alg_name, key_len, mode_name);
+
+  return silc_cipher_alloc(name, new_cipher);
+}
+
 /* Free's the given cipher. */
 
 void silc_cipher_free(SilcCipher cipher)
 {
   if (cipher) {
-    silc_free(cipher->context);
+    cipher->cipher->uninit(cipher->cipher, cipher->context);
+    memset(cipher, 0, sizeof(*cipher));
     silc_free(cipher);
   }
 }
 
 /* Returns TRUE if cipher `name' is supported. */
 
-SilcBool silc_cipher_is_supported(const unsigned char *name)
+SilcBool silc_cipher_is_supported(const char *name)
 {
-#ifndef SILC_EPOC
   SilcCipherObject *entry;
+  int i;
 
+#ifndef SILC_SYMBIAN
+  /* First check registered list of ciphers */
   if (silc_cipher_list) {
     silc_dlist_start(silc_cipher_list);
-    while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+    while ((entry = silc_dlist_get(silc_cipher_list))) {
       if (!strcmp(entry->name, name))
        return TRUE;
     }
   }
-#else
-  {
-    int i;
-    for (i = 0; silc_default_ciphers[i].name; i++)
-      if (!strcmp(silc_default_ciphers[i].name, name))
-       return TRUE;
-  }
-#endif /* SILC_EPOC */
+#endif /* SILC_SYMBIAN */
+
+  /* Check builtin list of ciphers */
+  for (i = 0; silc_default_ciphers[i].name; i++)
+    if (!strcmp(silc_default_ciphers[i].name, name))
+      return TRUE;
+
   return FALSE;
 }
 
 /* Returns comma separated list of supported ciphers. */
 
-char *silc_cipher_get_supported(void)
+char *silc_cipher_get_supported(SilcBool only_registered)
 {
-  SilcCipherObject *entry;
+  SilcCipherObject *entry, *entry2;
   char *list = NULL;
-  int len = 0;
+  int i, len = 0;
 
-#ifndef SILC_EPOC
+#ifndef SILC_SYMBIAN
   if (silc_cipher_list) {
     silc_dlist_start(silc_cipher_list);
-    while ((entry = silc_dlist_get(silc_cipher_list)) != SILC_LIST_END) {
+    while ((entry = silc_dlist_get(silc_cipher_list))) {
       len += strlen(entry->name);
       list = silc_realloc(list, len + 1);
 
@@ -280,11 +325,22 @@ char *silc_cipher_get_supported(void)
       len++;
     }
   }
-#else
-  {
-    int i;
+#endif /* SILC_SYMBIAN */
+
+  if (!only_registered || !silc_cipher_list) {
     for (i = 0; silc_default_ciphers[i].name; i++) {
       entry = (SilcCipherObject *)&(silc_default_ciphers[i]);
+
+      if (silc_cipher_list) {
+       silc_dlist_start(silc_cipher_list);
+       while ((entry2 = silc_dlist_get(silc_cipher_list))) {
+         if (!strcmp(entry2->name, entry->name))
+           break;
+       }
+       if (entry2)
+         continue;
+      }
+
       len += strlen(entry->name);
       list = silc_realloc(list, len + 1);
 
@@ -294,7 +350,6 @@ char *silc_cipher_get_supported(void)
       len++;
     }
   }
-#endif /* SILC_EPOC */
 
   list[len - 1] = 0;
 
@@ -307,12 +362,8 @@ SilcBool silc_cipher_encrypt(SilcCipher cipher, const unsigned char *src,
                             unsigned char *dst, SilcUInt32 len,
                             unsigned char *iv)
 {
-#ifdef SILC_DEBUG
-  assert((len & (cipher->cipher->block_len - 1)) == 0);
-#endif
-  if (len & (cipher->cipher->block_len - 1))
-    return FALSE;
-  return cipher->cipher->encrypt(cipher->context, src, dst, len,
+  return cipher->cipher->encrypt(cipher, cipher->cipher,
+                                cipher->context, src, dst, len,
                                 iv ? iv : cipher->iv);
 }
 
@@ -322,29 +373,27 @@ SilcBool silc_cipher_decrypt(SilcCipher cipher, const unsigned char *src,
                             unsigned char *dst, SilcUInt32 len,
                             unsigned char *iv)
 {
-#ifdef SILC_DEBUG
-  /*  assert((len & (cipher->cipher->block_len - 1)) == 0); */
-#endif
-  if (len & (cipher->cipher->block_len - 1))
-    return FALSE;
-  return cipher->cipher->decrypt(cipher->context, src, dst, len,
+  return cipher->cipher->decrypt(cipher, cipher->cipher,
+                                cipher->context, src, dst, len,
                                 iv ? iv : cipher->iv);
 }
 
 /* Sets the key for the cipher */
 
 SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
-                            SilcUInt32 keylen)
+                            SilcUInt32 keylen, SilcBool encryption)
 {
-  return cipher->cipher->set_key(cipher->context, key, keylen);
+  return cipher->cipher->set_key(cipher, cipher->cipher, cipher->context,
+                                (void *)key, keylen, encryption);
 }
 
 /* Sets the IV (initial vector) for the cipher. */
 
 void silc_cipher_set_iv(SilcCipher cipher, const unsigned char *iv)
 {
-  memset(&cipher->iv, 0, sizeof(cipher->iv));
-  memcpy(&cipher->iv, iv, cipher->cipher->block_len);
+  if (iv)
+    memmove(cipher->iv, iv, cipher->cipher->iv_len);
+  cipher->cipher->set_iv(cipher, cipher->cipher, cipher->context, cipher->iv);
 }
 
 /* Returns the IV (initial vector) of the cipher. */
@@ -368,9 +417,30 @@ SilcUInt32 silc_cipher_get_block_len(SilcCipher cipher)
   return cipher->cipher->block_len;
 }
 
+/* Returns the IV length of the cipher. */
+
+SilcUInt32 silc_cipher_get_iv_len(SilcCipher cipher)
+{
+  return cipher->cipher->iv_len;
+}
+
 /* Returns the name of the cipher */
 
 const char *silc_cipher_get_name(SilcCipher cipher)
 {
   return (const char *)cipher->cipher->name;
 }
+
+/* Returns the algorithm name of the cipher */
+
+const char *silc_cipher_get_alg_name(SilcCipher cipher)
+{
+  return (const char *)cipher->cipher->alg_name;
+}
+
+/* Returns cipher mode */
+
+SilcCipherMode silc_cipher_get_mode(SilcCipher cipher)
+{
+  return cipher->cipher->mode;
+}