Struct Config 

pub struct Config {
    pub WGPROXY_SERVER: String,
    pub WGPROXY_PUBKEY: [u8; 32],
    pub WGPROXY_LISTEN: SocketAddr,
    pub WGPROXY_TIMEOUT: Duration,
    pub WGPROXY_LOGLEVEL: u8,
}

The server config

Fields

WGPROXY_SERVER: String

The server address to forward the traffic to

Example

An address:port combination

WGPROXY_PUBKEY: [u8; 32]

The server public key for handshake validation

Note

The public key is used for handshake verfication and quick rejection when a new proxy connection is created. This is a security feature to ensure that the relay will not forward arbitrary rogue packets. If the handshake does not match the configured public key, the packet will be dropped.

WGPROXY_LISTEN: SocketAddr

The address to listen on and to use for relaying

Example

An inclusive range of ports, defaults to Self::WGPROXY_LISTEN_DEFAULT

WGPROXY_TIMEOUT: Duration

The timeout duration for NAT mappings to expire

Example

A duration in seconds, defaults to Self::WGPROXY_TIMEOUT_DEFAULT

WGPROXY_LOGLEVEL: u8

The log level

Possible Values

Possible values are:

• 0: Logs errors only
• 1: Logs warnings and errors
• 2: Logs informational messages, warnings, and errors
• 3: Logs debug and informational messages, warnings, and errors

Example

A positive integer value, defaults to Self::WGPROXY_LOGLEVEL_DEFAULT

Implementations

impl Config

pub const WGPROXY_LISTEN_DEFAULT: &str = "[::]:51820"

The default listening address if Self::WGPROXY_LISTEN is not specified

pub const WGPROXY_TIMEOUT_DEFAULT: &str = "60"

The default timeout in seconds if Self::WGPROXY_TIMEOUT is not specified

pub const WGPROXY_LOGLEVEL_DEFAULT: &str = "1"

The default loglevel if Self::WGPROXY_LOGLEVEL is not specified

pub fn from_env() -> Result<Self, Error>

Gets the config from the environment

pub fn wgproxy_loglevel() -> Result<u8, Error>

Parses the WGPROXY_LOGLEVEL environment variable, or falls back to Self::WGPROXY_LOGLEVEL_DEFAULT

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Loggable for &Config

fn write(&self, sink: &mut dyn Write) -> Result<(), Error>

Formats self and writes it to the given sink

fn log(self, severity: u8) -> Self

Converts a severity level to a logging prefix

fn skip(&self) -> bool

If logging self should be skipped or not