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.
97 lines
2.6 KiB
Go
97 lines
2.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 logging
|
|
|
|
import (
|
|
"net"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
"go.uber.org/zap/zapcore"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(DeleteFilter{})
|
|
caddy.RegisterModule(IPMaskFilter{})
|
|
}
|
|
|
|
// LogFieldFilter can filter (or manipulate)
|
|
// a field in a log entry. If delete is true,
|
|
// out will be ignored and the field will be
|
|
// removed from the output.
|
|
type LogFieldFilter interface {
|
|
Filter(zapcore.Field) zapcore.Field
|
|
}
|
|
|
|
// DeleteFilter is a Caddy log field filter that
|
|
// deletes the field.
|
|
type DeleteFilter struct{}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (DeleteFilter) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "caddy.logging.encoders.filter.delete",
|
|
New: func() caddy.Module { return new(DeleteFilter) },
|
|
}
|
|
}
|
|
|
|
// Filter filters the input field.
|
|
func (DeleteFilter) Filter(in zapcore.Field) zapcore.Field {
|
|
in.Type = zapcore.SkipType
|
|
return in
|
|
}
|
|
|
|
// IPMaskFilter is a Caddy log field filter that
|
|
// masks IP addresses.
|
|
type IPMaskFilter struct {
|
|
// The IPv4 range in CIDR notation.
|
|
IPv4CIDR int `json:"ipv4_cidr,omitempty"`
|
|
|
|
// The IPv6 range in CIDR notation.
|
|
IPv6CIDR int `json:"ipv6_cidr,omitempty"`
|
|
}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (IPMaskFilter) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "caddy.logging.encoders.filter.ip_mask",
|
|
New: func() caddy.Module { return new(IPMaskFilter) },
|
|
}
|
|
}
|
|
|
|
// Filter filters the input field.
|
|
func (m IPMaskFilter) Filter(in zapcore.Field) zapcore.Field {
|
|
host, port, err := net.SplitHostPort(in.String)
|
|
if err != nil {
|
|
host = in.String // assume whole thing was IP address
|
|
}
|
|
ipAddr := net.ParseIP(host)
|
|
if ipAddr == nil {
|
|
return in
|
|
}
|
|
bitLen := 32
|
|
cidrPrefix := m.IPv4CIDR
|
|
if ipAddr.To16() != nil {
|
|
bitLen = 128
|
|
cidrPrefix = m.IPv6CIDR
|
|
}
|
|
mask := net.CIDRMask(cidrPrefix, bitLen)
|
|
masked := ipAddr.Mask(mask)
|
|
if port == "" {
|
|
in.String = masked.String()
|
|
} else {
|
|
in.String = net.JoinHostPort(masked.String(), port)
|
|
}
|
|
return in
|
|
}
|