renet2_setup 0.14.0

Setup utilities for renet2
Documentation
use renet2_netcode::{ConnectToken, ServerCertHash};
use serde::{Deserialize, Serialize};

use std::{
    net::{Ipv4Addr, SocketAddr, SocketAddrV4},
    time::Duration,
};

use crate::{connect_token_to_bytes, ConnectionType, GameServerSetupConfig, ServerConnectToken};

//-------------------------------------------------------------------------------------------------------------------

/// Metadata required to generate connect tokens for in-memory clients.
#[cfg(feature = "memory_transport")]
#[derive(Debug, Clone)]
pub struct ConnectMetaMemory {
    pub server_config: GameServerSetupConfig,
    pub clients: Vec<renet2_netcode::MemorySocketClient>,
    pub socket_id: u8,
    pub auth_key: [u8; 32],
}

#[cfg(feature = "memory_transport")]
impl ConnectMetaMemory {
    /// Generates a new connect token for an in-memory client.
    ///
    /// Note that [`ConnectMetaMemory`] can contain sockets for multiple clients. We search available clients for
    /// the requested client id, and return `None` on failure.
    pub fn new_connect_token(&self, current_time: Duration, client_id: u64) -> Result<ServerConnectToken, String> {
        let token = ConnectToken::generate(
            current_time,
            self.server_config.protocol_id,
            self.server_config.expire_secs,
            client_id,
            self.server_config.timeout_secs,
            self.socket_id,
            vec![renet2_netcode::in_memory_server_addr()],
            None,
            &self.auth_key,
        )
        .map_err(|err| format!("failed generating connect token: {err:?}"))?;

        let token = connect_token_to_bytes(&token).map_err(|err| format!("failed writing connect token to bytes: {err:?}"))?;
        let client = self
            .clients
            .iter()
            .find(|c| c.id() == client_id)
            .cloned()
            .ok_or_else(|| format!("failed constructing connect token, requested in-memory client {client_id} is unknown"))?;

        Ok(ServerConnectToken::Memory { token, client })
    }
}

#[cfg(not(feature = "memory_transport"))]
#[derive(Debug, Clone)]
pub struct ConnectMetaMemory;

//-------------------------------------------------------------------------------------------------------------------

/// Metadata required to generate connect tokens for native-target clients.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConnectMetaNative {
    pub server_config: GameServerSetupConfig,
    pub server_addresses: Vec<SocketAddr>,
    pub socket_id: u8,
    pub auth_key: [u8; 32],
}

impl ConnectMetaNative {
    pub fn dummy() -> Self {
        let mut auth_key = [0u8; 32];
        auth_key[0] = 1;

        Self {
            server_config: GameServerSetupConfig::dummy(),
            server_addresses: vec![SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 8080u16))],
            socket_id: 0,
            auth_key,
        }
    }

    /// Generates a new connect token for a native client.
    pub fn new_connect_token(&self, current_time: Duration, client_id: u64) -> Result<ServerConnectToken, String> {
        let token = ConnectToken::generate(
            current_time,
            self.server_config.protocol_id,
            self.server_config.expire_secs,
            client_id,
            self.server_config.timeout_secs,
            self.socket_id,
            self.server_addresses.clone(),
            None,
            &self.auth_key,
        )
        .map_err(|err| format!("failed generating connect token: {err:?}"))?;

        let token = connect_token_to_bytes(&token).map_err(|err| format!("failed writing connect token to bytes: {err:?}"))?;
        Ok(ServerConnectToken::Native { token })
    }
}

//-------------------------------------------------------------------------------------------------------------------

/// Metadata required to generate connect tokens for wasm-target webtransport clients.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConnectMetaWasmWt {
    pub server_config: GameServerSetupConfig,
    pub server_addresses: Vec<SocketAddr>,
    pub socket_id: u8,
    pub auth_key: [u8; 32],
    pub cert_hashes: Vec<ServerCertHash>,
}

impl ConnectMetaWasmWt {
    /// Generates a new connect token for a wasm webtransport client.
    pub fn new_connect_token(&self, current_time: Duration, client_id: u64) -> Result<ServerConnectToken, String> {
        let token = ConnectToken::generate(
            current_time,
            self.server_config.protocol_id,
            self.server_config.expire_secs,
            client_id,
            self.server_config.timeout_secs,
            self.socket_id,
            self.server_addresses.clone(),
            None,
            &self.auth_key,
        )
        .map_err(|err| format!("failed generating connect token: {err:?}"))?;

        let token = connect_token_to_bytes(&token).map_err(|err| format!("failed writing connect token to bytes: {err:?}"))?;

        Ok(ServerConnectToken::WasmWt {
            token,
            cert_hashes: self.cert_hashes.clone(),
        })
    }
}

//-------------------------------------------------------------------------------------------------------------------

/// Metadata required to generate connect tokens for wasm-target websocket clients.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConnectMetaWasmWs {
    pub server_config: GameServerSetupConfig,
    pub server_addresses: Vec<SocketAddr>,
    pub socket_id: u8,
    pub auth_key: [u8; 32],
    pub url: url::Url,
}

impl ConnectMetaWasmWs {
    /// Generates a new connect token for a wasm websocket client.
    pub fn new_connect_token(&self, current_time: Duration, client_id: u64) -> Result<ServerConnectToken, String> {
        let token = ConnectToken::generate(
            current_time,
            self.server_config.protocol_id,
            self.server_config.expire_secs,
            client_id,
            self.server_config.timeout_secs,
            self.socket_id,
            self.server_addresses.clone(),
            None,
            &self.auth_key,
        )
        .map_err(|err| format!("failed generating connect token: {err:?}"))?;

        let token = connect_token_to_bytes(&token).map_err(|err| format!("failed writing connect token to bytes: {err:?}"))?;

        Ok(ServerConnectToken::WasmWs {
            token,
            url: self.url.clone(),
        })
    }
}

//-------------------------------------------------------------------------------------------------------------------

/// Metadata required to generate connect tokens for renet2 clients.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct ConnectMetas {
    #[serde(skip)]
    pub memory: Option<ConnectMetaMemory>,
    pub native: Option<ConnectMetaNative>,
    pub wasm_wt: Option<ConnectMetaWasmWt>,
    pub wasm_ws: Option<ConnectMetaWasmWs>,
}

impl ConnectMetas {
    pub fn new_connect_token(
        &self,
        current_time: Duration,
        client_id: u64,
        connection_type: ConnectionType,
    ) -> Result<ServerConnectToken, String> {
        match connection_type {
            ConnectionType::Memory | ConnectionType::Native => {
                let Some(meta) = &self.native else {
                    return Err("no native connect meta for native client".to_string());
                };
                meta.new_connect_token(current_time, client_id)
                    .map_err(|err| format!("failed constructing native connect token: {err:?}"))
            }
            ConnectionType::WasmWt => {
                // Clients that request webtransport can fall back to websockets.
                if let Some(meta) = &self.wasm_wt {
                    meta.new_connect_token(current_time, client_id)
                        .map_err(|err| format!("failed constructing wasm wt connect token for wasm client: {err:?}"))
                } else if let Some(meta) = &self.wasm_ws {
                    meta.new_connect_token(current_time, client_id)
                        .map_err(|err| format!("failed constructing wasm ws connect token for wasm client: {err:?}"))
                } else {
                    Err("no wasm webtransport connect meta for wasm client".to_string())
                }
            }
            ConnectionType::WasmWs => {
                let Some(meta) = &self.wasm_ws else {
                    return Err("no wasm websocket connect meta for wasm client".to_string());
                };
                meta.new_connect_token(current_time, client_id)
                    .map_err(|err| format!("failed constructing wasm ws connect token for wasm client: {err:?}"))
            }
        }
    }
}

//-------------------------------------------------------------------------------------------------------------------