gateway

Documentation

Index

• func FetchTLSCertificate(domain string, cacheDir string) (string, string, error)
• func UserCacheDir() (string, error)
• type Gateway
  • func NewGateway(fs *catfs.FS, rapi remotesapi.RemotesAPI, cfg *config.Config, ...) (*Gateway, error)
  • func (gw *Gateway) Close() error
  • func (gw *Gateway) Start()
  • func (gw *Gateway) Stop() error
  • func (gw *Gateway) UserDatabase() *db.UserDatabase

Functions

func FetchTLSCertificate

func FetchTLSCertificate(domain string, cacheDir string) (string, string, error)

FetchTLSCertificate will use the ACME protocol and LetsEncrypt to download a certificate to the user's cache dir automatically. This either needs rights to bind :80 (i.e. sudo) or the right capabilities (i.e. sudo setcap CAP_NET_BIND_SERVICE=+ep ~/go/bin/brig)

func UserCacheDir

func UserCacheDir() (string, error)

UserCacheDir is the same as os.UserCacheDir from go1.11, but taken from the standard library. This way it also works for go1.9 and go1.10.

This method should be replaced by os.UserCacheDir by go1.13.

Types

type Gateway

type Gateway struct {
	// contains filtered or unexported fields
}

Gateway is a small HTTP server that is able to serve files from brig over HTTP. This can be used to share files inside of brig with users that do not use brig.

func NewGateway

func NewGateway(fs *catfs.FS, rapi remotesapi.RemotesAPI, cfg *config.Config, ev *events.Listener, dbPath string) (*Gateway, error)

NewGateway returns a newly built gateway. This function does not yet start a server.

func (*Gateway) Close

func (gw *Gateway) Close() error

Close the gateway and clean up all open resouces.

func (*Gateway) Start

func (gw *Gateway) Start()

Start will start the gateway. If the gateway is not enabled in the config, this does nothing. The gateway is started in the background, this method does not block.

func (*Gateway) Stop

func (gw *Gateway) Stop() error

Stop stops the gateway gracefully.

func (*Gateway) UserDatabase

func (gw *Gateway) UserDatabase() *db.UserDatabase

UserDatabase returns the user database API.