Major restructuring of the internals of SILC Cipher API

[crypto.git] / lib / silccrypt / silccipher.h

diff --git a/lib/silccrypt/silccipher.h b/lib/silccrypt/silccipher.h
index b24a69697d987b682eb9e970385ed61d2903cf73..e64e3149359fac4f2b20d11bbc4f4d209532cc9f 100644 (file)
--- a/lib/silccrypt/silccipher.h
+++ b/lib/silccrypt/silccipher.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2007 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
@@ -95,6 +95,11 @@ typedef struct SilcCipherStruct *SilcCipher;
  *      The Electronic Codebook mode.  This mode does not provide sufficient
  *      security and should not be used.
  *
+ *    Each mode modifies the IV (initialization vector) of the cipher when
+ *    silc_cipher_encrypt or silc_cipher_decrypt is called.  The IV may be
+ *    set/reset by calling silc_cipher_set_iv and the current IV can be
+ *    retrieved by calling silc_cipher_get_iv.
+ *
  * SOURCE
  */
 typedef enum {
@@ -181,15 +186,15 @@ SilcBool silc_cipher_unregister_all(void);
  *
  * SYNOPSIS
  *
- *    SilcBool silc_cipher_alloc(const unsigned char *name,
+ *    SilcBool silc_cipher_alloc(const char *name,
  *                               SilcCipher *new_cipher);
  *
  * DESCRIPTION
  *
- *    Allocates a new SILC cipher object. Function returns 1 on succes and 0
- *    on error. The allocated cipher is returned in new_cipher argument. The
- *    caller must set the key to the cipher after this function has returned
- *    by calling the ciphers set_key function.
+ *    Allocates a new SILC cipher object. Function returns TRUE on succes 
+ *    and FALSE on error. The allocated cipher is returned in new_cipher
+ *    argument. The caller must set the key to the cipher after this
+ *    function has returned by calling the silc_cipher_set_key.
  *
  *    The following ciphers are supported:
  *
@@ -206,7 +211,24 @@ SilcBool silc_cipher_unregister_all(void);
  *    Notes about modes:
  *
  ***/
-SilcBool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher);
+SilcBool silc_cipher_alloc(const char *name, SilcCipher *new_cipher);
+
+/****f* silccrypt/SilcCipherAPI/silc_cipher_alloc
+ *
+ * SYNOPSIS
+ *
+ *    SilcBool silc_cipher_alloc_full(const char *alg_name,
+ *                                    SilcUInt32 key_len,
+ *                                    SilcCipherMode mode,
+ *                                    SilcCipher *new_cipher);
+ * DESCRIPTION
+ *
+ *    Same as silc_cipher_alloc but takes the cipher algorithm name,
+ *    key length and mode as separate arguments.  
+ *
+ ***/
+SilcBool silc_cipher_alloc_full(const char *alg_name, SilcUInt32 key_len,
+                               SilcCipherMode mode, SilcCipher *new_cipher);
 
 /****f* silccrypt/SilcCipherAPI/silc_cipher_free
  *
@@ -225,14 +247,14 @@ void silc_cipher_free(SilcCipher cipher);
  *
  * SYNOPSIS
  *
- * SilcBool silc_cipher_is_supported(const unsigned char *name);
+ * SilcBool silc_cipher_is_supported(const char *name);
  *
  * DESCRIPTION
  *
  *    Returns TRUE if cipher `name' is supported.
  *
  ***/
-SilcBool silc_cipher_is_supported(const unsigned char *name);
+SilcBool silc_cipher_is_supported(const char *name);
 
 /****f* silccrypt/SilcCipherAPI/silc_cipher_get_supported
  *
@@ -296,7 +318,7 @@ SilcBool silc_cipher_decrypt(SilcCipher cipher, const unsigned char *src,
  * SYNOPSIS
  *
  *    SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
- *                                 SilcUInt32 keylen, SilcBool encryption);
+ *                                 SilcUInt32 bit_keylen, SilcBool encryption);
  *
  * DESCRIPTION
  *
@@ -306,7 +328,7 @@ SilcBool silc_cipher_decrypt(SilcCipher cipher, const unsigned char *src,
  *
  ***/
 SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
-                            SilcUInt32 keylen, SilcBool encryption);
+                            SilcUInt32 bit_keylen, SilcBool encryption);
 
 /****f* silccrypt/SilcCipherAPI/silc_cipher_set_iv
  *
@@ -316,13 +338,16 @@ SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
  *
  * DESCRIPTION
  *
- *    Sets the IV (initial vector) for the cipher.  The `iv' must be
+ *    Sets the IV (initialization vector) for the cipher.  The `iv' must be
  *    the size of the block size of the cipher.  If `iv' is NULL this
  *    does not do anything.
  *
  *    If the encryption mode is CTR (Counter mode) this also resets the
  *    the counter for a new block.  This is done also if `iv' is NULL.
  *
+ *    If the encryption mode is CFB (cipher feedback) this also resets the
+ *    the feedback stream for a new block.  This is done also if `iv' is NULL.
+ *
  ***/
 void silc_cipher_set_iv(SilcCipher cipher, const unsigned char *iv);
 
@@ -388,11 +413,24 @@ SilcUInt32 silc_cipher_get_iv_len(SilcCipher cipher);
  *
  * DESCRIPTION
  *
- *    Returns the name of the cipher.
+ *    Returns the full name of the cipher (eg. 'aes-256-ctr').
  *
  ***/
 const char *silc_cipher_get_name(SilcCipher cipher);
 
+/****f* silccrypt/SilcCipherAPI/silc_cipher_get_alg_name
+ *
+ * SYNOPSIS
+ *
+ *    const char *silc_cipher_get_alg_name(SilcCipher cipher);
+ *
+ * DESCRIPTION
+ *
+ *    Returns the algorithm name of the cipher (eg. 'aes').
+ *
+ ***/
+const char *silc_cipher_get_alg_name(SilcCipher cipher);
+
 /****f* silccrypt/SilcCipherAPI/silc_cipher_get_mode
  *
  * SYNOPSIS