Added SILC Thread Queue API

[silc.git] / lib / silccrypt / silcpkcs.h

diff --git a/lib/silccrypt/silcpkcs.h b/lib/silccrypt/silcpkcs.h
index fa3230eea55b9671f183c36ca16b5d6933e5ff6a..2fd34f7490650fb731eda7c30007401524b1f626 100644 (file)
--- a/lib/silccrypt/silcpkcs.h
+++ b/lib/silccrypt/silcpkcs.h
@@ -469,7 +469,9 @@ SilcBool silc_pkcs_public_key_alloc(SilcPKCSType type,
  *
  * DESCRIPTION
  *
- *    Frees the public key.
+ *    Frees the public key.  This will also automatically free the underlaying
+ *    PKCS specific public key.  All public keys allocated through the
+ *    PKCS API must be freed by calling this function.
  *
  ***/
 void silc_pkcs_public_key_free(SilcPublicKey public_key);
@@ -580,7 +582,9 @@ SilcUInt32 silc_pkcs_private_key_get_len(SilcPrivateKey private_key);
  *
  * DESCRIPTION
  *
- *    Frees the private key.
+ *    Frees the public key.  This will also automatically free the underlaying
+ *    PKCS specific private key.  All private keys allocated through the
+ *    PKCS API must be freed by calling this function.
  *
  ***/
 void silc_pkcs_private_key_free(SilcPrivateKey private_key);
@@ -675,7 +679,6 @@ SilcAsyncOperation silc_pkcs_sign(SilcPrivateKey private_key,
  *                                        unsigned char *data,
  *                                        SilcUInt32 data_len,
  *                                        SilcHash hash,
- *                                        SilcRng rng,
  *                                        SilcPKCSVerifyCb verify_cb,
  *                                        void *context);
  *
@@ -687,9 +690,8 @@ SilcAsyncOperation silc_pkcs_sign(SilcPrivateKey private_key,
  *    before verification.  If the `hash' is NULL, then the hash algorithm
  *    to be used is retrieved from the signature.  If it isn't present in the
  *    signature the verification is done as is without hashing.  The `rng'
- *    is usually not needed, however some algorithms might need it so it is
- *    wise to provide it.  If this returns NULL the asynchronous operation
- *    cannot be controlled.
+ *    is usually not needed and may be NULL.  If this returns NULL the
+ *    asynchronous operation cannot be controlled.
  *
  ***/
 SilcAsyncOperation silc_pkcs_verify(SilcPublicKey public_key,
@@ -698,7 +700,6 @@ SilcAsyncOperation silc_pkcs_verify(SilcPublicKey public_key,
                                    unsigned char *data,
                                    SilcUInt32 data_len,
                                    SilcHash hash,
-                                   SilcRng rng,
                                    SilcPKCSVerifyCb verify_cb,
                                    void *context);