You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boundary/internal/cmd/commands/targetscmd/ssh_funcs.go

347 lines
11 KiB

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package targetscmd
import (
"fmt"
"strconv"
"time"
"github.com/hashicorp/boundary/api/targets"
"github.com/hashicorp/boundary/internal/cmd/base"
"github.com/hashicorp/go-bexpr"
)
func init() {
extraSshActionsFlagsMapFunc = extraSshActionsFlagsMapFuncImpl
extraSshFlagsFunc = extraSshFlagsFuncImpl
extraSshFlagsHandlingFunc = extraSshFlagsHandlingFuncImpl
extraSshSynopsisFunc = extraSshSynopsisFuncImpl
}
func extraSshActionsFlagsMapFuncImpl() map[string][]string {
return map[string][]string{
"create": {
"address", "default-port", "default-client-port", "session-max-seconds", "session-connection-limit",
"egress-worker-filter", "ingress-worker-filter", "enable-session-recording",
"storage-bucket-id", "with-alias-value", "with-alias-scope-id", "with-alias-authorize-session-host-id",
},
"update": {
"address", "default-port", "default-client-port", "session-max-seconds", "session-connection-limit",
"worker-filter", "egress-worker-filter", "ingress-worker-filter", "enable-session-recording",
"storage-bucket-id",
},
}
}
type extraSshCmdVars struct {
flagDefaultPort string
flagDefaultClientPort string
flagSessionMaxSeconds string
flagSessionConnectionLimit string
flagWorkerFilter string
flagEgressWorkerFilter string
flagIngressWorkerFilter string
flagAddress string
flagStorageBucketId string
flagEnableSessionRecording string
flagWithAliasValue string
flagWithAliasScopeId string
flagWithAliasHostId string
}
func (c *SshCommand) extraSshHelpFunc(helpMap map[string]func() string) string {
var helpStr string
switch c.Func {
case "create":
helpStr = base.WrapForHelpText([]string{
"Usage: boundary targets create ssh [options] [args]",
"",
" Create a ssh-type target. Example:",
"",
` $ boundary targets create ssh -name prodops -description "Ssh target for ProdOps"`,
"",
"",
})
case "update":
helpStr = base.WrapForHelpText([]string{
"Usage: boundary targets update ssh [options] [args]",
"",
" Update a ssh-type target given its ID. Example:",
"",
` $ boundary targets update ssh -id tssh_1234567890 -name "devops" -description "Ssh target for DevOps"`,
"",
"",
})
}
return helpStr + c.Flags().Help()
}
func extraSshFlagsFuncImpl(c *SshCommand, set *base.FlagSets, f *base.FlagSet) {
fs := set.NewFlagSet("SSH Target Options")
for _, name := range flagsSshMap[c.Func] {
switch name {
case "address":
fs.StringVar(&base.StringVar{
Name: "address",
Target: &c.flagAddress,
Usage: "Optionally, a valid network address to connect to for this target. Can not be used alongside host sources.",
})
case "default-port":
fs.StringVar(&base.StringVar{
Name: "default-port",
Target: &c.flagDefaultPort,
Usage: "Optionally, the default port to set on the target. If not specified, it will be set to 22.",
})
case "default-client-port":
fs.StringVar(&base.StringVar{
Name: "default-client-port",
Target: &c.flagDefaultClientPort,
Usage: "The default client port to set on the target.",
})
case "session-max-seconds":
fs.StringVar(&base.StringVar{
Name: "session-max-seconds",
Target: &c.flagSessionMaxSeconds,
Usage: `The maximum lifetime of the session, including all connections. Can be specified as an integer number of seconds or a duration string.`,
})
case "session-connection-limit":
fs.StringVar(&base.StringVar{
Name: "session-connection-limit",
Target: &c.flagSessionConnectionLimit,
Usage: "The maximum number of connections allowed for a session. -1 means unlimited.",
})
case "worker-filter":
fs.StringVar(&base.StringVar{
Name: "worker-filter",
Target: &c.flagWorkerFilter,
Usage: "Deprecated: use egress or ingress filters instead.",
})
case "egress-worker-filter":
fs.StringVar(&base.StringVar{
Name: "egress-worker-filter",
Target: &c.flagEgressWorkerFilter,
Usage: "A boolean expression to filter which egress workers can handle sessions for this target.",
})
case "ingress-worker-filter":
fs.StringVar(&base.StringVar{
Name: "ingress-worker-filter",
Target: &c.flagIngressWorkerFilter,
Usage: "A boolean expression to filter which ingress workers can handle sessions for this target.",
})
case "storage-bucket-id":
fs.StringVar(&base.StringVar{
Name: "storage-bucket-id",
Target: &c.flagStorageBucketId,
Usage: "The public ID of the storage bucket to associate with this target.",
})
case "enable-session-recording":
fs.StringVar(&base.StringVar{
Name: "enable-session-recording",
Target: &c.flagEnableSessionRecording,
Usage: "A boolean indicating if session recording is enabled for this target.",
})
case "with-alias-value":
fs.StringVar(&base.StringVar{
Name: "with-alias-value",
Target: &c.flagWithAliasValue,
Usage: "The value for an alias to be created for and at the same time as this target.",
})
case "with-alias-scope-id":
fs.StringVar(&base.StringVar{
Name: "with-alias-scope-id",
Target: &c.flagWithAliasScopeId,
Default: "global",
Usage: "The scope id for an alias to be created for and at the same time as this target.",
})
case "with-alias-authorize-session-host-id":
fs.StringVar(&base.StringVar{
Name: "with-alias-authorize-session-host-id",
Target: &c.flagWithAliasHostId,
Usage: "The authorize session host id flag used by an alias to be created for and at the same time as this target.",
})
}
}
}
func extraSshFlagsHandlingFuncImpl(c *SshCommand, _ *base.FlagSets, opts *[]targets.Option) bool {
switch c.flagDefaultPort {
case "":
case "null":
*opts = append(*opts, targets.DefaultSshTargetDefaultPort())
default:
port, err := strconv.ParseUint(c.flagDefaultPort, 10, 32)
if err != nil {
c.UI.Error(fmt.Sprintf("Error parsing %q: %s", c.flagDefaultPort, err))
return false
}
*opts = append(*opts, targets.WithSshTargetDefaultPort(uint32(port)))
}
switch c.flagDefaultClientPort {
case "":
case "null":
*opts = append(*opts, targets.DefaultSshTargetDefaultClientPort())
default:
port, err := strconv.ParseUint(c.flagDefaultClientPort, 10, 32)
if err != nil {
c.UI.Error(fmt.Sprintf("Error parsing %q: %s", c.flagDefaultClientPort, err))
return false
}
*opts = append(*opts, targets.WithSshTargetDefaultClientPort(uint32(port)))
}
switch c.flagSessionMaxSeconds {
case "":
case "null":
*opts = append(*opts, targets.DefaultSessionMaxSeconds())
default:
var final uint32
dur, err := strconv.ParseUint(c.flagSessionMaxSeconds, 10, 32)
if err == nil {
final = uint32(dur)
} else {
dur, err := time.ParseDuration(c.flagSessionMaxSeconds)
if err != nil {
c.UI.Error(fmt.Sprintf("Error parsing %q: %s", c.flagSessionMaxSeconds, err))
return false
}
final = uint32(dur.Seconds())
}
*opts = append(*opts, targets.WithSessionMaxSeconds(final))
}
switch c.flagSessionConnectionLimit {
case "":
case "null":
*opts = append(*opts, targets.DefaultSessionConnectionLimit())
default:
limit, err := strconv.ParseInt(c.flagSessionConnectionLimit, 10, 32)
if err != nil {
c.UI.Error(fmt.Sprintf("Error parsing %q: %s", c.flagSessionConnectionLimit, err))
return false
}
*opts = append(*opts, targets.WithSessionConnectionLimit(int32(limit)))
}
switch c.flagWorkerFilter {
case "":
case "null":
*opts = append(*opts, targets.DefaultWorkerFilter())
default:
if _, err := bexpr.CreateEvaluator(c.flagWorkerFilter); err != nil {
c.UI.Error(fmt.Sprintf("Unable to successfully parse worker filter expression: %s", err))
return false
}
*opts = append(*opts, targets.WithWorkerFilter(c.flagWorkerFilter))
}
switch c.flagEgressWorkerFilter {
case "":
case "null":
*opts = append(*opts, targets.DefaultEgressWorkerFilter())
default:
if _, err := bexpr.CreateEvaluator(c.flagEgressWorkerFilter); err != nil {
c.UI.Error(fmt.Sprintf("Unable to successfully parse egress filter expression: %s", err))
return false
}
*opts = append(*opts, targets.WithEgressWorkerFilter(c.flagEgressWorkerFilter))
}
switch c.flagIngressWorkerFilter {
case "":
case "null":
*opts = append(*opts, targets.DefaultIngressWorkerFilter())
default:
if _, err := bexpr.CreateEvaluator(c.flagIngressWorkerFilter); err != nil {
c.UI.Error(fmt.Sprintf("Unable to successfully parse ingress filter expression: %s", err))
return false
}
*opts = append(*opts, targets.WithIngressWorkerFilter(c.flagIngressWorkerFilter))
}
switch c.flagAddress {
case "":
case "null":
*opts = append(*opts, targets.DefaultAddress())
default:
*opts = append(*opts, targets.WithAddress(c.flagAddress))
}
switch c.flagStorageBucketId {
case "":
case "null":
*opts = append(*opts, targets.DefaultSshTargetStorageBucketId())
default:
*opts = append(*opts, targets.WithSshTargetStorageBucketId(c.flagStorageBucketId))
}
switch c.flagEnableSessionRecording {
case "":
case "false":
*opts = append(*opts, targets.WithSshTargetEnableSessionRecording(false))
case "true":
*opts = append(*opts, targets.WithSshTargetEnableSessionRecording(true))
default:
c.UI.Error(fmt.Sprintf("Invalid bool value for enable-session-recording %v", c.flagEnableSessionRecording))
return false
}
var aliasValue string
switch c.flagWithAliasValue {
case "":
case "null":
c.UI.Error("The with-alias-value flag cannot be set to null")
return false
default:
aliasValue = c.flagWithAliasValue
}
var aliasScopeId string
switch c.flagWithAliasScopeId {
case "":
case "null":
c.UI.Error("The with-alias-scope-id flag cannot be set to null")
return false
default:
aliasScopeId = c.flagWithAliasScopeId
}
var aliasHostId string
switch c.flagWithAliasHostId {
case "":
case "null":
c.UI.Error("The with-alias-authorize-session-host-id flag cannot be set to null")
return false
default:
aliasHostId = c.flagWithAliasHostId
}
switch {
case aliasValue != "" && aliasScopeId == "":
c.UI.Error("The with-alias-value flag must be used with the with-alias-scope-id flag")
return false
case aliasValue != "" && aliasScopeId != "":
a := targets.Alias{
Value: aliasValue,
ScopeId: aliasScopeId,
}
if aliasHostId != "" {
a.Attributes = &targets.TargetAliasAttributes{
AuthorizeSessionArguments: &targets.AuthorizeSessionArguments{
HostId: aliasHostId,
},
}
}
*opts = append(*opts, targets.WithAliases([]targets.Alias{a}))
}
return true
}
func extraSshSynopsisFuncImpl(_ *SshCommand) string {
return "Create a ssh-type target (HCP only)"
}