mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-25 10:40:02 +08:00
Tim BuckleyandNoah Stride
83f10035ff
* Machine ID: Refactor `tbot` CLI This significantly refactors the tbot CLI. In addition to a major overhaul of our CLI config handling, it also exposes a number of new subcommands for starting more than just an identity output via pure CLI. * Move new CLI handling into lib/tbot/cli; add all new subcommands This moves the new CLI handling code into `lib/tbot/cli`, splits `cli.go` into several better organized files, and adds all missing subcommands for major tbot functionality. * Add sane global handling, convert most other commands to new style This introduces a dedicated global args struct and removes CLIConf. As most other non-start (and configure) commands depended on that effectively global namespace, this refactors all of them to use the new style with properly namespaced command structs. This also introduces a `genericExecutorHandler` helper to simplify subcommands that run an arbitrary action without modifying the config. This also solves a number of longstanding CLI handling bugs resulting from the shared arg namespace. A few args were moved to globals that should always have been exposed, so now things like `--log-format` will work consistently. A few commands were left unconverted since they don't make use of any of the global args or config loading machinery. They could be converted easily but are technically simpler as written. We may opt to convert them, or to do so later. Some headway on testing, but more work is needed. * First batch of tests This adds the first batch of tests on the new CLI along with a bunch of associated changes made while fixing these tests and others. This also splits off 2 new flag helpers: LegacyDestinationDirArgs and AuthProxyArgs. These are reusable embeddable structs to handle legacy-style --destination-dir behavior, and modern --auth-server and --proxy-server. `tbot init` and its tests had a subtle dependency old-style `--destination-dir` handling so we can now reuse that. There may be other subcommands that require something similar. * Remove outdated TODO * Restore TestConfigCLIOnlySample * Fix lints * Fix missing embedded flag init * Code review feedback * Add docstrings * Add unit tests for all "start" commands and globals Also includes a few minor fixes discovered in testing - DiagAddr was not handled properly in shared args, and removed an unused field. * Fix imports * Add helper for repetitive test * Fix command name * Adjust behaviour of `tbot kube credentials` command * Add tests for remaining commands * Appease linter * Add godocs --------- Co-authored-by: Noah Stride <noah.stride@goteleport.com>
82 lines
3.3 KiB
Go
82 lines
3.3 KiB
Go
/*
|
|
* Teleport
|
|
* Copyright (C) 2024 Gravitational, Inc.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package cli
|
|
|
|
// SSHProxyCommand includes fields for `tbot ssh-proxy-command`
|
|
type SSHProxyCommand struct {
|
|
*genericExecutorHandler[SSHProxyCommand]
|
|
|
|
// DestinationDir stores the generated end-user certificates.
|
|
DestinationDir string
|
|
|
|
// Cluster is the name of the Teleport cluster on which resources should
|
|
// be accessed.
|
|
Cluster string
|
|
|
|
// ProxyServer is the teleport proxy address. Unlike `AuthServer` this must
|
|
// explicitly point to a Teleport proxy.
|
|
// Example: "example.teleport.sh:443"
|
|
ProxyServer string
|
|
|
|
// User is the os login to use for ssh connections.
|
|
User string
|
|
|
|
// Host is the target ssh machine to connect to.
|
|
Host string
|
|
|
|
// Post is the post of the ssh machine to connect on.
|
|
Port string
|
|
|
|
// EnableResumption turns on automatic session resumption to prevent connections from
|
|
// being dropped if Proxy connectivity is lost.
|
|
EnableResumption bool
|
|
|
|
// TLSRoutingEnabled indicates whether the cluster has TLS routing enabled.
|
|
TLSRoutingEnabled bool
|
|
|
|
// ConnectionUpgradeRequired indicates that an ALPN connection upgrade is required
|
|
// for connections to the cluster.
|
|
ConnectionUpgradeRequired bool
|
|
|
|
// TSHConfigPath is the path to a tsh config file.
|
|
TSHConfigPath string
|
|
}
|
|
|
|
// NewSSHProxyCommand initializes the `tbot ssh-proxy-command` subcommand and
|
|
// its fields.
|
|
func NewSSHProxyCommand(app KingpinClause, action func(*SSHProxyCommand) error) *SSHProxyCommand {
|
|
cmd := app.Command("ssh-proxy-command", "An OpenSSH/PuTTY proxy command").Hidden()
|
|
|
|
c := &SSHProxyCommand{}
|
|
c.genericExecutorHandler = newGenericExecutorHandler(cmd, c, action)
|
|
|
|
cmd.Flag("destination-dir", "The destination directory with which to authenticate tsh").StringVar(&c.DestinationDir)
|
|
cmd.Flag("cluster", "The cluster name. Extracted from the certificate if unset.").StringVar(&c.Cluster)
|
|
cmd.Flag("user", "The remote user name for the connection").Required().StringVar(&c.User)
|
|
cmd.Flag("host", "The remote host to connect to").Required().StringVar(&c.Host)
|
|
cmd.Flag("port", "The remote port to connect on.").StringVar(&c.Port)
|
|
cmd.Flag("proxy-server", "The Teleport proxy server to use, in host:port form.").Required().StringVar(&c.ProxyServer)
|
|
cmd.Flag("tls-routing", "Whether the Teleport cluster has tls routing enabled.").Required().BoolVar(&c.TLSRoutingEnabled)
|
|
cmd.Flag("connection-upgrade", "Whether the Teleport cluster requires an ALPN connection upgrade.").Required().BoolVar(&c.ConnectionUpgradeRequired)
|
|
cmd.Flag("proxy-templates", "The path to a file containing proxy templates to be evaluated.").StringVar(&c.TSHConfigPath)
|
|
cmd.Flag("resume", "Enable SSH connection resumption").BoolVar(&c.EnableResumption)
|
|
|
|
return c
|
|
}
|