1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
// Copyright 2015-2022 Benjamin Fry <benjaminfry@me.com>
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// https://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// https://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
use bytes::{Bytes, BytesMut};
use quinn::{RecvStream, SendStream, VarInt};
use tracing::debug;
use crate::{
error::{ProtoError, ProtoErrorKind},
op::Message,
xfer::DnsResponse,
};
/// ```text
/// 5.1. Connection Establishment
///
/// DoQ connections are established as described in the QUIC transport specification [RFC9000]. During connection establishment,
/// DoQ support is indicated by selecting the ALPN token "doq" in the crypto handshake.
/// ```
pub(crate) const DOQ_ALPN: &[u8] = b"doq";
/// [DoQ Error Codes](https://www.ietf.org/archive/id/draft-ietf-dprive-dnsoquic-10.html#name-doq-error-codes), draft-ietf-dprive-dnsoquic, Feb. 28, 2022
/// ```text
/// 5.3. DoQ Error Codes
///
/// The following error codes are defined for use when abruptly terminating streams, aborting reading of streams, or immediately closing connections:
///
/// DOQ_NO_ERROR (0x0):
/// No error. This is used when the connection or stream needs to be closed, but there is no error to signal.
///
/// DOQ_INTERNAL_ERROR (0x1):
/// The DoQ implementation encountered an internal error and is incapable of pursuing the transaction or the connection.
///
/// DOQ_PROTOCOL_ERROR (0x2):
/// The DoQ implementation encountered an protocol error and is forcibly aborting the connection.
///
/// DOQ_REQUEST_CANCELLED (0x3):
/// A DoQ client uses this to signal that it wants to cancel an outstanding transaction.
///
/// DOQ_EXCESSIVE_LOAD (0x4):
/// A DoQ implementation uses this to signal when closing a connection due to excessive load.
///
/// DOQ_ERROR_RESERVED (0xd098ea5e):
/// Alternative error code used for tests.
/// ```
#[derive(Clone, Copy)]
pub enum DoqErrorCode {
/// No error. This is used when the connection or stream needs to be closed, but there is no error to signal.
NoError,
/// The DoQ implementation encountered an internal error and is incapable of pursuing the transaction or the connection.
InternalError,
/// The DoQ implementation encountered an protocol error and is forcibly aborting the connection.
ProtocolError,
/// A DoQ client uses this to signal that it wants to cancel an outstanding transaction.
RequestCancelled,
/// A DoQ implementation uses this to signal when closing a connection due to excessive load.
ExcessiveLoad,
/// Alternative error code used for tests.
ErrorReserved,
/// Unknown Error code
Unknown(u32),
}
// not using repr(u32) above because of the Unknown
const NO_ERROR: u32 = 0x0;
const INTERNAL_ERROR: u32 = 0x1;
const PROTOCOL_ERROR: u32 = 0x2;
const REQUEST_CANCELLED: u32 = 0x3;
const EXCESSIVE_LOAD: u32 = 0x4;
const ERROR_RESERVED: u32 = 0xd098ea5e;
impl From<DoqErrorCode> for VarInt {
fn from(doq_error: DoqErrorCode) -> Self {
use DoqErrorCode::*;
match doq_error {
NoError => Self::from_u32(NO_ERROR),
InternalError => Self::from_u32(INTERNAL_ERROR),
ProtocolError => Self::from_u32(PROTOCOL_ERROR),
RequestCancelled => Self::from_u32(REQUEST_CANCELLED),
ExcessiveLoad => Self::from_u32(EXCESSIVE_LOAD),
ErrorReserved => Self::from_u32(ERROR_RESERVED),
Unknown(code) => Self::from_u32(code),
}
}
}
impl From<VarInt> for DoqErrorCode {
fn from(doq_error: VarInt) -> Self {
let code: u32 = if let Ok(code) = doq_error.into_inner().try_into() {
code
} else {
return Self::ProtocolError;
};
match code {
NO_ERROR => Self::NoError,
INTERNAL_ERROR => Self::InternalError,
PROTOCOL_ERROR => Self::ProtocolError,
REQUEST_CANCELLED => Self::RequestCancelled,
EXCESSIVE_LOAD => Self::ExcessiveLoad,
ERROR_RESERVED => Self::ErrorReserved,
_ => Self::Unknown(code),
}
}
}
/// A single bi-directional stream
pub struct QuicStream {
send_stream: SendStream,
receive_stream: RecvStream,
}
impl QuicStream {
pub(crate) fn new(send_stream: SendStream, receive_stream: RecvStream) -> Self {
Self {
send_stream,
receive_stream,
}
}
/// Send the DNS message to the other side
pub async fn send(&mut self, mut message: Message) -> Result<(), ProtoError> {
// RFC: When sending queries over a QUIC connection, the DNS Message ID MUST be set to zero. The stream mapping for DoQ allows for
// unambiguous correlation of queries and responses and so the Message ID field is not required.
message.set_id(0);
let bytes = Bytes::from(message.to_vec()?);
self.send_bytes(bytes).await
}
/// Send pre-encoded bytes, warning, QUIC requires the message id to be 0.
pub async fn send_bytes(&mut self, bytes: Bytes) -> Result<(), ProtoError> {
// In order that multiple responses can be parsed, a 2-octet length field is used in exactly the same way as the 2-octet length
// field defined for DNS over TCP [RFC1035]. The practical result of this is that the content of each QUIC stream is exactly
// the same as the content of a TCP connection that would manage exactly one query.All DNS messages (queries and responses)
// sent over DoQ connections MUST be encoded as a 2-octet length field followed by the message content as specified in [RFC1035].
let bytes_len = u16::try_from(bytes.len())
.map_err(|_e| ProtoErrorKind::MaxBufferSizeExceeded(bytes.len()))?;
let len = bytes_len.to_be_bytes().to_vec();
let len = Bytes::from(len);
debug!("received packet len: {} bytes: {:x?}", bytes_len, bytes);
self.send_stream.write_all_chunks(&mut [len, bytes]).await?;
Ok(())
}
/// finishes the send stream, i.e. there will be no more data sent to the remote
pub async fn finish(&mut self) -> Result<(), ProtoError> {
self.send_stream.finish().await?;
Ok(())
}
/// Receive a single packet
pub async fn receive(&mut self) -> Result<DnsResponse, ProtoError> {
let bytes = self.receive_bytes().await?;
let message = Message::from_vec(&bytes)?;
// assert that the message id is 0, this is a bad dns-over-quic packet if not
if message.id() != 0 {
self.reset(DoqErrorCode::ProtocolError)
.map_err(|_| debug!("stream already closed"))
.ok();
return Err(ProtoErrorKind::QuicMessageIdNot0(message.id()).into());
}
Ok(DnsResponse::new(message, bytes.to_vec()))
}
// TODO: we should change the protocol handlers to work with Messages since some require things like 0 for the Message ID.
/// Receive a single packet as raw bytes
pub async fn receive_bytes(&mut self) -> Result<BytesMut, ProtoError> {
// following above, the data should be first the length, followed by the message(s)
let mut len = [0u8; 2];
self.receive_stream.read_exact(&mut len).await?;
let len = u16::from_be_bytes(len) as usize;
// RFC: DoQ Queries and Responses are sent on QUIC streams, which in theory can carry up to 2^62 bytes.
// However, DNS messages are restricted in practice to a maximum size of 65535 bytes. This maximum size
// is enforced by the use of a two-octet message length field in DNS over TCP [RFC1035] and DNS over TLS [RFC7858],
// and by the definition of the "application/dns-message" for DNS over HTTP [RFC8484]. DoQ enforces the same restriction.
let mut bytes = BytesMut::with_capacity(len);
bytes.resize(len, 0);
if let Err(e) = self.receive_stream.read_exact(&mut bytes[..len]).await {
debug!("received bad packet len: {} bytes: {:?}", len, bytes);
self.reset(DoqErrorCode::ProtocolError)
.map_err(|_| debug!("stream already closed"))
.ok();
return Err(e.into());
}
debug!("received packet len: {} bytes: {:x?}", len, bytes);
Ok(bytes)
}
/// Reset the sending stream due to some error
pub fn reset(&mut self, code: DoqErrorCode) -> Result<(), ProtoError> {
self.send_stream
.reset(code.into())
.map_err(|_| ProtoError::from(ProtoErrorKind::QuinnUnknownStreamError))
}
/// Stop the receiving stream due to some error
pub fn stop(&mut self, code: DoqErrorCode) -> Result<(), ProtoError> {
self.receive_stream
.stop(code.into())
.map_err(|_| ProtoError::from(ProtoErrorKind::QuinnUnknownStreamError))
}
}