summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2012-11-06 21:36:35 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2012-11-06 21:36:35 +0100
commit3f34f7ee180c4c20411daa1678a50c033011829d (patch)
tree1bb998cf3e029c945f8a2d335d8c79642dcf0a56
parent885e339e5542cac1266e21b710d7419fa813b8e5 (diff)
downloadgnutls-3f34f7ee180c4c20411daa1678a50c033011829d.tar.gz
updated doc
-rw-r--r--lib/gnutls_cert.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c
index f784cc5f81..f699a889d6 100644
--- a/lib/gnutls_cert.c
+++ b/lib/gnutls_cert.c
@@ -692,7 +692,7 @@ gnutls_certificate_verify_peers2 (gnutls_session_t session,
/**
* gnutls_certificate_verify_peers3:
* @session: is a gnutls session
- * @hostname: is the expected name of the peer
+ * @hostname: is the expected name of the peer; may be %NULL
* @status: is the output of the verification
*
* This function will verify the peer's certificate and its name and
@@ -701,8 +701,9 @@ gnutls_certificate_verify_peers2 (gnutls_session_t session,
* bitwise or'd or zero if the certificate is trusted. Note that verification
* failure does not imply a negative return value. Only the @status is updated.
*
- * In case the @hostname does not match the %GNUTLS_CERT_UNEXPECTED_OWNER
- * status flag will be set.
+ * If the @hostname provided is non-NULL then this function will compare
+ * the hostname in the certificate against the given. If they do not match
+ * the %GNUTLS_CERT_UNEXPECTED_OWNER status flag will be set.
*
* If available the OCSP Certificate Status extension will be
* utilized by this function.