Skip to main content

CertificateManager

Struct CertificateManager 

Source
pub struct CertificateManager<D: AcmeDnsChallenge> {
    store: CertStore,
    dns: Arc<D>,
    account: Account,
    environment: Environment,
    domains: Vec<String>,
    policy: RenewalPolicy,
    tracker: Mutex<RenewalTracker>,
    cert: Arc<SwappableCert>,
    provider: CryptoProvider,
}
Expand description

The PDS’s own certificate: issuance, renewal and the live rustls state, in one place.

Fields§

§store: CertStore§dns: Arc<D>§account: Account§environment: Environment§domains: Vec<String>§policy: RenewalPolicy§tracker: Mutex<RenewalTracker>§cert: Arc<SwappableCert>§provider: CryptoProvider

Implementations§

Source§

impl<D: AcmeDnsChallenge + 'static> CertificateManager<D>

Source

pub async fn bootstrap( data_dir: &Path, zone: &str, environment: Environment, contact: &[&str], policy: RenewalPolicy, dns: Arc<D>, ) -> Result<Arc<Self>, BootstrapError>

Loads or obtains a certificate for zone and *.zone, from data_dir/tls/zones/<zone>, and returns a manager ready to serve and renew it.

One manager covers exactly one zone. A deployment configured with several needs one of these each — crate::fleet::CertificateFleet is what builds and holds them.

Installs ring as the process’s default rustls crypto provider if none is installed yet; if one is already installed (for instance by another part of the process that also uses rustls) this is a no-op rather than an error – a second install attempt is expected, not exceptional.

Source

pub async fn bootstrap_with_account( data_dir: &Path, zone: &str, environment: Environment, contact: &[&str], policy: RenewalPolicy, dns: Arc<D>, account: Account, ) -> Result<Arc<Self>, BootstrapError>

Assembles a manager from an [Account] built elsewhere, skipping CertificateManager::bootstrap’s own credential-loading and its hardcoded ReqwestAcmeClient against environment.directory_url().

This is the seam a test drives against an in-process fake ACME directory: CertificateManager::bootstrap has no way to reach anything but a real Let’s Encrypt endpoint, so nothing downstream of it could run without one. Production code that already holds an [Account] – for instance one restored through a different credential path than crate::storage::CertStore – can use this directly too.

Source

async fn finish_bootstrap( store: CertStore, zone: &str, environment: Environment, contact: &[&str], policy: RenewalPolicy, dns: Arc<D>, account: Account, ) -> Result<Arc<Self>, BootstrapError>

Everything both bootstrap paths share once an [Account] is in hand: publish the zone’s CAA record, load or issue the certificate, and assemble the manager.

Source

pub fn zone(&self) -> &str

The zone this manager holds a certificate for.

Source

pub fn resolver(&self) -> Arc<SwappableCert>

The live certificate resolver. Build the process’s one rustls::ServerConfig from this once, at startup; renewal swaps the certificate this resolver hands back, not the config or the listener.

Source

pub async fn alert_level(&self) -> AlertLevel

How urgently the current renewal state should be surfaced, right now.

Source

pub async fn run_renewal_loop(self: Arc<Self>)

Runs forever, checking on CHECK_INTERVAL whether renewal is due and attempting it when it is.

A failed attempt never touches Self::resolver: the certificate already being served keeps being served, and the failure is only recorded in the tracker that Self::alert_level reads. Intended to be spawned once and left running for the life of the process.

Source

pub async fn maybe_renew(&self)

Checks whether renewal is due and, if so, attempts it once. Split out from Self::run_renewal_loop so a test can call it directly on a clock it controls, without waiting on CHECK_INTERVAL.

Source

async fn apply_renewal(&self, issued: IssuedCertificate, now: OffsetDateTime)

Source

async fn record_failure(&self, err: IssueError, now: OffsetDateTime)

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
§

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

§

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

§

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

§

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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

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
§

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

Source§

type Output = T

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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