mirror of
https://github.com/caddyserver/caddy.git
synced 2025-04-22 04:18:47 +08:00
Merge branch 'master' into authenticate-provider-error
This commit is contained in:
commit
d3975b1eaf
admin.goadmin_test.gocaddy.gocontext.gogo.modgo.sum
internal/filesystems
listeners.gomodules
79
admin.go
79
admin.go
@ -221,7 +221,8 @@ func (admin *AdminConfig) newAdminHandler(addr NetworkAddress, remote bool, _ Co
|
||||
if remote {
|
||||
muxWrap.remoteControl = admin.Remote
|
||||
} else {
|
||||
muxWrap.enforceHost = !addr.isWildcardInterface()
|
||||
// see comment in allowedOrigins() as to why we disable the host check for unix/fd networks
|
||||
muxWrap.enforceHost = !addr.isWildcardInterface() && !addr.IsUnixNetwork() && !addr.IsFdNetwork()
|
||||
muxWrap.allowedOrigins = admin.allowedOrigins(addr)
|
||||
muxWrap.enforceOrigin = admin.EnforceOrigin
|
||||
}
|
||||
@ -310,47 +311,43 @@ func (admin AdminConfig) allowedOrigins(addr NetworkAddress) []*url.URL {
|
||||
for _, o := range admin.Origins {
|
||||
uniqueOrigins[o] = struct{}{}
|
||||
}
|
||||
if admin.Origins == nil {
|
||||
// RFC 2616, Section 14.26:
|
||||
// "A client MUST include a Host header field in all HTTP/1.1 request
|
||||
// messages. If the requested URI does not include an Internet host
|
||||
// name for the service being requested, then the Host header field MUST
|
||||
// be given with an empty value."
|
||||
//
|
||||
// UPDATE July 2023: Go broke this by patching a minor security bug in 1.20.6.
|
||||
// Understandable, but frustrating. See:
|
||||
// https://github.com/golang/go/issues/60374
|
||||
// See also the discussion here:
|
||||
// https://github.com/golang/go/issues/61431
|
||||
//
|
||||
// We can no longer conform to RFC 2616 Section 14.26 from either Go or curl
|
||||
// in purity. (Curl allowed no host between 7.40 and 7.50, but now requires a
|
||||
// bogus host; see https://superuser.com/a/925610.) If we disable Host/Origin
|
||||
// security checks, the infosec community assures me that it is secure to do
|
||||
// so, because:
|
||||
//
|
||||
// 1) Browsers do not allow access to unix sockets
|
||||
// 2) DNS is irrelevant to unix sockets
|
||||
//
|
||||
// If either of those two statements ever fail to hold true, it is not the
|
||||
// fault of Caddy.
|
||||
//
|
||||
// Thus, we do not fill out allowed origins and do not enforce Host
|
||||
// requirements for unix sockets. Enforcing it leads to confusion and
|
||||
// frustration, when UDS have their own permissions from the OS.
|
||||
// Enforcing host requirements here is effectively security theater,
|
||||
// and a false sense of security.
|
||||
//
|
||||
// See also the discussion in #6832.
|
||||
if admin.Origins == nil && !addr.IsUnixNetwork() && !addr.IsFdNetwork() {
|
||||
if addr.isLoopback() {
|
||||
if addr.IsUnixNetwork() || addr.IsFdNetwork() {
|
||||
// RFC 2616, Section 14.26:
|
||||
// "A client MUST include a Host header field in all HTTP/1.1 request
|
||||
// messages. If the requested URI does not include an Internet host
|
||||
// name for the service being requested, then the Host header field MUST
|
||||
// be given with an empty value."
|
||||
//
|
||||
// UPDATE July 2023: Go broke this by patching a minor security bug in 1.20.6.
|
||||
// Understandable, but frustrating. See:
|
||||
// https://github.com/golang/go/issues/60374
|
||||
// See also the discussion here:
|
||||
// https://github.com/golang/go/issues/61431
|
||||
//
|
||||
// We can no longer conform to RFC 2616 Section 14.26 from either Go or curl
|
||||
// in purity. (Curl allowed no host between 7.40 and 7.50, but now requires a
|
||||
// bogus host; see https://superuser.com/a/925610.) If we disable Host/Origin
|
||||
// security checks, the infosec community assures me that it is secure to do
|
||||
// so, because:
|
||||
// 1) Browsers do not allow access to unix sockets
|
||||
// 2) DNS is irrelevant to unix sockets
|
||||
//
|
||||
// I am not quite ready to trust either of those external factors, so instead
|
||||
// of disabling Host/Origin checks, we now allow specific Host values when
|
||||
// accessing the admin endpoint over unix sockets. I definitely don't trust
|
||||
// DNS (e.g. I don't trust 'localhost' to always resolve to the local host),
|
||||
// and IP shouldn't even be used, but if it is for some reason, I think we can
|
||||
// at least be reasonably assured that 127.0.0.1 and ::1 route to the local
|
||||
// machine, meaning that a hypothetical browser origin would have to be on the
|
||||
// local machine as well.
|
||||
uniqueOrigins[""] = struct{}{}
|
||||
uniqueOrigins["127.0.0.1"] = struct{}{}
|
||||
uniqueOrigins["::1"] = struct{}{}
|
||||
} else {
|
||||
uniqueOrigins[net.JoinHostPort("localhost", addr.port())] = struct{}{}
|
||||
uniqueOrigins[net.JoinHostPort("::1", addr.port())] = struct{}{}
|
||||
uniqueOrigins[net.JoinHostPort("127.0.0.1", addr.port())] = struct{}{}
|
||||
}
|
||||
}
|
||||
if !addr.IsUnixNetwork() && !addr.IsFdNetwork() {
|
||||
uniqueOrigins[net.JoinHostPort("localhost", addr.port())] = struct{}{}
|
||||
uniqueOrigins[net.JoinHostPort("::1", addr.port())] = struct{}{}
|
||||
uniqueOrigins[net.JoinHostPort("127.0.0.1", addr.port())] = struct{}{}
|
||||
} else {
|
||||
uniqueOrigins[addr.JoinHostPort(0)] = struct{}{}
|
||||
}
|
||||
}
|
||||
|
@ -531,6 +531,7 @@ func TestAdminRouterProvisioning(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestAllowedOriginsUnixSocket(t *testing.T) {
|
||||
// see comment in allowedOrigins() as to why we do not fill out allowed origins for UDS
|
||||
tests := []struct {
|
||||
name string
|
||||
addr NetworkAddress
|
||||
@ -543,12 +544,8 @@ func TestAllowedOriginsUnixSocket(t *testing.T) {
|
||||
Network: "unix",
|
||||
Host: "/tmp/caddy.sock",
|
||||
},
|
||||
origins: nil, // default origins
|
||||
expectOrigins: []string{
|
||||
"", // empty host as per RFC 2616
|
||||
"127.0.0.1",
|
||||
"::1",
|
||||
},
|
||||
origins: nil, // default origins
|
||||
expectOrigins: []string{},
|
||||
},
|
||||
{
|
||||
name: "unix socket with custom origins",
|
||||
@ -578,7 +575,7 @@ func TestAllowedOriginsUnixSocket(t *testing.T) {
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
for i, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
admin := AdminConfig{
|
||||
Origins: test.origins,
|
||||
@ -592,7 +589,7 @@ func TestAllowedOriginsUnixSocket(t *testing.T) {
|
||||
}
|
||||
|
||||
if len(gotOrigins) != len(test.expectOrigins) {
|
||||
t.Errorf("Expected %d origins but got %d", len(test.expectOrigins), len(gotOrigins))
|
||||
t.Errorf("%d: Expected %d origins but got %d", i, len(test.expectOrigins), len(gotOrigins))
|
||||
return
|
||||
}
|
||||
|
||||
@ -607,7 +604,7 @@ func TestAllowedOriginsUnixSocket(t *testing.T) {
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(expectMap, gotMap) {
|
||||
t.Errorf("Origins mismatch.\nExpected: %v\nGot: %v", test.expectOrigins, gotOrigins)
|
||||
t.Errorf("%d: Origins mismatch.\nExpected: %v\nGot: %v", i, test.expectOrigins, gotOrigins)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
104
caddy.go
104
caddy.go
@ -81,13 +81,14 @@ type Config struct {
|
||||
// associated value.
|
||||
AppsRaw ModuleMap `json:"apps,omitempty" caddy:"namespace="`
|
||||
|
||||
apps map[string]App
|
||||
storage certmagic.Storage
|
||||
apps map[string]App
|
||||
storage certmagic.Storage
|
||||
eventEmitter eventEmitter
|
||||
|
||||
cancelFunc context.CancelFunc
|
||||
|
||||
// filesystems is a dict of filesystems that will later be loaded from and added to.
|
||||
filesystems FileSystems
|
||||
// fileSystems is a dict of fileSystems that will later be loaded from and added to.
|
||||
fileSystems FileSystems
|
||||
}
|
||||
|
||||
// App is a thing that Caddy runs.
|
||||
@ -442,6 +443,10 @@ func run(newCfg *Config, start bool) (Context, error) {
|
||||
}
|
||||
globalMetrics.configSuccess.Set(1)
|
||||
globalMetrics.configSuccessTime.SetToCurrentTime()
|
||||
|
||||
// TODO: This event is experimental and subject to change.
|
||||
ctx.emitEvent("started", nil)
|
||||
|
||||
// now that the user's config is running, finish setting up anything else,
|
||||
// such as remote admin endpoint, config loader, etc.
|
||||
return ctx, finishSettingUp(ctx, ctx.cfg)
|
||||
@ -509,7 +514,7 @@ func provisionContext(newCfg *Config, replaceAdminServer bool) (Context, error)
|
||||
}
|
||||
|
||||
// create the new filesystem map
|
||||
newCfg.filesystems = &filesystems.FilesystemMap{}
|
||||
newCfg.fileSystems = &filesystems.FileSystemMap{}
|
||||
|
||||
// prepare the new config for use
|
||||
newCfg.apps = make(map[string]App)
|
||||
@ -696,6 +701,9 @@ func unsyncedStop(ctx Context) {
|
||||
return
|
||||
}
|
||||
|
||||
// TODO: This event is experimental and subject to change.
|
||||
ctx.emitEvent("stopping", nil)
|
||||
|
||||
// stop each app
|
||||
for name, a := range ctx.cfg.apps {
|
||||
err := a.Stop()
|
||||
@ -1038,6 +1046,92 @@ func Version() (simple, full string) {
|
||||
return
|
||||
}
|
||||
|
||||
// Event represents something that has happened or is happening.
|
||||
// An Event value is not synchronized, so it should be copied if
|
||||
// being used in goroutines.
|
||||
//
|
||||
// EXPERIMENTAL: Events are subject to change.
|
||||
type Event struct {
|
||||
// If non-nil, the event has been aborted, meaning
|
||||
// propagation has stopped to other handlers and
|
||||
// the code should stop what it was doing. Emitters
|
||||
// may choose to use this as a signal to adjust their
|
||||
// code path appropriately.
|
||||
Aborted error
|
||||
|
||||
// The data associated with the event. Usually the
|
||||
// original emitter will be the only one to set or
|
||||
// change these values, but the field is exported
|
||||
// so handlers can have full access if needed.
|
||||
// However, this map is not synchronized, so
|
||||
// handlers must not use this map directly in new
|
||||
// goroutines; instead, copy the map to use it in a
|
||||
// goroutine. Data may be nil.
|
||||
Data map[string]any
|
||||
|
||||
id uuid.UUID
|
||||
ts time.Time
|
||||
name string
|
||||
origin Module
|
||||
}
|
||||
|
||||
// NewEvent creates a new event, but does not emit the event. To emit an
|
||||
// event, call Emit() on the current instance of the caddyevents app insteaad.
|
||||
//
|
||||
// EXPERIMENTAL: Subject to change.
|
||||
func NewEvent(ctx Context, name string, data map[string]any) (Event, error) {
|
||||
id, err := uuid.NewRandom()
|
||||
if err != nil {
|
||||
return Event{}, fmt.Errorf("generating new event ID: %v", err)
|
||||
}
|
||||
name = strings.ToLower(name)
|
||||
return Event{
|
||||
Data: data,
|
||||
id: id,
|
||||
ts: time.Now(),
|
||||
name: name,
|
||||
origin: ctx.Module(),
|
||||
}, nil
|
||||
}
|
||||
|
||||
func (e Event) ID() uuid.UUID { return e.id }
|
||||
func (e Event) Timestamp() time.Time { return e.ts }
|
||||
func (e Event) Name() string { return e.name }
|
||||
func (e Event) Origin() Module { return e.origin } // Returns the module that originated the event. May be nil, usually if caddy core emits the event.
|
||||
|
||||
// CloudEvent exports event e as a structure that, when
|
||||
// serialized as JSON, is compatible with the
|
||||
// CloudEvents spec.
|
||||
func (e Event) CloudEvent() CloudEvent {
|
||||
dataJSON, _ := json.Marshal(e.Data)
|
||||
return CloudEvent{
|
||||
ID: e.id.String(),
|
||||
Source: e.origin.CaddyModule().String(),
|
||||
SpecVersion: "1.0",
|
||||
Type: e.name,
|
||||
Time: e.ts,
|
||||
DataContentType: "application/json",
|
||||
Data: dataJSON,
|
||||
}
|
||||
}
|
||||
|
||||
// CloudEvent is a JSON-serializable structure that
|
||||
// is compatible with the CloudEvents specification.
|
||||
// See https://cloudevents.io.
|
||||
// EXPERIMENTAL: Subject to change.
|
||||
type CloudEvent struct {
|
||||
ID string `json:"id"`
|
||||
Source string `json:"source"`
|
||||
SpecVersion string `json:"specversion"`
|
||||
Type string `json:"type"`
|
||||
Time time.Time `json:"time"`
|
||||
DataContentType string `json:"datacontenttype,omitempty"`
|
||||
Data json.RawMessage `json:"data,omitempty"`
|
||||
}
|
||||
|
||||
// ErrEventAborted cancels an event.
|
||||
var ErrEventAborted = errors.New("event aborted")
|
||||
|
||||
// ActiveContext returns the currently-active context.
|
||||
// This function is experimental and might be changed
|
||||
// or removed in the future.
|
||||
|
32
context.go
32
context.go
@ -91,14 +91,14 @@ func (ctx *Context) OnCancel(f func()) {
|
||||
ctx.cleanupFuncs = append(ctx.cleanupFuncs, f)
|
||||
}
|
||||
|
||||
// Filesystems returns a ref to the FilesystemMap.
|
||||
// FileSystems returns a ref to the FilesystemMap.
|
||||
// EXPERIMENTAL: This API is subject to change.
|
||||
func (ctx *Context) Filesystems() FileSystems {
|
||||
func (ctx *Context) FileSystems() FileSystems {
|
||||
// if no config is loaded, we use a default filesystemmap, which includes the osfs
|
||||
if ctx.cfg == nil {
|
||||
return &filesystems.FilesystemMap{}
|
||||
return &filesystems.FileSystemMap{}
|
||||
}
|
||||
return ctx.cfg.filesystems
|
||||
return ctx.cfg.fileSystems
|
||||
}
|
||||
|
||||
// Returns the active metrics registry for the context
|
||||
@ -277,6 +277,14 @@ func (ctx Context) LoadModule(structPointer any, fieldName string) (any, error)
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// emitEvent is a small convenience method so the caddy core can emit events, if the event app is configured.
|
||||
func (ctx Context) emitEvent(name string, data map[string]any) Event {
|
||||
if ctx.cfg == nil || ctx.cfg.eventEmitter == nil {
|
||||
return Event{}
|
||||
}
|
||||
return ctx.cfg.eventEmitter.Emit(ctx, name, data)
|
||||
}
|
||||
|
||||
// loadModulesFromSomeMap loads modules from val, which must be a type of map[string]any.
|
||||
// Depending on inlineModuleKey, it will be interpreted as either a ModuleMap (key is the module
|
||||
// name) or as a regular map (key is not the module name, and module name is defined inline).
|
||||
@ -429,6 +437,14 @@ func (ctx Context) LoadModuleByID(id string, rawMsg json.RawMessage) (any, error
|
||||
|
||||
ctx.moduleInstances[id] = append(ctx.moduleInstances[id], val)
|
||||
|
||||
// if the loaded module happens to be an app that can emit events, store it so the
|
||||
// core can have access to emit events without an import cycle
|
||||
if ee, ok := val.(eventEmitter); ok {
|
||||
if _, ok := ee.(App); ok {
|
||||
ctx.cfg.eventEmitter = ee
|
||||
}
|
||||
}
|
||||
|
||||
return val, nil
|
||||
}
|
||||
|
||||
@ -600,3 +616,11 @@ func (ctx *Context) WithValue(key, value any) Context {
|
||||
exitFuncs: ctx.exitFuncs,
|
||||
}
|
||||
}
|
||||
|
||||
// eventEmitter is a small interface that inverts dependencies for
|
||||
// the caddyevents package, so the core can emit events without an
|
||||
// import cycle (i.e. the caddy package doesn't have to import
|
||||
// the caddyevents package, which imports the caddy package).
|
||||
type eventEmitter interface {
|
||||
Emit(ctx Context, eventName string, data map[string]any) Event
|
||||
}
|
||||
|
6
go.mod
6
go.mod
@ -8,7 +8,7 @@ require (
|
||||
github.com/Masterminds/sprig/v3 v3.3.0
|
||||
github.com/alecthomas/chroma/v2 v2.15.0
|
||||
github.com/aryann/difflib v0.0.0-20210328193216-ff5ff6dc229b
|
||||
github.com/caddyserver/certmagic v0.22.2
|
||||
github.com/caddyserver/certmagic v0.23.0
|
||||
github.com/caddyserver/zerossl v0.1.3
|
||||
github.com/cloudflare/circl v1.6.0
|
||||
github.com/dustin/go-humanize v1.0.1
|
||||
@ -17,7 +17,7 @@ require (
|
||||
github.com/google/uuid v1.6.0
|
||||
github.com/klauspost/compress v1.18.0
|
||||
github.com/klauspost/cpuid/v2 v2.2.10
|
||||
github.com/mholt/acmez/v3 v3.1.1
|
||||
github.com/mholt/acmez/v3 v3.1.2
|
||||
github.com/prometheus/client_golang v1.19.1
|
||||
github.com/quic-go/quic-go v0.50.1
|
||||
github.com/smallstep/certificates v0.26.1
|
||||
@ -116,7 +116,7 @@ require (
|
||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
||||
github.com/jackc/pgtype v1.14.0 // indirect
|
||||
github.com/jackc/pgx/v4 v4.18.3 // indirect
|
||||
github.com/libdns/libdns v0.2.3
|
||||
github.com/libdns/libdns v1.0.0-beta.1
|
||||
github.com/manifoldco/promptui v0.9.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.13 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
|
12
go.sum
12
go.sum
@ -93,8 +93,8 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
||||
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
||||
github.com/bradfitz/go-smtpd v0.0.0-20170404230938-deb6d6237625/go.mod h1:HYsPBTaaSFSlLx/70C2HPIMNZpVV8+vt/A+FMnYP11g=
|
||||
github.com/buger/jsonparser v0.0.0-20181115193947-bf1c66bbce23/go.mod h1:bbYlZJ7hK1yFx9hf58LP0zeX7UjIGs20ufpu3evjr+s=
|
||||
github.com/caddyserver/certmagic v0.22.2 h1:qzZURXlrxwR5m25/jpvVeEyJHeJJMvAwe5zlMufOTQk=
|
||||
github.com/caddyserver/certmagic v0.22.2/go.mod h1:hbqE7BnkjhX5IJiFslPmrSeobSeZvI6ux8tyxhsd6qs=
|
||||
github.com/caddyserver/certmagic v0.23.0 h1:CfpZ/50jMfG4+1J/u2LV6piJq4HOfO6ppOnOf7DkFEU=
|
||||
github.com/caddyserver/certmagic v0.23.0/go.mod h1:9mEZIWqqWoI+Gf+4Trh04MOVPD0tGSxtqsxg87hAIH4=
|
||||
github.com/caddyserver/zerossl v0.1.3 h1:onS+pxp3M8HnHpN5MMbOMyNjmTheJyWRaZYwn+YTAyA=
|
||||
github.com/caddyserver/zerossl v0.1.3/go.mod h1:CxA0acn7oEGO6//4rtrRjYgEoa4MFw/XofZnrYwGqG4=
|
||||
github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8=
|
||||
@ -327,8 +327,8 @@ github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
|
||||
github.com/lib/pq v1.10.2/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
|
||||
github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
|
||||
github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
|
||||
github.com/libdns/libdns v0.2.3 h1:ba30K4ObwMGB/QTmqUxf3H4/GmUrCAIkMWejeGl12v8=
|
||||
github.com/libdns/libdns v0.2.3/go.mod h1:4Bj9+5CQiNMVGf87wjX4CY3HQJypUHRuLvlsfsZqLWQ=
|
||||
github.com/libdns/libdns v1.0.0-beta.1 h1:KIf4wLfsrEpXpZ3vmc/poM8zCATXT2klbdPe6hyOBjQ=
|
||||
github.com/libdns/libdns v1.0.0-beta.1/go.mod h1:4Bj9+5CQiNMVGf87wjX4CY3HQJypUHRuLvlsfsZqLWQ=
|
||||
github.com/lunixbochs/vtclean v1.0.0/go.mod h1:pHhQNgMf3btfWnGBVipUOjRYhoOsdGqdm/+2c2E2WMI=
|
||||
github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
|
||||
github.com/mailru/easyjson v0.0.0-20190312143242-1de009706dbe/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
|
||||
@ -347,8 +347,8 @@ github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D
|
||||
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
|
||||
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI=
|
||||
github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
|
||||
github.com/mholt/acmez/v3 v3.1.1 h1:Jh+9uKHkPxUJdxM16q5mOr+G2V0aqkuFtNA28ihCxhQ=
|
||||
github.com/mholt/acmez/v3 v3.1.1/go.mod h1:L1wOU06KKvq7tswuMDwKdcHeKpFFgkppZy/y0DFxagQ=
|
||||
github.com/mholt/acmez/v3 v3.1.2 h1:auob8J/0FhmdClQicvJvuDavgd5ezwLBfKuYmynhYzc=
|
||||
github.com/mholt/acmez/v3 v3.1.2/go.mod h1:L1wOU06KKvq7tswuMDwKdcHeKpFFgkppZy/y0DFxagQ=
|
||||
github.com/microcosm-cc/bluemonday v1.0.1/go.mod h1:hsXNsILzKxV+sX77C5b8FSuKF00vh2OMYv+xgHpAMF4=
|
||||
github.com/miekg/dns v1.1.63 h1:8M5aAw6OMZfFXTT7K5V0Eu5YiiL8l7nUAkyN6C9YwaY=
|
||||
github.com/miekg/dns v1.1.63/go.mod h1:6NGHfjhpmr5lt3XPLuyfDJi5AXbNIPM9PY6H6sF1Nfs=
|
||||
|
@ -7,10 +7,10 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
DefaultFilesystemKey = "default"
|
||||
DefaultFileSystemKey = "default"
|
||||
)
|
||||
|
||||
var DefaultFilesystem = &wrapperFs{key: DefaultFilesystemKey, FS: OsFS{}}
|
||||
var DefaultFileSystem = &wrapperFs{key: DefaultFileSystemKey, FS: OsFS{}}
|
||||
|
||||
// wrapperFs exists so can easily add to wrapperFs down the line
|
||||
type wrapperFs struct {
|
||||
@ -18,24 +18,24 @@ type wrapperFs struct {
|
||||
fs.FS
|
||||
}
|
||||
|
||||
// FilesystemMap stores a map of filesystems
|
||||
// FileSystemMap stores a map of filesystems
|
||||
// the empty key will be overwritten to be the default key
|
||||
// it includes a default filesystem, based off the os fs
|
||||
type FilesystemMap struct {
|
||||
type FileSystemMap struct {
|
||||
m sync.Map
|
||||
}
|
||||
|
||||
// note that the first invocation of key cannot be called in a racy context.
|
||||
func (f *FilesystemMap) key(k string) string {
|
||||
func (f *FileSystemMap) key(k string) string {
|
||||
if k == "" {
|
||||
k = DefaultFilesystemKey
|
||||
k = DefaultFileSystemKey
|
||||
}
|
||||
return k
|
||||
}
|
||||
|
||||
// Register will add the filesystem with key to later be retrieved
|
||||
// A call with a nil fs will call unregister, ensuring that a call to Default() will never be nil
|
||||
func (f *FilesystemMap) Register(k string, v fs.FS) {
|
||||
func (f *FileSystemMap) Register(k string, v fs.FS) {
|
||||
k = f.key(k)
|
||||
if v == nil {
|
||||
f.Unregister(k)
|
||||
@ -47,23 +47,23 @@ func (f *FilesystemMap) Register(k string, v fs.FS) {
|
||||
// Unregister will remove the filesystem with key from the filesystem map
|
||||
// if the key is the default key, it will set the default to the osFS instead of deleting it
|
||||
// modules should call this on cleanup to be safe
|
||||
func (f *FilesystemMap) Unregister(k string) {
|
||||
func (f *FileSystemMap) Unregister(k string) {
|
||||
k = f.key(k)
|
||||
if k == DefaultFilesystemKey {
|
||||
f.m.Store(k, DefaultFilesystem)
|
||||
if k == DefaultFileSystemKey {
|
||||
f.m.Store(k, DefaultFileSystem)
|
||||
} else {
|
||||
f.m.Delete(k)
|
||||
}
|
||||
}
|
||||
|
||||
// Get will get a filesystem with a given key
|
||||
func (f *FilesystemMap) Get(k string) (v fs.FS, ok bool) {
|
||||
func (f *FileSystemMap) Get(k string) (v fs.FS, ok bool) {
|
||||
k = f.key(k)
|
||||
c, ok := f.m.Load(strings.TrimSpace(k))
|
||||
if !ok {
|
||||
if k == DefaultFilesystemKey {
|
||||
f.m.Store(k, DefaultFilesystem)
|
||||
return DefaultFilesystem, true
|
||||
if k == DefaultFileSystemKey {
|
||||
f.m.Store(k, DefaultFileSystem)
|
||||
return DefaultFileSystem, true
|
||||
}
|
||||
return nil, ok
|
||||
}
|
||||
@ -71,7 +71,7 @@ func (f *FilesystemMap) Get(k string) (v fs.FS, ok bool) {
|
||||
}
|
||||
|
||||
// Default will get the default filesystem in the filesystem map
|
||||
func (f *FilesystemMap) Default() fs.FS {
|
||||
val, _ := f.Get(DefaultFilesystemKey)
|
||||
func (f *FileSystemMap) Default() fs.FS {
|
||||
val, _ := f.Get(DefaultFileSystemKey)
|
||||
return val
|
||||
}
|
||||
|
@ -210,7 +210,7 @@ func (na NetworkAddress) IsUnixNetwork() bool {
|
||||
return IsUnixNetwork(na.Network)
|
||||
}
|
||||
|
||||
// IsUnixNetwork returns true if na.Network is
|
||||
// IsFdNetwork returns true if na.Network is
|
||||
// fd or fdgram.
|
||||
func (na NetworkAddress) IsFdNetwork() bool {
|
||||
return IsFdNetwork(na.Network)
|
||||
@ -641,7 +641,7 @@ func RegisterNetwork(network string, getListener ListenerFunc) {
|
||||
if network == "tcp" || network == "tcp4" || network == "tcp6" ||
|
||||
network == "udp" || network == "udp4" || network == "udp6" ||
|
||||
network == "unix" || network == "unixpacket" || network == "unixgram" ||
|
||||
strings.HasPrefix("ip:", network) || strings.HasPrefix("ip4:", network) || strings.HasPrefix("ip6:", network) ||
|
||||
strings.HasPrefix(network, "ip:") || strings.HasPrefix(network, "ip4:") || strings.HasPrefix(network, "ip6:") ||
|
||||
network == "fd" || network == "fdgram" {
|
||||
panic("network type " + network + " is reserved")
|
||||
}
|
||||
|
@ -20,9 +20,7 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"go.uber.org/zap"
|
||||
|
||||
"github.com/caddyserver/caddy/v2"
|
||||
@ -206,27 +204,26 @@ func (app *App) On(eventName string, handler Handler) error {
|
||||
//
|
||||
// Note that the data map is not copied, for efficiency. After Emit() is called, the
|
||||
// data passed in should not be changed in other goroutines.
|
||||
func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) Event {
|
||||
func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) caddy.Event {
|
||||
logger := app.logger.With(zap.String("name", eventName))
|
||||
|
||||
id, err := uuid.NewRandom()
|
||||
e, err := caddy.NewEvent(ctx, eventName, data)
|
||||
if err != nil {
|
||||
logger.Error("failed generating new event ID", zap.Error(err))
|
||||
logger.Error("failed to create event", zap.Error(err))
|
||||
}
|
||||
|
||||
eventName = strings.ToLower(eventName)
|
||||
|
||||
e := Event{
|
||||
Data: data,
|
||||
id: id,
|
||||
ts: time.Now(),
|
||||
name: eventName,
|
||||
origin: ctx.Module(),
|
||||
var originModule caddy.ModuleInfo
|
||||
var originModuleID caddy.ModuleID
|
||||
var originModuleName string
|
||||
if origin := e.Origin(); origin != nil {
|
||||
originModule = origin.CaddyModule()
|
||||
originModuleID = originModule.ID
|
||||
originModuleName = originModule.String()
|
||||
}
|
||||
|
||||
logger = logger.With(
|
||||
zap.String("id", e.id.String()),
|
||||
zap.String("origin", e.origin.CaddyModule().String()))
|
||||
zap.String("id", e.ID().String()),
|
||||
zap.String("origin", originModuleName))
|
||||
|
||||
// add event info to replacer, make sure it's in the context
|
||||
repl, ok := ctx.Context.Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
|
||||
@ -239,15 +236,15 @@ func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) E
|
||||
case "event":
|
||||
return e, true
|
||||
case "event.id":
|
||||
return e.id, true
|
||||
return e.ID(), true
|
||||
case "event.name":
|
||||
return e.name, true
|
||||
return e.Name(), true
|
||||
case "event.time":
|
||||
return e.ts, true
|
||||
return e.Timestamp(), true
|
||||
case "event.time_unix":
|
||||
return e.ts.UnixMilli(), true
|
||||
return e.Timestamp().UnixMilli(), true
|
||||
case "event.module":
|
||||
return e.origin.CaddyModule().ID, true
|
||||
return originModuleID, true
|
||||
case "event.data":
|
||||
return e.Data, true
|
||||
}
|
||||
@ -269,7 +266,7 @@ func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) E
|
||||
// invoke handlers bound to the event by name and also all events; this for loop
|
||||
// iterates twice at most: once for the event name, once for "" (all events)
|
||||
for {
|
||||
moduleID := e.origin.CaddyModule().ID
|
||||
moduleID := originModuleID
|
||||
|
||||
// implement propagation up the module tree (i.e. start with "a.b.c" then "a.b" then "a" then "")
|
||||
for {
|
||||
@ -292,7 +289,7 @@ func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) E
|
||||
zap.Any("handler", handler))
|
||||
|
||||
if err := handler.Handle(ctx, e); err != nil {
|
||||
aborted := errors.Is(err, ErrAborted)
|
||||
aborted := errors.Is(err, caddy.ErrEventAborted)
|
||||
|
||||
logger.Error("handler error",
|
||||
zap.Error(err),
|
||||
@ -326,76 +323,9 @@ func (app *App) Emit(ctx caddy.Context, eventName string, data map[string]any) E
|
||||
return e
|
||||
}
|
||||
|
||||
// Event represents something that has happened or is happening.
|
||||
// An Event value is not synchronized, so it should be copied if
|
||||
// being used in goroutines.
|
||||
//
|
||||
// EXPERIMENTAL: As with the rest of this package, events are
|
||||
// subject to change.
|
||||
type Event struct {
|
||||
// If non-nil, the event has been aborted, meaning
|
||||
// propagation has stopped to other handlers and
|
||||
// the code should stop what it was doing. Emitters
|
||||
// may choose to use this as a signal to adjust their
|
||||
// code path appropriately.
|
||||
Aborted error
|
||||
|
||||
// The data associated with the event. Usually the
|
||||
// original emitter will be the only one to set or
|
||||
// change these values, but the field is exported
|
||||
// so handlers can have full access if needed.
|
||||
// However, this map is not synchronized, so
|
||||
// handlers must not use this map directly in new
|
||||
// goroutines; instead, copy the map to use it in a
|
||||
// goroutine.
|
||||
Data map[string]any
|
||||
|
||||
id uuid.UUID
|
||||
ts time.Time
|
||||
name string
|
||||
origin caddy.Module
|
||||
}
|
||||
|
||||
func (e Event) ID() uuid.UUID { return e.id }
|
||||
func (e Event) Timestamp() time.Time { return e.ts }
|
||||
func (e Event) Name() string { return e.name }
|
||||
func (e Event) Origin() caddy.Module { return e.origin }
|
||||
|
||||
// CloudEvent exports event e as a structure that, when
|
||||
// serialized as JSON, is compatible with the
|
||||
// CloudEvents spec.
|
||||
func (e Event) CloudEvent() CloudEvent {
|
||||
dataJSON, _ := json.Marshal(e.Data)
|
||||
return CloudEvent{
|
||||
ID: e.id.String(),
|
||||
Source: e.origin.CaddyModule().String(),
|
||||
SpecVersion: "1.0",
|
||||
Type: e.name,
|
||||
Time: e.ts,
|
||||
DataContentType: "application/json",
|
||||
Data: dataJSON,
|
||||
}
|
||||
}
|
||||
|
||||
// CloudEvent is a JSON-serializable structure that
|
||||
// is compatible with the CloudEvents specification.
|
||||
// See https://cloudevents.io.
|
||||
type CloudEvent struct {
|
||||
ID string `json:"id"`
|
||||
Source string `json:"source"`
|
||||
SpecVersion string `json:"specversion"`
|
||||
Type string `json:"type"`
|
||||
Time time.Time `json:"time"`
|
||||
DataContentType string `json:"datacontenttype,omitempty"`
|
||||
Data json.RawMessage `json:"data,omitempty"`
|
||||
}
|
||||
|
||||
// ErrAborted cancels an event.
|
||||
var ErrAborted = errors.New("event aborted")
|
||||
|
||||
// Handler is a type that can handle events.
|
||||
type Handler interface {
|
||||
Handle(context.Context, Event) error
|
||||
Handle(context.Context, caddy.Event) error
|
||||
}
|
||||
|
||||
// Interface guards
|
||||
|
@ -69,11 +69,11 @@ func (xs *Filesystems) Provision(ctx caddy.Context) error {
|
||||
}
|
||||
// register that module
|
||||
ctx.Logger().Debug("registering fs", zap.String("fs", f.Key))
|
||||
ctx.Filesystems().Register(f.Key, f.fileSystem)
|
||||
ctx.FileSystems().Register(f.Key, f.fileSystem)
|
||||
// remember to unregister the module when we are done
|
||||
xs.defers = append(xs.defers, func() {
|
||||
ctx.Logger().Debug("unregistering fs", zap.String("fs", f.Key))
|
||||
ctx.Filesystems().Unregister(f.Key)
|
||||
ctx.FileSystems().Unregister(f.Key)
|
||||
})
|
||||
}
|
||||
return nil
|
||||
|
@ -73,7 +73,7 @@ func init() {
|
||||
// `{http.request.local.host}` | The host (IP) part of the local address the connection arrived on
|
||||
// `{http.request.local.port}` | The port part of the local address the connection arrived on
|
||||
// `{http.request.local}` | The local address the connection arrived on
|
||||
// `{http.request.remote.host}` | The host (IP) part of the remote client's address
|
||||
// `{http.request.remote.host}` | The host (IP) part of the remote client's address, if available (not known with HTTP/3 early data)
|
||||
// `{http.request.remote.port}` | The port part of the remote client's address
|
||||
// `{http.request.remote}` | The address of the remote client
|
||||
// `{http.request.scheme}` | The request scheme, typically `http` or `https`
|
||||
|
@ -274,7 +274,7 @@ func celFileMatcherMacroExpander() parser.MacroExpander {
|
||||
func (m *MatchFile) Provision(ctx caddy.Context) error {
|
||||
m.logger = ctx.Logger()
|
||||
|
||||
m.fsmap = ctx.Filesystems()
|
||||
m.fsmap = ctx.FileSystems()
|
||||
|
||||
if m.Root == "" {
|
||||
m.Root = "{http.vars.root}"
|
||||
|
@ -117,7 +117,7 @@ func TestFileMatcher(t *testing.T) {
|
||||
},
|
||||
} {
|
||||
m := &MatchFile{
|
||||
fsmap: &filesystems.FilesystemMap{},
|
||||
fsmap: &filesystems.FileSystemMap{},
|
||||
Root: "./testdata",
|
||||
TryFiles: []string{"{http.request.uri.path}", "{http.request.uri.path}/"},
|
||||
}
|
||||
@ -229,7 +229,7 @@ func TestPHPFileMatcher(t *testing.T) {
|
||||
},
|
||||
} {
|
||||
m := &MatchFile{
|
||||
fsmap: &filesystems.FilesystemMap{},
|
||||
fsmap: &filesystems.FileSystemMap{},
|
||||
Root: "./testdata",
|
||||
TryFiles: []string{"{http.request.uri.path}", "{http.request.uri.path}/index.php"},
|
||||
SplitPath: []string{".php"},
|
||||
@ -273,7 +273,7 @@ func TestPHPFileMatcher(t *testing.T) {
|
||||
func TestFirstSplit(t *testing.T) {
|
||||
m := MatchFile{
|
||||
SplitPath: []string{".php"},
|
||||
fsmap: &filesystems.FilesystemMap{},
|
||||
fsmap: &filesystems.FileSystemMap{},
|
||||
}
|
||||
actual, remainder := m.firstSplit("index.PHP/somewhere")
|
||||
expected := "index.PHP"
|
||||
|
@ -186,7 +186,7 @@ func (FileServer) CaddyModule() caddy.ModuleInfo {
|
||||
func (fsrv *FileServer) Provision(ctx caddy.Context) error {
|
||||
fsrv.logger = ctx.Logger()
|
||||
|
||||
fsrv.fsmap = ctx.Filesystems()
|
||||
fsrv.fsmap = ctx.FileSystems()
|
||||
|
||||
if fsrv.FileSystem == "" {
|
||||
fsrv.FileSystem = "{http.vars.fs}"
|
||||
|
@ -309,7 +309,9 @@ func (h *Handler) doActiveHealthCheckForAllHosts() {
|
||||
}
|
||||
}()
|
||||
|
||||
networkAddr, err := caddy.NewReplacer().ReplaceOrErr(upstream.Dial, true, true)
|
||||
repl := caddy.NewReplacer()
|
||||
|
||||
networkAddr, err := repl.ReplaceOrErr(upstream.Dial, true, true)
|
||||
if err != nil {
|
||||
if c := h.HealthChecks.Active.logger.Check(zapcore.ErrorLevel, "invalid use of placeholders in dial address for active health checks"); c != nil {
|
||||
c.Write(
|
||||
@ -344,14 +346,24 @@ func (h *Handler) doActiveHealthCheckForAllHosts() {
|
||||
return
|
||||
}
|
||||
hostAddr := addr.JoinHostPort(0)
|
||||
dialAddr := hostAddr
|
||||
if addr.IsUnixNetwork() || addr.IsFdNetwork() {
|
||||
// this will be used as the Host portion of a http.Request URL, and
|
||||
// paths to socket files would produce an error when creating URL,
|
||||
// so use a fake Host value instead; unix sockets are usually local
|
||||
hostAddr = "localhost"
|
||||
}
|
||||
err = h.doActiveHealthCheck(DialInfo{Network: addr.Network, Address: dialAddr}, hostAddr, networkAddr, upstream)
|
||||
|
||||
// Fill in the dial info for the upstream
|
||||
// If the upstream is set, use that instead
|
||||
dialInfoUpstream := upstream
|
||||
if h.HealthChecks.Active.Upstream != "" {
|
||||
dialInfoUpstream = &Upstream{
|
||||
Dial: h.HealthChecks.Active.Upstream,
|
||||
}
|
||||
}
|
||||
dialInfo, _ := dialInfoUpstream.fillDialInfo(repl)
|
||||
|
||||
err = h.doActiveHealthCheck(dialInfo, hostAddr, networkAddr, upstream)
|
||||
if err != nil {
|
||||
if c := h.HealthChecks.Active.logger.Check(zapcore.ErrorLevel, "active health check failed"); c != nil {
|
||||
c.Write(
|
||||
|
@ -17,7 +17,6 @@ package reverseproxy
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/netip"
|
||||
"strconv"
|
||||
"sync/atomic"
|
||||
@ -100,8 +99,7 @@ func (u *Upstream) Full() bool {
|
||||
|
||||
// fillDialInfo returns a filled DialInfo for upstream u, using the request
|
||||
// context. Note that the returned value is not a pointer.
|
||||
func (u *Upstream) fillDialInfo(r *http.Request) (DialInfo, error) {
|
||||
repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
|
||||
func (u *Upstream) fillDialInfo(repl *caddy.Replacer) (DialInfo, error) {
|
||||
var addr caddy.NetworkAddress
|
||||
|
||||
// use provided dial address
|
||||
|
@ -532,7 +532,7 @@ func (h *Handler) proxyLoopIteration(r *http.Request, origReq *http.Request, w h
|
||||
// the dial address may vary per-request if placeholders are
|
||||
// used, so perform those replacements here; the resulting
|
||||
// DialInfo struct should have valid network address syntax
|
||||
dialInfo, err := upstream.fillDialInfo(r)
|
||||
dialInfo, err := upstream.fillDialInfo(repl)
|
||||
if err != nil {
|
||||
return true, fmt.Errorf("making dial info: %v", err)
|
||||
}
|
||||
|
@ -641,10 +641,6 @@ nextName:
|
||||
}
|
||||
|
||||
relName := libdns.RelativeName(domain+".", zone)
|
||||
// TODO: libdns.RelativeName should probably return "@" instead of "". (The latest commits of libdns do this, so remove this logic once upgraded.)
|
||||
if relName == "" {
|
||||
relName = "@"
|
||||
}
|
||||
|
||||
// get existing records for this domain; we need to make sure another
|
||||
// record exists for it so we don't accidentally trample a wildcard; we
|
||||
@ -657,23 +653,25 @@ nextName:
|
||||
zap.Error(err))
|
||||
continue
|
||||
}
|
||||
var httpsRec libdns.Record
|
||||
var httpsRec libdns.ServiceBinding
|
||||
var nameHasExistingRecord bool
|
||||
for _, rec := range recs {
|
||||
// TODO: providers SHOULD normalize root-level records to be named "@"; remove the extra conditions when the transition to the new semantics is done
|
||||
if rec.Name == relName || (rec.Name == "" && relName == "@") {
|
||||
rr := rec.RR()
|
||||
if rr.Name == relName {
|
||||
// CNAME records are exclusive of all other records, so we cannot publish an HTTPS
|
||||
// record for a domain that is CNAME'd. See #6922.
|
||||
if rec.Type == "CNAME" {
|
||||
if rr.Type == "CNAME" {
|
||||
dnsPub.logger.Warn("domain has CNAME record, so unable to publish ECH data to HTTPS record",
|
||||
zap.String("domain", domain),
|
||||
zap.String("cname_value", rec.Value))
|
||||
zap.String("cname_value", rr.Data))
|
||||
continue nextName
|
||||
}
|
||||
nameHasExistingRecord = true
|
||||
if rec.Type == "HTTPS" && (rec.Target == "" || rec.Target == ".") {
|
||||
httpsRec = rec
|
||||
break
|
||||
if svcb, ok := rec.(libdns.ServiceBinding); ok && svcb.Scheme == "https" {
|
||||
if svcb.Target == "" || svcb.Target == "." {
|
||||
httpsRec = svcb
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -689,31 +687,24 @@ nextName:
|
||||
zap.String("zone", zone))
|
||||
continue
|
||||
}
|
||||
params := make(svcParams)
|
||||
if httpsRec.Value != "" {
|
||||
params, err = parseSvcParams(httpsRec.Value)
|
||||
if err != nil {
|
||||
dnsPub.logger.Error("unable to parse existing DNS record to publish ECH data to HTTPS DNS record",
|
||||
zap.String("domain", domain),
|
||||
zap.String("https_rec_value", httpsRec.Value),
|
||||
zap.Error(err))
|
||||
continue
|
||||
}
|
||||
params := httpsRec.Params
|
||||
if params == nil {
|
||||
params = make(libdns.SvcParams)
|
||||
}
|
||||
|
||||
// overwrite only the ech SvcParamKey
|
||||
// overwrite only the "ech" SvcParamKey
|
||||
params["ech"] = []string{base64.StdEncoding.EncodeToString(configListBin)}
|
||||
|
||||
// publish record
|
||||
_, err = dnsPub.provider.SetRecords(ctx, zone, []libdns.Record{
|
||||
{
|
||||
libdns.ServiceBinding{
|
||||
// HTTPS and SVCB RRs: RFC 9460 (https://www.rfc-editor.org/rfc/rfc9460)
|
||||
Type: "HTTPS",
|
||||
Scheme: "https",
|
||||
Name: relName,
|
||||
Priority: 2, // allows a manual override with priority 1
|
||||
Target: ".",
|
||||
Value: params.String(),
|
||||
TTL: 1 * time.Minute, // TODO: for testing only
|
||||
Priority: 2, // allows a manual override with priority 1
|
||||
Target: ".",
|
||||
Params: params,
|
||||
},
|
||||
})
|
||||
if err != nil {
|
||||
@ -952,172 +943,6 @@ func newECHConfigID(ctx caddy.Context) (uint8, error) {
|
||||
return 0, fmt.Errorf("depleted attempts to find an available config_id")
|
||||
}
|
||||
|
||||
// svcParams represents SvcParamKey and SvcParamValue pairs as
|
||||
// described in https://www.rfc-editor.org/rfc/rfc9460 (section 2.1).
|
||||
type svcParams map[string][]string
|
||||
|
||||
// parseSvcParams parses service parameters into a structured type
|
||||
// for safer manipulation.
|
||||
func parseSvcParams(input string) (svcParams, error) {
|
||||
if len(input) > 4096 {
|
||||
return nil, fmt.Errorf("input too long: %d", len(input))
|
||||
}
|
||||
|
||||
params := make(svcParams)
|
||||
input = strings.TrimSpace(input) + " "
|
||||
|
||||
for cursor := 0; cursor < len(input); cursor++ {
|
||||
var key, rawVal string
|
||||
|
||||
keyValPair:
|
||||
for i := cursor; i < len(input); i++ {
|
||||
switch input[i] {
|
||||
case '=':
|
||||
key = strings.ToLower(strings.TrimSpace(input[cursor:i]))
|
||||
i++
|
||||
cursor = i
|
||||
|
||||
var quoted bool
|
||||
if input[cursor] == '"' {
|
||||
quoted = true
|
||||
i++
|
||||
cursor = i
|
||||
}
|
||||
|
||||
var escaped bool
|
||||
|
||||
for j := cursor; j < len(input); j++ {
|
||||
switch input[j] {
|
||||
case '"':
|
||||
if !quoted {
|
||||
return nil, fmt.Errorf("illegal DQUOTE at position %d", j)
|
||||
}
|
||||
if !escaped {
|
||||
// end of quoted value
|
||||
rawVal = input[cursor:j]
|
||||
j++
|
||||
cursor = j
|
||||
break keyValPair
|
||||
}
|
||||
case '\\':
|
||||
escaped = true
|
||||
case ' ', '\t', '\n', '\r':
|
||||
if !quoted {
|
||||
// end of unquoted value
|
||||
rawVal = input[cursor:j]
|
||||
cursor = j
|
||||
break keyValPair
|
||||
}
|
||||
default:
|
||||
escaped = false
|
||||
}
|
||||
}
|
||||
|
||||
case ' ', '\t', '\n', '\r':
|
||||
// key with no value (flag)
|
||||
key = input[cursor:i]
|
||||
params[key] = []string{}
|
||||
cursor = i
|
||||
break keyValPair
|
||||
}
|
||||
}
|
||||
|
||||
if rawVal == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
var sb strings.Builder
|
||||
|
||||
var escape int // start of escape sequence (after \, so 0 is never a valid start)
|
||||
for i := 0; i < len(rawVal); i++ {
|
||||
ch := rawVal[i]
|
||||
if escape > 0 {
|
||||
// validate escape sequence
|
||||
// (RFC 9460 Appendix A)
|
||||
// escaped: "\" ( non-digit / dec-octet )
|
||||
// non-digit: "%x21-2F / %x3A-7E"
|
||||
// dec-octet: "0-255 as a 3-digit decimal number"
|
||||
if ch >= '0' && ch <= '9' {
|
||||
// advance to end of decimal octet, which must be 3 digits
|
||||
i += 2
|
||||
if i > len(rawVal) {
|
||||
return nil, fmt.Errorf("value ends with incomplete escape sequence: %s", rawVal[escape:])
|
||||
}
|
||||
decOctet, err := strconv.Atoi(rawVal[escape : i+1])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if decOctet < 0 || decOctet > 255 {
|
||||
return nil, fmt.Errorf("invalid decimal octet in escape sequence: %s (%d)", rawVal[escape:i], decOctet)
|
||||
}
|
||||
sb.WriteRune(rune(decOctet))
|
||||
escape = 0
|
||||
continue
|
||||
} else if (ch < 0x21 || ch > 0x2F) && (ch < 0x3A && ch > 0x7E) {
|
||||
return nil, fmt.Errorf("illegal escape sequence %s", rawVal[escape:i])
|
||||
}
|
||||
}
|
||||
switch ch {
|
||||
case ';', '(', ')':
|
||||
// RFC 9460 Appendix A:
|
||||
// > contiguous = 1*( non-special / escaped )
|
||||
// > non-special is VCHAR minus DQUOTE, ";", "(", ")", and "\".
|
||||
return nil, fmt.Errorf("illegal character in value %q at position %d: %s", rawVal, i, string(ch))
|
||||
case '\\':
|
||||
escape = i + 1
|
||||
default:
|
||||
sb.WriteByte(ch)
|
||||
escape = 0
|
||||
}
|
||||
}
|
||||
|
||||
params[key] = strings.Split(sb.String(), ",")
|
||||
}
|
||||
|
||||
return params, nil
|
||||
}
|
||||
|
||||
// String serializes svcParams into zone presentation format.
|
||||
func (params svcParams) String() string {
|
||||
var sb strings.Builder
|
||||
for key, vals := range params {
|
||||
if sb.Len() > 0 {
|
||||
sb.WriteRune(' ')
|
||||
}
|
||||
sb.WriteString(key)
|
||||
var hasVal, needsQuotes bool
|
||||
for _, val := range vals {
|
||||
if len(val) > 0 {
|
||||
hasVal = true
|
||||
}
|
||||
if strings.ContainsAny(val, `" `) {
|
||||
needsQuotes = true
|
||||
}
|
||||
if hasVal && needsQuotes {
|
||||
break
|
||||
}
|
||||
}
|
||||
if hasVal {
|
||||
sb.WriteRune('=')
|
||||
}
|
||||
if needsQuotes {
|
||||
sb.WriteRune('"')
|
||||
}
|
||||
for i, val := range vals {
|
||||
if i > 0 {
|
||||
sb.WriteRune(',')
|
||||
}
|
||||
val = strings.ReplaceAll(val, `"`, `\"`)
|
||||
val = strings.ReplaceAll(val, `,`, `\,`)
|
||||
sb.WriteString(val)
|
||||
}
|
||||
if needsQuotes {
|
||||
sb.WriteRune('"')
|
||||
}
|
||||
}
|
||||
return sb.String()
|
||||
}
|
||||
|
||||
// ECHPublisher is an interface for publishing ECHConfigList values
|
||||
// so that they can be used by clients.
|
||||
type ECHPublisher interface {
|
||||
|
@ -1,129 +0,0 @@
|
||||
package caddytls
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestParseSvcParams(t *testing.T) {
|
||||
for i, test := range []struct {
|
||||
input string
|
||||
expect svcParams
|
||||
shouldErr bool
|
||||
}{
|
||||
{
|
||||
input: `alpn="h2,h3" no-default-alpn ipv6hint=2001:db8::1 port=443`,
|
||||
expect: svcParams{
|
||||
"alpn": {"h2", "h3"},
|
||||
"no-default-alpn": {},
|
||||
"ipv6hint": {"2001:db8::1"},
|
||||
"port": {"443"},
|
||||
},
|
||||
},
|
||||
{
|
||||
input: `key=value quoted="some string" flag`,
|
||||
expect: svcParams{
|
||||
"key": {"value"},
|
||||
"quoted": {"some string"},
|
||||
"flag": {},
|
||||
},
|
||||
},
|
||||
{
|
||||
input: `key="nested \"quoted\" value,foobar"`,
|
||||
expect: svcParams{
|
||||
"key": {`nested "quoted" value`, "foobar"},
|
||||
},
|
||||
},
|
||||
{
|
||||
input: `alpn=h3,h2 tls-supported-groups=29,23 no-default-alpn ech="foobar"`,
|
||||
expect: svcParams{
|
||||
"alpn": {"h3", "h2"},
|
||||
"tls-supported-groups": {"29", "23"},
|
||||
"no-default-alpn": {},
|
||||
"ech": {"foobar"},
|
||||
},
|
||||
},
|
||||
{
|
||||
input: `escape=\097`,
|
||||
expect: svcParams{
|
||||
"escape": {"a"},
|
||||
},
|
||||
},
|
||||
{
|
||||
input: `escapes=\097\098c`,
|
||||
expect: svcParams{
|
||||
"escapes": {"abc"},
|
||||
},
|
||||
},
|
||||
} {
|
||||
actual, err := parseSvcParams(test.input)
|
||||
if err != nil && !test.shouldErr {
|
||||
t.Errorf("Test %d: Expected no error, but got: %v (input=%q)", i, err, test.input)
|
||||
continue
|
||||
} else if err == nil && test.shouldErr {
|
||||
t.Errorf("Test %d: Expected an error, but got no error (input=%q)", i, test.input)
|
||||
continue
|
||||
}
|
||||
if !reflect.DeepEqual(test.expect, actual) {
|
||||
t.Errorf("Test %d: Expected %v, got %v (input=%q)", i, test.expect, actual, test.input)
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestSvcParamsString(t *testing.T) {
|
||||
// this test relies on the parser also working
|
||||
// because we can't just compare string outputs
|
||||
// since map iteration is unordered
|
||||
for i, test := range []svcParams{
|
||||
|
||||
{
|
||||
"alpn": {"h2", "h3"},
|
||||
"no-default-alpn": {},
|
||||
"ipv6hint": {"2001:db8::1"},
|
||||
"port": {"443"},
|
||||
},
|
||||
|
||||
{
|
||||
"key": {"value"},
|
||||
"quoted": {"some string"},
|
||||
"flag": {},
|
||||
},
|
||||
{
|
||||
"key": {`nested "quoted" value`, "foobar"},
|
||||
},
|
||||
{
|
||||
"alpn": {"h3", "h2"},
|
||||
"tls-supported-groups": {"29", "23"},
|
||||
"no-default-alpn": {},
|
||||
"ech": {"foobar"},
|
||||
},
|
||||
} {
|
||||
combined := test.String()
|
||||
parsed, err := parseSvcParams(combined)
|
||||
if err != nil {
|
||||
t.Errorf("Test %d: Expected no error, but got: %v (input=%q)", i, err, test)
|
||||
continue
|
||||
}
|
||||
if len(parsed) != len(test) {
|
||||
t.Errorf("Test %d: Expected %d keys, but got %d", i, len(test), len(parsed))
|
||||
continue
|
||||
}
|
||||
for key, expectedVals := range test {
|
||||
if expected, actual := len(expectedVals), len(parsed[key]); expected != actual {
|
||||
t.Errorf("Test %d: Expected key %s to have %d values, but had %d", i, key, expected, actual)
|
||||
continue
|
||||
}
|
||||
for j, expected := range expectedVals {
|
||||
if actual := parsed[key][j]; actual != expected {
|
||||
t.Errorf("Test %d key %q value %d: Expected '%s' but got '%s'", i, key, j, expected, actual)
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
||||
if !reflect.DeepEqual(parsed, test) {
|
||||
t.Errorf("Test %d: Expected %#v, got %#v", i, test, combined)
|
||||
continue
|
||||
}
|
||||
}
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user