auditor

Documentation

Index

• func All() []string
• func Register(name string, driver Provider)
• type Auditor
• type Hook
• type Provider
  • func Get(name string) Provider

Functions

func All

func All() []string

All return all registered auditors

func Register

func Register(name string, driver Provider)

Register adds an auditor with given name to registry

Types

type Auditor

type Auditor interface {

	// All msg between piper and upstream will be put into the hook
	// nil for ignore
	GetUpstreamHook() Hook

	// All msg between piper and downstream will be put into the hook
	// nil for ignore
	GetDownstreamHook() Hook

	// Will be called when connection closed
	Close() error
}

Auditor holds Hooks for upstream and downstream

type Hook

type Hook func(conn ssh.ConnMetadata, msg []byte) ([]byte, error)

Hook is called after ssh connection pipe is established and all msg will be put into the hook and msg will be converted to the return value of this func

type Provider

type Provider interface {
	registry.Plugin

	// Will be called when piped connection established
	// nil for no Auditor needed for this connection
	Create(ssh.ConnMetadata) (Auditor, error)
}

Provider is a factory for Auditor

func Get

func Get(name string) Provider

Get returns an auditor by name, return nil if not found