mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-16 21:56:40 -05:00
3c90e370a4
This commit goes a long way toward making automated documentation of Caddy config and Caddy modules possible. It's a broad, sweeping change, but mostly internal. It allows us to automatically generate docs for all Caddy modules (including future third-party ones) and make them viewable on a web page; it also doubles as godoc comments. As such, this commit makes significant progress in migrating the docs from our temporary wiki page toward our new website which is still under construction. With this change, all host modules will use ctx.LoadModule() and pass in both the struct pointer and the field name as a string. This allows the reflect package to read the struct tag from that field so that it can get the necessary information like the module namespace and the inline key. This has the nice side-effect of unifying the code and documentation. It also simplifies module loading, and handles several variations on field types for raw module fields (i.e. variations on json.RawMessage, such as arrays and maps). I also renamed ModuleInfo.Name -> ModuleInfo.ID, to make it clear that the ID is the "full name" which includes both the module namespace and the name. This clarity is helpful when describing module hierarchy. As of this change, Caddy modules are no longer an experimental design. I think the architecture is good enough to go forward.
90 lines
2.5 KiB
Go
90 lines
2.5 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"
|
|
"fmt"
|
|
"io/ioutil"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(FileLoader{})
|
|
}
|
|
|
|
// FileLoader loads certificates and their associated keys from disk.
|
|
type FileLoader []CertKeyFilePair
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (FileLoader) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "tls.certificates.load_files",
|
|
New: func() caddy.Module { return new(FileLoader) },
|
|
}
|
|
}
|
|
|
|
// CertKeyFilePair pairs certificate and key file names along with their
|
|
// encoding format so that they can be loaded from disk.
|
|
type CertKeyFilePair struct {
|
|
// Path to the certificate (public key) file.
|
|
Certificate string `json:"certificate"`
|
|
|
|
// Path to the private key file.
|
|
Key string `json:"key"`
|
|
|
|
// The format of the cert and key. Can be "pem". Default: "pem"
|
|
Format string `json:"format,omitempty"`
|
|
|
|
// Arbitrary values to associate with this certificate.
|
|
// Can be useful when you want to select a particular
|
|
// certificate when there may be multiple valid candidates.
|
|
Tags []string `json:"tags,omitempty"`
|
|
}
|
|
|
|
// LoadCertificates returns the certificates to be loaded by fl.
|
|
func (fl FileLoader) LoadCertificates() ([]Certificate, error) {
|
|
var certs []Certificate
|
|
for _, pair := range fl {
|
|
certData, err := ioutil.ReadFile(pair.Certificate)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
keyData, err := ioutil.ReadFile(pair.Key)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var cert tls.Certificate
|
|
switch pair.Format {
|
|
case "":
|
|
fallthrough
|
|
case "pem":
|
|
cert, err = tls.X509KeyPair(certData, keyData)
|
|
default:
|
|
return nil, fmt.Errorf("unrecognized certificate/key encoding format: %s", pair.Format)
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
certs = append(certs, Certificate{Certificate: cert, Tags: pair.Tags})
|
|
}
|
|
return certs, nil
|
|
}
|
|
|
|
// Interface guard
|
|
var _ CertificateLoader = (FileLoader)(nil)
|