View Source SiteEncrypt.Acme.Client (site_encrypt v0.6.0)
ACME related functions for endpoints managed by SiteEncrypt
.
This module exposes higher-level ACME client-side scenarios, such as new account creation, and
certification. Normally these functions are invoked automatically by SiteEncrypt
processes.
The functions in this module operate on a running endpoint managed by SiteEncrypt
. For Phoenix
this means that the endpoint must be started through SiteEncrypt.Phoenix
.
See also SiteEncrypt.Acme.Client.API
for details about API sessions and lower level API.
Summary
Functions
Obtains the new certificate.
Returns API
session for the existing account.
Creates the new account.
Functions
@spec create_certificate(SiteEncrypt.Acme.Client.API.session(), SiteEncrypt.id()) :: {SiteEncrypt.pems(), SiteEncrypt.Acme.Client.API.session()}
Obtains the new certificate.
The obtained certificate will not be applied to the endpoint or stored to disk. If you want to
apply the new certificate to the endpoint, you can pass the returned pems to the function
SiteEncrypt.set_certificate/2
.
@spec for_existing_account( SiteEncrypt.id(), JOSE.JWK.t(), SiteEncrypt.Acme.Client.API.session_opts() ) :: SiteEncrypt.Acme.Client.API.session()
Returns API
session for the existing account.
@spec new_account(SiteEncrypt.id(), SiteEncrypt.Acme.Client.API.session_opts()) :: SiteEncrypt.Acme.Client.API.session()
Creates the new account.