Skip to main content

AdminConfig

Struct AdminConfig 

Source
pub struct AdminConfig {
    pub enabled: bool,
    pub bind_address: String,
    pub base_url: String,
    pub session_ttl_seconds: u64,
    pub session_idle_timeout_seconds: u64,
    pub login_max_attempts: u32,
    pub login_window_seconds: u64,
    pub require_mfa: bool,
    pub max_body_bytes: usize,
    pub page_size_max: i64,
    pub template_dir: String,
    pub tls: AdminTlsConfig,
}
Expand description

The web admin interface: a second listener, on its own socket, serving no ACME.

Process-wide, not per-profile – an operator manages every endpoint this process serves, so there is no [profiles.<name>].admin and this is not in PROFILE_SECTIONS.

Off by default. A certificate authority should not grow a management surface because somebody upgraded it.

Fields§

§enabled: bool§bind_address: String

Loopback on purpose. This listener has no admission control and no filter chain, and until AdminTlsConfig::enabled is set, no transport security either. webadmin::check_config refuses to start on a non-loopback bind while TLS is off.

§base_url: String

The origin the panel is reached at. Load-bearing three times over: the CSRF origin check compares against it, a generated self-signed certificate takes its host, and the pages will build absolute URLs from it – exactly as server.base_url does for the ACME listener.

§session_ttl_seconds: u64

Absolute session lifetime. Never extended by activity: past it, the operator signs in again.

§session_idle_timeout_seconds: u64

Idle session lifetime, advanced on use (at most once a minute, so a polling page is not a stream of database writes).

§login_max_attempts: u32

Failed logins allowed from one address per window, then 429 with a Retry-After. The password hash is deliberately expensive, so this is an availability control as much as a credential one.

§login_window_seconds: u64§require_mfa: bool

Require a second factor of every operator.

What this changes is the operator who has none: with it on, their next sign-in lands on the enrolment page and their session stays pending_mfa until they finish. An operator who already has a factor is challenged whether this is set or not – the flag governs enrolment, not enforcement.

Deliberately not “refuse a password-only login”: enrolling needs a session and a session would then need a factor, so setting this on a panel with no enrolled operator would brick it, with no way in to fix it.

Does not retroactively end sessions that predate it. The lever that does is acme-proxy admin session revoke --all.

§max_body_bytes: usize

Largest admin request body – a small JSON object or a form.

§page_size_max: i64

Ceiling on ?limit= for the list endpoints.

§template_dir: String

Override individual page templates on disk, mirroring notify.template_dir. Empty means the compiled-in defaults.

§tls: AdminTlsConfig

Trait Implementations§

Source§

impl Clone for AdminConfig

Source§

fn clone(&self) -> AdminConfig

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

impl Debug for AdminConfig

Source§

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

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

impl Default for AdminConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AdminConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = 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<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