Skip to main content

C2Config

Struct C2Config 

Source
pub struct C2Config {
    pub api_listen: SocketAddr,
    pub control_endpoint: String,
    pub control_tunnel_listen: Option<SocketAddr>,
    pub nodes: Vec<C2NodeConfig>,
    pub node_listen: Option<SocketAddr>,
    pub timings: C2Timings,
    /* private fields */
}

Fields§

§api_listen: SocketAddr§control_endpoint: String§control_tunnel_listen: Option<SocketAddr>

Optional TCP control accept bound to the C2 tunnel address. The unix control_endpoint listener is always started as well.

§nodes: Vec<C2NodeConfig>§node_listen: Option<SocketAddr>

Where nodes that cannot be dialled come to announce themselves. None unless at least one node is configured accept.

§timings: C2Timings

Implementations§

Source§

impl C2Config

Source

pub fn new( api_listen: SocketAddr, api_token: impl Into<String>, nodes: Vec<C2NodeConfig>, ) -> Result<Self, C2ConfigError>

Source

pub fn with_node_listen( self, node_listen: SocketAddr, ) -> Result<Self, C2ConfigError>

Binds the address nodes call in on.

Loopback, or one concrete C2 WireGuard tunnel address (same rule as Self::with_control_tunnel_listen). The node wire authenticates both ends but encrypts nothing, so 0.0.0.0 and other unspecified binds are refused: off-tunnel plaintext would expose terminal contents. When the listen address is the C2 tunnel IP, kernel WireGuard encrypts the path and either side may dial.

Source

pub fn validate_call_home(&self) -> Result<(), C2ConfigError>

Every node that waits to be called needs somewhere to call, so a config that asks for one without the other is refused rather than started into a relay that can never reach that node. Checked at startup, not at connect time, because the failure is total and permanent – there is nothing to retry.

Source

pub fn with_timings(self, timings: C2Timings) -> Self

Source

pub fn with_control_endpoint( self, endpoint: impl Into<String>, ) -> Result<Self, C2ConfigError>

Source

pub fn with_control_tunnel_listen( self, listen: SocketAddr, ) -> Result<Self, C2ConfigError>

TCP door for an HQ WireGuard client. Bound to one concrete address (the address on the C2 tunnel), never 0.0.0.0 or port 0. Does not replace the unix control listener.

Trait Implementations§

Source§

impl Clone for C2Config

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more