X-Git-Url: http://git.silcnet.org/gitweb/?p=crypto.git;a=blobdiff_plain;f=lib%2Fsilccrypt%2Fsilchash.h;h=9f6602a494e8afd5c7fd250a7bb3e316857b0b59;hp=b076d55f110e1c71dda133d6ed4797f3f2bc4d32;hb=57af98efbd82c4c89c81850f42b02585fed1a16a;hpb=38d89c8cd04b2b9b7e487230420bbf21d26ac722 diff --git a/lib/silccrypt/silchash.h b/lib/silccrypt/silchash.h index b076d55f..9f6602a4 100644 --- a/lib/silccrypt/silchash.h +++ b/lib/silccrypt/silchash.h @@ -1,10 +1,10 @@ /* - silchash.h + silchash.h Author: Pekka Riikonen - Copyright (C) 1999 - 2002 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 @@ -31,10 +31,10 @@ * ***/ -/****s* silccrypt/SilcHashAPI/SilcHash +/****s* silccrypt/SilcHash * * NAME - * + * * typedef struct SilcHashStruct *SilcHash; * * DESCRIPTION @@ -47,31 +47,36 @@ ***/ typedef struct SilcHashStruct *SilcHash; -/****s* silccrypt/SilcHashAPI/SilcHashObject +/****d* silccrypt/Hashes * * NAME - * - * typedef struct { ... } SilcHashObject; + * + * Hash functions * * DESCRIPTION * - * This structure represents one hash function. The hash function's - * name, digest length and block length are defined in the structure. - * This structure is then given as argument to the silc_hash_register. - * That function is used to register all hash functions into SILC. - * They can be then allocated by the name found in this structure by - * calling the silc_hash_alloc. + * Supported hash function names. These names can be given as argument + * to silc_hash_alloc. * - ***/ + * SOURCE + */ +#define SILC_HASH_SHA256 "sha256" /* SHA-256 */ +#define SILC_HASH_SHA512 "sha512" /* SHA-512 */ +#define SILC_HASH_SHA1 "sha1" /* SHA-1 */ +#define SILC_HASH_MD5 "md5" /* MD5 */ +/***/ + +/* Hash implementation object */ typedef struct { char *name; - SilcUInt32 hash_len; - SilcUInt32 block_len; + char *oid; + SilcUInt16 hash_len; + SilcUInt16 block_len; void (*init)(void *); void (*update)(void *, const unsigned char *, SilcUInt32); void (*final)(void *, unsigned char *); - void (*transform)(SilcUInt32 *, const unsigned char *); + void (*transform)(void *, const unsigned char *); SilcUInt32 (*context_len)(); } SilcHashObject; @@ -82,97 +87,98 @@ typedef struct { /* Default hash functions for silc_hash_register_default(). */ extern DLLAPI const SilcHashObject silc_default_hash[]; -/* Default HASH function in the SILC protocol */ -#define SILC_DEFAULT_HASH "sha1" +/* Max hash length */ +#define SILC_HASH_MAXLEN 64 /* Macros */ /* Following macros are used to implement the SILC Hash API. These macros should be used instead of declaring functions by hand. */ -/* Function names in SILC Hash modules. The name of the hash function - is appended into these names and used to the get correct symbol out - of the module. All SILC Hash API compliant modules has to support - these names as function names (use macros below to assure this). */ -#define SILC_HASH_SIM_INIT "init" -#define SILC_HASH_SIM_UPDATE "update" -#define SILC_HASH_SIM_FINAL "final" -#define SILC_HASH_SIM_TRANSFORM "transform" -#define SILC_HASH_SIM_CONTEXT_LEN "context_len" - /* Macros that can be used to declare SILC Hash API functions. */ -#define SILC_HASH_API_INIT(hash) \ +#define SILC_HASH_API_INIT(hash) \ void silc_##hash##_init(void *context) #define SILC_HASH_API_UPDATE(hash) \ void silc_##hash##_update(void *context, const unsigned char *data, \ SilcUInt32 len) -#define SILC_HASH_API_FINAL(hash) \ +#define SILC_HASH_API_FINAL(hash) \ void silc_##hash##_final(void *context, unsigned char *digest) #define SILC_HASH_API_TRANSFORM(hash) \ -void silc_##hash##_transform(SilcUInt32 *state, const unsigned char *buffer) -#define SILC_HASH_API_CONTEXT_LEN(hash) \ +void silc_##hash##_transform(void *state, const unsigned char *buffer) +#define SILC_HASH_API_CONTEXT_LEN(hash) \ SilcUInt32 silc_##hash##_context_len() /* Prototypes */ -/****f* silccrypt/SilcHashAPI/silc_hash_register +/****f* silccrypt/silc_hash_register * * SYNOPSIS * - * bool silc_hash_register(const SilcHashObject *hash); + * SilcBool silc_hash_register(const SilcHashObject *hash); * * DESCRIPTION * - * Registers a new hash function into the SILC. This function is used - * at the initialization of the SILC. All registered hash functions - * should be unregistered with silc_hash_unregister. The `hash' includes - * the name of the hash function, digest length and block length. Usually - * this function is not called directly. Instead, application can call - * the silc_hash_register_default to register all default hash functions - * that are builtin the sources. Returns FALSE on error. + * Registers a new hash function into the SILC. This function can be + * used at the initialization. All registered hash functions should be + * unregistered with silc_hash_unregister. Returns FALSE on error. + * Usually this function is not needed. The default hash functions are + * automatically registered. This can be used to change the order of + * the registered hash functions by re-registering them in desired order, + * or add new hash functions. * ***/ -bool silc_hash_register(const SilcHashObject *hash); +SilcBool silc_hash_register(const SilcHashObject *hash); -/****f* silccrypt/SilcHashAPI/silc_hash_unregister +/****f* silccrypt/silc_hash_unregister * * SYNOPSIS * - * bool silc_hash_unregister(SilcHashObject *hash); + * SilcBool silc_hash_unregister(SilcHashObject *hash); * * DESCRIPTION * * Unregister a hash function from SILC by the SilcHashObject `hash'. - * This should be called for all registered hash functions. Returns - * FALSE on error. + * This should be called for all hash functions registered with + * silc_hash_register. Returns FALSE on error. * ***/ -bool silc_hash_unregister(SilcHashObject *hash); +SilcBool silc_hash_unregister(SilcHashObject *hash); -/****f* silccrypt/SilcHashAPI/silc_hash_register_default +/****f* silccrypt/silc_hash_register_default * * SYNOPSIS * - * bool silc_hash_register_default(void); + * SilcBool silc_hash_register_default(void); * * DESCRIPTION * - * Registers all default hash functions into the SILC. These are the - * hash functions that are builtin in the sources. See the list of - * default hash functions in the silchash.c source file. The application - * may use this to register default hash functions if specific hash - * function in any specific order is not wanted (application's - * configuration usually may decide the order of the registration, in - * which case this function should not be used). + * Registers all default hash functions into the SILC. Application + * need not call this directly. By calling silc_crypto_init this function + * is called. * ***/ -bool silc_hash_register_default(void); +SilcBool silc_hash_register_default(void); -/****f* silccrypt/SilcHashAPI/silc_hash_alloc +/****f* silccrypt/silc_hash_unregister_all * * SYNOPSIS * - * bool silc_hash_alloc(const unsigned char *name, SilcHash *new_hash); + * SilcBool silc_hash_unregister_all(void); + * + * DESCRIPTION + * + * Unregisters all registered hash functions. Application need not + * call this directly. By calling silc_crypto_uninit this function is + * called. + * + ***/ +SilcBool silc_hash_unregister_all(void); + +/****f* silccrypt/silc_hash_alloc + * + * SYNOPSIS + * + * SilcBool silc_hash_alloc(const char *name, SilcHash *new_hash); * * DESCRIPTION * @@ -181,9 +187,24 @@ bool silc_hash_register_default(void); * returns FALSE if such hash function does not exist. * ***/ -bool silc_hash_alloc(const unsigned char *name, SilcHash *new_hash); +SilcBool silc_hash_alloc(const char *name, SilcHash *new_hash); -/****f* silccrypt/SilcHashAPI/silc_hash_free +/****f* silccrypt/silc_hash_alloc_by_oid + * + * SYNOPSIS + * + * SilcBool silc_hash_alloc_by_oid(const char *oid, SilcHash *new_hash); + * + * DESCRIPTION + * + * Same as silc_hash_alloc but allocates the hash algorithm by the + * hash algorithm OID string indicated by `oid'. Returns FALSE if such + * hash function does not exist. + * + ***/ +SilcBool silc_hash_alloc_by_oid(const char *oid, SilcHash *new_hash); + +/****f* silccrypt/silc_hash_free * * SYNOPSIS * @@ -196,20 +217,20 @@ bool silc_hash_alloc(const unsigned char *name, SilcHash *new_hash); ***/ void silc_hash_free(SilcHash hash); -/****f* silccrypt/SilcHashAPI/silc_hash_is_supported +/****f* silccrypt/silc_hash_is_supported * * SYNOPSIS * - * bool silc_hash_is_supported(const unsigned char *name); + * SilcBool silc_hash_is_supported(const char *name); * * DESCRIPTION * * Returns TRUE if the hash function indicated by the `name' exists. * ***/ -bool silc_hash_is_supported(const unsigned char *name); +SilcBool silc_hash_is_supported(const char *name); -/****f* silccrypt/SilcHashAPI/silc_hash_get_supported +/****f* silccrypt/silc_hash_get_supported * * SYNOPSIS * @@ -225,7 +246,7 @@ bool silc_hash_is_supported(const unsigned char *name); ***/ char *silc_hash_get_supported(void); -/****f* silccrypt/SilcHashAPI/silc_hash_len +/****f* silccrypt/silc_hash_len * * SYNOPSIS * @@ -238,7 +259,7 @@ char *silc_hash_get_supported(void); ***/ SilcUInt32 silc_hash_len(SilcHash hash); -/****f* silccrypt/SilcHashAPI/silc_hash_block_len +/****f* silccrypt/silc_hash_block_len * * SYNOPSIS * @@ -251,7 +272,7 @@ SilcUInt32 silc_hash_len(SilcHash hash); ***/ SilcUInt32 silc_hash_block_len(SilcHash hash); -/****f* silccrypt/SilcHashAPI/silc_hash_get_name +/****f* silccrypt/silc_hash_get_name * * SYNOPSIS * @@ -264,7 +285,21 @@ SilcUInt32 silc_hash_block_len(SilcHash hash); ***/ const char *silc_hash_get_name(SilcHash hash); -/****f* silccrypt/SilcHashAPI/silc_hash_make +/****f* silccrypt/silc_hash_get_oid + * + * SYNOPSIS + * + * const char *silc_hash_get_name(SilcHash hash); + * + * DESCRIPTION + * + * Returns the hash OID string. Returns NULL if the hash doesn't have + * OID string. Use strlen() to get the OID string length. + * + ***/ +const char *silc_hash_get_oid(SilcHash hash); + +/****f* silccrypt/silc_hash_make * * SYNOPSIS * @@ -282,7 +317,7 @@ const char *silc_hash_get_name(SilcHash hash); void silc_hash_make(SilcHash hash, const unsigned char *data, SilcUInt32 len, unsigned char *return_hash); -/****f* silccrypt/SilcHashAPI/silc_hash_init +/****f* silccrypt/silc_hash_init * * SYNOPSIS * @@ -296,14 +331,14 @@ void silc_hash_make(SilcHash hash, const unsigned char *data, * put them into a buffer and compute the digest from the buffer by * calling the silc_hash_make, or you can use the silc_hash_init, * silc_hash_update and silc_hash_final to do the digest. This function - * prepares the allocated hash function context for this kind of digest + * prepares the allocated hash function context for this kind of digest * computation. To add the data to be used in the digest computation * call the silc_hash_update function. * ***/ void silc_hash_init(SilcHash hash); -/****f* silccrypt/SilcHashAPI/silc_hash_update +/****f* silccrypt/silc_hash_update * * SYNOPSIS * @@ -331,7 +366,7 @@ void silc_hash_init(SilcHash hash); void silc_hash_update(SilcHash hash, const unsigned char *data, SilcUInt32 data_len); -/****f* silccrypt/SilcHashAPI/silc_hash_final +/****f* silccrypt/silc_hash_final * * SYNOPSIS * @@ -348,11 +383,11 @@ void silc_hash_update(SilcHash hash, const unsigned char *data, ***/ void silc_hash_final(SilcHash hash, unsigned char *return_hash); -/****f* silccrypt/SilcHashAPI/silc_hash_transform +/****f* silccrypt/silc_hash_transform * * SYNOPSIS * - * void silc_hash_transform(SilcHash hash, SilcUInt32 *state, + * void silc_hash_transform(SilcHash hash, void *state, * const unsigned char *data); * * DESCRIPTION @@ -363,10 +398,10 @@ void silc_hash_final(SilcHash hash, unsigned char *return_hash); * known by the caller. Usually this function is not needed. * ***/ -void silc_hash_transform(SilcHash hash, SilcUInt32 *state, +void silc_hash_transform(SilcHash hash, void *state, const unsigned char *data); -/****f* silccrypt/SilcHashAPI/silc_hash_fingerprint +/****f* silccrypt/silc_hash_fingerprint * * SYNOPSIS * @@ -387,7 +422,7 @@ void silc_hash_transform(SilcHash hash, SilcUInt32 *state, char *silc_hash_fingerprint(SilcHash hash, const unsigned char *data, SilcUInt32 data_len); -/****f* silccrypt/SilcHashAPI/silc_hash_babbleprint +/****f* silccrypt/silc_hash_babbleprint * * SYNOPSIS * @@ -396,7 +431,7 @@ char *silc_hash_fingerprint(SilcHash hash, const unsigned char *data, * * DESCRIPTION * - * Utility function which can be used to create a textual bableprint + * Utility function which can be used to create a textual babbleprint * out of the data indicated by `data' of length of `data_len' bytes. * If `hash' is NULL then SHA1 hash function is used automatically. * The caller must free the returned string.