X-Git-Url: http://git.silcnet.org/gitweb/?p=crypto.git;a=blobdiff_plain;f=lib%2Fsilccrypt%2Fsilccipher.h;h=d86de0ebb82becae19e663af2b6b49f58d05637d;hp=3afede61ea8c486e5a4175c601005046d3149d87;hb=57af98efbd82c4c89c81850f42b02585fed1a16a;hpb=fb1e58b1bc106212a845da866d0d4e9433c3ae22 diff --git a/lib/silccrypt/silccipher.h b/lib/silccrypt/silccipher.h index 3afede61..d86de0eb 100644 --- a/lib/silccrypt/silccipher.h +++ b/lib/silccrypt/silccipher.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - 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 @@ -17,9 +17,6 @@ */ -#ifndef SILCCIPHER_H -#define SILCCIPHER_H - /****h* silccrypt/SILC Cipher Interface * * DESCRIPTION @@ -30,11 +27,17 @@ * ***/ -/****s* silccrypt/SilcCipherAPI/SilcCipher +#ifndef SILCCIPHER_H +#define SILCCIPHER_H + +/* Forward declarations */ +typedef struct SilcCipherObjectStruct SilcCipherObject; + +/****s* silccrypt/SilcCipher * * NAME * - * typedef struct { ... } SilcCipher; + * typedef struct SilcCipherStruct *SilcCipher; * * DESCRIPTION * @@ -46,71 +49,103 @@ ***/ typedef struct SilcCipherStruct *SilcCipher; -/* The default SILC Cipher object to represent any cipher in SILC. */ -typedef struct { - char *name; - SilcBool (*set_key)(void *, const unsigned char *, SilcUInt32, SilcBool); - void (*set_iv)(void *, const unsigned char *); - SilcBool (*encrypt)(void *, const unsigned char *, unsigned char *, - SilcUInt32, unsigned char *); - SilcBool (*decrypt)(void *, const unsigned char *, unsigned char *, - SilcUInt32, unsigned char *); - SilcUInt32 (*context_len)(); - unsigned int key_len : 10; - unsigned int block_len : 8; - unsigned int iv_len : 8; - unsigned int mode : 6; -} SilcCipherObject; - -#define SILC_CIPHER_MAX_IV_SIZE 16 +/****d* silccrypt/Ciphers + * + * NAME + * + * Ciphers + * + * DESCRIPTION + * + * Supported ciphers names. These names can be given as argument + * to silc_cipher_alloc. + * + * SOURCE + */ -/* Marks for all ciphers in silc. This can be used in silc_cipher_unregister - to unregister all ciphers at once. */ -#define SILC_ALL_CIPHERS ((SilcCipherObject *)1) +/* AES in CTR mode, in different key lengths */ +#define SILC_CIPHER_AES_256_CTR "aes-256-ctr" +#define SILC_CIPHER_AES_192_CTR "aes-192-ctr" +#define SILC_CIPHER_AES_128_CTR "aes-128-ctr" + +/* AES in CBC mode, in different key lengths */ +#define SILC_CIPHER_AES_256_CBC "aes-256-cbc" +#define SILC_CIPHER_AES_192_CBC "aes-192-cbc" +#define SILC_CIPHER_AES_128_CBC "aes-128-cbc" + +/* AES in CFB mode, in different key lengths */ +#define SILC_CIPHER_AES_256_CFB "aes-256-cfb" +#define SILC_CIPHER_AES_192_CFB "aes-192-cfb" +#define SILC_CIPHER_AES_128_CFB "aes-128-cfb" + +/* AES in ECB mode, in different key lengths */ +#define SILC_CIPHER_AES_256_ECB "aes-256-ecb" +#define SILC_CIPHER_AES_192_ECB "aes-192-ecb" +#define SILC_CIPHER_AES_128_ECB "aes-128-ecb" + +/* Twofish in CTR mode, in different key lengths */ +#define SILC_CIPHER_TWOFISH_256_CTR "twofish-256-ctr" +#define SILC_CIPHER_TWOFISH_192_CTR "twofish-192-ctr" +#define SILC_CIPHER_TWOFISH_128_CTR "twofish-128-ctr" + +/* Twofish in CBC mode, in different key lengths */ +#define SILC_CIPHER_TWOFISH_256_CBC "twofish-256-cbc" +#define SILC_CIPHER_TWOFISH_192_CBC "twofish-192-cbc" +#define SILC_CIPHER_TWOFISH_128_CBC "twofish-128-cbc" + +/* Twofish in CFB mode, in different key lengths */ +#define SILC_CIPHER_TWOFISH_256_CFB "twofish-256-cfb" +#define SILC_CIPHER_TWOFISH_192_CFB "twofish-192-cfb" +#define SILC_CIPHER_TWOFISH_128_CFB "twofish-128-cfb" + +/* Twofish in ECB mode, in different key lengths */ +#define SILC_CIPHER_TWOFISH_256_ECB "twofish-256-ecb" +#define SILC_CIPHER_TWOFISH_192_ECB "twofish-192-ecb" +#define SILC_CIPHER_TWOFISH_128_ECB "twofish-128-ecb" + +/* CAST-128 in CTR, CBC, CFB, ECB modes, 128-bit key length */ +#define SILC_CIPHER_CAST5_128_CTR "cast5-128-ctr" +#define SILC_CIPHER_CAST5_128_CBC "cast5-128-cbc" +#define SILC_CIPHER_CAST5_128_CFB "cast5-128-cfb" +#define SILC_CIPHER_CAST5_128_ECB "cast5-128-ecb" + +/* DES in CTR, CBC, CFB, ECB modes, 56-bit key length */ +#define SILC_CIPHER_DES_56_CTR "des-56-ctr" +#define SILC_CIPHER_DES_56_CBC "des-56-cbc" +#define SILC_CIPHER_DES_56_CFB "des-56-cfb" +#define SILC_CIPHER_DES_56_ECB "des-56-ecb" + +/* 3DES in CTR, CBC, CFB, ECB modes, 168-bit (192-bit) key length */ +#define SILC_CIPHER_3DES_168_CTR "3des-168-ctr" +#define SILC_CIPHER_3DES_168_CBC "3des-168-cbc" +#define SILC_CIPHER_3DES_168_CFB "3des-168-cfb" +#define SILC_CIPHER_3DES_168_ECB "3des-168-ecb" + +/* No encryption */ +#define SILC_CIPHER_NONE "none" +/***/ -/* Static list of ciphers for silc_cipher_register_default(). */ -extern DLLAPI const SilcCipherObject silc_default_ciphers[]; +/****d* silccrypt/Cipher Algorithms + * + * NAME + * + * Cipher Algorithms + * + * DESCRIPTION + * + * Supported cipher algorithm names. These names can be give as argument + * to silc_cipher_alloc_full. + * + * SOURCE + */ +#define SILC_CIPHER_AES "aes" /* AES */ +#define SILC_CIPHER_TWOFISH "twofish" /* Twofish */ +#define SILC_CIPHER_CAST5 "cast5" /* CAST-128 */ +#define SILC_CIPHER_DES "des" /* DES */ +#define SILC_CIPHER_3DES "3des" /* Triple-DES */ +/***/ -/* Default cipher in the SILC protocol */ -#define SILC_DEFAULT_CIPHER "aes-256-cbc" - -/* Macros */ - -/* Function names in SILC Crypto modules. The name of the cipher - is appended into these names and used to the get correct symbol out - of the module. All SILC Crypto API compliant modules must support - these function names (use macros below to assure this). */ -#define SILC_CIPHER_SIM_SET_KEY "set_key" -#define SILC_CIPHER_SIM_ENCRYPT "encrypt" -#define SILC_CIPHER_SIM_DECRYPT "decrypt" -#define SILC_CIPHER_SIM_CONTEXT_LEN "context_len" - -/* These macros can be used to implement the SILC Crypto API and to avoid - errors in the API these macros should be used always. */ -#define SILC_CIPHER_API_SET_KEY(cipher) \ -SilcBool silc_##cipher##_set_key(void *context, \ - const unsigned char *key, \ - SilcUInt32 keylen, \ - SilcBool encryption) -#define SILC_CIPHER_API_SET_IV(cipher) \ -void silc_##cipher##_set_iv(void *context, \ - const unsigned char *iv) -#define SILC_CIPHER_API_ENCRYPT(cipher) \ -SilcBool silc_##cipher##_encrypt(void *context, \ - const unsigned char *src, \ - unsigned char *dst, \ - SilcUInt32 len, \ - unsigned char *iv) -#define SILC_CIPHER_API_DECRYPT(cipher) \ -SilcBool silc_##cipher##_decrypt(void *context, \ - const unsigned char *src, \ - unsigned char *dst, \ - SilcUInt32 len, \ - unsigned char *iv) -#define SILC_CIPHER_API_CONTEXT_LEN(cipher) \ -SilcUInt32 silc_##cipher##_context_len() - -/****d* silccrypt/SilcCipherAPI/SilcCipherMode +/****d* silccrypt/SilcCipherMode * * NAME * @@ -118,7 +153,47 @@ SilcUInt32 silc_##cipher##_context_len() * * DESCRIPTION * - * Cipher modes. + * Cipher modes. Notes about cipher modes and implementation: + * + * SILC_CIPHER_MODE_CBC + * + * The Cipher-block Chaining mode. The plaintext length must be + * multiple by the cipher block size. If it isn't the plaintext must + * be padded. + * + * SILC_CIPHER_MODE_CTR + * + * The Counter mode. The CTR mode does not require the plaintext length + * to be multiple by the cipher block size. If the last plaintext block + * is shorter the remaining bits of the key stream are used next time + * silc_cipher_encrypt is called. If silc_cipher_set_iv is called it + * will reset the counter for a new block (discarding any remaining + * bits from previous key stream). The CTR mode expects MSB first + * ordered counter. Note also, the counter is incremented when + * silc_cipher_encrypt is called for the first time, before encrypting. + * + * SILC_CIPHER_MODE_CFB + * + * The Cipher Feedback mode. The CFB mode does not require the plaintext + * length to be multiple by the cipher block size. If the last plaintext + * block is shorter the remaining bits of the stream are used next time + * silc_cipher_encrypt is called. If silc_cipher_set_iv is called it + * will reset the feedback for a new block (discarding any remaining + * bits from previous stream). + * + * SILC_CIPHER_MODE_OFB + * + * The Output Feedback mode. + * + * SILC_CIPHER_MODE_ECB + * + * The Electronic Codebook mode. This mode does not provide sufficient + * security and should not be used alone. + * + * Each mode using and IV (initialization vector) modifies the IV 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 */ @@ -131,9 +206,20 @@ typedef enum { } SilcCipherMode; /***/ +#define SILC_CIPHER_MAX_IV_SIZE 16 /* Maximum IV size */ + +/* Marks for all ciphers in silc. This can be used in silc_cipher_unregister + to unregister all ciphers at once. */ +#define SILC_ALL_CIPHERS ((SilcCipherObject *)1) + +#include "silccipher_i.h" + +/* Static list of ciphers for silc_cipher_register_default(). */ +extern DLLAPI const SilcCipherObject silc_default_ciphers[]; + /* Prototypes */ -/****f* silccrypt/SilcCipherAPI/silc_cipher_register +/****f* silccrypt/silc_cipher_register * * SYNOPSIS * @@ -141,15 +227,16 @@ typedef enum { * * DESCRIPTION * - * 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 a new cipher into SILC. This can be used at the initialization + * of an applicatio. Usually this function is not needed. The default + * ciphers are automatically registered. This can be used to change the + * order of the registered ciphers by re-registering them in desired order, + * or add new ciphers. * ***/ SilcBool silc_cipher_register(const SilcCipherObject *cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_unregister +/****f* silccrypt/silc_cipher_unregister * * SYNOPSIS * @@ -162,7 +249,7 @@ SilcBool silc_cipher_register(const SilcCipherObject *cipher); ***/ SilcBool silc_cipher_unregister(SilcCipherObject *cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_register_default +/****f* silccrypt/silc_cipher_register_default * * SYNOPSIS * @@ -171,13 +258,13 @@ SilcBool silc_cipher_unregister(SilcCipherObject *cipher); * DESCRIPTION * * 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. + * Application need not call this directly. By calling silc_crypto_init + * this function is called. * ***/ SilcBool silc_cipher_register_default(void); -/****f* silccrypt/SilcCipherAPI/silc_cipher_unregister_all +/****f* silccrypt/silc_cipher_unregister_all * * SYNOPSIS * @@ -185,54 +272,47 @@ SilcBool silc_cipher_register_default(void); * * DESCRIPTION * - * Unregisters all ciphers. + * Unregisters all ciphers. Application need not call this directly. + * By calling silc_crypto_init this function is called. * ***/ SilcBool silc_cipher_unregister_all(void); -/****f* silccrypt/SilcCipherAPI/silc_cipher_alloc +/****f* silccrypt/silc_cipher_alloc * * 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. - * - * The following ciphers are supported: + * 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. * - * aes-256-ctr AES-256, Counter mode - * aes-192-ctr AES-192, Counter mode - * aes-128-ctr AES,128, Counter mode - * aes-256-cbc AES-256, Cipher block chaining mode - * aes-192-cbc AES-192, Cipher block chaining mode - * aes-128-cbc AES,128, Cipher block chaining mode - * twofish-256-cbc Twofish-256, Cipher block chaining mode - * twofish-192-cbc Twofish-192, Cipher block chaining mode - * twofish-128-cbc Twofish-128, Cipher block chaining mode + ***/ +SilcBool silc_cipher_alloc(const char *name, SilcCipher *new_cipher); + +/****f* silccrypt/silc_cipher_alloc * - * Notes about modes: + * SYNOPSIS * - * The CTR is normal counter mode. The CTR mode does not require the - * plaintext length to be multiple by the cipher block size. If the last - * plaintext block is shorter the remaining bits of the key stream are - * used next time silc_cipher_encrypt is called. If silc_cipher_set_iv - * is called it will reset the counter for a new block (discarding any - * remaining bits from previous key stream). + * SilcBool silc_cipher_alloc_full(const char *alg_name, + * SilcUInt32 key_len, + * SilcCipherMode mode, + * SilcCipher *new_cipher); + * DESCRIPTION * - * The CBC is mode is a standard CBC mode. The plaintext length must be - * multiple by the cipher block size. If it isn't the plaintext must be - * padded. + * Same as silc_cipher_alloc but takes the cipher algorithm name, + * key length and mode as separate arguments. * ***/ -SilcBool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher); +SilcBool silc_cipher_alloc_full(const char *alg_name, SilcUInt32 key_len, + SilcCipherMode mode, SilcCipher *new_cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_free +/****f* silccrypt/silc_cipher_free * * SYNOPSIS * @@ -245,33 +325,37 @@ SilcBool silc_cipher_alloc(const unsigned char *name, SilcCipher *new_cipher); ***/ void silc_cipher_free(SilcCipher cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_is_supported +/****f* silccrypt/silc_cipher_is_supported * * 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 +/****f* silccrypt/silc_cipher_get_supported * * SYNOPSIS * - * char *silc_cipher_get_supported(void); + * char *silc_cipher_get_supported(SilcBool only_registered); * * DESCRIPTION * - * Returns comma separated list of supported ciphers. + * Returns comma separated list of supported ciphers. If `only_registered' + * is TRUE only ciphers explicitly registered with silc_cipher_register + * are returned. If FALSE, then all registered and default builtin + * ciphers are returned. However, if there are no registered ciphers + * and `only_registered' is TRUE, the builtin ciphers are returned. * ***/ -char *silc_cipher_get_supported(void); +char *silc_cipher_get_supported(SilcBool only_registered); -/****f* silccrypt/SilcCipherAPI/silc_cipher_encrypt +/****f* silccrypt/silc_cipher_encrypt * * SYNOPSIS * @@ -291,7 +375,7 @@ SilcBool silc_cipher_encrypt(SilcCipher cipher, const unsigned char *src, unsigned char *dst, SilcUInt32 len, unsigned char *iv); -/****f* silccrypt/SilcCipherAPI/silc_cipher_decrypt +/****f* silccrypt/silc_cipher_decrypt * * SYNOPSIS * @@ -311,12 +395,12 @@ SilcBool silc_cipher_decrypt(SilcCipher cipher, const unsigned char *src, unsigned char *dst, SilcUInt32 len, unsigned char *iv); -/****f* silccrypt/SilcCipherAPI/silc_cipher_set_key +/****f* silccrypt/silc_cipher_set_key * * SYNOPSIS * * SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key, - * SilcUInt32 keylen, SilcBool encryption); + * SilcUInt32 bit_keylen, SilcBool encryption); * * DESCRIPTION * @@ -326,9 +410,9 @@ 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 +/****f* silccrypt/silc_cipher_set_iv * * SYNOPSIS * @@ -336,17 +420,20 @@ 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); -/****f* silccrypt/SilcCipherAPI/silc_cipher_get_iv +/****f* silccrypt/silc_cipher_get_iv * * SYNOPSIS * @@ -361,7 +448,7 @@ void silc_cipher_set_iv(SilcCipher cipher, const unsigned char *iv); ***/ unsigned char *silc_cipher_get_iv(SilcCipher cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_get_key_len +/****f* silccrypt/silc_cipher_get_key_len * * SYNOPSIS * @@ -374,7 +461,7 @@ unsigned char *silc_cipher_get_iv(SilcCipher cipher); ***/ SilcUInt32 silc_cipher_get_key_len(SilcCipher cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_get_block_len +/****f* silccrypt/silc_cipher_get_block_len * * SYNOPSIS * @@ -387,7 +474,7 @@ SilcUInt32 silc_cipher_get_key_len(SilcCipher cipher); ***/ SilcUInt32 silc_cipher_get_block_len(SilcCipher cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_get_iv_len +/****f* silccrypt/silc_cipher_get_iv_len * * SYNOPSIS * @@ -400,7 +487,7 @@ SilcUInt32 silc_cipher_get_block_len(SilcCipher cipher); ***/ SilcUInt32 silc_cipher_get_iv_len(SilcCipher cipher); -/****f* silccrypt/SilcCipherAPI/silc_cipher_get_name +/****f* silccrypt/silc_cipher_get_name * * SYNOPSIS * @@ -408,12 +495,25 @@ 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_mode +/****f* silccrypt/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/silc_cipher_get_mode * * SYNOPSIS *