acme

package

v5.0.2 Latest Latest Go to latest Published: Oct 3, 2022 License: Apache-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-micro/microwire

Links

Open Source Insights

Documentation ¶

Overview ¶

Package acme abstracts away various ACME libraries

Constants ¶

View Source

const (
	LetsEncryptStagingCA    = "https://acme-staging-v02.api.letsencrypt.org/directory"
	LetsEncryptProductionCA = "https://acme-v02.api.letsencrypt.org/directory"
)

The Let's Encrypt ACME endpoints.

Variables ¶

View Source

var (
	// ErrProviderNotImplemented can be returned when attempting to
	// instantiate an unimplemented provider.
	ErrProviderNotImplemented = errors.New("Provider not implemented")
)

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(o *Options)

Option (or Options) are passed to New() to configure providers.

func AcceptToS ¶

func AcceptToS(b bool) Option

AcceptToS indicates whether you accept your CA's terms of service.

func CA ¶

func CA(CA string) Option

CA sets the CA of an acme.Options.

func Cache ¶

func Cache(c interface{}) Option

Cache provides a cache / storage interface to the underlying ACME library as there is no standard, this needs to be validated by the underlying implementation.

func ChallengeProvider ¶

func ChallengeProvider(p challenge.Provider) Option

ChallengeProvider sets the Challenge provider of an acme.Options if set, it enables the DNS challenge, otherwise tls-alpn-01 will be used.

func Logger ¶

func Logger(l logger.Logger) Option

Logger sets the underline logger.

func OnDemand ¶

func OnDemand(b bool) Option

OnDemand enables on-demand certificate issuance. Not recommended for use with the DNS challenge, as the first connection may be very slow.

type Options ¶

type Options struct {
	// AcceptTLS must be set to true to indicate that you have read your
	// provider's terms of service.
	AcceptToS bool
	// CA is the CA to use
	CA string
	// ChallengeProvider is a go-acme/lego challenge provider. Set this if you
	// want to use DNS Challenges. Otherwise, tls-alpn-01 will be used
	ChallengeProvider challenge.Provider
	// Issue certificates for domains on demand. Otherwise, certs will be
	// retrieved / issued on start-up.
	OnDemand bool
	// Cache is a storage interface. Most ACME libraries have an cache, but
	// there's no defined interface, so if you consume this option
	// sanity check it before using.
	Cache interface{}

	// Logger is the underling logging framework
	Logger logger.Logger
}

Options represents various options you can present to ACME providers.

func DefaultOptions ¶

func DefaultOptions() Options

DefaultOptions uses the Let's Encrypt Production CA, with DNS Challenge disabled.

type Provider ¶

type Provider interface {
	// Listen returns a new listener
	Listen(...string) (net.Listener, error)
	// TLSConfig returns a tls config
	TLSConfig(...string) (*tls.Config, error)
}

Provider is a ACME provider interface.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
autocert Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.	Package autocert is the ACME provider from golang.org/x/crypto/acme/autocert This provider does not take any config.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL