common

Documentation

Index

• Constants
• func Ref(s kingpin.Settings) *services.Ref
• func Run()
• type AuthCommand
  • func (a *AuthCommand) ExportAuthorities(client *auth.TunClient) error
  • func (a *AuthCommand) GenerateAndSignKeys(client *auth.TunClient) error
  • func (a *AuthCommand) GenerateKeys() error
  • func (a *AuthCommand) ListAuthorities(client *auth.TunClient) error
• type AuthServerCommand
• type CLIConfig
• type CreateCommand
  • func (u *CreateCommand) Create(client *auth.TunClient) error
• type DeleteCommand
  • func (d *DeleteCommand) Delete(client *auth.TunClient) error
• type GetCommand
  • func (g *GetCommand) Get(client *auth.TunClient) error
• type NodeCommand
  • func (u *NodeCommand) Invite(client *auth.TunClient) error
  • func (u *NodeCommand) ListActive(client *auth.TunClient) error
• type ReverseTunnelCommand
  • func (r *ReverseTunnelCommand) Delete(client *auth.TunClient) error
  • func (r *ReverseTunnelCommand) ListActive(client *auth.TunClient) error
  • func (r *ReverseTunnelCommand) Upsert(client *auth.TunClient) error
• type SAMLCommand
  • func (s *SAMLCommand) ExportSAML(client *auth.TunClient) error
• type TokenCommand
  • func (c *TokenCommand) Del(client *auth.TunClient) error
  • func (c *TokenCommand) List(client *auth.TunClient) error
• type UserCommand
  • func (u *UserCommand) Add(client *auth.TunClient) error
  • func (u *UserCommand) Delete(client *auth.TunClient) error
  • func (u *UserCommand) List(client *auth.TunClient) error
  • func (u *UserCommand) Update(client *auth.TunClient) error

Constants

const (
	IdentityFormatFile    = "file"
	IdentityFormatDir     = "dir"
	DefaultIdentityFormat = IdentityFormatFile
)

const (
	GlobalHelpString = "CLI Admin tool for the Teleport Auth service. Runs on a host where Teleport Auth is running."
	AddUserHelp      = `` /* 633-byte string literal not displayed */

	AddNodeHelp = `` /* 501-byte string literal not displayed */

	ListNodesHelp = `Notes:
  SSH nodes send periodic heartbeat to the Auth service. This command prints
  the list of current online nodes.
`
)

Functions

func Ref

func Ref(s kingpin.Settings) *services.Ref

func Run

func Run()

Types

type AuthCommand

type AuthCommand struct {
	// contains filtered or unexported fields
}

func (*AuthCommand) ExportAuthorities

func (a *AuthCommand) ExportAuthorities(client *auth.TunClient) error

ExportAuthorities outputs the list of authorities in OpenSSH compatible formats If --type flag is given, only prints keys for CAs of this type, otherwise prints all keys

func (*AuthCommand) GenerateAndSignKeys

func (a *AuthCommand) GenerateAndSignKeys(client *auth.TunClient) error

GenerateAndSignKeys generates a new keypair and signs it for role

func (*AuthCommand) GenerateKeys

func (a *AuthCommand) GenerateKeys() error

GenerateKeys generates a new keypair

func (*AuthCommand) ListAuthorities

func (a *AuthCommand) ListAuthorities(client *auth.TunClient) error

ListAuthorities shows list of user authorities we trust

type AuthServerCommand

type AuthServerCommand struct {
	// contains filtered or unexported fields
}

type CLIConfig

type CLIConfig struct {
	Debug        bool
	ConfigFile   string
	ConfigString string
}

type CreateCommand

type CreateCommand struct {
	// contains filtered or unexported fields
}

func (*CreateCommand) Create

func (u *CreateCommand) Create(client *auth.TunClient) error

Create updates or insterts one or many resources

type DeleteCommand

type DeleteCommand struct {
	// contains filtered or unexported fields
}

func (*DeleteCommand) Delete

func (d *DeleteCommand) Delete(client *auth.TunClient) error

Delete deletes resource by name

type GetCommand

type GetCommand struct {
	// contains filtered or unexported fields
}

func (*GetCommand) Get

func (g *GetCommand) Get(client *auth.TunClient) error

Get prints one or many resources of a certain type

type NodeCommand

type NodeCommand struct {
	// contains filtered or unexported fields
}

func (*NodeCommand) Invite

func (u *NodeCommand) Invite(client *auth.TunClient) error

Invite generates a token which can be used to add another SSH node to a cluster

func (*NodeCommand) ListActive

func (u *NodeCommand) ListActive(client *auth.TunClient) error

ListActive retreives the list of nodes who recently sent heartbeats to to a cluster and prints it to stdout

type ReverseTunnelCommand

type ReverseTunnelCommand struct {
	// contains filtered or unexported fields
}

func (*ReverseTunnelCommand) Delete

func (r *ReverseTunnelCommand) Delete(client *auth.TunClient) error

Delete deletes teleport user(s). User IDs are passed as a comma-separated list in UserCommand.login

func (*ReverseTunnelCommand) ListActive

func (r *ReverseTunnelCommand) ListActive(client *auth.TunClient) error

ListActive retreives the list of nodes who recently sent heartbeats to to a cluster and prints it to stdout

func (*ReverseTunnelCommand) Upsert

func (r *ReverseTunnelCommand) Upsert(client *auth.TunClient) error

Upsert updates or inserts new reverse tunnel

type SAMLCommand

type SAMLCommand struct {
	// contains filtered or unexported fields
}

func (*SAMLCommand) ExportSAML

func (s *SAMLCommand) ExportSAML(client *auth.TunClient) error

ExportSAML outputs a certificate in CRT format to be used by an idP (identity provider) to validate an AuthnRequest.

type TokenCommand

type TokenCommand struct {
	// contains filtered or unexported fields
}

func (*TokenCommand) Del

func (c *TokenCommand) Del(client *auth.TunClient) error

onTokenList is called to execute "tokens del" command

func (*TokenCommand) List

func (c *TokenCommand) List(client *auth.TunClient) error

onTokenList is called to execute "tokens ls" command

type UserCommand

type UserCommand struct {
	// contains filtered or unexported fields
}

func (*UserCommand) Add

func (u *UserCommand) Add(client *auth.TunClient) error

Add creates a new sign-up token and prints a token URL to stdout. A user is not created until he visits the sign-up URL and completes the process

func (*UserCommand) Delete

func (u *UserCommand) Delete(client *auth.TunClient) error

Delete deletes teleport user(s). User IDs are passed as a comma-separated list in UserCommand.login

func (*UserCommand) List

func (u *UserCommand) List(client *auth.TunClient) error

List prints all existing user accounts

func (*UserCommand) Update

func (u *UserCommand) Update(client *auth.TunClient) error

Update updates existing user