settings

Documentation

Index

• Variables
• func EncodeConfig(c Config) []byte
• func Env(name string) string
• func EnvBool(name string) bool
• func EnvDuration(name string, def time.Duration) time.Duration
• func EnvInt(name string, def int) int
• func L4Proto(s string) (head, proto string)
• func ParseAuth(auth string) (string, string)
• type Config
  • func DecodeConfig(b []byte) (*Config, error)
• type Remote
  • func DecodeRemote(s string) (*Remote, error)
  • func (r Remote) CanListen() bool
  • func (r Remote) Encode() string
  • func (r Remote) Local() string
  • func (r Remote) Remote() string
  • func (r Remote) String() string
  • func (r Remote) UserAddr() string
• type Remotes
  • func (rs Remotes) Encode() []string
  • func (rs Remotes) Reversed(reverse bool) Remotes
• type User
  • func (u *User) HasAccess(addr string) bool
  • func (u *User) ToJSON() (string, error)
  • func (u *User) ValidateUser() error
• type UserIndex
  • func NewUserIndex(logger *cio.Logger) *UserIndex
  • func (u *UserIndex) LoadUsers(configFile string) error
  • func (u *UserIndex) ToJSON() (string, error)
  • func (u *UserIndex) WriteUsers() error
• type Users
  • func NewUsers() *Users
  • func (u *Users) AddUser(user *User)
  • func (u *Users) Del(key string)
  • func (u *Users) Get(key string) (*User, bool)
  • func (u *Users) Len() int
  • func (u *Users) Reset(users []*User)
  • func (u *Users) Set(key string, user *User)

Variables

var UserAllowAll = regexp.MustCompile(".*")

Functions

func EncodeConfig

func EncodeConfig(c Config) []byte

func Env

func Env(name string) string

Env returns a chisel environment variable

func EnvBool

func EnvBool(name string) bool

EnvBool returns a boolean using an environment variable

func EnvDuration

func EnvDuration(name string, def time.Duration) time.Duration

EnvDuration returns a duration using an environment variable, with a default fallback

func EnvInt

func EnvInt(name string, def int) int

EnvInt returns an integer using an environment variable, with a default fallback

func L4Proto

func L4Proto(s string) (head, proto string)

L4Proto extacts the layer-4 protocol from the given string

func ParseAuth

func ParseAuth(auth string) (string, string)

Types

type Config

type Config struct {
	Version string
	Remotes
}

func DecodeConfig

func DecodeConfig(b []byte) (*Config, error)

type Remote

type Remote struct {
	UserAddress            string
	LocalHost, LocalPort   string
	RemoteHost, RemotePort string
	Reverse                bool
}

func DecodeRemote

func DecodeRemote(s string) (*Remote, error)

func (Remote) CanListen

func (r Remote) CanListen() bool

CanListen checks if the port can be listened on

func (Remote) Encode

func (r Remote) Encode() string

Encode remote to a string

func (Remote) Local

func (r Remote) Local() string

Local is the decodable local portion

func (Remote) Remote

func (r Remote) Remote() string

Remote is the decodable remote portion

func (Remote) String

func (r Remote) String() string

implement Stringer

func (Remote) UserAddr

func (r Remote) UserAddr() string

UserAddr is checked when checking if a user has access to a given remote

type Remotes

type Remotes []*Remote

func (Remotes) Encode

func (rs Remotes) Encode() []string

Encode back into strings

func (Remotes) Reversed

func (rs Remotes) Reversed(reverse bool) Remotes

TODO: Legacy to be removed

type User

type User struct {
	Name    string           `json:"username"`
	Pass    string           `json:"password"`
	Addrs   []*regexp.Regexp `json:"addresses"`
	IsAdmin bool             `json:"is_admin"`
}

func (*User) HasAccess

func (u *User) HasAccess(addr string) bool

func (*User) ToJSON

func (u *User) ToJSON() (string, error)

func (*User) ValidateUser

func (u *User) ValidateUser() error

ValidateUser validates the fields of the User struct

type UserIndex

type UserIndex struct {
	*cio.Logger
	*Users
	// contains filtered or unexported fields
}

UserIndex is a reloadable user source

func NewUserIndex

func NewUserIndex(logger *cio.Logger) *UserIndex

NewUserIndex creates a source for users

func (*UserIndex) LoadUsers

func (u *UserIndex) LoadUsers(configFile string) error

LoadUsers is responsible for loading users from a file

func (*UserIndex) ToJSON

func (u *UserIndex) ToJSON() (string, error)

func (*UserIndex) WriteUsers

func (u *UserIndex) WriteUsers() error

WriteUsers writes the current users to the configuration file

type Users

type Users struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewUsers

func NewUsers() *Users

func (*Users) AddUser

func (u *Users) AddUser(user *User)

AddUser adds a users to the set

func (*Users) Del

func (u *Users) Del(key string)

Del deletes a users from the list

func (*Users) Get

func (u *Users) Get(key string) (*User, bool)

Get user from the index by key

func (*Users) Len

func (u *Users) Len() int

Len returns the numbers of users

func (*Users) Reset

func (u *Users) Reset(users []*User)

Reset all users to the given set, Use nil to remove all.

func (*Users) Set

func (u *Users) Set(key string, user *User)

Set a users into the list by specific key