autocert

Documentation

Index

• Constants
• Variables
• type CertExpiries
• type CertState
• type Config
  • func (cfg *Config) GetLegoConfig() (*User, *lego.Config, gperr.Error)
  • func (cfg *Config) LoadACMEKey() (*ecdsa.PrivateKey, error)
  • func (cfg *Config) SaveACMEKey(key *ecdsa.PrivateKey) error
  • func (cfg *Config) Validate() gperr.Error
• type Generator
  • func DNSProvider[CT any, PT challenge.Provider](defaultCfg func() *CT, newProvider func(*CT) (PT, error)) Generator
• type Provider
  • func NewProvider(cfg *Config, user *User, legoCfg *lego.Config) *Provider
  • func (p *Provider) GetCert(_ *tls.ClientHelloInfo) (*tls.Certificate, error)
  • func (p *Provider) GetCertPath() string
  • func (p *Provider) GetExpiries() CertExpiries
  • func (p *Provider) GetKeyPath() string
  • func (p *Provider) GetName() string
  • func (p *Provider) LoadCert() error
  • func (p *Provider) ObtainCert() error
  • func (p *Provider) ScheduleRenewal(parent task.Parent)
  • func (p *Provider) Setup() (err error)
  • func (p *Provider) ShouldRenewOn() time.Time
• type User
  • func (u *User) GetEmail() string
  • func (u *User) GetPrivateKey() crypto.PrivateKey
  • func (u *User) GetRegistration() *registration.Resource

Constants

const (
	ProviderLocal  = "local"
	ProviderPseudo = "pseudo"
)

const (
	CertFileDefault    = certBasePath + "cert.crt"
	KeyFileDefault     = certBasePath + "priv.key"
	ACMEKeyFileDefault = certBasePath + "acme.key"
)

Variables

var (
	ErrMissingDomain   = gperr.New("missing field 'domains'")
	ErrMissingEmail    = gperr.New("missing field 'email'")
	ErrMissingProvider = gperr.New("missing field 'provider'")
	ErrInvalidDomain   = gperr.New("invalid domain")
	ErrUnknownProvider = gperr.New("unknown provider")
)

var ErrGetCertFailure = errors.New("get certificate failed")

var Providers = make(map[string]Generator)

Types

type CertExpiries

type CertExpiries map[string]time.Time

type CertState

type CertState int

const (
	CertStateValid CertState = iota
	CertStateExpired
	CertStateMismatch
)

type Config

type Config struct {
	Email       string         `json:"email,omitempty"`
	Domains     []string       `json:"domains,omitempty"`
	CertPath    string         `json:"cert_path,omitempty"`
	KeyPath     string         `json:"key_path,omitempty"`
	ACMEKeyPath string         `json:"acme_key_path,omitempty"`
	Provider    string         `json:"provider,omitempty"`
	Options     map[string]any `json:"options,omitempty"`
}

func (*Config) GetLegoConfig

func (cfg *Config) GetLegoConfig() (*User, *lego.Config, gperr.Error)

func (*Config) LoadACMEKey

func (cfg *Config) LoadACMEKey() (*ecdsa.PrivateKey, error)

func (*Config) SaveACMEKey

func (cfg *Config) SaveACMEKey(key *ecdsa.PrivateKey) error

func (*Config) Validate

func (cfg *Config) Validate() gperr.Error

Validate implements the utils.CustomValidator interface.

type Generator

type Generator func(map[string]any) (challenge.Provider, gperr.Error)

func DNSProvider

func DNSProvider[CT any, PT challenge.Provider](
	defaultCfg func() *CT,
	newProvider func(*CT) (PT, error),
) Generator

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

func NewProvider

func NewProvider(cfg *Config, user *User, legoCfg *lego.Config) *Provider

func (*Provider) GetCert

func (p *Provider) GetCert(_ *tls.ClientHelloInfo) (*tls.Certificate, error)

func (*Provider) GetCertPath

func (p *Provider) GetCertPath() string

func (*Provider) GetExpiries

func (p *Provider) GetExpiries() CertExpiries

func (*Provider) GetKeyPath

func (p *Provider) GetKeyPath() string

func (*Provider) GetName

func (p *Provider) GetName() string

func (*Provider) LoadCert

func (p *Provider) LoadCert() error

func (*Provider) ObtainCert

func (p *Provider) ObtainCert() error

func (*Provider) ScheduleRenewal

func (p *Provider) ScheduleRenewal(parent task.Parent)

func (*Provider) Setup

func (p *Provider) Setup() (err error)

func (*Provider) ShouldRenewOn

func (p *Provider) ShouldRenewOn() time.Time

ShouldRenewOn returns the time at which the certificate should be renewed.

type User

type User struct {
	Email        string
	Registration *registration.Resource
	Key          crypto.PrivateKey
}

func (*User) GetEmail

func (u *User) GetEmail() string

func (*User) GetPrivateKey

func (u *User) GetPrivateKey() crypto.PrivateKey

func (*User) GetRegistration

func (u *User) GetRegistration() *registration.Resource