portredirect 0.3.0

PortRedirect is a tool that bridges your frontend and backend by redirecting TCP connections through a persistent QUIC connection. It provides both a server (accepting TCP connections and forwarding them via QUIC) and a client (relaying QUIC streams to a TCP destination).
Documentation 
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

// PortRedirect
//
// License: GPL-3.0-only

use anyhow::{Context, Result};
use std::{path::PathBuf, time::Duration};

pub mod app_data;
pub mod bi_stream;
pub mod client;
pub mod forward;
pub mod metrics_helper;
pub mod protocol;
pub mod quic;
pub mod server;

/// Returns the path to the configuration directory, creating it if necessary.
pub fn get_config_dir(override_config_dir: Option<String>) -> Result<PathBuf> {
    // Use the override if provided, otherwise fall back to the platform's config directory.
    let config_dir = if let Some(override_path) = override_config_dir {
        PathBuf::from(override_path)
    } else {
        let mut config_dir =
            dirs::config_dir().context("Failed to find your platform's config directory")?;
        config_dir.push("portredirect");
        config_dir
    };

    // Create the directory if it doesn't exist
    std::fs::create_dir_all(&config_dir).context("create config dir")?;

    Ok(config_dir)
}

pub struct PortRedirectProtocol;

impl PortRedirectProtocol {
    pub const CONNECTION_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(30);
    pub const CONNECTION_KEEPALIVE_TIMEOUT: Duration = Duration::from_secs(5);
    pub const AUTHENTICATION_TIMEOUT: Duration = Duration::from_secs(10);
    pub const CHALLENGE_REQUEST_BUFFER_LENGTH: usize = 256;

    // TODO choose these values non-arbitrarily
    pub const QUIC_STREAM_READ_BUFFER_SIZE: usize = 64 * 1024; // 64 KiB
    pub const QUIC_CRYPTO_BUFFER_SIZE: usize = 64 * 1024;
}

pub type ByteCount = u64;