2019-08-09 13:05:47 -05:00
|
|
|
// 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 caddyfile
|
|
|
|
|
|
|
|
import (
|
2021-01-04 13:11:36 -05:00
|
|
|
"bytes"
|
2019-08-09 13:05:47 -05:00
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Adapter adapts Caddyfile to Caddy JSON.
|
|
|
|
type Adapter struct {
|
|
|
|
ServerType ServerType
|
|
|
|
}
|
|
|
|
|
|
|
|
// Adapt converts the Caddyfile config in body to Caddy JSON.
|
2022-08-02 15:39:09 -05:00
|
|
|
func (a Adapter) Adapt(body []byte, options map[string]any) ([]byte, []caddyconfig.Warning, error) {
|
2019-08-09 13:05:47 -05:00
|
|
|
if a.ServerType == nil {
|
|
|
|
return nil, nil, fmt.Errorf("no server type")
|
|
|
|
}
|
|
|
|
if options == nil {
|
2022-08-02 15:39:09 -05:00
|
|
|
options = make(map[string]any)
|
2019-08-09 13:05:47 -05:00
|
|
|
}
|
|
|
|
|
2019-08-22 14:38:37 -05:00
|
|
|
filename, _ := options["filename"].(string)
|
2019-08-09 13:05:47 -05:00
|
|
|
if filename == "" {
|
|
|
|
filename = "Caddyfile"
|
|
|
|
}
|
|
|
|
|
2020-01-09 11:40:16 -05:00
|
|
|
serverBlocks, err := Parse(filename, body)
|
2019-08-09 13:05:47 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
cfg, warnings, err := a.ServerType.Setup(serverBlocks, options)
|
|
|
|
if err != nil {
|
|
|
|
return nil, warnings, err
|
|
|
|
}
|
|
|
|
|
2021-01-04 13:11:36 -05:00
|
|
|
// lint check: see if input was properly formatted; sometimes messy files files parse
|
2021-01-19 16:21:11 -05:00
|
|
|
// successfully but result in logical errors (the Caddyfile is a bad format, I'm sorry)
|
2023-01-21 23:28:37 -05:00
|
|
|
if warning, different := FormattingDifference(filename, body); different {
|
2021-01-19 16:21:11 -05:00
|
|
|
warnings = append(warnings, warning)
|
2019-08-09 13:05:47 -05:00
|
|
|
}
|
2021-01-04 13:11:36 -05:00
|
|
|
|
|
|
|
result, err := json.Marshal(cfg)
|
2019-08-09 13:05:47 -05:00
|
|
|
|
|
|
|
return result, warnings, err
|
|
|
|
}
|
|
|
|
|
2023-01-21 23:28:37 -05:00
|
|
|
// FormattingDifference returns a warning and true if the formatted version
|
2021-01-19 16:21:11 -05:00
|
|
|
// is any different from the input; empty warning and false otherwise.
|
|
|
|
// TODO: also perform this check on imported files
|
2023-01-21 23:28:37 -05:00
|
|
|
func FormattingDifference(filename string, body []byte) (caddyconfig.Warning, bool) {
|
2021-04-02 12:55:34 -05:00
|
|
|
// replace windows-style newlines to normalize comparison
|
|
|
|
normalizedBody := bytes.Replace(body, []byte("\r\n"), []byte("\n"), -1)
|
|
|
|
|
|
|
|
formatted := Format(normalizedBody)
|
|
|
|
if bytes.Equal(formatted, normalizedBody) {
|
2021-01-19 16:21:11 -05:00
|
|
|
return caddyconfig.Warning{}, false
|
|
|
|
}
|
|
|
|
|
|
|
|
// find where the difference is
|
|
|
|
line := 1
|
2021-04-02 12:55:34 -05:00
|
|
|
for i, ch := range normalizedBody {
|
2021-01-19 16:21:11 -05:00
|
|
|
if i >= len(formatted) || ch != formatted[i] {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
if ch == '\n' {
|
|
|
|
line++
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return caddyconfig.Warning{
|
|
|
|
File: filename,
|
|
|
|
Line: line,
|
2021-12-07 12:03:58 -05:00
|
|
|
Message: "Caddyfile input is not formatted; run the 'caddy fmt' command to fix inconsistencies",
|
2021-01-19 16:21:11 -05:00
|
|
|
}, true
|
|
|
|
}
|
|
|
|
|
2019-08-09 13:05:47 -05:00
|
|
|
// Unmarshaler is a type that can unmarshal
|
|
|
|
// Caddyfile tokens to set itself up for a
|
|
|
|
// JSON encoding. The goal of an unmarshaler
|
|
|
|
// is not to set itself up for actual use,
|
|
|
|
// but to set itself up for being marshaled
|
|
|
|
// into JSON. Caddyfile-unmarshaled values
|
|
|
|
// will not be used directly; they will be
|
|
|
|
// encoded as JSON and then used from that.
|
caddytls: Refactor certificate selection policies (close #1575)
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.
2020-04-01 21:49:35 -05:00
|
|
|
// Implementations must be able to support
|
|
|
|
// multiple segments (instances of their
|
|
|
|
// directive or batch of tokens); typically
|
|
|
|
// this means wrapping all token logic in
|
|
|
|
// a loop: `for d.Next() { ... }`.
|
2019-08-09 13:05:47 -05:00
|
|
|
type Unmarshaler interface {
|
|
|
|
UnmarshalCaddyfile(d *Dispenser) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// ServerType is a type that can evaluate a Caddyfile and set up a caddy config.
|
|
|
|
type ServerType interface {
|
|
|
|
// Setup takes the server blocks which
|
|
|
|
// contain tokens, as well as options
|
|
|
|
// (e.g. CLI flags) and creates a Caddy
|
|
|
|
// config, along with any warnings or
|
|
|
|
// an error.
|
2022-08-02 15:39:09 -05:00
|
|
|
Setup([]ServerBlock, map[string]any) (*caddy.Config, []caddyconfig.Warning, error)
|
2019-08-09 13:05:47 -05:00
|
|
|
}
|
|
|
|
|
2021-01-05 16:39:30 -05:00
|
|
|
// UnmarshalModule instantiates a module with the given ID and invokes
|
|
|
|
// UnmarshalCaddyfile on the new value using the immediate next segment
|
|
|
|
// of d as input. In other words, d's next token should be the first
|
|
|
|
// token of the module's Caddyfile input.
|
|
|
|
//
|
|
|
|
// This function is used when the next segment of Caddyfile tokens
|
|
|
|
// belongs to another Caddy module. The returned value is often
|
|
|
|
// type-asserted to the module's associated type for practical use
|
|
|
|
// when setting up a config.
|
|
|
|
func UnmarshalModule(d *Dispenser, moduleID string) (Unmarshaler, error) {
|
|
|
|
mod, err := caddy.GetModule(moduleID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, d.Errf("getting module named '%s': %v", moduleID, err)
|
|
|
|
}
|
|
|
|
inst := mod.New()
|
|
|
|
unm, ok := inst.(Unmarshaler)
|
|
|
|
if !ok {
|
|
|
|
return nil, d.Errf("module %s is not a Caddyfile unmarshaler; is %T", mod.ID, inst)
|
|
|
|
}
|
|
|
|
err = unm.UnmarshalCaddyfile(d.NewFromNextSegment())
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return unm, nil
|
|
|
|
}
|
|
|
|
|
2019-08-09 13:05:47 -05:00
|
|
|
// Interface guard
|
|
|
|
var _ caddyconfig.Adapter = (*Adapter)(nil)
|