config

Documentation

Index

• Constants
• Variables
• func HelpPrompt(options kong.HelpOptions, ctx *kong.Context) error
• type Options
  • func ConfigureOptions() (*Options, error)
  • func (opts *Options) Summarize()

Constants

const (
	UsageExamples = `` /* 486-byte string literal not displayed */

)

Variables

var Version = "?"

Functions

func HelpPrompt

func HelpPrompt(options kong.HelpOptions, ctx *kong.Context) error

Types

type Options

type Options struct {
	UUID          string `help:"UUID form of the qsocket secret." name:"uuid" hidden:""`
	Secret        string `help:"Secret (e.g. password)." name:"secret" short:"s"`
	Execute       string `help:"Execute command [e.g. \"bash -il\" or \"cmd.exe\"]" name:"exec" short:"e"`
	ForwardAddr   string `help:"IP:PORT for traffic forwarding." name:"forward" short:"f"`
	ProbeInterval int    `help:"Probe interval for connecting QSRN." name:"probe" short:"t" default:"5"`
	DisableTLS    bool   `help:"Disable TLS encryption." name:"no-tls" short:"C"`
	Interactive   bool   `help:"Execute with a PTY shell." name:"interactive" short:"i"`
	Listen        bool   `help:"Server mode. (listen for connections)" name:"listen" short:"l"`
	RandomSecret  bool   `help:"Generate a Secret. (random)" name:"generate" short:"g"`
	CertPinning   bool   `help:"Enable certificate pinning on TLS connections." name:"pin" short:"K"`
	Quiet         bool   `help:"Quiet mode. (no stdout)" name:"quiet" short:"q"`
	UseTor        bool   `help:"Use TOR for connecting QSRN." name:"tor" short:"T"`
	Verbose       bool   `help:"Verbose mode." name:"verbose" short:"v"`
	Version       kong.VersionFlag
}

Main config struct for parsing the TOML file

func ConfigureOptions

func ConfigureOptions() (*Options, error)

ConfigureOptions accepts a flag set and augments it with agentgo-server specific flags. On success, an options structure is returned configured based on the selected flags.

func (*Options) Summarize

func (opts *Options) Summarize()