mirror of
https://github.com/caddyserver/caddy.git
synced 2024-11-25 09:40:13 +08:00
ab80ff4fd2
This commits dds 3 separate, but very related features: 1. Automated server identity management How do you know you're connecting to the server you think you are? How do you know the server connecting to you is the server instance you think it is? Mutually-authenticated TLS (mTLS) answers both of these questions. Using TLS to authenticate requires a public/private key pair (and the peer must trust the certificate you present to it). Fortunately, Caddy is really good at managing certificates by now. We tap into that power to make it possible for Caddy to obtain and renew its own identity credentials, or in other words, a certificate that can be used for both server verification when clients connect to it, and client verification when it connects to other servers. Its associated private key is essentially its identity, and TLS takes care of possession proofs. This configuration is simply a list of identifiers and an optional list of custom certificate issuers. Identifiers are things like IP addresses or DNS names that can be used to access the Caddy instance. The default issuers are ZeroSSL and Let's Encrypt, but these are public CAs, so they won't issue certs for private identifiers. Caddy will simply manage credentials for these, which other parts of Caddy can use, for example: remote administration or dynamic config loading (described below). 2. Remote administration over secure connection This feature adds generic remote admin functionality that is safe to expose on a public interface. - The "remote" (or "secure") endpoint is optional. It does not affect the standard/local/plaintext endpoint. - It's the same as the [API endpoint on localhost:2019](https://caddyserver.com/docs/api), but over TLS. - TLS cannot be disabled on this endpoint. - TLS mutual auth is required, and cannot be disabled. - The server's certificate _must_ be obtained and renewed via automated means, such as ACME. It cannot be manually loaded. - The TLS server takes care of verifying the client. - The admin handler takes care of application-layer permissions (methods and paths that each client is allowed to use).\ - Sensible defaults are still WIP. - Config fields subject to change/renaming. 3. Dyanmic config loading at startup Since this feature was planned in tandem with remote admin, and depends on its changes, I am combining them into one PR. Dynamic config loading is where you tell Caddy how to load its config, and then it loads and runs that. First, it will load the config you give it (and persist that so it can be optionally resumed later). Then, it will try pulling its _actual_ config using the module you've specified (dynamically loaded configs are _not_ persisted to storage, since resuming them doesn't make sense). This PR comes with a standard config loader module called `caddy.config_loaders.http`. Caddyfile config for all of this can probably be added later. COMMITS: * admin: Secure socket for remote management Functional, but still WIP. Optional secure socket for the admin endpoint is designed for remote management, i.e. to be exposed on a public port. It enforces TLS mutual authentication which cannot be disabled. The default port for this is :2021. The server certificate cannot be specified manually, it MUST be obtained from a certificate issuer (i.e. ACME). More polish and sensible defaults are still in development. Also cleaned up and consolidated the code related to quitting the process. * Happy lint * Implement dynamic config loading; HTTP config loader module This allows Caddy to load a dynamic config when it starts. Dynamically-loaded configs are intentionally not persisted to storage. Includes an implementation of the standard config loader, HTTPLoader. Can be used to download configs over HTTP(S). * Refactor and cleanup; prevent recursive config pulls Identity management is now separated from remote administration. There is no need to enable remote administration if all you want is identity management, but you will need to configure identity management if you want remote administration. * Fix lint warnings * Rename identities->identifiers for consistency
70 lines
2.0 KiB
Go
70 lines
2.0 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 caddy
|
|
|
|
import (
|
|
"os"
|
|
"os/signal"
|
|
|
|
"go.uber.org/zap"
|
|
)
|
|
|
|
// TrapSignals create signal/interrupt handlers as best it can for the
|
|
// current OS. This is a rather invasive function to call in a Go program
|
|
// that captures signals already, so in that case it would be better to
|
|
// implement these handlers yourself.
|
|
func TrapSignals() {
|
|
trapSignalsCrossPlatform()
|
|
trapSignalsPosix()
|
|
}
|
|
|
|
// trapSignalsCrossPlatform captures SIGINT or interrupt (depending
|
|
// on the OS), which initiates a graceful shutdown. A second SIGINT
|
|
// or interrupt will forcefully exit the process immediately.
|
|
func trapSignalsCrossPlatform() {
|
|
go func() {
|
|
shutdown := make(chan os.Signal, 1)
|
|
signal.Notify(shutdown, os.Interrupt)
|
|
|
|
for i := 0; true; i++ {
|
|
<-shutdown
|
|
|
|
if i > 0 {
|
|
Log().Warn("force quit", zap.String("signal", "SIGINT"))
|
|
os.Exit(ExitCodeForceQuit)
|
|
}
|
|
|
|
Log().Info("shutting down", zap.String("signal", "SIGINT"))
|
|
go exitProcessFromSignal("SIGINT")
|
|
}
|
|
}()
|
|
}
|
|
|
|
// exitProcessFromSignal exits the process from a system signal.
|
|
func exitProcessFromSignal(sigName string) {
|
|
logger := Log().With(zap.String("signal", sigName))
|
|
exitProcess(logger)
|
|
}
|
|
|
|
// Exit codes. Generally, you should NOT
|
|
// automatically restart the process if the
|
|
// exit code is ExitCodeFailedStartup (1).
|
|
const (
|
|
ExitCodeSuccess = iota
|
|
ExitCodeFailedStartup
|
|
ExitCodeForceQuit
|
|
ExitCodeFailedQuit
|
|
)
|