mirror of
https://github.com/status-im/consul.git
synced 2025-01-09 21:35:52 +00:00
5fb9df1640
* Adding explicit MPL license for sub-package This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at <Blog URL>, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * add missing license headers * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 * Update copyright file headers to BUSL-1.1 --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
104 lines
3.4 KiB
Go
104 lines
3.4 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package config
|
|
|
|
import (
|
|
"github.com/hashicorp/consul/api"
|
|
"github.com/hashicorp/consul/command/flags"
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
func New() *cmd {
|
|
return &cmd{}
|
|
}
|
|
|
|
type cmd struct{}
|
|
|
|
func (c *cmd) Run(args []string) int {
|
|
return cli.RunResultHelp
|
|
}
|
|
|
|
func (c *cmd) Synopsis() string {
|
|
return synopsis
|
|
}
|
|
|
|
func (c *cmd) Help() string {
|
|
return flags.Usage(help, nil)
|
|
}
|
|
|
|
const synopsis = "Interact with Consul's Centralized Configurations"
|
|
const help = `
|
|
Usage: consul config <subcommand> [options] [args]
|
|
|
|
This command has subcommands for interacting with Consul's Centralized
|
|
Configuration system. Here are some simple examples, and more detailed
|
|
examples are available in the subcommands or the documentation.
|
|
|
|
Write a config:
|
|
|
|
$ consul config write web.serviceconf.hcl
|
|
|
|
Read a config:
|
|
|
|
$ consul config read -kind service-defaults -name web
|
|
|
|
List all configs for a type:
|
|
|
|
$ consul config list -kind service-defaults
|
|
|
|
Delete a config:
|
|
|
|
$ consul config delete -kind service-defaults -name web
|
|
|
|
For more examples, ask for subcommand help or view the documentation.
|
|
`
|
|
|
|
const (
|
|
// TODO(pglass): These warnings can go away when the UI provides visibility into
|
|
// permissive mTLS settings (expected 1.17).
|
|
WarningServiceDefaultsPermissiveMTLS = "MutualTLSMode=permissive is insecure. " +
|
|
"Set to `strict` when your service no longer needs to accept non-mTLS " +
|
|
"traffic. Check `tcp.permissive_public_listener` metrics in Envoy for " +
|
|
"non-mTLS traffic. Refer to Consul documentation for more information."
|
|
|
|
WarningProxyDefaultsPermissiveMTLS = "MutualTLSMode=permissive is insecure. " +
|
|
"To keep your services secure, set MutualTLSMode to `strict` whenever possible " +
|
|
"and override with service-defaults only if necessary. To check which " +
|
|
"service-defaults are currently in permissive mode, run `consul config list " +
|
|
"-kind service-defaults -filter 'MutualTLSMode = \"permissive\"'`."
|
|
|
|
WarningMeshAllowEnablingPermissiveMutualTLS = "AllowEnablingPermissiveMutualTLS=true " +
|
|
"allows insecure MutualTLSMode=permissive configurations in the proxy-defaults " +
|
|
"and service-defaults config entries. You can set " +
|
|
"AllowEnablingPermissiveMutualTLS=false at any time to disallow additional " +
|
|
"permissive configurations. To list services in permissive mode, run `consul " +
|
|
"config list -kind service-defaults -filter 'MutualTLSMode = \"permissive\"'`."
|
|
)
|
|
|
|
// KindSpecificWriteWarning returns a warning message for the given config
|
|
// entry write. Use this to inform the user of (un)recommended settings when
|
|
// they read or write config entries with the CLI.
|
|
//
|
|
// Do not return a warning on default/zero values. Because the config
|
|
// entry is parsed, we cannot distinguish between an absent field in the
|
|
// user-provided content and a zero value, so we'd end up warning on
|
|
// every invocation.
|
|
func KindSpecificWriteWarning(reqEntry api.ConfigEntry) string {
|
|
switch req := reqEntry.(type) {
|
|
case *api.ServiceConfigEntry:
|
|
if req.MutualTLSMode == api.MutualTLSModePermissive {
|
|
return WarningServiceDefaultsPermissiveMTLS
|
|
}
|
|
case *api.ProxyConfigEntry:
|
|
if req.MutualTLSMode == api.MutualTLSModePermissive {
|
|
return WarningProxyDefaultsPermissiveMTLS
|
|
}
|
|
case *api.MeshConfigEntry:
|
|
if req.AllowEnablingPermissiveMutualTLS == true {
|
|
return WarningMeshAllowEnablingPermissiveMutualTLS
|
|
}
|
|
}
|
|
return ""
|
|
}
|