mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-17 10:33:46 +08:00
3ae07a73dc
* Made trusted leaf certificates pluggable into the tls.client_auth.leaf module * Added leaf loaders modules: file, folder, pem aand storage * Cleaned implementation of leaf cert loader modules * Added tests for leaf certs file and folder loaders * cmd: fix the output of the `Usage` section (#6138) * core: OnExit hooks (#6128) * core: OnExit callbacks * core: Process-global OnExit callbacks * ci: bump golangci/golangci-lint-action from 3 to 4 (#6141) Bumps [golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action) from 3 to 4. - [Release notes](https://github.com/golangci/golangci-lint-action/releases) - [Commits](https://github.com/golangci/golangci-lint-action/compare/v3...v4) --- updated-dependencies: - dependency-name: golangci/golangci-lint-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Added more leaf certificate loaders tests and cleaned up code * Modified leaf cert loaders json field names and cleaned up storage loader comment * Update modules/caddytls/leaffileloader.go * Update LeafStorageLoader certificates field name * Upgraded protobuf version --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Mohammed Al Sahaf <msaa1990@gmail.com> Co-authored-by: Matt Holt <mholt@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
130 lines
3.6 KiB
Go
130 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/x509"
|
|
"encoding/json"
|
|
"encoding/pem"
|
|
"fmt"
|
|
|
|
"github.com/caddyserver/certmagic"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(LeafStorageLoader{})
|
|
}
|
|
|
|
// LeafStorageLoader loads leaf certificates from the
|
|
// globally configured storage module.
|
|
type LeafStorageLoader struct {
|
|
// A list of certificate file names to be loaded from storage.
|
|
Certificates []string `json:"certificates,omitempty"`
|
|
|
|
// The storage module where the trusted leaf certificates are stored. Absent
|
|
// explicit storage implies the use of Caddy default storage.
|
|
StorageRaw json.RawMessage `json:"storage,omitempty" caddy:"namespace=caddy.storage inline_key=module"`
|
|
|
|
// Reference to the globally configured storage module.
|
|
storage certmagic.Storage
|
|
|
|
ctx caddy.Context
|
|
}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (LeafStorageLoader) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "tls.leaf_cert_loader.storage",
|
|
New: func() caddy.Module { return new(LeafStorageLoader) },
|
|
}
|
|
}
|
|
|
|
// Provision loads the storage module for sl.
|
|
func (sl *LeafStorageLoader) Provision(ctx caddy.Context) error {
|
|
if sl.StorageRaw != nil {
|
|
val, err := ctx.LoadModule(sl, "StorageRaw")
|
|
if err != nil {
|
|
return fmt.Errorf("loading storage module: %v", err)
|
|
}
|
|
cmStorage, err := val.(caddy.StorageConverter).CertMagicStorage()
|
|
if err != nil {
|
|
return fmt.Errorf("creating storage configuration: %v", err)
|
|
}
|
|
sl.storage = cmStorage
|
|
}
|
|
if sl.storage == nil {
|
|
sl.storage = ctx.Storage()
|
|
}
|
|
sl.ctx = ctx
|
|
|
|
repl, ok := ctx.Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
|
|
if !ok {
|
|
repl = caddy.NewReplacer()
|
|
}
|
|
for k, path := range sl.Certificates {
|
|
sl.Certificates[k] = repl.ReplaceKnown(path, "")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// LoadLeafCertificates returns the certificates to be loaded by sl.
|
|
func (sl LeafStorageLoader) LoadLeafCertificates() ([]*x509.Certificate, error) {
|
|
certificates := make([]*x509.Certificate, 0, len(sl.Certificates))
|
|
for _, path := range sl.Certificates {
|
|
certData, err := sl.storage.Load(sl.ctx, path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ders, err := convertPEMToDER(certData)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
certs, err := x509.ParseCertificates(ders)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
certificates = append(certificates, certs...)
|
|
}
|
|
return certificates, nil
|
|
}
|
|
|
|
func convertPEMToDER(pemData []byte) ([]byte, error) {
|
|
var ders []byte
|
|
// while block is not nil, we have more certificates in the file
|
|
for block, rest := pem.Decode(pemData); block != nil; block, rest = pem.Decode(rest) {
|
|
if block.Type != "CERTIFICATE" {
|
|
return nil, fmt.Errorf("no CERTIFICATE pem block found in the given pem data")
|
|
}
|
|
ders = append(
|
|
ders,
|
|
block.Bytes...,
|
|
)
|
|
}
|
|
// if we decoded nothing, return an error
|
|
if len(ders) == 0 {
|
|
return nil, fmt.Errorf("no CERTIFICATE pem block found in the given pem data")
|
|
}
|
|
return ders, nil
|
|
}
|
|
|
|
// Interface guard
|
|
var (
|
|
_ LeafCertificateLoader = (*LeafStorageLoader)(nil)
|
|
_ caddy.Provisioner = (*LeafStorageLoader)(nil)
|
|
)
|