[1.1.1.1] Add warning about lack of RFC for DoH JSON format #19756
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SebastiaanYN
requested review from
a team and
RebeccaTamachiro
as code owners
RebeccaTamachiro
approved these changes
Feb 6, 2025
hannes-cf
reviewed
Feb 7, 2025
| --- | ||
|
|
||
| Cloudflare respects DNS wireformat as defined in [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035). | ||
| Cloudflare respects DNS wireformat as defined in [RFC 1035](https://www.rfc-editor.org/rfc/rfc1035.html). |
Contributor
There was a problem hiding this comment.
@SebastiaanYN can we point to certain section in this RFC that contains the specifics we're following here? Like section 7. RESOLVER IMPLEMENTATION
Contributor
Author
There was a problem hiding this comment.
In this case we're referring to the RFC as a whole because it's about the data format, which is defined in multiple sections of the RFC (2/3/4)
Contributor
There was a problem hiding this comment.
okay, then let's keep it as suggested 👍
hannes-cf
reviewed
Feb 7, 2025
| For critical use cases, it is recommended to use the [DNS over HTTPS wireformat](/1.1.1.1/encryption/dns-over-https/make-api-requests/dns-wireformat/), which is defined in [RFC 1035](https://www.rfc-editor.org/rfc/rfc1035.html). | ||
| ::: | ||
|
|
||
| Cloudflare's DNS over HTTPS endpoint also supports JSON format for querying DNS data. For lack of an agreed upon JSON schema for DNS over HTTPS in the Internet Engineering Task Force (IETF), Cloudflare has chosen to follow the same schema as Google's DNS over HTTPS resolver. |
Contributor
There was a problem hiding this comment.
wondering if we should phrase this a bit more generally like
(...) chosen to follow the same schema as
Google's DNS over HTTPS resolverother common public resolvers' DNS over HTTPS implementation. 🤔
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a warning about the lack of RFC to the DoH JSON format documentation, and point users to the wireformat for critical use cases.
Screenshots (optional)
Documentation checklist