s2n-quic-dc 0.88.0

Internal crate used by s2n-quic
Documentation
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use crate::{
    either::Either,
    event::{self, EndpointPublisher, IntoEvent, Subscriber},
    msg,
    path::secret,
    stream::{
        endpoint,
        environment::{
            tokio::{self as env, Environment},
            Environment as _,
        },
        recv,
        server::{self, accept},
        socket::{Ext as _, Socket},
        TransportFeatures,
    },
};
use core::ops::ControlFlow;
use s2n_quic_core::{inet::SocketAddress, time::Clock};
use std::io;
use tracing::debug;

pub struct Acceptor<S, Sub>
where
    S: Socket,
    Sub: Subscriber + Clone,
{
    sender: accept::Sender<Sub>,
    socket: S,
    recv_buffer: msg::recv::Message,
    handshake: server::handshake::Map,
    env: Environment<Sub>,
    secrets: secret::Map,
    accept_flavor: accept::Flavor,
}

impl<S, Sub> Acceptor<S, Sub>
where
    S: Socket,
    Sub: Subscriber + Clone,
{
    #[inline]
    pub fn new(
        id: usize,
        socket: S,
        sender: &accept::Sender<Sub>,
        env: &Environment<Sub>,
        secrets: &secret::Map,
        accept_flavor: accept::Flavor,
    ) -> Self {
        #[expect(
            clippy::unwrap_used,
            reason = "converting the compile-time constant 9000 is infallible since it is a valid non-zero value"
        )]
        let acceptor = Self {
            sender: sender.clone(),
            socket,
            recv_buffer: msg::recv::Message::new(9000.try_into().unwrap()),
            handshake: Default::default(),
            env: env.clone(),
            secrets: secrets.clone(),
            accept_flavor,
        };

        if let Ok(addr) = acceptor.socket.local_addr() {
            let addr: SocketAddress = addr.into();
            let local_address = addr.into_event();
            acceptor
                .env
                .endpoint_publisher()
                .on_acceptor_udp_started(event::builder::AcceptorUdpStarted { id, local_address });
        }

        acceptor
    }

    pub async fn run(mut self) {
        loop {
            match self.accept_one().await {
                Ok(ControlFlow::Continue(())) => continue,
                Ok(ControlFlow::Break(())) => break,
                Err(error) => {
                    self.env.endpoint_publisher().on_acceptor_udp_io_error(
                        event::builder::AcceptorUdpIoError { error: &error },
                    );
                }
            }
        }
    }

    async fn accept_one(&mut self) -> io::Result<ControlFlow<()>> {
        let packet = self.recv_packet().await?;

        let now = self.env.clock().get_time();
        let publisher = self.env.endpoint_publisher_with_time(now);

        let server::handshake::Outcome::Created {
            receiver: handshake,
        } = self.handshake.handle(&packet, &mut self.recv_buffer)
        else {
            return Ok(ControlFlow::Continue(()));
        };

        let remote_addr = self.recv_buffer.remote_address();

        let meta = event::api::ConnectionMeta {
            id: 0, // TODO use an actual connection ID
            timestamp: now.into_event(),
        };
        let info = event::api::ConnectionInfo {};

        let subscriber_ctx = self
            .env
            .subscriber()
            .create_connection_context(&meta, &info);

        let recv_buffer = recv::buffer::Local::new(self.recv_buffer.take(), Some(handshake));
        let recv_buffer = Either::A(recv_buffer);

        let peer = env::udp::Owned(remote_addr, recv_buffer);

        let mut secret_control = vec![];
        let (crypto, parameters, application_data) = match endpoint::derive_stream_credentials(
            &packet,
            &self.secrets,
            &TransportFeatures::UDP,
            &mut secret_control,
        ) {
            Ok(result) => result,
            Err(error) => {
                if !secret_control.is_empty() {
                    let addr = msg::addr::Addr::new(remote_addr);
                    let ecn = Default::default();
                    let buffer = &[io::IoSlice::new(&secret_control)];
                    let _ = self.socket.try_send(&addr, ecn, buffer);
                }
                return Err(error);
            }
        };

        let stream = match endpoint::accept_stream(
            now,
            &self.env,
            peer,
            &packet,
            &self.secrets,
            subscriber_ctx,
            None,
            crypto,
            parameters,
            secret_control,
            application_data,
        ) {
            Ok(stream) => stream,
            Err(error) => {
                tracing::trace!("send_start");

                let buffer = &error.secret_control;
                if !buffer.is_empty() {
                    let addr = msg::addr::Addr::new(remote_addr);
                    let ecn = Default::default();
                    let buffer = &[io::IoSlice::new(&error.secret_control)];

                    // ignore any errors since this is just for responding to invalid connect attempts
                    let _ = self.socket.try_send(&addr, ecn, buffer);
                }

                tracing::trace!("send_finish");
                return Err(error.error);
            }
        };

        {
            let remote_address: SocketAddress = stream.shared.remote_addr();
            let remote_address = &remote_address;
            let creds = stream.shared.credentials();
            let credential_id = &*creds.id;
            let stream_id = creds.key_id.as_u64();
            publisher.on_acceptor_udp_stream_enqueued(event::builder::AcceptorUdpStreamEnqueued {
                remote_address,
                credential_id,
                stream_id,
            });
        }

        let res = match self.accept_flavor {
            accept::Flavor::Fifo => self.sender.send_back(stream),
            accept::Flavor::Lifo => self.sender.send_front(stream),
        };

        match res {
            Ok(prev) => {
                if let Some(stream) = prev {
                    stream.prune(
                        event::builder::AcceptorStreamPruneReason::AcceptQueueCapacityExceeded,
                    );
                }

                Ok(ControlFlow::Continue(()))
            }
            Err(_undelivered_stream) => {
                debug!("application accept queue dropped; shutting down");
                Ok(ControlFlow::Break(()))
            }
        }
    }

    async fn recv_packet(&mut self) -> io::Result<server::InitialPacket> {
        loop {
            // discard any pending packets
            self.recv_buffer.clear();
            self.socket.recv_buffer(&mut self.recv_buffer).await?;

            let remote_address = self.recv_buffer.remote_address();
            let remote_address = &remote_address;
            let packet = server::InitialPacket::peek(&mut self.recv_buffer, 16);

            let publisher = self.env.endpoint_publisher();
            publisher.on_acceptor_udp_datagram_received(
                event::builder::AcceptorUdpDatagramReceived {
                    remote_address,
                    len: self.recv_buffer.payload_len(),
                },
            );

            match packet {
                Ok(packet) => {
                    publisher.on_acceptor_udp_packet_received(
                        event::builder::AcceptorUdpPacketReceived {
                            remote_address,
                            credential_id: &*packet.credentials.id,
                            stream_id: packet.stream_id.into_varint().as_u64(),
                            payload_len: packet.payload_len,
                            is_zero_offset: packet.is_zero_offset,
                            is_retransmission: packet.is_retransmission,
                            is_fin: packet.is_fin,
                            is_fin_known: packet.is_fin_known,
                        },
                    );

                    return Ok(packet);
                }
                Err(error) => {
                    publisher.on_acceptor_udp_packet_dropped(
                        event::builder::AcceptorUdpPacketDropped {
                            remote_address,
                            reason: error.into_event(),
                        },
                    );

                    continue;
                }
            }
        }
    }
}