traefik/pkg/tls/certificate_store.go

189 lines
4.8 KiB
Go
Raw Normal View History

package tls
import (
"crypto/tls"
"crypto/x509"
2018-07-06 08:30:03 +00:00
"net"
"sort"
"strings"
"time"
2018-07-06 08:30:03 +00:00
"github.com/patrickmn/go-cache"
"github.com/traefik/traefik/v2/pkg/log"
"github.com/traefik/traefik/v2/pkg/safe"
)
// CertificateStore store for dynamic certificates.
type CertificateStore struct {
2018-07-06 08:30:03 +00:00
DynamicCerts *safe.Safe
DefaultCertificate *tls.Certificate
CertCache *cache.Cache
}
// NewCertificateStore create a store for dynamic certificates.
2018-07-06 08:30:03 +00:00
func NewCertificateStore() *CertificateStore {
s := &safe.Safe{}
s.Set(make(map[string]*tls.Certificate))
2018-07-06 08:30:03 +00:00
return &CertificateStore{
DynamicCerts: s,
2018-07-06 08:30:03 +00:00
CertCache: cache.New(1*time.Hour, 10*time.Minute),
}
}
func (c CertificateStore) getDefaultCertificateDomains() []string {
var allCerts []string
if c.DefaultCertificate == nil {
return allCerts
}
x509Cert, err := x509.ParseCertificate(c.DefaultCertificate.Certificate[0])
if err != nil {
log.WithoutContext().Errorf("Could not parse default certificate: %v", err)
return allCerts
}
if len(x509Cert.Subject.CommonName) > 0 {
allCerts = append(allCerts, x509Cert.Subject.CommonName)
}
allCerts = append(allCerts, x509Cert.DNSNames...)
for _, ipSan := range x509Cert.IPAddresses {
allCerts = append(allCerts, ipSan.String())
}
return allCerts
}
2020-05-11 10:06:07 +00:00
// GetAllDomains return a slice with all the certificate domain.
func (c CertificateStore) GetAllDomains() []string {
2020-12-18 17:44:03 +00:00
allDomains := c.getDefaultCertificateDomains()
// Get dynamic certificates
if c.DynamicCerts != nil && c.DynamicCerts.Get() != nil {
for domain := range c.DynamicCerts.Get().(map[string]*Certificate) {
2020-12-18 17:44:03 +00:00
allDomains = append(allDomains, domain)
}
}
2020-12-18 17:44:03 +00:00
return allDomains
}
2018-07-06 08:30:03 +00:00
2020-05-11 10:06:07 +00:00
// GetBestCertificate returns the best match certificate, and caches the response.
func (c *CertificateStore) GetBestCertificate(clientHello *tls.ClientHelloInfo) *Certificate {
if c == nil {
return nil
}
serverName := strings.ToLower(strings.TrimSpace(clientHello.ServerName))
if len(serverName) == 0 {
2018-07-06 08:30:03 +00:00
// If no ServerName is provided, Check for local IP address matches
host, _, err := net.SplitHostPort(clientHello.Conn.LocalAddr().String())
if err != nil {
log.WithoutContext().Debugf("Could not split host/port: %v", err)
2018-07-06 08:30:03 +00:00
}
serverName = strings.TrimSpace(host)
2018-07-06 08:30:03 +00:00
}
if cert, ok := c.CertCache.Get(serverName); ok {
return cert.(*Certificate)
2018-07-06 08:30:03 +00:00
}
matchedCerts := map[string]*Certificate{}
2018-07-06 08:30:03 +00:00
if c.DynamicCerts != nil && c.DynamicCerts.Get() != nil {
for domains, cert := range c.DynamicCerts.Get().(map[string]*Certificate) {
2018-07-06 08:30:03 +00:00
for _, certDomain := range strings.Split(domains, ",") {
if matchDomain(serverName, certDomain) {
2018-07-06 08:30:03 +00:00
matchedCerts[certDomain] = cert
}
}
}
}
if len(matchedCerts) > 0 {
// sort map by keys
keys := make([]string, 0, len(matchedCerts))
for k := range matchedCerts {
keys = append(keys, k)
}
sort.Strings(keys)
// cache best match
c.CertCache.SetDefault(serverName, matchedCerts[keys[len(keys)-1]])
2018-07-06 08:30:03 +00:00
return matchedCerts[keys[len(keys)-1]]
}
return nil
}
// GetCertificate returns the first certificate matching all the given domains.
func (c *CertificateStore) GetCertificate(domains []string) *tls.Certificate {
if c == nil {
return nil
}
sort.Strings(domains)
domainsKey := strings.Join(domains, ",")
if cert, ok := c.CertCache.Get(domainsKey); ok {
return cert.(*tls.Certificate)
}
if c.DynamicCerts != nil && c.DynamicCerts.Get() != nil {
for certDomains, cert := range c.DynamicCerts.Get().(map[string]*tls.Certificate) {
if domainsKey == certDomains {
c.CertCache.SetDefault(domainsKey, cert)
return cert
}
var matchedDomains []string
for _, certDomain := range strings.Split(certDomains, ",") {
for _, checkDomain := range domains {
if certDomain == checkDomain {
matchedDomains = append(matchedDomains, certDomain)
}
}
}
if len(matchedDomains) == len(domains) {
c.CertCache.SetDefault(domainsKey, cert)
return cert
}
}
}
return nil
}
2020-05-11 10:06:07 +00:00
// ResetCache clears the cache in the store.
2018-07-06 08:30:03 +00:00
func (c CertificateStore) ResetCache() {
if c.CertCache != nil {
c.CertCache.Flush()
}
}
// matchDomain returns whether the server name matches the cert domain.
// The server name, from TLS SNI, must not have trailing dots (https://datatracker.ietf.org/doc/html/rfc6066#section-3).
// This is enforced by https://github.com/golang/go/blob/d3d7998756c33f69706488cade1cd2b9b10a4c7f/src/crypto/tls/handshake_messages.go#L423-L427.
func matchDomain(serverName, certDomain string) bool {
// TODO: assert equality after removing the trailing dots?
if serverName == certDomain {
2018-07-06 08:30:03 +00:00
return true
}
for len(certDomain) > 0 && certDomain[len(certDomain)-1] == '.' {
certDomain = certDomain[:len(certDomain)-1]
}
labels := strings.Split(serverName, ".")
2018-07-06 08:30:03 +00:00
for i := range labels {
labels[i] = "*"
candidate := strings.Join(labels, ".")
if certDomain == candidate {
return true
}
}
return false
}