-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Write our own DNS message reader #9541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+468
−21
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
241 changes: 241 additions & 0 deletions
241
okhttp-dnsoverhttps/src/main/kotlin/okhttp3/dnsoverhttps/-DnsMessageReader.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,241 @@ | ||
| /* | ||
| * Copyright (c) 2026 OkHttp Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| @file:Suppress("ktlint:standard:filename") | ||
|
|
||
| package okhttp3.dnsoverhttps | ||
|
|
||
| import java.io.IOException | ||
| import okio.Buffer | ||
| import okio.BufferedSource | ||
| import okio.ByteString | ||
| import okio.ProtocolException | ||
|
|
||
| /** | ||
| * https://datatracker.ietf.org/doc/html/rfc1035 | ||
| */ | ||
| internal class DnsMessageReader( | ||
| source: BufferedSource, | ||
| ) { | ||
| /** | ||
| * Keep a reference to the source at its initial offset, so we can implement name compression. | ||
| * That mechanism requires us to backtrack in the message. | ||
| */ | ||
| private val sourceOffsetZero = source | ||
| private val source = source.peek() | ||
|
|
||
| fun read(): DnsMessage { | ||
| val id = source.readShort() | ||
| val flags = source.readShort().toInt() | ||
|
|
||
| val questionCount = source.readShort().toUShort().toInt() | ||
| val answerCount = source.readShort().toUShort().toInt() | ||
| val authorityRecordCount = source.readShort().toUShort().toInt() | ||
| val additionalRecordCount = source.readShort().toUShort().toInt() | ||
|
|
||
| val questions = ArrayList<Question>(questionCount) | ||
| for (i in 0 until questionCount) { | ||
| questions += readQuestion() | ||
| } | ||
|
|
||
| val answers = ArrayList<ResourceRecord>(answerCount) | ||
| for (i in 0 until answerCount) { | ||
| answers += readResourceRecord() ?: continue | ||
| } | ||
|
|
||
| val authorityRecords = ArrayList<ResourceRecord>(authorityRecordCount) | ||
| for (i in 0 until authorityRecordCount) { | ||
| authorityRecords += readResourceRecord() ?: continue | ||
| } | ||
|
|
||
| val additionalRecords = ArrayList<ResourceRecord>(additionalRecordCount) | ||
| for (i in 0 until additionalRecordCount) { | ||
| additionalRecords += readResourceRecord() ?: continue | ||
| } | ||
|
|
||
| if (!source.exhausted()) { | ||
| throw ProtocolException("unexpected trailing data in message") | ||
| } | ||
|
|
||
| sourceOffsetZero.skipAll() | ||
|
|
||
| return DnsMessage( | ||
| id = id, | ||
| flags = flags, | ||
| questions = questions, | ||
| answers = answers, | ||
| authorityRecords = authorityRecords, | ||
| additionalRecords = additionalRecords, | ||
| ) | ||
| } | ||
|
|
||
| private fun readQuestion(): Question { | ||
| val name = readName() | ||
| val type = source.readShort() | ||
| val `class` = source.readShort() | ||
| return Question( | ||
| name = name, | ||
| type = type, | ||
| `class` = `class`, | ||
| ) | ||
| } | ||
|
|
||
| private fun readName(): String { | ||
| val result = Buffer() | ||
| readName(source, result) | ||
| return result.readUtf8() | ||
| } | ||
|
|
||
| private tailrec fun readName( | ||
| source: BufferedSource, | ||
| sink: Buffer, | ||
| ) { | ||
| while (true) { | ||
| val labelTypeAndLength = source.readByte().toUByte().toInt() | ||
| val labelType = labelTypeAndLength and 0b11000000 | ||
| val labelLength = labelTypeAndLength and 0b00111111 | ||
| when (labelType) { | ||
| // Inline value. | ||
| 0b00_000000 -> { | ||
| if (labelLength == 0) return | ||
| if (sink.size > 0L) sink.writeByte('.'.code) | ||
| sink.write(source, labelLength.toLong()) | ||
| } | ||
|
|
||
| // Compressed suffix. | ||
| 0b11_000000 -> { | ||
| val offsetLength = (labelLength shl 8) or source.readByte().toUByte().toInt() | ||
| val offsetSource = sourceOffsetZero.peek() | ||
| offsetSource.skip(offsetLength.toLong()) | ||
| return readName(offsetSource, sink) | ||
| } | ||
|
|
||
| 0b01_000000, 0b10_000000 -> { | ||
| throw ProtocolException("unsupported label type") | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** Returns null if this record type is unsupported. */ | ||
| fun readResourceRecord(): ResourceRecord? { | ||
| val name = readName() | ||
| val type = source.readShort().toInt() | ||
| val `class` = source.readShort().toInt() | ||
| val timeToLive = source.readInt() | ||
| val recordDataLength = source.readShort().toLong() | ||
|
|
||
| when { | ||
| `class` == CLASS_IN && type == TYPE_A -> { | ||
| if (recordDataLength != 4L) throw ProtocolException("unexpected record length") | ||
| val address = source.readByteString(4L) | ||
| return ResourceRecord.IpAddress( | ||
| name = name, | ||
| timeToLive = timeToLive, | ||
| address = address, | ||
| ) | ||
| } | ||
|
|
||
| `class` == CLASS_IN && type == TYPE_AAAA -> { | ||
| if (recordDataLength != 16L) throw ProtocolException("unexpected record length") | ||
| val address = source.readByteString(16L) | ||
| return ResourceRecord.IpAddress( | ||
| name = name, | ||
| timeToLive = timeToLive, | ||
| address = address, | ||
| ) | ||
| } | ||
|
|
||
| else -> { | ||
| source.skip(recordDataLength) | ||
| return null | ||
| } | ||
| } | ||
| } | ||
|
|
||
| data class DnsMessage( | ||
| val id: Short, | ||
| val flags: Int, | ||
| val questions: List<Question>, | ||
| val answers: List<ResourceRecord>, | ||
| val authorityRecords: List<ResourceRecord> = listOf(), | ||
| val additionalRecords: List<ResourceRecord> = listOf(), | ||
| ) { | ||
| val responseCode: Int | ||
| get() = (flags and 0b0000_0000_0000_1111) | ||
|
|
||
| // Avoid Short.hashCode(short) which isn't available on Android 5. | ||
| override fun hashCode(): Int { | ||
| var result = 0 | ||
| result = 31 * result + id | ||
| result = 31 * result + flags | ||
| result = 31 * result + questions.hashCode() | ||
| result = 31 * result + answers.hashCode() | ||
| result = 31 * result + authorityRecords.hashCode() | ||
| result = 31 * result + additionalRecords.hashCode() | ||
| return result | ||
| } | ||
| } | ||
|
|
||
| data class Question( | ||
| val name: String, | ||
| val type: Short, | ||
| val `class`: Short, | ||
| ) { | ||
| // Avoid Short.hashCode(short) which isn't available on Android 5. | ||
| override fun hashCode(): Int { | ||
| var result = 0 | ||
| result = 31 * result + name.hashCode() | ||
| result = 31 * result + type | ||
| result = 31 * result + `class` | ||
| return result | ||
| } | ||
| } | ||
|
|
||
| sealed interface ResourceRecord { | ||
| val name: String | ||
| val timeToLive: Int | ||
|
|
||
| data class IpAddress( | ||
| override val name: String, | ||
| override val timeToLive: Int, | ||
| val address: ByteString, | ||
| ) : ResourceRecord { | ||
| // Avoid Int.hashCode(int) which isn't available on Android 5. | ||
| override fun hashCode(): Int { | ||
| var result = 0 | ||
| result = 31 * result + name.hashCode() | ||
| result = 31 * result + timeToLive | ||
| result = 31 * result + address.hashCode() | ||
| return result | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| internal val TYPE_A = 1 | ||
| internal val TYPE_AAAA = 28 | ||
|
|
||
| internal val CLASS_IN = 1 | ||
|
|
||
| internal val RESPONSE_CODE_SUCCESS = 0 | ||
| internal val RESPONSE_CODE_SERVER_FAILURE = 2 | ||
|
|
||
| @Throws(IOException::class) | ||
| internal fun BufferedSource.skipAll() { | ||
| while (!exhausted()) { | ||
| skip(buffer.size) | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ package okhttp3.dnsoverhttps | |
|
|
||
| import java.io.IOException | ||
| import java.net.InetAddress | ||
| import java.net.ProtocolException | ||
| import java.net.UnknownHostException | ||
| import java.util.concurrent.CountDownLatch | ||
| import okhttp3.Call | ||
|
|
@@ -81,15 +82,14 @@ class DnsOverHttps internal constructor( | |
|
|
||
| val failures = ArrayList<Exception>(2) | ||
| val results = ArrayList<InetAddress>(5) | ||
| executeRequests(hostname, networkRequests, results, failures) | ||
| executeRequests(networkRequests, results, failures) | ||
|
|
||
| return results.ifEmpty { | ||
| throwBestFailure(hostname, failures) | ||
| } | ||
| } | ||
|
|
||
| private fun executeRequests( | ||
| hostname: String, | ||
| networkRequests: List<Call>, | ||
| responses: MutableList<InetAddress>, | ||
| failures: MutableList<Exception>, | ||
|
|
@@ -113,7 +113,7 @@ class DnsOverHttps internal constructor( | |
| call: Call, | ||
| response: Response, | ||
| ) { | ||
| processResponse(response, hostname, responses, failures) | ||
| processResponse(response, responses, failures) | ||
| latch.countDown() | ||
| } | ||
| }, | ||
|
|
@@ -129,16 +129,15 @@ class DnsOverHttps internal constructor( | |
|
|
||
| private fun processResponse( | ||
| response: Response, | ||
| hostname: String, | ||
| results: MutableList<InetAddress>, | ||
| failures: MutableList<Exception>, | ||
| ) { | ||
| try { | ||
| val addresses = readResponse(hostname, response) | ||
| val addresses = readResponse(response) | ||
| synchronized(results) { | ||
| results.addAll(addresses) | ||
| } | ||
| } catch (e: Exception) { | ||
| } catch (e: IOException) { | ||
| synchronized(failures) { | ||
| failures.add(e) | ||
| } | ||
|
|
@@ -170,31 +169,44 @@ class DnsOverHttps internal constructor( | |
| throw unknownHostException | ||
| } | ||
|
|
||
| @Throws(Exception::class) | ||
| private fun readResponse( | ||
| hostname: String, | ||
| response: Response, | ||
| ): List<InetAddress> { | ||
| if (response.cacheResponse == null && response.protocol !== Protocol.HTTP_2 && response.protocol !== Protocol.QUIC) { | ||
| @Throws(IOException::class) | ||
| private fun readResponse(response: Response): List<InetAddress> { | ||
| if ( | ||
| response.cacheResponse == null && | ||
| response.protocol !== Protocol.HTTP_2 && | ||
| response.protocol !== Protocol.QUIC | ||
| ) { | ||
| Platform.get().log("Incorrect protocol: ${response.protocol}", Platform.WARN) | ||
| } | ||
|
|
||
| response.use { | ||
| if (!response.isSuccessful) { | ||
| throw IOException("response: " + response.code + " " + response.message) | ||
| throw IOException("response: ${response.code} ${response.message}") | ||
| } | ||
|
|
||
| val body = response.body | ||
|
|
||
| if (body.contentLength() > MAX_RESPONSE_SIZE) { | ||
| throw IOException( | ||
| throw ProtocolException( | ||
| "response size exceeds limit ($MAX_RESPONSE_SIZE bytes): ${body.contentLength()} bytes", | ||
| ) | ||
| } | ||
|
|
||
| val responseBytes = body.source().readByteString() | ||
| val dnsResponse = DnsMessageReader(body.source()).read() | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nice |
||
| when (dnsResponse.responseCode) { | ||
| RESPONSE_CODE_SUCCESS -> { | ||
| return dnsResponse.answers | ||
| .filterIsInstance<DnsMessageReader.ResourceRecord.IpAddress>() | ||
| .map { InetAddress.getByAddress(it.address.toByteArray()) } | ||
| } | ||
|
|
||
| RESPONSE_CODE_SERVER_FAILURE -> { | ||
| throw UnknownHostException("DNS server failure") | ||
| } | ||
|
|
||
| return DnsRecordCodec.decodeAnswers(hostname, responseBytes) | ||
| else -> { | ||
| throw UnknownHostException() | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'd have to be using an 8-year-old version of AGP to not get this automatically desugared by D8/R8: https://r8.googlesource.com/r8/+/516a6684f134d06eff08080e7ef7129517071817
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ll follow-up to fix our Animal Sniffer config, which doesn’t know that R8 can do stuff like this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#9566