access

package

v0.7.0 Latest Latest Go to latest Published: Nov 6, 2023 License: AGPL-3.0 Imports: 18 Imported by: 0

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/practable/relay

Links

Open Source Insights

Documentation ¶

Index ¶

func API(closed <-chan struct{}, wg *sync.WaitGroup, config Config)
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func API ¶

func API(closed <-chan struct{}, wg *sync.WaitGroup, config Config)

API starts the API Inputs @closed - channel will be closed when server shutsdown @wg - waitgroup, we must wg.Done() when we are shutdown @port - where to listen locally @host - external FQDN of the host (for checking against tokens) e.g. https://relay-access.practable.io @target - FQDN of the relay instance e.g. wss://relay.practable.io @secret- HMAC shared secret which incoming tokens will be signed with @cs - pointer to the CodeStore this API shares with the crossbar websocket relay @ds - pointer to the Deny list allowNoBookingID - whether to accept tokens without bookingID (set to yes to be backwards compatible) @options - for future backwards compatibility (no options currently available)

Types ¶

type Config ¶ added in v0.3.0

type Config struct {
	AllowNoBookingID bool
	CodeStore        *ttlcode.CodeStore
	DenyChannel      chan string
	DenyStore        *deny.Store
	Host             string
	Hub              *crossbar.Hub
	Port             int
	Secret           string
	Target           string
}

Config specifies parameters for the access service

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
models
restapi Package restapi RelayAccess	Package restapi RelayAccess
operations

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