Skip to main content

TlsConfig

Struct TlsConfig 

Source
pub struct TlsConfig {
    pub cert: Option<Box<str>>,
    pub key: Option<Box<str>>,
    pub auto: Option<bool>,
    pub email: Option<Box<str>>,
    pub staging: Option<bool>,
    pub cache_dir: Option<Box<str>>,
    pub dns_provider: Option<Box<str>>,
    pub dns_api_token_env: Option<Box<str>>,
    pub dns_api_token_file: Option<Box<str>>,
}
Expand description

Re-export of the shared TLS config block used by the proxy config. Shared TLS configuration parsed from TOML. Used by all suspension-stack tools (Camber, Kingpin, Damper).

Fields§

§cert: Option<Box<str>>

Path to a PEM-encoded certificate file for manual TLS.

§key: Option<Box<str>>

Path to a PEM-encoded private key file for manual TLS.

§auto: Option<bool>

Enable automatic certificate provisioning.

§email: Option<Box<str>>

Contact email for ACME registration.

§staging: Option<bool>

Use the ACME staging environment instead of production.

§cache_dir: Option<Box<str>>

Directory used to cache ACME account and certificate data.

§dns_provider: Option<Box<str>>

DNS provider name for DNS-01 challenges.

§dns_api_token_env: Option<Box<str>>

Environment variable containing the DNS API token.

§dns_api_token_file: Option<Box<str>>

File containing the DNS API token.

Implementations§

Source§

impl TlsConfig

Source

pub fn validate(&self) -> Result<(), RuntimeError>

Validate that the configured TLS mode is internally consistent.

Source

pub fn auto(&self) -> bool

Return whether automatic TLS is enabled.

Source

pub fn email(&self) -> Option<&str>

Return the configured ACME contact email.

Source

pub fn staging(&self) -> bool

Return whether ACME staging mode is enabled.

Source

pub fn cert(&self) -> Option<&str>

Return the configured certificate path for manual TLS.

Source

pub fn key(&self) -> Option<&str>

Return the configured private key path for manual TLS.

Source

pub fn cache_dir(&self) -> Option<&str>

Return the configured ACME cache directory.

Source

pub fn dns_provider(&self) -> Option<&str>

Return the configured DNS provider name.

Source

pub fn dns_api_token_env(&self) -> Option<&str>

Return the environment variable name holding the DNS API token.

Source

pub fn dns_api_token_file(&self) -> Option<&str>

Return the file path holding the DNS API token.

Trait Implementations§

Source§

impl Debug for TlsConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TlsConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TlsConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,