mirror of
https://github.com/caddyserver/caddy.git
synced 2025-01-27 23:03:37 -05:00
caddytls: Clean up some code related to automation
This commit is contained in:
parent
c67c8e60cc
commit
0433f9d075
4 changed files with 318 additions and 299 deletions
|
@ -195,7 +195,7 @@ func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
||||||
tlsApp.Automation = new(caddytls.AutomationConfig)
|
tlsApp.Automation = new(caddytls.AutomationConfig)
|
||||||
}
|
}
|
||||||
tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, &caddytls.AutomationPolicy{
|
tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, &caddytls.AutomationPolicy{
|
||||||
Hosts: sblockHosts,
|
Subjects: sblockHosts,
|
||||||
IssuerRaw: caddyconfig.JSONModuleObject(issuer, "module", issuer.(caddy.Module).CaddyModule().ID.Name(), &warnings),
|
IssuerRaw: caddyconfig.JSONModuleObject(issuer, "module", issuer.(caddy.Module).CaddyModule().ID.Name(), &warnings),
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
|
@ -768,17 +768,17 @@ func consolidateAutomationPolicies(aps []*caddytls.AutomationPolicy) []*caddytls
|
||||||
// if the policy is the same, we can keep just one, but we have
|
// if the policy is the same, we can keep just one, but we have
|
||||||
// to be careful which one we keep; if only one has any hostnames
|
// to be careful which one we keep; if only one has any hostnames
|
||||||
// defined, then we need to keep the one without any hostnames,
|
// defined, then we need to keep the one without any hostnames,
|
||||||
// otherwise the one without any hosts (a catch-all) would be
|
// otherwise the one without any subjects (a catch-all) would be
|
||||||
// eaten up by the one with hosts; and if both have hosts, we
|
// eaten up by the one with subjects; and if both have subjects, we
|
||||||
// need to combine their lists
|
// need to combine their lists
|
||||||
if reflect.DeepEqual(aps[i].IssuerRaw, aps[j].IssuerRaw) &&
|
if reflect.DeepEqual(aps[i].IssuerRaw, aps[j].IssuerRaw) &&
|
||||||
aps[i].ManageSync == aps[j].ManageSync {
|
aps[i].ManageSync == aps[j].ManageSync {
|
||||||
if len(aps[i].Hosts) == 0 && len(aps[j].Hosts) > 0 {
|
if len(aps[i].Subjects) == 0 && len(aps[j].Subjects) > 0 {
|
||||||
aps = append(aps[:j], aps[j+1:]...)
|
aps = append(aps[:j], aps[j+1:]...)
|
||||||
} else if len(aps[i].Hosts) > 0 && len(aps[j].Hosts) == 0 {
|
} else if len(aps[i].Subjects) > 0 && len(aps[j].Subjects) == 0 {
|
||||||
aps = append(aps[:i], aps[i+1:]...)
|
aps = append(aps[:i], aps[i+1:]...)
|
||||||
} else {
|
} else {
|
||||||
aps[i].Hosts = append(aps[i].Hosts, aps[j].Hosts...)
|
aps[i].Subjects = append(aps[i].Subjects, aps[j].Subjects...)
|
||||||
aps = append(aps[:j], aps[j+1:]...)
|
aps = append(aps[:j], aps[j+1:]...)
|
||||||
}
|
}
|
||||||
i--
|
i--
|
||||||
|
@ -789,7 +789,7 @@ func consolidateAutomationPolicies(aps []*caddytls.AutomationPolicy) []*caddytls
|
||||||
|
|
||||||
// ensure any catch-all policies go last
|
// ensure any catch-all policies go last
|
||||||
sort.SliceStable(aps, func(i, j int) bool {
|
sort.SliceStable(aps, func(i, j int) bool {
|
||||||
return len(aps[i].Hosts) > len(aps[j].Hosts)
|
return len(aps[i].Subjects) > len(aps[j].Subjects)
|
||||||
})
|
})
|
||||||
|
|
||||||
return aps
|
return aps
|
||||||
|
|
|
@ -235,7 +235,7 @@ uniqueDomainsLoop:
|
||||||
// one automation policy would be confusing and an error
|
// one automation policy would be confusing and an error
|
||||||
if app.tlsApp.Automation != nil {
|
if app.tlsApp.Automation != nil {
|
||||||
for _, ap := range app.tlsApp.Automation.Policies {
|
for _, ap := range app.tlsApp.Automation.Policies {
|
||||||
for _, apHost := range ap.Hosts {
|
for _, apHost := range ap.Subjects {
|
||||||
if apHost == d {
|
if apHost == d {
|
||||||
continue uniqueDomainsLoop
|
continue uniqueDomainsLoop
|
||||||
}
|
}
|
||||||
|
@ -424,7 +424,7 @@ func (app *App) createAutomationPolicies(ctx caddy.Context, publicNames, interna
|
||||||
// custom CA endpoint, for example - whichever one we choose must
|
// custom CA endpoint, for example - whichever one we choose must
|
||||||
// have a host list that is a superset of the policy we make...
|
// have a host list that is a superset of the policy we make...
|
||||||
// the policy with no host filter is guaranteed to qualify
|
// the policy with no host filter is guaranteed to qualify
|
||||||
if len(ap.Hosts) == 0 {
|
if len(ap.Subjects) == 0 {
|
||||||
basePolicy = ap
|
basePolicy = ap
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
@ -451,7 +451,7 @@ func (app *App) createAutomationPolicies(ctx caddy.Context, publicNames, interna
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
newPolicy.Issuer = issuer
|
newPolicy.Issuer = issuer
|
||||||
newPolicy.Hosts = hosts
|
newPolicy.Subjects = hosts
|
||||||
|
|
||||||
return app.tlsApp.AddAutomationPolicy(newPolicy)
|
return app.tlsApp.AddAutomationPolicy(newPolicy)
|
||||||
}
|
}
|
||||||
|
|
301
modules/caddytls/automation.go
Normal file
301
modules/caddytls/automation.go
Normal file
|
@ -0,0 +1,301 @@
|
||||||
|
// Copyright 2015 Matthew Holt and The Caddy Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package caddytls
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/caddyserver/caddy/v2"
|
||||||
|
"github.com/caddyserver/certmagic"
|
||||||
|
"github.com/go-acme/lego/v3/challenge"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AutomationConfig designates configuration for the
|
||||||
|
// construction and use of ACME clients.
|
||||||
|
type AutomationConfig struct {
|
||||||
|
// The list of automation policies. The first matching
|
||||||
|
// policy will be applied for a given certificate/name.
|
||||||
|
Policies []*AutomationPolicy `json:"policies,omitempty"`
|
||||||
|
|
||||||
|
// On-Demand TLS defers certificate operations to the
|
||||||
|
// moment they are needed, e.g. during a TLS handshake.
|
||||||
|
// Useful when you don't know all the hostnames up front.
|
||||||
|
// Caddy was the first web server to deploy this technology.
|
||||||
|
OnDemand *OnDemandConfig `json:"on_demand,omitempty"`
|
||||||
|
|
||||||
|
// Caddy staples OCSP (and caches the response) for all
|
||||||
|
// qualifying certificates by default. This setting
|
||||||
|
// changes how often it scans responses for freshness,
|
||||||
|
// and updates them if they are getting stale.
|
||||||
|
OCSPCheckInterval caddy.Duration `json:"ocsp_interval,omitempty"`
|
||||||
|
|
||||||
|
// Every so often, Caddy will scan all loaded, managed
|
||||||
|
// certificates for expiration. This setting changes how
|
||||||
|
// frequently the scan for expiring certificates is
|
||||||
|
// performed. If your certificate lifetimes are very
|
||||||
|
// short (less than ~24 hours), you should set this to
|
||||||
|
// a low value.
|
||||||
|
RenewCheckInterval caddy.Duration `json:"renew_interval,omitempty"`
|
||||||
|
|
||||||
|
defaultAutomationPolicy *AutomationPolicy
|
||||||
|
}
|
||||||
|
|
||||||
|
// AutomationPolicy designates the policy for automating the
|
||||||
|
// management (obtaining, renewal, and revocation) of managed
|
||||||
|
// TLS certificates.
|
||||||
|
//
|
||||||
|
// An AutomationPolicy value is not valid until it has been
|
||||||
|
// provisioned; use the `AddAutomationPolicy()` method on the
|
||||||
|
// TLS app to properly provision a new policy.
|
||||||
|
type AutomationPolicy struct {
|
||||||
|
// Which subjects (hostnames or IP addresses) this policy applies to.
|
||||||
|
Subjects []string `json:"subjects,omitempty"`
|
||||||
|
|
||||||
|
// The module that will issue certificates. Default: acme
|
||||||
|
IssuerRaw json.RawMessage `json:"issuer,omitempty" caddy:"namespace=tls.issuance inline_key=module"`
|
||||||
|
|
||||||
|
// If true, certificates will be requested with MustStaple. Not all
|
||||||
|
// CAs support this, and there are potentially serious consequences
|
||||||
|
// of enabling this feature without proper threat modeling.
|
||||||
|
MustStaple bool `json:"must_staple,omitempty"`
|
||||||
|
|
||||||
|
// How long before a certificate's expiration to try renewing it,
|
||||||
|
// as a function of its total lifetime. As a general and conservative
|
||||||
|
// rule, it is a good idea to renew a certificate when it has about
|
||||||
|
// 1/3 of its total lifetime remaining. This utilizes the majority
|
||||||
|
// of the certificate's lifetime while still saving time to
|
||||||
|
// troubleshoot problems. However, for extremely short-lived certs,
|
||||||
|
// you may wish to increase the ratio to ~1/2.
|
||||||
|
RenewalWindowRatio float64 `json:"renewal_window_ratio,omitempty"`
|
||||||
|
|
||||||
|
// The type of key to generate for certificates.
|
||||||
|
// Supported values: `ed25519`, `p256`, `p384`, `rsa2048`, `rsa4096`.
|
||||||
|
KeyType string `json:"key_type,omitempty"`
|
||||||
|
|
||||||
|
// Optionally configure a separate storage module associated with this
|
||||||
|
// manager, instead of using Caddy's global/default-configured storage.
|
||||||
|
StorageRaw json.RawMessage `json:"storage,omitempty" caddy:"namespace=caddy.storage inline_key=module"`
|
||||||
|
|
||||||
|
// If true, certificates will be managed "on demand"; that is, during
|
||||||
|
// TLS handshakes or when needed, as opposed to at startup or config
|
||||||
|
// load.
|
||||||
|
OnDemand bool `json:"on_demand,omitempty"`
|
||||||
|
|
||||||
|
// If true, certificate management will be conducted
|
||||||
|
// in the foreground; this will block config reloads
|
||||||
|
// and return errors if there were problems with
|
||||||
|
// obtaining or renewing certificates. This is often
|
||||||
|
// not desirable, especially when serving sites out
|
||||||
|
// of your control. Default: false
|
||||||
|
// TODO: is this really necessary per-policy? why not a global setting...
|
||||||
|
ManageSync bool `json:"manage_sync,omitempty"`
|
||||||
|
|
||||||
|
// Issuer stores the decoded issuer parameters. This is only
|
||||||
|
// used to populate an underlying certmagic.Config's Issuer
|
||||||
|
// field; it is not referenced thereafter.
|
||||||
|
Issuer certmagic.Issuer `json:"-"`
|
||||||
|
|
||||||
|
magic *certmagic.Config
|
||||||
|
storage certmagic.Storage
|
||||||
|
}
|
||||||
|
|
||||||
|
// provision converts ap into a CertMagic config.
|
||||||
|
func (ap *AutomationPolicy) provision(tlsApp *TLS) error {
|
||||||
|
// policy-specific storage implementation
|
||||||
|
if ap.StorageRaw != nil {
|
||||||
|
val, err := tlsApp.ctx.LoadModule(ap, "StorageRaw")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("loading TLS storage module: %v", err)
|
||||||
|
}
|
||||||
|
cmStorage, err := val.(caddy.StorageConverter).CertMagicStorage()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("creating TLS storage configuration: %v", err)
|
||||||
|
}
|
||||||
|
ap.storage = cmStorage
|
||||||
|
}
|
||||||
|
|
||||||
|
var ond *certmagic.OnDemandConfig
|
||||||
|
if ap.OnDemand {
|
||||||
|
var onDemand *OnDemandConfig
|
||||||
|
if tlsApp.Automation != nil {
|
||||||
|
onDemand = tlsApp.Automation.OnDemand
|
||||||
|
}
|
||||||
|
|
||||||
|
ond = &certmagic.OnDemandConfig{
|
||||||
|
DecisionFunc: func(name string) error {
|
||||||
|
if onDemand != nil {
|
||||||
|
if onDemand.Ask != "" {
|
||||||
|
err := onDemandAskRequest(onDemand.Ask, name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// check the rate limiter last because
|
||||||
|
// doing so makes a reservation
|
||||||
|
if !onDemandRateLimiter.Allow() {
|
||||||
|
return fmt.Errorf("on-demand rate limit exceeded")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ap.IssuerRaw != nil {
|
||||||
|
val, err := tlsApp.ctx.LoadModule(ap, "IssuerRaw")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("loading TLS automation management module: %s", err)
|
||||||
|
}
|
||||||
|
ap.Issuer = val.(certmagic.Issuer)
|
||||||
|
}
|
||||||
|
|
||||||
|
keySource := certmagic.StandardKeyGenerator{
|
||||||
|
KeyType: supportedCertKeyTypes[ap.KeyType],
|
||||||
|
}
|
||||||
|
|
||||||
|
storage := ap.storage
|
||||||
|
if storage == nil {
|
||||||
|
storage = tlsApp.ctx.Storage()
|
||||||
|
}
|
||||||
|
|
||||||
|
template := certmagic.Config{
|
||||||
|
MustStaple: ap.MustStaple,
|
||||||
|
RenewalWindowRatio: ap.RenewalWindowRatio,
|
||||||
|
KeySource: keySource,
|
||||||
|
OnDemand: ond,
|
||||||
|
Storage: storage,
|
||||||
|
Issuer: ap.Issuer, // if nil, certmagic.New() will set default in returned Config
|
||||||
|
}
|
||||||
|
if rev, ok := ap.Issuer.(certmagic.Revoker); ok {
|
||||||
|
template.Revoker = rev
|
||||||
|
}
|
||||||
|
ap.magic = certmagic.New(tlsApp.certCache, template)
|
||||||
|
|
||||||
|
// sometimes issuers may need the parent certmagic.Config in
|
||||||
|
// order to function properly (for example, ACMEIssuer needs
|
||||||
|
// access to the correct storage and cache so it can solve
|
||||||
|
// ACME challenges -- it's an annoying, inelegant circular
|
||||||
|
// dependency that I don't know how to resolve nicely!)
|
||||||
|
if configger, ok := ap.Issuer.(ConfigSetter); ok {
|
||||||
|
configger.SetConfig(ap.magic)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ChallengesConfig configures the ACME challenges.
|
||||||
|
type ChallengesConfig struct {
|
||||||
|
// HTTP configures the ACME HTTP challenge. This
|
||||||
|
// challenge is enabled and used automatically
|
||||||
|
// and by default.
|
||||||
|
HTTP *HTTPChallengeConfig `json:"http,omitempty"`
|
||||||
|
|
||||||
|
// TLSALPN configures the ACME TLS-ALPN challenge.
|
||||||
|
// This challenge is enabled and used automatically
|
||||||
|
// and by default.
|
||||||
|
TLSALPN *TLSALPNChallengeConfig `json:"tls-alpn,omitempty"`
|
||||||
|
|
||||||
|
// Configures the ACME DNS challenge. Because this
|
||||||
|
// challenge typically requires credentials for
|
||||||
|
// interfacing with a DNS provider, this challenge is
|
||||||
|
// not enabled by default. This is the only challenge
|
||||||
|
// type which does not require a direct connection
|
||||||
|
// to Caddy from an external server.
|
||||||
|
DNSRaw json.RawMessage `json:"dns,omitempty" caddy:"namespace=tls.dns inline_key=provider"`
|
||||||
|
|
||||||
|
DNS challenge.Provider `json:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTPChallengeConfig configures the ACME HTTP challenge.
|
||||||
|
type HTTPChallengeConfig struct {
|
||||||
|
// If true, the HTTP challenge will be disabled.
|
||||||
|
Disabled bool `json:"disabled,omitempty"`
|
||||||
|
|
||||||
|
// An alternate port on which to service this
|
||||||
|
// challenge. Note that the HTTP challenge port is
|
||||||
|
// hard-coded into the spec and cannot be changed,
|
||||||
|
// so you would have to forward packets from the
|
||||||
|
// standard HTTP challenge port to this one.
|
||||||
|
AlternatePort int `json:"alternate_port,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLSALPNChallengeConfig configures the ACME TLS-ALPN challenge.
|
||||||
|
type TLSALPNChallengeConfig struct {
|
||||||
|
// If true, the TLS-ALPN challenge will be disabled.
|
||||||
|
Disabled bool `json:"disabled,omitempty"`
|
||||||
|
|
||||||
|
// An alternate port on which to service this
|
||||||
|
// challenge. Note that the TLS-ALPN challenge port
|
||||||
|
// is hard-coded into the spec and cannot be changed,
|
||||||
|
// so you would have to forward packets from the
|
||||||
|
// standard TLS-ALPN challenge port to this one.
|
||||||
|
AlternatePort int `json:"alternate_port,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnDemandConfig configures on-demand TLS, for obtaining
|
||||||
|
// needed certificates at handshake-time. Because this
|
||||||
|
// feature can easily be abused, you should set up rate
|
||||||
|
// limits and/or an internal endpoint that Caddy can
|
||||||
|
// "ask" if it should be allowed to manage certificates
|
||||||
|
// for a given hostname.
|
||||||
|
type OnDemandConfig struct {
|
||||||
|
// An optional rate limit to throttle the
|
||||||
|
// issuance of certificates from handshakes.
|
||||||
|
RateLimit *RateLimit `json:"rate_limit,omitempty"`
|
||||||
|
|
||||||
|
// If Caddy needs to obtain or renew a certificate
|
||||||
|
// during a TLS handshake, it will perform a quick
|
||||||
|
// HTTP request to this URL to check if it should be
|
||||||
|
// allowed to try to get a certificate for the name
|
||||||
|
// in the "domain" query string parameter, like so:
|
||||||
|
// `?domain=example.com`. The endpoint must return a
|
||||||
|
// 200 OK status if a certificate is allowed;
|
||||||
|
// anything else will cause it to be denied.
|
||||||
|
// Redirects are not followed.
|
||||||
|
Ask string `json:"ask,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RateLimit specifies an interval with optional burst size.
|
||||||
|
type RateLimit struct {
|
||||||
|
// A duration value. A certificate may be obtained 'burst'
|
||||||
|
// times during this interval.
|
||||||
|
Interval caddy.Duration `json:"interval,omitempty"`
|
||||||
|
|
||||||
|
// How many times during an interval a certificate can be obtained.
|
||||||
|
Burst int `json:"burst,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConfigSetter is implemented by certmagic.Issuers that
|
||||||
|
// need access to a parent certmagic.Config as part of
|
||||||
|
// their provisioning phase. For example, the ACMEIssuer
|
||||||
|
// requires a config so it can access storage and the
|
||||||
|
// cache to solve ACME challenges.
|
||||||
|
type ConfigSetter interface {
|
||||||
|
SetConfig(cfg *certmagic.Config)
|
||||||
|
}
|
||||||
|
|
||||||
|
// These perpetual values are used for on-demand TLS.
|
||||||
|
var (
|
||||||
|
onDemandRateLimiter = certmagic.NewRateLimiter(0, 0)
|
||||||
|
onDemandAskClient = &http.Client{
|
||||||
|
Timeout: 10 * time.Second,
|
||||||
|
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
||||||
|
return fmt.Errorf("following http redirects is not allowed")
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
|
@ -28,7 +28,6 @@ import (
|
||||||
|
|
||||||
"github.com/caddyserver/caddy/v2"
|
"github.com/caddyserver/caddy/v2"
|
||||||
"github.com/caddyserver/certmagic"
|
"github.com/caddyserver/certmagic"
|
||||||
"github.com/go-acme/lego/v3/challenge"
|
|
||||||
"go.uber.org/zap"
|
"go.uber.org/zap"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -183,7 +182,7 @@ func (t *TLS) Validate() error {
|
||||||
// isn't useful and is probably a mistake
|
// isn't useful and is probably a mistake
|
||||||
hostSet := make(map[string]int)
|
hostSet := make(map[string]int)
|
||||||
for i, ap := range t.Automation.Policies {
|
for i, ap := range t.Automation.Policies {
|
||||||
for _, h := range ap.Hosts {
|
for _, h := range ap.Subjects {
|
||||||
if first, ok := hostSet[h]; ok {
|
if first, ok := hostSet[h]; ok {
|
||||||
return fmt.Errorf("automation policy %d: cannot apply more than one automation policy to host: %s (first match in policy %d)", i, h, first)
|
return fmt.Errorf("automation policy %d: cannot apply more than one automation policy to host: %s (first match in policy %d)", i, h, first)
|
||||||
}
|
}
|
||||||
|
@ -300,7 +299,7 @@ func (t *TLS) AddAutomationPolicy(ap *AutomationPolicy) error {
|
||||||
for i, other := range t.Automation.Policies {
|
for i, other := range t.Automation.Policies {
|
||||||
// if a catch-all policy (or really, any policy with
|
// if a catch-all policy (or really, any policy with
|
||||||
// fewer names) exists, prioritize this new policy
|
// fewer names) exists, prioritize this new policy
|
||||||
if len(other.Hosts) < len(ap.Hosts) {
|
if len(other.Subjects) < len(ap.Subjects) {
|
||||||
t.Automation.Policies = append(t.Automation.Policies[:i],
|
t.Automation.Policies = append(t.Automation.Policies[:i],
|
||||||
append([]*AutomationPolicy{ap}, t.Automation.Policies[i+1:]...)...)
|
append([]*AutomationPolicy{ap}, t.Automation.Policies[i+1:]...)...)
|
||||||
return nil
|
return nil
|
||||||
|
@ -318,10 +317,10 @@ func (t *TLS) getConfigForName(name string) *certmagic.Config {
|
||||||
|
|
||||||
func (t *TLS) getAutomationPolicyForName(name string) *AutomationPolicy {
|
func (t *TLS) getAutomationPolicyForName(name string) *AutomationPolicy {
|
||||||
for _, ap := range t.Automation.Policies {
|
for _, ap := range t.Automation.Policies {
|
||||||
if len(ap.Hosts) == 0 {
|
if len(ap.Subjects) == 0 {
|
||||||
return ap // no host filter is an automatic match
|
return ap // no host filter is an automatic match
|
||||||
}
|
}
|
||||||
for _, h := range ap.Hosts {
|
for _, h := range ap.Subjects {
|
||||||
if h == name {
|
if h == name {
|
||||||
return ap
|
return ap
|
||||||
}
|
}
|
||||||
|
@ -399,261 +398,6 @@ type Certificate struct {
|
||||||
Tags []string
|
Tags []string
|
||||||
}
|
}
|
||||||
|
|
||||||
// AutomationConfig designates configuration for the
|
|
||||||
// construction and use of ACME clients.
|
|
||||||
type AutomationConfig struct {
|
|
||||||
// The list of automation policies. The first matching
|
|
||||||
// policy will be applied for a given certificate/name.
|
|
||||||
Policies []*AutomationPolicy `json:"policies,omitempty"`
|
|
||||||
|
|
||||||
// On-Demand TLS defers certificate operations to the
|
|
||||||
// moment they are needed, e.g. during a TLS handshake.
|
|
||||||
// Useful when you don't know all the hostnames up front.
|
|
||||||
// Caddy was the first web server to deploy this technology.
|
|
||||||
OnDemand *OnDemandConfig `json:"on_demand,omitempty"`
|
|
||||||
|
|
||||||
// Caddy staples OCSP (and caches the response) for all
|
|
||||||
// qualifying certificates by default. This setting
|
|
||||||
// changes how often it scans responses for freshness,
|
|
||||||
// and updates them if they are getting stale.
|
|
||||||
OCSPCheckInterval caddy.Duration `json:"ocsp_interval,omitempty"`
|
|
||||||
|
|
||||||
// Every so often, Caddy will scan all loaded, managed
|
|
||||||
// certificates for expiration. This setting changes how
|
|
||||||
// frequently the scan for expiring certificates is
|
|
||||||
// performed. If your certificate lifetimes are very
|
|
||||||
// short (less than ~24 hours), you should set this to
|
|
||||||
// a low value.
|
|
||||||
RenewCheckInterval caddy.Duration `json:"renew_interval,omitempty"`
|
|
||||||
|
|
||||||
defaultAutomationPolicy *AutomationPolicy
|
|
||||||
}
|
|
||||||
|
|
||||||
// AutomationPolicy designates the policy for automating the
|
|
||||||
// management (obtaining, renewal, and revocation) of managed
|
|
||||||
// TLS certificates.
|
|
||||||
//
|
|
||||||
// An AutomationPolicy value is not valid until it has been
|
|
||||||
// provisioned; use the `AddAutomationPolicy()` method on the
|
|
||||||
// TLS app to properly provision a new policy.
|
|
||||||
type AutomationPolicy struct {
|
|
||||||
// Which hostnames this policy applies to.
|
|
||||||
Hosts []string `json:"hosts,omitempty"`
|
|
||||||
|
|
||||||
// The module that will issue certificates. Default: acme
|
|
||||||
IssuerRaw json.RawMessage `json:"issuer,omitempty" caddy:"namespace=tls.issuance inline_key=module"`
|
|
||||||
|
|
||||||
// If true, certificates will be requested with MustStaple. Not all
|
|
||||||
// CAs support this, and there are potentially serious consequences
|
|
||||||
// of enabling this feature without proper threat modeling.
|
|
||||||
MustStaple bool `json:"must_staple,omitempty"`
|
|
||||||
|
|
||||||
// How long before a certificate's expiration to try renewing it,
|
|
||||||
// as a function of its total lifetime. As a general and conservative
|
|
||||||
// rule, it is a good idea to renew a certificate when it has about
|
|
||||||
// 1/3 of its total lifetime remaining. This utilizes the majority
|
|
||||||
// of the certificate's lifetime while still saving time to
|
|
||||||
// troubleshoot problems. However, for extremely short-lived certs,
|
|
||||||
// you may wish to increase the ratio to ~1/2.
|
|
||||||
RenewalWindowRatio float64 `json:"renewal_window_ratio,omitempty"`
|
|
||||||
|
|
||||||
// The type of key to generate for certificates.
|
|
||||||
// Supported values: `ed25519`, `p256`, `p384`, `rsa2048`, `rsa4096`.
|
|
||||||
KeyType string `json:"key_type,omitempty"`
|
|
||||||
|
|
||||||
// Optionally configure a separate storage module associated with this
|
|
||||||
// manager, instead of using Caddy's global/default-configured storage.
|
|
||||||
StorageRaw json.RawMessage `json:"storage,omitempty" caddy:"namespace=caddy.storage inline_key=module"`
|
|
||||||
|
|
||||||
// If true, certificates will be managed "on demand", that is, during
|
|
||||||
// TLS handshakes or when needed, as opposed to at startup or config
|
|
||||||
// load.
|
|
||||||
OnDemand bool `json:"on_demand,omitempty"`
|
|
||||||
|
|
||||||
// If true, certificate management will be conducted
|
|
||||||
// in the foreground; this will block config reloads
|
|
||||||
// and return errors if there were problems with
|
|
||||||
// obtaining or renewing certificates. This is often
|
|
||||||
// not desirable, especially when serving sites out
|
|
||||||
// of your control. Default: false
|
|
||||||
// TODO: is this really necessary per-policy? why not a global setting...
|
|
||||||
ManageSync bool `json:"manage_sync,omitempty"`
|
|
||||||
|
|
||||||
// Issuer stores the decoded issuer parameters. This is only
|
|
||||||
// used to populate an underlying certmagic.Config's Issuer
|
|
||||||
// field; it is not referenced thereafter.
|
|
||||||
Issuer certmagic.Issuer `json:"-"`
|
|
||||||
|
|
||||||
magic *certmagic.Config
|
|
||||||
storage certmagic.Storage
|
|
||||||
}
|
|
||||||
|
|
||||||
// provision converts ap into a CertMagic config.
|
|
||||||
func (ap *AutomationPolicy) provision(tlsApp *TLS) error {
|
|
||||||
// policy-specific storage implementation
|
|
||||||
if ap.StorageRaw != nil {
|
|
||||||
val, err := tlsApp.ctx.LoadModule(ap, "StorageRaw")
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("loading TLS storage module: %v", err)
|
|
||||||
}
|
|
||||||
cmStorage, err := val.(caddy.StorageConverter).CertMagicStorage()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("creating TLS storage configuration: %v", err)
|
|
||||||
}
|
|
||||||
ap.storage = cmStorage
|
|
||||||
}
|
|
||||||
|
|
||||||
var ond *certmagic.OnDemandConfig
|
|
||||||
if ap.OnDemand {
|
|
||||||
var onDemand *OnDemandConfig
|
|
||||||
if tlsApp.Automation != nil {
|
|
||||||
onDemand = tlsApp.Automation.OnDemand
|
|
||||||
}
|
|
||||||
|
|
||||||
ond = &certmagic.OnDemandConfig{
|
|
||||||
DecisionFunc: func(name string) error {
|
|
||||||
if onDemand != nil {
|
|
||||||
if onDemand.Ask != "" {
|
|
||||||
err := onDemandAskRequest(onDemand.Ask, name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// check the rate limiter last because
|
|
||||||
// doing so makes a reservation
|
|
||||||
if !onDemandRateLimiter.Allow() {
|
|
||||||
return fmt.Errorf("on-demand rate limit exceeded")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ap.IssuerRaw != nil {
|
|
||||||
val, err := tlsApp.ctx.LoadModule(ap, "IssuerRaw")
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("loading TLS automation management module: %s", err)
|
|
||||||
}
|
|
||||||
ap.Issuer = val.(certmagic.Issuer)
|
|
||||||
}
|
|
||||||
|
|
||||||
keySource := certmagic.StandardKeyGenerator{
|
|
||||||
KeyType: supportedCertKeyTypes[ap.KeyType],
|
|
||||||
}
|
|
||||||
|
|
||||||
storage := ap.storage
|
|
||||||
if storage == nil {
|
|
||||||
storage = tlsApp.ctx.Storage()
|
|
||||||
}
|
|
||||||
|
|
||||||
template := certmagic.Config{
|
|
||||||
MustStaple: ap.MustStaple,
|
|
||||||
RenewalWindowRatio: ap.RenewalWindowRatio,
|
|
||||||
KeySource: keySource,
|
|
||||||
OnDemand: ond,
|
|
||||||
Storage: storage,
|
|
||||||
Issuer: ap.Issuer, // if nil, certmagic.New() will set default in returned Config
|
|
||||||
}
|
|
||||||
if rev, ok := ap.Issuer.(certmagic.Revoker); ok {
|
|
||||||
template.Revoker = rev
|
|
||||||
}
|
|
||||||
ap.magic = certmagic.New(tlsApp.certCache, template)
|
|
||||||
|
|
||||||
// sometimes issuers may need the parent certmagic.Config in
|
|
||||||
// order to function properly (for example, ACMEIssuer needs
|
|
||||||
// access to the correct storage and cache so it can solve
|
|
||||||
// ACME challenges -- it's an annoying, inelegant circular
|
|
||||||
// dependency that I don't know how to resolve nicely!)
|
|
||||||
if configger, ok := ap.Issuer.(ConfigSetter); ok {
|
|
||||||
configger.SetConfig(ap.magic)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ChallengesConfig configures the ACME challenges.
|
|
||||||
type ChallengesConfig struct {
|
|
||||||
// HTTP configures the ACME HTTP challenge. This
|
|
||||||
// challenge is enabled and used automatically
|
|
||||||
// and by default.
|
|
||||||
HTTP *HTTPChallengeConfig `json:"http,omitempty"`
|
|
||||||
|
|
||||||
// TLSALPN configures the ACME TLS-ALPN challenge.
|
|
||||||
// This challenge is enabled and used automatically
|
|
||||||
// and by default.
|
|
||||||
TLSALPN *TLSALPNChallengeConfig `json:"tls-alpn,omitempty"`
|
|
||||||
|
|
||||||
// Configures the ACME DNS challenge. Because this
|
|
||||||
// challenge typically requires credentials for
|
|
||||||
// interfacing with a DNS provider, this challenge is
|
|
||||||
// not enabled by default. This is the only challenge
|
|
||||||
// type which does not require a direct connection
|
|
||||||
// to Caddy from an external server.
|
|
||||||
DNSRaw json.RawMessage `json:"dns,omitempty" caddy:"namespace=tls.dns inline_key=provider"`
|
|
||||||
|
|
||||||
DNS challenge.Provider `json:"-"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// HTTPChallengeConfig configures the ACME HTTP challenge.
|
|
||||||
type HTTPChallengeConfig struct {
|
|
||||||
// If true, the HTTP challenge will be disabled.
|
|
||||||
Disabled bool `json:"disabled,omitempty"`
|
|
||||||
|
|
||||||
// An alternate port on which to service this
|
|
||||||
// challenge. Note that the HTTP challenge port is
|
|
||||||
// hard-coded into the spec and cannot be changed,
|
|
||||||
// so you would have to forward packets from the
|
|
||||||
// standard HTTP challenge port to this one.
|
|
||||||
AlternatePort int `json:"alternate_port,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// TLSALPNChallengeConfig configures the ACME TLS-ALPN challenge.
|
|
||||||
type TLSALPNChallengeConfig struct {
|
|
||||||
// If true, the TLS-ALPN challenge will be disabled.
|
|
||||||
Disabled bool `json:"disabled,omitempty"`
|
|
||||||
|
|
||||||
// An alternate port on which to service this
|
|
||||||
// challenge. Note that the TLS-ALPN challenge port
|
|
||||||
// is hard-coded into the spec and cannot be changed,
|
|
||||||
// so you would have to forward packets from the
|
|
||||||
// standard TLS-ALPN challenge port to this one.
|
|
||||||
AlternatePort int `json:"alternate_port,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// OnDemandConfig configures on-demand TLS, for obtaining
|
|
||||||
// needed certificates at handshake-time. Because this
|
|
||||||
// feature can easily be abused, you should set up rate
|
|
||||||
// limits and/or an internal endpoint that Caddy can
|
|
||||||
// "ask" if it should be allowed to manage certificates
|
|
||||||
// for a given hostname.
|
|
||||||
type OnDemandConfig struct {
|
|
||||||
// An optional rate limit to throttle the
|
|
||||||
// issuance of certificates from handshakes.
|
|
||||||
RateLimit *RateLimit `json:"rate_limit,omitempty"`
|
|
||||||
|
|
||||||
// If Caddy needs to obtain or renew a certificate
|
|
||||||
// during a TLS handshake, it will perform a quick
|
|
||||||
// HTTP request to this URL to check if it should be
|
|
||||||
// allowed to try to get a certificate for the name
|
|
||||||
// in the "domain" query string parameter, like so:
|
|
||||||
// `?domain=example.com`. The endpoint must return a
|
|
||||||
// 200 OK status if a certificate is allowed;
|
|
||||||
// anything else will cause it to be denied.
|
|
||||||
// Redirects are not followed.
|
|
||||||
Ask string `json:"ask,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// RateLimit specifies an interval with optional burst size.
|
|
||||||
type RateLimit struct {
|
|
||||||
// A duration value. A certificate may be obtained 'burst'
|
|
||||||
// times during this interval.
|
|
||||||
Interval caddy.Duration `json:"interval,omitempty"`
|
|
||||||
|
|
||||||
// How many times during an interval a certificate can be obtained.
|
|
||||||
Burst int `json:"burst,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// AutomateLoader is a no-op certificate loader module
|
// AutomateLoader is a no-op certificate loader module
|
||||||
// that is treated as a special case: it uses this app's
|
// that is treated as a special case: it uses this app's
|
||||||
// automation features to load certificates for the
|
// automation features to load certificates for the
|
||||||
|
@ -669,26 +413,6 @@ func (AutomateLoader) CaddyModule() caddy.ModuleInfo {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConfigSetter is implemented by certmagic.Issuers that
|
|
||||||
// need access to a parent certmagic.Config as part of
|
|
||||||
// their provisioning phase. For example, the ACMEIssuer
|
|
||||||
// requires a config so it can access storage and the
|
|
||||||
// cache to solve ACME challenges.
|
|
||||||
type ConfigSetter interface {
|
|
||||||
SetConfig(cfg *certmagic.Config)
|
|
||||||
}
|
|
||||||
|
|
||||||
// These perpetual values are used for on-demand TLS.
|
|
||||||
var (
|
|
||||||
onDemandRateLimiter = certmagic.NewRateLimiter(0, 0)
|
|
||||||
onDemandAskClient = &http.Client{
|
|
||||||
Timeout: 10 * time.Second,
|
|
||||||
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
|
||||||
return fmt.Errorf("following http redirects is not allowed")
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
// Variables related to storage cleaning.
|
// Variables related to storage cleaning.
|
||||||
var (
|
var (
|
||||||
storageCleanInterval = 12 * time.Hour
|
storageCleanInterval = 12 * time.Hour
|
||||||
|
@ -697,15 +421,16 @@ var (
|
||||||
storageCleanMu sync.Mutex
|
storageCleanMu sync.Mutex
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const automateKey = "automate"
|
||||||
|
|
||||||
// Interface guards
|
// Interface guards
|
||||||
var (
|
var (
|
||||||
_ caddy.App = (*TLS)(nil)
|
_ caddy.App = (*TLS)(nil)
|
||||||
_ caddy.Provisioner = (*TLS)(nil)
|
_ caddy.Provisioner = (*TLS)(nil)
|
||||||
|
_ caddy.Validator = (*TLS)(nil)
|
||||||
_ caddy.CleanerUpper = (*TLS)(nil)
|
_ caddy.CleanerUpper = (*TLS)(nil)
|
||||||
)
|
)
|
||||||
|
|
||||||
const automateKey = "automate"
|
|
||||||
|
|
||||||
// TODO: This is temporary until the release candidates
|
// TODO: This is temporary until the release candidates
|
||||||
// (beta 16 changed the storage path for certificates),
|
// (beta 16 changed the storage path for certificates),
|
||||||
// after which this function can be deleted
|
// after which this function can be deleted
|
||||||
|
@ -823,10 +548,3 @@ func (t *TLS) moveCertificates() error {
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Interface guards
|
|
||||||
var (
|
|
||||||
_ caddy.Provisioner = (*TLS)(nil)
|
|
||||||
_ caddy.Validator = (*TLS)(nil)
|
|
||||||
_ caddy.App = (*TLS)(nil)
|
|
||||||
)
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue