summaryrefslogtreecommitdiff
path: root/libdane
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2014-12-12 08:26:53 +0100
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2014-12-12 08:27:10 +0100
commitf5e3698fcc73554cafa03ee8565e5f403f921a48 (patch)
tree905ca23cf17bdd2dcd9db21f28b73cc6db1a15ec /libdane
parentdf8017736631c64120c3dd048b8026b738da5316 (diff)
downloadgnutls-f5e3698fcc73554cafa03ee8565e5f403f921a48.tar.gz
improved documentation on dane
Diffstat (limited to 'libdane')
-rw-r--r--libdane/dane.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/libdane/dane.c b/libdane/dane.c
index 162bb24bab..4223350497 100644
--- a/libdane/dane.c
+++ b/libdane/dane.c
@@ -748,14 +748,17 @@ verify_ee(const gnutls_datum_t * raw_crt,
* is set. If a DNSSEC signature is not available for the DANE
* record then the verify flag %DANE_VERIFY_NO_DNSSEC_DATA is set.
*
- * Note that the CA constraint only applies for the directly certifying CA
- * and does not account for long CA chains.
- *
* Due to the many possible options of DANE, there is no single threat
* model countered. When notifying the user about DANE verification results
* it may be better to mention: DANE verification did not reject the certificate,
* rather than mentioning a successful DANE verication.
*
+ * Note that this function is designed to be run in addition to
+ * PKIX - certificate chain - verification. To be run independently
+ * the %DANE_VFLAG_ONLY_CHECK_EE_USAGE flag should be specified;
+ * then the function will check whether the key of the peer matches the
+ * key advertized in the DANE entry.
+ *
* If the @q parameter is provided it will be used for caching entries.
*
* Returns: On success, %DANE_E_SUCCESS (0) is returned, otherwise a
@@ -849,15 +852,17 @@ dane_verify_crt_raw(dane_state_t s,
* is set. If a DNSSEC signature is not available for the DANE
* record then the verify flag %DANE_VERIFY_NO_DNSSEC_DATA is set.
*
- * Note that the CA constraint only applies for the directly certifying CA
- * and does not account for long CA chains. Moreover this function does not
- * validate the provided chain.
- *
* Due to the many possible options of DANE, there is no single threat
* model countered. When notifying the user about DANE verification results
* it may be better to mention: DANE verification did not reject the certificate,
* rather than mentioning a successful DANE verication.
*
+ * Note that this function is designed to be run in addition to
+ * PKIX - certificate chain - verification. To be run independently
+ * the %DANE_VFLAG_ONLY_CHECK_EE_USAGE flag should be specified;
+ * then the function will check whether the key of the peer matches the
+ * key advertized in the DANE entry.
+ *
* If the @q parameter is provided it will be used for caching entries.
*
* Returns: On success, %DANE_E_SUCCESS (0) is returned, otherwise a
@@ -917,7 +922,7 @@ dane_verify_crt(dane_state_t s,
* See dane_verify_crt() for more information.
*
* This will not verify the chain for validity; unless the DANE
- * verification is restricted to end certificates, this has to
+ * verification is restricted to end certificates, this must be
* be performed separately using gnutls_certificate_verify_peers3().
*
* Returns: On success, %DANE_E_SUCCESS (0) is returned, otherwise a