Add note about DoH proof building usage.
authorMatt Corallo <git@bluematt.me>
Mon, 12 Feb 2024 03:34:00 +0000 (03:34 +0000)
committerMatt Corallo <git@bluematt.me>
Mon, 12 Feb 2024 03:34:00 +0000 (03:34 +0000)
src/query.rs

index 07954b3cb9fccc348803c00a5c229b20be1eca76..bb8fd7d43db725c7f95ec275535c76b496ba2ce4 100644 (file)
@@ -183,6 +183,11 @@ const MAX_REQUESTS: usize = 10;
 /// [`ProofBuilder::process_response`] should be called, and each fresh query returned should be
 /// sent to the resolver. Once [`ProofBuilder::awaiting_responses`] returns false,
 /// [`ProofBuilder::finish_proof`] should be called to fetch the resulting proof.
+///
+/// To build a DNSSEC proof using a DoH server, take each [`QueryBuf`], encode it as base64url, and
+/// make a query to `https://doh-server/endpoint?dns=base64url_encoded_query` with an `Accept`
+/// header of `application/dns-message`. Each response, in raw binary, can be fed directly into
+/// [`ProofBuilder::process_response`].
 pub struct ProofBuilder {
        proof: Vec<u8>,
        min_ttl: u32,