Skip to main content

AdminState

Struct AdminState 

Source
pub struct AdminState {
    pub database: Arc<Database>,
    pub config: Arc<Config>,
    pub profiles: Arc<HashMap<String, Arc<Profile>>>,
    pub logins: Arc<LoginLimiter>,
    pub templates: Arc<Environment<'static>>,
    pub audit: Arc<Auditor>,
    pub notifiers: Notifiers,
    pub jobs: JobQueue,
}
Expand description

Shared state for every admin route.

Not acme_proxy_protocol::router::AppState: that one holds exactly one Profile, and this listener is cross-profile by nature — an operator lists accounts from every endpoint at once, and revoking an order needs that order’s own profile’s revocation route, which may name a different CA from the one the request arrived through.

Fields§

§database: Arc<Database>§config: Arc<Config>§profiles: Arc<HashMap<String, Arc<Profile>>>

Keyed by profile name — the lookup orders.profile needs.

§logins: Arc<LoginLimiter>§templates: Arc<Environment<'static>>

The /ui templates, embedded defaults overlaid by admin.template_dir. Built once: the loader reads a file per template on first use, and rebuilding it per request would mean a disk read per page.

§audit: Arc<Auditor>

The same process-wide auditor the ACME listener holds. Shared rather than a second instance: an operator revoking through the panel writes into the one trail, and the reverse-lookup cache is worth sharing.

§notifiers: Notifiers

The profile name -> dispatcher map, as a reload-stable handle — the same type NotifyJob and the signer backends hold. Used only to reach the process-wide security dispatcher under acme_proxy_jobs::notify::ADMIN_DISPATCHER_KEY via AdminState::notify_security.

§jobs: JobQueue

The durable queue: a revocation for a backend only the worker role holds is queued here, and a local CA’s CRL regeneration after one.

Implementations§

Source§

impl AdminState

Source

pub fn new( database: Arc<Database>, config: Arc<Config>, profiles: &[Arc<Profile>], audit: Arc<Auditor>, notifiers: Notifiers, jobs: JobQueue, ) -> Self

Builds the state from what serve_on already has in hand.

Takes a slice, not the Vec: build_app consumes that vec, so the admin side has to be built first, and expressing it in the signature is what stops the ordering being rediscovered as a borrow error.

Source

pub fn with_logins( database: Arc<Database>, config: Arc<Config>, profiles: &[Arc<Profile>], audit: Arc<Auditor>, notifiers: Notifiers, jobs: JobQueue, previous_logins: Option<&LoginLimiter>, ) -> Self

new, carrying the previous generation’s login counters.

Only a configuration reload passes Some: every other caller is building the first generation, where there is nothing to carry. See LoginLimiter::rebuilt for why the counters move but the limits do not.

Trait Implementations§

Source§

impl Clone for AdminState

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

impl FromRequestParts<AdminState> for PageSession

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageSessionWrite

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageAdminWrite

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageAdminRead

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageSelfServiceWrite

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageMfaPending

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageMfaSubmit

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PageEnrolWrite

Source§

type Rejection = PageError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for Authenticated

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for AdminRead

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for AuthenticatedWrite

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for AdminWrite

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for SelfServiceWrite

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PendingMfa

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for PendingMfaSubmit

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl FromRequestParts<AdminState> for EnrolWrite

Source§

type Rejection = AdminError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &AdminState, ) -> Result<Self, Self::Rejection>

Perform the extraction.

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> 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 = !

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