X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilccrypt%2Fsilccipher.h;h=e64e3149359fac4f2b20d11bbc4f4d209532cc9f;hb=9f20f0382b6229eca740925a73f96294f6dcedc6;hp=47f848e9b3589da509fc8fb223616528770d73e0;hpb=d804a9f387732767bc57c7bc89ac16ac78869f2f;p=crypto.git diff --git a/lib/silccrypt/silccipher.h b/lib/silccrypt/silccipher.h index 47f848e9..e64e3149 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 @@ -186,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: * @@ -211,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 * @@ -230,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 * @@ -301,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 * @@ -311,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 * @@ -396,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