mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-28 06:33:47 +03:00
6ca5828221
Certificate selection used to be a module, but this seems unnecessary, especially since the built-in CustomSelectionPolicy allows quite complex selection logic on a number of fields in certs. If we need to extend that logic, we can, but I don't think there are SO many possibilities that we need modules. This update also allows certificate selection to choose between multiple matching certs based on client compatibility and makes a number of other improvements in the default cert selection logic, both here and in the latest CertMagic. The hardest part of this was the conn policy consolidation logic (Caddyfile only, of course). We have to merge connection policies that we can easily combine, because if two certs are manually loaded in a Caddyfile site block, that produces two connection policies, and each cert is tagged with a different tag, meaning only the first would ever be selected. So given the same matchers, we can merge the two, but this required improving the Tag selection logic to support multiple tags to choose from, hence "tags" changed to "any_tag" or "all_tags" (but we use any_tag in our Caddyfile logic). Combining conn policies with conflicting settings is impossible, so that should return an error if two policies with the exact same matchers have non-empty settings that are not the same (the one exception being any_tag which we can merge because the logic for them is to OR them). It was a bit complicated. It seems to work in numerous tests I've conducted, but we'll see how it pans out in the release candidates.
124 lines
3.6 KiB
Go
124 lines
3.6 KiB
Go
// 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 (
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"fmt"
|
|
"math/big"
|
|
|
|
"github.com/caddyserver/certmagic"
|
|
)
|
|
|
|
// CustomCertSelectionPolicy represents a policy for selecting the certificate
|
|
// used to complete a handshake when there may be multiple options. All fields
|
|
// specified must match the candidate certificate for it to be chosen.
|
|
// This was needed to solve https://github.com/caddyserver/caddy/issues/2588.
|
|
type CustomCertSelectionPolicy struct {
|
|
// The certificate must have one of these serial numbers.
|
|
SerialNumber []*big.Int `json:"serial_number,omitempty"`
|
|
|
|
// The certificate must have one of these organization names.
|
|
SubjectOrganization []string `json:"subject_organization,omitempty"`
|
|
|
|
// The certificate must use this public key algorithm.
|
|
PublicKeyAlgorithm PublicKeyAlgorithm `json:"public_key_algorithm,omitempty"`
|
|
|
|
// The certificate must have at least one of the tags in the list.
|
|
AnyTag []string `json:"any_tag,omitempty"`
|
|
|
|
// The certificate must have all of the tags in the list.
|
|
AllTags []string `json:"all_tags,omitempty"`
|
|
}
|
|
|
|
// SelectCertificate implements certmagic.CertificateSelector. It
|
|
// only chooses a certificate that at least meets the criteria in
|
|
// p. It then chooses the first non-expired certificate that is
|
|
// compatible with the client. If none are valid, it chooses the
|
|
// first viable candidate anyway.
|
|
func (p CustomCertSelectionPolicy) SelectCertificate(hello *tls.ClientHelloInfo, choices []certmagic.Certificate) (certmagic.Certificate, error) {
|
|
viable := make([]certmagic.Certificate, 0, len(choices))
|
|
|
|
nextChoice:
|
|
for _, cert := range choices {
|
|
if len(p.SerialNumber) > 0 {
|
|
var found bool
|
|
for _, sn := range p.SerialNumber {
|
|
if cert.Leaf.SerialNumber.Cmp(sn) == 0 {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
if !found {
|
|
continue
|
|
}
|
|
}
|
|
|
|
if len(p.SubjectOrganization) > 0 {
|
|
var found bool
|
|
for _, subjOrg := range p.SubjectOrganization {
|
|
for _, org := range cert.Leaf.Subject.Organization {
|
|
if subjOrg == org {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
}
|
|
if !found {
|
|
continue
|
|
}
|
|
}
|
|
|
|
if p.PublicKeyAlgorithm != PublicKeyAlgorithm(x509.UnknownPublicKeyAlgorithm) &&
|
|
PublicKeyAlgorithm(cert.Leaf.PublicKeyAlgorithm) != p.PublicKeyAlgorithm {
|
|
continue
|
|
}
|
|
|
|
if len(p.AnyTag) > 0 {
|
|
var found bool
|
|
for _, tag := range p.AnyTag {
|
|
if cert.HasTag(tag) {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
if !found {
|
|
continue
|
|
}
|
|
}
|
|
|
|
if len(p.AllTags) > 0 {
|
|
for _, tag := range p.AllTags {
|
|
if !cert.HasTag(tag) {
|
|
continue nextChoice
|
|
}
|
|
}
|
|
}
|
|
|
|
// this certificate at least meets the policy's requirements,
|
|
// but we still have to check expiration and compatibility
|
|
viable = append(viable, cert)
|
|
}
|
|
|
|
if len(viable) == 0 {
|
|
return certmagic.Certificate{}, fmt.Errorf("no certificates matched custom selection policy")
|
|
}
|
|
|
|
return certmagic.DefaultCertificateSelector(hello, viable)
|
|
}
|
|
|
|
// Interface guard
|
|
var _ certmagic.CertificateSelector = (*CustomCertSelectionPolicy)(nil)
|