site_encrypt v0.3.0 SiteEncrypt.Acme.Client View Source

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.

Link to this section Summary

Functions

Obtains the new certificate.

Returns API session for the existing account.

Creates the new account.

Link to this section Functions

Link to this function

create_certificate(session, id)

View Source

Specs

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.

Link to this function

for_existing_account(id, account_key, session_opts)

View Source

Specs

Returns API session for the existing account.

Link to this function

new_account(id, session_opts \\ [])

View Source

Specs

Creates the new account.