chserver

package

v1.9.1 Latest Latest Go to latest Published: Aug 20, 2023 License: MIT Imports: 28 Imported by: 17

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jpillora/chisel

Links

Open Source Insights

Documentation ¶

Index ¶

type Config
type Server
- func NewServer(c *Config) (*Server, error)
type TLSConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

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

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 ¶ added in v1.7.0

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 ¶ added in v1.7.0

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 ¶ added in v1.7.0

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

TLSConfig enables configures TLS

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL