commit cfea3ebd01932a23b9093153cf97d9d41b9a86cc
author Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com> Mon Jul 10 11:45:47 2017 +0200
committer Simon Butcher <simon.butcher@arm.com> Fri Jul 28 13:15:57 2017 +0100
tree 8581a8963739750c2a068d7f4349aea61ebd9c09
parent e23f7b312dab0f7a3cc547b3759bff1a7647ba6f

Update doc of return value of verify()

include/polarssl/x509_crt.h

diff --git a/include/polarssl/x509_crt.h b/include/polarssl/x509_crt.h
index eef7f3a..d534ad8 100644
--- a/include/polarssl/x509_crt.h
+++ b/include/polarssl/x509_crt.h
@@ -252,11 +252,13 @@
  * \param f_vrfy   verification function
  * \param p_vrfy   verification parameter
  *
- * \return         0 if successful or POLARSSL_ERR_X509_SIG_VERIFY_FAILED,
- *                 in which case *flags will have one or more BADCERT_XXX or
- *                 BADCRL_XXX flags set,
- *                 or another error in case of a fatal error encountered
- *                 during the verification process.
+ * \return         0 (and flags set to 0) if the chain was verified and valid,
+ *                 POLARSSL_ERR_X509_CERT_VERIFY_FAILED if the chain was verified
+ *                 but found to be invalid, in which case *flags will have one
+ *                 or more BADCERT_XXX or POLARSSL_X509_BADCRL_XXX
+ *                 flags set, or another error (and flags set to 0xffffffff)
+ *                 in case of a fatal error encountered during the
+ *                 verification process.
  */
 int x509_crt_verify( x509_crt *crt,
                      x509_crt *trust_ca,