X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilccrypt%2Fsilcrng.h;h=bf32fd8fcac2e9d9802613331b7559f03e86e49c;hb=e7b6c157b80152bf9fb9266e6bdd93f9fb0db776;hp=7dbdcbf6a692655716b955db638ccb8893e36823;hpb=595427b2acb6044721844ae651f5bbd204643b12;p=silc.git diff --git a/lib/silccrypt/silcrng.h b/lib/silccrypt/silcrng.h index 7dbdcbf6..bf32fd8f 100644 --- a/lib/silccrypt/silcrng.h +++ b/lib/silccrypt/silcrng.h @@ -1,10 +1,10 @@ /* - silcrng.h + silcrng.h Author: Pekka Riikonen - Copyright (C) 1997 - 2002 Pekka Riikonen + Copyright (C) 1997 - 2007 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 @@ -39,7 +39,7 @@ /****s* silccrypt/SilcRNGAPI/SilcRng * * NAME - * + * * typedef struct SilcRngStruct *SilcRng; * * DESCRIPTION @@ -174,7 +174,8 @@ SilcUInt32 silc_rng_get_rn32(SilcRng rng); * DESCRIPTION * * Returns random string in HEX form of the length of `len' bytes. - * The caller must free returned data buffer. + * The caller must free returned data buffer. It is guaranteed the + * data string goes not include any zero (0x00) bytes. * ***/ unsigned char *silc_rng_get_rn_string(SilcRng rng, SilcUInt32 len); @@ -183,15 +184,18 @@ unsigned char *silc_rng_get_rn_string(SilcRng rng, SilcUInt32 len); * * SYNOPSIS * - * unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len); + * SilcBool silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len, + * unsigned char *buf, SilcUInt32 buf_size); * * DESCRIPTION * - * Returns random binary data of the length of `len' bytes. The - * caller must free returned data buffer. + * Returns random binary data of the length of `len' bytes to the `buf' + * of maximum size of `buf_size'. It is guaranteed the data buffer does + * not include any zero (0x00) bytes. * ***/ -unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len); +SilcBool silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len, + unsigned char *buf, SilcUInt32 buf_size); /****f* silccrypt/SilcRNGAPI/silc_rng_add_noise * @@ -201,7 +205,7 @@ unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len); * * DESCRIPTION * - * Add the data buffer indicated by `buffer' of length of `len' bytes + * Add the data buffer indicated by `buffer' of length of `len' bytes * as noise to the random number generator. The random number generator * is restirred (reseeded) when this function is called. * @@ -212,7 +216,7 @@ void silc_rng_add_noise(SilcRng rng, unsigned char *buffer, SilcUInt32 len); * * SYNOPSIS * - * bool silc_rng_global_init(SilcRng rng); + * SilcBool silc_rng_global_init(SilcRng rng); * * DESCRIPTION * @@ -232,13 +236,13 @@ void silc_rng_add_noise(SilcRng rng, unsigned char *buffer, SilcUInt32 len); * the RNG as argument. * ***/ -bool silc_rng_global_init(SilcRng rng); +SilcBool silc_rng_global_init(SilcRng rng); /****f* silccrypt/SilcRNGAPI/silc_rng_global_uninit * * SYNOPSIS * - * bool silc_rng_global_uninit(void); + * SilcBool silc_rng_global_uninit(void); * * DESCRIPTION * @@ -246,7 +250,7 @@ bool silc_rng_global_init(SilcRng rng); * be called if silc_rng_global_init was called with non-NULL RNG. * ***/ -bool silc_rng_global_uninit(void); +SilcBool silc_rng_global_uninit(void); /****f* silccrypt/SilcRNGAPI/silc_rng_global_get_byte * @@ -317,7 +321,8 @@ SilcUInt32 silc_rng_global_get_rn32(void); * DESCRIPTION * * Returns random string in HEX form of the length of `len' bytes. - * The caller must free returned data buffer. + * The caller must free returned data buffer. It is guaranteed the + * data string goes not include any zero (0x00) bytes. * ***/ unsigned char *silc_rng_global_get_rn_string(SilcUInt32 len); @@ -326,15 +331,19 @@ unsigned char *silc_rng_global_get_rn_string(SilcUInt32 len); * * SYNOPSIS * - * unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len); + * SilcBool silc_rng_global_get_rn_data(SilcRng rng, SilcUInt32 len, + * unsigned char *buf, + * SilcUInt32 buf_size); * * DESCRIPTION * - * Returns random binary data of the length of `len' bytes. The - * caller must free returned data buffer. + * Returns random binary data of the length of `len' bytes to the `buf' + * of maximum size of `buf_size'. It is guaranteed the data buffer does + * not include any zero (0x00) bytes. * ***/ -unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len); +SilcBool silc_rng_global_get_rn_data(SilcRng rng, SilcUInt32 len, + unsigned char *buf, SilcUInt32 buf_size); /****f* silccrypt/SilcRNGAPI/silc_rng_global_add_noise * @@ -344,7 +353,7 @@ unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len); * * DESCRIPTION * - * Add the data buffer indicated by `buffer' of length of `len' bytes + * Add the data buffer indicated by `buffer' of length of `len' bytes * as noise to the random number generator. The random number generator * is restirred (reseeded) when this function is called. *