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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
// 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 std::{
fmt::{self, Display},
future::Future,
net::SocketAddr,
pin::Pin,
sync::Arc,
task::{Context, Poll},
};
use futures_util::{future::FutureExt, stream::Stream};
use quinn::{
crypto::rustls::QuicClientConfig, ClientConfig, Connection, Endpoint, TransportConfig, VarInt,
};
use rustls::{version::TLS13, ClientConfig as TlsClientConfig};
use crate::{
error::ProtoError,
quic::quic_stream::{DoqErrorCode, QuicStream},
udp::UdpSocket,
xfer::{DnsRequest, DnsRequestSender, DnsResponse, DnsResponseStream},
};
use super::{quic_config, quic_stream};
/// A DNS client connection for DNS-over-QUIC
#[must_use = "futures do nothing unless polled"]
#[derive(Clone)]
pub struct QuicClientStream {
quic_connection: Connection,
name_server_name: Arc<str>,
name_server: SocketAddr,
is_shutdown: bool,
}
impl Display for QuicClientStream {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
write!(
formatter,
"QUIC({},{})",
self.name_server, self.name_server_name
)
}
}
impl QuicClientStream {
/// Builder for QuicClientStream
pub fn builder() -> QuicClientStreamBuilder {
QuicClientStreamBuilder::default()
}
async fn inner_send(
connection: Connection,
message: DnsRequest,
) -> Result<DnsResponse, ProtoError> {
let (send_stream, recv_stream) = connection.open_bi().await?;
// RFC: The mapping specified here requires that the client selects a separate
// QUIC stream for each query. The server then uses the same stream to provide all the response messages for that query.
let mut stream = QuicStream::new(send_stream, recv_stream);
stream.send(message.into_parts().0).await?;
// The client MUST send the DNS query over the selected stream,
// and MUST indicate through the STREAM FIN mechanism that no further data will be sent on that stream.
stream.finish().await?;
stream.receive().await
}
}
impl DnsRequestSender for QuicClientStream {
/// The send loop for QUIC in DNS stipulates that a new QUIC "stream" should be opened and use for sending data.
///
/// It should be closed after receiving the response. TODO: AXFR/IXFR support...
///
/// ```text
/// 5.2. Stream Mapping and Usage
///
/// The mapping of DNS traffic over QUIC streams takes advantage of the QUIC stream features detailed in Section 2 of [RFC9000],
/// the QUIC transport specification.
///
/// DNS traffic follows a simple pattern in which the client sends a query, and the server provides one or more responses
/// (multiple responses can occur in zone transfers).The mapping specified here requires that the client selects a separate
/// QUIC stream for each query. The server then uses the same stream to provide all the response messages for that query. 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].
/// The client MUST select the next available client-initiated bidirectional stream for each subsequent query on a QUIC connection,
/// in conformance with the QUIC transport specification [RFC9000].The client MUST send the DNS query over the selected stream,
/// and MUST indicate through the STREAM FIN mechanism that no further data will be sent on that stream.The server MUST send the
/// response(s) on the same stream and MUST indicate, after the last response, through the STREAM FIN mechanism that no further
/// data will be sent on that stream.Therefore, a single DNS transaction consumes a single bidirectional client-initiated stream.
/// This means that the client's first query occurs on QUIC stream 0, the second on 4, and so on (see Section 2.1 of [RFC9000].
/// Servers MAY defer processing of a query until the STREAM FIN has been indicated on the stream selected by the client. Servers
/// and clients MAY monitor the number of "dangling" streams for which the expected queries or responses have been received but
/// not the STREAM FIN. Implementations MAY impose a limit on the number of such dangling streams. If limits are encountered,
/// implementations MAY close the connection.
///
/// 5.2.1. DNS Message IDs
///
/// 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.
///
/// This has implications for proxying DoQ message to and from other transports. For example, proxies may have to manage the
/// fact that DoQ can support a larger number of outstanding queries on a single connection than e.g., DNS over TCP because DoQ
/// is not limited by the Message ID space. This issue already exists for DoH, where a Message ID of 0 is recommended.When forwarding
/// a DNS message from DoQ over another transport, a DNS Message ID MUST be generated according to the rules of the protocol that is
/// in use. When forwarding a DNS message from another transport over DoQ, the Message ID MUST be set to zero.
/// ```
fn send_message(&mut self, message: DnsRequest) -> DnsResponseStream {
if self.is_shutdown {
panic!("can not send messages after stream is shutdown")
}
Box::pin(Self::inner_send(self.quic_connection.clone(), message)).into()
}
fn shutdown(&mut self) {
self.is_shutdown = true;
self.quic_connection
.close(DoqErrorCode::NoError.into(), b"Shutdown");
}
fn is_shutdown(&self) -> bool {
self.is_shutdown
}
}
impl Stream for QuicClientStream {
type Item = Result<(), ProtoError>;
fn poll_next(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
if self.is_shutdown {
Poll::Ready(None)
} else {
Poll::Ready(Some(Ok(())))
}
}
}
/// A QUIC connection builder for DNS-over-QUIC
#[derive(Clone)]
pub struct QuicClientStreamBuilder {
crypto_config: Option<TlsClientConfig>,
transport_config: Arc<TransportConfig>,
bind_addr: Option<SocketAddr>,
}
impl QuicClientStreamBuilder {
/// Constructs a new TlsStreamBuilder with the associated ClientConfig
pub fn crypto_config(&mut self, crypto_config: TlsClientConfig) -> &mut Self {
self.crypto_config = Some(crypto_config);
self
}
/// Sets the address to connect from.
pub fn bind_addr(&mut self, bind_addr: SocketAddr) -> &mut Self {
self.bind_addr = Some(bind_addr);
self
}
/// Creates a new QuicStream to the specified name_server
///
/// # Arguments
///
/// * `name_server` - IP and Port for the remote DNS resolver
/// * `dns_name` - The DNS name, Subject Public Key Info (SPKI) name, as associated to a certificate
pub fn build(self, name_server: SocketAddr, dns_name: String) -> QuicClientConnect {
QuicClientConnect(Box::pin(self.connect(name_server, dns_name)) as _)
}
/// Create a QuicStream with existing connection
pub fn build_with_future(
self,
socket: Arc<dyn quinn::AsyncUdpSocket>,
name_server: SocketAddr,
dns_name: String,
) -> QuicClientConnect {
QuicClientConnect(Box::pin(self.connect_with_future(socket, name_server, dns_name)) as _)
}
async fn connect_with_future(
self,
socket: Arc<dyn quinn::AsyncUdpSocket>,
name_server: SocketAddr,
dns_name: String,
) -> Result<QuicClientStream, ProtoError> {
let endpoint_config = quic_config::endpoint();
let endpoint = Endpoint::new_with_abstract_socket(
endpoint_config,
None,
socket,
Arc::new(quinn::TokioRuntime),
)?;
self.connect_inner(endpoint, name_server, dns_name).await
}
async fn connect(
self,
name_server: SocketAddr,
dns_name: String,
) -> Result<QuicClientStream, ProtoError> {
let connect = if let Some(bind_addr) = self.bind_addr {
<tokio::net::UdpSocket as UdpSocket>::connect_with_bind(name_server, bind_addr)
} else {
<tokio::net::UdpSocket as UdpSocket>::connect(name_server)
};
let socket = connect.await?;
let socket = socket.into_std()?;
let endpoint_config = quic_config::endpoint();
let endpoint = Endpoint::new(endpoint_config, None, socket, Arc::new(quinn::TokioRuntime))?;
self.connect_inner(endpoint, name_server, dns_name).await
}
async fn connect_inner(
self,
mut endpoint: Endpoint,
name_server: SocketAddr,
dns_name: String,
) -> Result<QuicClientStream, ProtoError> {
// ensure the ALPN protocol is set correctly
let mut crypto_config = if let Some(crypto_config) = self.crypto_config {
crypto_config
} else {
client_config_tls13()?
};
if crypto_config.alpn_protocols.is_empty() {
crypto_config.alpn_protocols = vec![quic_stream::DOQ_ALPN.to_vec()];
}
let early_data_enabled = crypto_config.enable_early_data;
let mut client_config =
ClientConfig::new(Arc::new(QuicClientConfig::try_from(crypto_config)?));
client_config.transport_config(self.transport_config.clone());
endpoint.set_default_client_config(client_config);
let connecting = endpoint.connect(name_server, &dns_name)?;
// TODO: for Client/Dynamic update, don't use RTT, for queries, do use it.
let quic_connection = if early_data_enabled {
match connecting.into_0rtt() {
Ok((new_connection, _)) => new_connection,
Err(connecting) => connecting.await?,
}
} else {
connecting.await?
};
Ok(QuicClientStream {
quic_connection,
name_server_name: Arc::from(dns_name),
name_server,
is_shutdown: false,
})
}
}
/// Default crypto options for quic
pub fn client_config_tls13() -> Result<TlsClientConfig, ProtoError> {
use rustls::RootCertStore;
#[cfg_attr(
not(any(feature = "native-certs", feature = "webpki-roots")),
allow(unused_mut)
)]
let mut root_store = RootCertStore::empty();
#[cfg(all(feature = "native-certs", not(feature = "webpki-roots")))]
{
use crate::error::ProtoErrorKind;
let (added, ignored) =
root_store.add_parsable_certificates(rustls_native_certs::load_native_certs()?);
if ignored > 0 {
tracing::warn!(
"failed to parse {} certificate(s) from the native root store",
ignored,
);
}
if added == 0 {
return Err(ProtoErrorKind::NativeCerts.into());
}
}
#[cfg(feature = "webpki-roots")]
root_store.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
Ok(
TlsClientConfig::builder_with_provider(Arc::new(rustls::crypto::ring::default_provider()))
.with_protocol_versions(&[&TLS13])
.unwrap() // The ring default provider is guaranteed to support TLS 1.3
.with_root_certificates(root_store)
.with_no_client_auth(),
)
}
impl Default for QuicClientStreamBuilder {
fn default() -> Self {
let mut transport_config = quic_config::transport();
// clients never accept new bidirectional streams
transport_config.max_concurrent_bidi_streams(VarInt::from_u32(0));
Self {
crypto_config: None,
transport_config: Arc::new(transport_config),
bind_addr: None,
}
}
}
/// A future that resolves to an QuicClientStream
pub struct QuicClientConnect(
Pin<Box<dyn Future<Output = Result<QuicClientStream, ProtoError>> + Send>>,
);
impl Future for QuicClientConnect {
type Output = Result<QuicClientStream, ProtoError>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.0.poll_unpin(cx)
}
}
/// A future that resolves to
pub struct QuicClientResponse(
Pin<Box<dyn Future<Output = Result<DnsResponse, ProtoError>> + Send>>,
);
impl Future for QuicClientResponse {
type Output = Result<DnsResponse, ProtoError>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.0.as_mut().poll(cx).map_err(ProtoError::from)
}
}