chserver

Documentation

Index

• type Config
• type Server
  • func NewServer(c *Config) (*Server, error)
  • func (s *Server) AddUser(user, pass string, addrs ...string) error
  • func (s *Server) Close() error
  • func (s *Server) DeleteUser(user string)
  • func (s *Server) GetFingerprint() string
  • func (s *Server) ResetUsers(users []*settings.User)
  • func (s *Server) Run(host, port string) error
  • func (s *Server) Start(host, port string) error
  • func (s *Server) StartContext(ctx context.Context, host, port string) error
  • func (s *Server) Wait() error
• type TLSConfig
• type UpdateUserRequest

Types

type Config

type Config struct {
	KeySeed   string
	KeyFile   string
	AuthFile  string
	Auth      string
	Proxy     string
	Reverse   bool
	KeepAlive time.Duration
	TLS       TLSConfig
	TlsConf   *tls.Config
}

Config is the configuration for the chisel service

type Server

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

Server respresent a chisel service

func NewServer

func NewServer(c *Config) (*Server, error)

NewServer creates and returns a new chisel server

func (*Server) AddUser

func (s *Server) AddUser(user, pass string, addrs ...string) error

AddUser adds a new user into the server user index

func (*Server) Close

func (s *Server) Close() error

Close forcibly closes the http server

func (*Server) DeleteUser

func (s *Server) DeleteUser(user string)

DeleteUser removes a user from the server user index

func (*Server) GetFingerprint

func (s *Server) GetFingerprint() string

GetFingerprint is used to access the server fingerprint

func (*Server) ResetUsers

func (s *Server) ResetUsers(users []*settings.User)

ResetUsers in the server user index. Use nil to remove all.

func (*Server) Run

func (s *Server) Run(host, port string) error

Run is responsible for starting the chisel service. Internally this calls Start then Wait.

func (*Server) Start

func (s *Server) Start(host, port string) error

Start is responsible for kicking off the http server

func (*Server) StartContext

func (s *Server) StartContext(ctx context.Context, host, port string) error

StartContext is responsible for kicking off the http server, and can be closed by cancelling the provided context

func (*Server) Wait

func (s *Server) Wait() error

Wait waits for the http server to close

type TLSConfig

type TLSConfig struct {
	Key     string
	Cert    string
	Domains []string
	CA      string
}

TLSConfig enables configures TLS

type UpdateUserRequest

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