cli_plugin

Documentation

Index

• Constants
• Variables
• type CommandRunner
  • func (r *CommandRunner) Allow() (string, error)
  • func (r *CommandRunner) List() (string, error)
  • func (r *CommandRunner) Remove() (string, error)
• type Plugin
  • func (p *Plugin) GetMetadata() plugin.PluginMetadata
  • func (p *Plugin) Run(cliConnection plugin.CliConnection, args []string)
  • func (p *Plugin) RunWithErrors(cliConnection plugin.CliConnection, args []string) (string, error)
• type ValidArgs
  • func ValidateArgs(cliConnection plugin.CliConnection, args []string) (ValidArgs, error)

Constants

const AllowCommand = "allow-access"

const ListCommand = "list-access"

const MaxPort = 65535

const MinPort = 1

const PrivateDataPlaceholder = "[PRIVATE DATA HIDDEN]"

const RemoveCommand = "remove-access"

Variables

var AllowUsageRegex = fmt.Sprintf(`\A%s\s+\S+\s+\S+\s+(--|-)\w+(\s+|=)\w+\s+(--|-)\w+(\s+|=)\w+\z`, AllowCommand)

var ListUsageRegex = fmt.Sprintf(`\A%s\s*(--app(\s+|=)\S+\z|\z)`, ListCommand)

var RemoveUsageRegex = fmt.Sprintf(`\A%s\s+\S+\s+\S+\s+(--|-)\w+(\s+|=)\w+\s+(--|-)\w+(\s+|=)\w+\z`, RemoveCommand)

Types

type CommandRunner

type CommandRunner struct {
	Styler        *styles.StyleGroup
	Logger        *log.Logger
	PolicyClient  policy_client.ExternalPolicyClient
	CliConnection plugin.CliConnection
	Args          []string
}

func (*CommandRunner) Allow

func (r *CommandRunner) Allow() (string, error)

func (*CommandRunner) List

func (r *CommandRunner) List() (string, error)

func (*CommandRunner) Remove

func (r *CommandRunner) Remove() (string, error)

type Plugin

type Plugin struct {
	Styler       *styles.StyleGroup
	Version      versionGetter
	Logger       *log.Logger
	PolicyClient policy_client.ExternalPolicyClient
}

func (*Plugin) GetMetadata

func (p *Plugin) GetMetadata() plugin.PluginMetadata

func (*Plugin) Run

func (p *Plugin) Run(cliConnection plugin.CliConnection, args []string)

func (*Plugin) RunWithErrors

func (p *Plugin) RunWithErrors(cliConnection plugin.CliConnection, args []string) (string, error)

type ValidArgs

type ValidArgs struct {
	SourceAppName string
	DestAppName   string
	Protocol      string
	Port          int
}

func ValidateArgs

func ValidateArgs(cliConnection plugin.CliConnection, args []string) (ValidArgs, error)