config

Documentation

Index

• Variables
• func GetPath() string
• func Wizard(configPath string, config *SSHrimp) (string, error)
• type Agent
• type CertificateAuthority
• type SSHrimp
  • func NewSSHrimp() *SSHrimp
  • func NewSSHrimpWithDefaults() *SSHrimp
  • func (c *SSHrimp) Read(configPath string) error
  • func (c *SSHrimp) Write(configPath string) error

Variables

var DefaultPath = ".ssh/sshrimp.toml"

DefaultPath of the sshrimp config file

var EnvVarName = "SSHRIMP_CONFIG"

EnvVarName is the optional environment variable that if set overrides DefaultPath

var SupportedAwsRegions = []string{
	"ap-east-1",
	"ap-northeast-1",
	"ap-northeast-2",
	"ap-south-1",
	"ap-southeast-1",
	"ap-southeast-2",
	"ca-central-1",
	"eu-central-1",
	"eu-north-1",
	"eu-west-1",
	"eu-west-2",
	"eu-west-3",
	"me-south-1",
	"sa-east-1",
	"us-east-1",
	"us-east-2",
	"us-west-1",
	"us-west-2",
}

List of supported regions for the config wizard

var SupportedGcpRegions = []string{
	"europe-west1",
	"europe-west2",
	"europe-west3",
	"us-central1",
	"us-east1",
	"us-east4",
	"asia-northeast1",
	"asia-east2",
}

Functions

func GetPath

func GetPath() string

GetPath returns the default sshrimp config file path taking into account EnvVarName

func Wizard

func Wizard(configPath string, config *SSHrimp) (string, error)

Wizard launches a interactive question/answer terminal prompt to create a config file

Types

type Agent

type Agent struct {
	ProviderURL    string
	ClientID       string
	ClientSecret   string
	BrowserCommand []string
	Socket         string
	Scopes         []string
	KeyPath        string
	Port           int
	Url            string
}

Agent config for the sshrimp-agent agent

type CertificateAuthority

type CertificateAuthority struct {
	Project            string
	AccountID          int
	Regions            []string
	FunctionName       string
	KeyAlias           string
	ForceCommandRegex  string
	SourceAddressRegex string
	UsernameRegexs     []string
	UsernameClaims     []string
	ValidAfterOffset   string
	ValidBeforeOffset  string
	Extensions         []string
}

CertificateAuthority config for the sshrimp-ca lambda

type SSHrimp

type SSHrimp struct {
	Agent                Agent
	CertificateAuthority CertificateAuthority
}

SSHrimp main configuration struct for sshrimp-agent and sshrimp-ca

func NewSSHrimp

func NewSSHrimp() *SSHrimp

NewSSHrimp returns SSHrimp

func NewSSHrimpWithDefaults

func NewSSHrimpWithDefaults() *SSHrimp

NewSSHrimpWithDefaults returns SSHrimp with defaults already set

func (*SSHrimp) Read

func (c *SSHrimp) Read(configPath string) error

func (*SSHrimp) Write

func (c *SSHrimp) Write(configPath string) error