controls

Documentation

Index

• func Read(dir string) (map[string]string, map[string]Control, error)
• type Control
  • func (c *Control) Validate() ControlError
• type ControlError
• type InvalidAuthKeyError
  • func (e *InvalidAuthKeyError) Error() string
  • func (e *InvalidAuthKeyError) GetType() string
• type InvalidCategoryError
  • func (e *InvalidCategoryError) Error() string
  • func (e *InvalidCategoryError) GetType() string
• type InvalidCommandError
  • func (e *InvalidCommandError) Error() string
  • func (e *InvalidCommandError) GetType() string
• type InvalidControlNameError
  • func (e *InvalidControlNameError) Error() string
  • func (e *InvalidControlNameError) GetType() string
• type NoAuthKeysError
  • func (e *NoAuthKeysError) Error() string
  • func (e *NoAuthKeysError) GetType() string

Functions

func Read

func Read(dir string) (map[string]string, map[string]Control, error)

Read imports all *.toml files from dir (including subdirectories) and returns authKeys and controls

Types

type Control

type Control struct {
	Category string
	ID       int
	Allowed  []string
	AuthKeys []string
}

Control holds the config for one Miniserver control

func (*Control) Validate

func (c *Control) Validate() ControlError

Validate returns an error if a control contains invalid data

type ControlError

type ControlError interface {
	Error() string
	GetType() string
}

ControlError implements GetType() wich is used in tests to test the validation.

type InvalidAuthKeyError

type InvalidAuthKeyError struct {
	Name string
}

InvalidAuthKeyError is an error type for invalid authKeys

func (*InvalidAuthKeyError) Error

func (e *InvalidAuthKeyError) Error() string

func (*InvalidAuthKeyError) GetType

func (e *InvalidAuthKeyError) GetType() string

GetType returns a string containing the error Type

type InvalidCategoryError

type InvalidCategoryError struct {
	Category string
}

InvalidCategoryError is an error type for invalid categories

func (*InvalidCategoryError) Error

func (e *InvalidCategoryError) Error() string

func (*InvalidCategoryError) GetType

func (e *InvalidCategoryError) GetType() string

GetType returns a string containing the error Type

type InvalidCommandError

type InvalidCommandError struct {
	Category string
	Command  string
}

InvalidCommandError is an error type for invalid commands

func (*InvalidCommandError) Error

func (e *InvalidCommandError) Error() string

func (*InvalidCommandError) GetType

func (e *InvalidCommandError) GetType() string

GetType returns a string containing the error Type

type InvalidControlNameError

type InvalidControlNameError struct {
	Name string
}

InvalidControlNameError is an error type for invalid commands

func (*InvalidControlNameError) Error

func (e *InvalidControlNameError) Error() string

func (*InvalidControlNameError) GetType

func (e *InvalidControlNameError) GetType() string

GetType returns a string containing the error Type

type NoAuthKeysError

type NoAuthKeysError struct {
	Name string
}

NoAuthKeysError is an error type for invalid authKeys

func (*NoAuthKeysError) Error

func (e *NoAuthKeysError) Error() string

func (*NoAuthKeysError) GetType

func (e *NoAuthKeysError) GetType() string

GetType returns a string containing the error Type