]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
corrected the documentation of the verification functions.
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Sat, 17 Mar 2012 08:24:00 +0000 (09:24 +0100)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Sat, 17 Mar 2012 08:24:00 +0000 (09:24 +0100)
lib/gnutls_pubkey.c
lib/x509/crq.c
lib/x509/x509.c

index ba0c2c4e051a8b162a999fbd9e16755dfae43d42..d66a531a8353d4f434c269d2814b2230c04febfc 100644 (file)
@@ -1304,8 +1304,8 @@ gnutls_pubkey_import_dsa_raw (gnutls_pubkey_t key,
  * This function will verify the given signed data, using the
  * parameters from the certificate.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
- *   negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure).
+ * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
+ * is returned, and zero or positive code on success.
  *
  * Since: 2.12.0
  **/
@@ -1343,8 +1343,8 @@ gnutls_pubkey_verify_data (gnutls_pubkey_t pubkey, unsigned int flags,
  * This function will verify the given signed data, using the
  * parameters from the certificate.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
- *   negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure).
+ * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
+ * is returned, and zero or positive code on success.
  *
  * Since: 3.0
  **/
@@ -1384,8 +1384,8 @@ gnutls_pubkey_verify_data2 (gnutls_pubkey_t pubkey,
  * This function will verify the given signed digest, using the
  * parameters from the public key.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
- *   negative error value (%GNUTLS_E_PK_SIG_VERIFY_FAILED in verification failure).
+ * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
+ * is returned, and zero or positive code on success.
  *
  * Since: 2.12.0
  **/
index e21341ebba514220473a693db051d739e9712647..4873d69087318b6ebf13ecccbd576645ccb22531 100644 (file)
@@ -2422,9 +2422,8 @@ gnutls_x509_crq_privkey_sign (gnutls_x509_crq_t crq, gnutls_privkey_t key,
  * This function will verify self signature in the certificate
  * request and return its status.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned,
- * %GNUTLS_E_PK_SIG_VERIFY_FAILED if verification failed, otherwise a
- * negative error value.
+ * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
+ * is returned, and zero or positive code on success.
  *
  * Since 2.12.0
  **/
index d98a2b6529fe192c263850d2a094c6069b5fc5a4..fc36e89192886b486527cdacad3d05c1be6a5a52 100644 (file)
@@ -2585,7 +2585,7 @@ gnutls_x509_crt_get_preferred_hash_algorithm (gnutls_x509_crt_t crt,
  * Deprecated. Please use gnutls_pubkey_verify_data().
  *
  * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
- * is returned, and a positive code on success.
+ * is returned, and zero or positive code on success.
  **/
 int
 gnutls_x509_crt_verify_data (gnutls_x509_crt_t crt, unsigned int flags,
@@ -2623,7 +2623,7 @@ gnutls_x509_crt_verify_data (gnutls_x509_crt_t crt, unsigned int flags,
  * Deprecated. Please use gnutls_pubkey_verify_data().
  *
  * Returns: In case of a verification failure %GNUTLS_E_PK_SIG_VERIFY_FAILED 
- * is returned, and a positive code on success.
+ * is returned, and zero or positive code on success.
  **/
 int
 gnutls_x509_crt_verify_hash (gnutls_x509_crt_t crt, unsigned int flags,