ssh

Documentation

Overview

Provides ssh access to gears.

Provide SSH client commands and API that will enable SSH key distribution and revocation to individual servers. Key types are pluggable to allow other forms of access.

Index

• Constants
• func AddAuthorizedKeyGenerationType(handler AuthorizedKeysHandler)
• func AddKeyTypeHandler(id string, handler KeyTypeHandler)
• func AddPermissionHandler(id string, handler PermissionHandler)
• func GenerateAuthorizedKeysFor(user *user.User, forceCreate, printToStdOut bool) error
• func KeyFingerprint(key key.PublicKey) utils.Fingerprint
• func SshAccessBasePath(i containers.Identifier) string
• func SshAccessPathFor(i containers.Identifier, name string) string
• type AuthorizedKeysHandler
• type KeyLocator
• type KeyTypeHandler
  • func KeyTypeHandlerFor(id string) (KeyTypeHandler, bool)
• type PermissionHandler
  • func PermissionHandlerFor(id string) (PermissionHandler, bool)
• type SimpleKeyLocator
  • func (l *SimpleKeyLocator) NameForKey() string
  • func (l *SimpleKeyLocator) PathToKey() string

Constants

const ContainerPermissionType = "container"

Functions

func AddAuthorizedKeyGenerationType

func AddAuthorizedKeyGenerationType(handler AuthorizedKeysHandler)

Register a function to generate authorized keys for a system user.

func AddKeyTypeHandler

func AddKeyTypeHandler(id string, handler KeyTypeHandler)

Register a function to generate authorized keys for a system user.

func AddPermissionHandler

func AddPermissionHandler(id string, handler PermissionHandler)

Register a function to generate authorized keys for a system user.

func GenerateAuthorizedKeysFor

func GenerateAuthorizedKeysFor(user *user.User, forceCreate, printToStdOut bool) error

func KeyFingerprint

func KeyFingerprint(key key.PublicKey) utils.Fingerprint

func SshAccessBasePath

func SshAccessBasePath(i containers.Identifier) string

func SshAccessPathFor

func SshAccessPathFor(i containers.Identifier, name string) string

Types

type AuthorizedKeysHandler

type AuthorizedKeysHandler interface {
	MatchesUser(*user.User) bool
	GenerateAuthorizedKeysFile(u *user.User, forceCreate bool, printStdout bool) error
}

type KeyLocator

type KeyLocator interface {
	PathToKey() string
	NameForKey() string
}

type KeyTypeHandler

type KeyTypeHandler interface {
	CreateKey(key utils.RawMessage) (KeyLocator, error)
}

func KeyTypeHandlerFor

func KeyTypeHandlerFor(id string) (KeyTypeHandler, bool)

type PermissionHandler

type PermissionHandler interface {
	CreatePermission(locator KeyLocator, permission *utils.RawMessage) error
}

func PermissionHandlerFor

func PermissionHandlerFor(id string) (PermissionHandler, bool)

type SimpleKeyLocator

type SimpleKeyLocator struct {
	Path string
	Name string
}

func (*SimpleKeyLocator) NameForKey

func (l *SimpleKeyLocator) NameForKey() string

func (*SimpleKeyLocator) PathToKey

func (l *SimpleKeyLocator) PathToKey() string