hub

package
v0.3.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 23, 2021 License: AGPL-3.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MsgTypeAnnouncement = "announcement"
	MsgTypeStatus       = "status"
)

Variables

View Source 
var (
	// ErrMissingInfo signifies that the hub is missing the HubAnnouncement.
	ErrMissingInfo = errors.New("hub is missing Announcement")

	// ErrMissingTransports signifies that the hub announcement did not specify any transports.
	ErrMissingTransports = errors.New("hub announcement is missing transports")

	// ErrMissingIPs signifies that the hub announcement did not specify any IPs.
	ErrMissingIPs = errors.New("hub announcement is missing IPs")

	// ErrTemporaryValidationError is returned when a validation error might be temporary.
	ErrTemporaryValidationError = errors.New("temporary validation error")
)
View Source 
var BaselineCharset = regexp.MustCompile(

	`^[` +

		` !#()*+,\-\./0-9:=?@A-Z[\]^_a-z{|}~` +

		`ŠŒŽšœžŸ¡¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ` +

		`]*$`,
)

Functions

func CreateHubSignet 

func CreateHubSignet(toolID string, securityLevel int) (private, public *jess.Signet, err error)

CreateHubSignet creates a signet with the correct ID for usage as a Hub Identity.

func LanesEqual added in v0.3.0 

func LanesEqual(a, b []*Lane) bool

LanesEqual returns whether the given []*Lane are equal.

func MakeHubDBKey added in v0.3.0 

func MakeHubDBKey(mapName, hubID string) string

func MakeHubMsgDBKey added in v0.3.0 

func MakeHubMsgDBKey(mapName string, msgType MsgType, hubID string) string

func QueryRawGossipMsgs added in v0.3.0 

func QueryRawGossipMsgs(mapName string, msgType MsgType) (it *iterator.Iterator, err error)

func RemoveHub 

func RemoveHub(mapName string, hubID string) error

RemoveHub deletes a Hub from the database.

func SaveHubMsg added in v0.3.0 

func SaveHubMsg(id string, mapName string, msgType MsgType, data []byte) error

SaveHubMsg saves a raw (and signed) message received by another Hub.

func SetNavigatorAccess 

func SetNavigatorAccess(fn func(mapName, hubID string) *Hub)

SetNavigatorAccess sets a shortcut function to access hubs from the navigator instead of having go through the database. This also reduces the number of object in RAM and better caches parsed attributes.

func SignHubMsg 

func SignHubMsg(msg []byte, env *jess.Envelope, enableTofu bool) ([]byte, error)

SignHubMsg signs the given serialized hub msg with the given configuration.

func SortLanes added in v0.3.0 

func SortLanes(l []*Lane)

SortLanes sorts a slice of Lanes.

Types

type Announcement added in v0.3.0 

type Announcement struct {

	// Primary Key
	// hash of public key
	// must be checked if it matches the public key
	ID string // via jess.LabeledHash

	// PublicKey *jess.Signet
	// PublicKey // if not part of signature
	// Signature *jess.Letter
	Timestamp int64 // Unix timestamp in seconds

	// Node Information
	Name           string // name of the node
	Group          string // person or organisation, who is in control of the node (should be same for all nodes of this person or organisation)
	ContactAddress string // contact possibility  (recommended, but optional)
	ContactService string // type of service of the contact address, if not email

	// currently unused, but collected for later use
	Hosters    []string // hoster supply chain (reseller, hosting provider, datacenter operator, ...)
	Datacenter string   // datacenter will be bullshit checked

	// Network Location and Access
	// If node is behind NAT (or similar), IP addresses must be configured
	IPv4       net.IP // must be global and accessible
	IPv6       net.IP // must be global and accessible
	Transports []string

	// Policies - default permit
	Entry []string
	// {"+ ", "- *"}
	Exit []string
}

Announcement is the main message type to publish Hub Information. This only changes if updated manually.

func (*Announcement) Copy added in v0.3.0 

func (a *Announcement) Copy() (*Announcement, error)

Copy returns a deep copy of the Announcement.

func (*Announcement) Equal added in v0.3.0 

func (a *Announcement) Equal(b *Announcement) bool

Equal returns whether the given Announcements are equal.

func (*Announcement) Export added in v0.3.0 

func (ha *Announcement) Export(env *jess.Envelope) ([]byte, error)

Export exports the announcement with the given signature configuration.

type Hub 

type Hub struct {
	sync.Mutex
	record.Base

	ID        string
	PublicKey *jess.Signet
	Map       string

	Info   *Announcement
	Status *Status

	FirstSeen     time.Time
	VerifiedIPs   bool
	InvalidInfo   bool
	InvalidStatus bool
}

Hub represents a network node in the SPN.

func ApplyAnnouncement added in v0.3.0 

func ApplyAnnouncement(hub *Hub, data []byte, mapName string, scope Scope, selfcheck bool) (_ *Hub, forward bool, err error)

ApplyAnnouncement applies the announcement to the Hub if it passes all the checks. If no Hub is provided, it is loaded from the database or created.

func ApplyStatus added in v0.3.0 

func ApplyStatus(hub *Hub, data []byte, mapName string, scope Scope, selfcheck bool) (_ *Hub, forward bool, err error)

ApplyStatus applies a status update if it passes all the checks.

func EnsureHub 

func EnsureHub(r record.Record) (*Hub, error)

EnsureHub makes sure a database record is a Hub.

func GetHub 

func GetHub(mapName string, hubID string) (*Hub, error)

GetHub get a Hub from the database - or the navigator, if configured.

func GetHubByKey added in v0.3.0 

func GetHubByKey(key string) (*Hub, error)

func OpenHubMsg 

func OpenHubMsg(hub *Hub, data []byte, mapName string, tofu bool) (msg []byte, sendingHub *Hub, err error)

OpenHubMsg opens a signed hub msg and verifies the signature using the provided hub or the local database. If TOFU is enabled, the signature is always accepted, if valid.

func ParseBootstrapHub added in v0.3.0 

func ParseBootstrapHub(bootstrapTransport string, mapName string) (*Hub, error)

func (*Hub) AddLane added in v0.3.0 

func (h *Hub) AddLane(newLane *Lane) error

AddLane adds a new Lane to the Hub Status.

func (*Hub) GetInfo added in v0.3.0 

func (h *Hub) GetInfo() *Announcement

GetInfo returns the hub info.

func (*Hub) GetLaneTo added in v0.3.0 

func (h *Hub) GetLaneTo(hubID string) *Lane

GetLaneTo returns the lane to the given Hub, if it exists.

func (*Hub) GetSignet 

func (h *Hub) GetSignet(id string, recipient bool) (*jess.Signet, error)

GetSignet returns the public key identified by the given ID from the Hub Status.

func (*Hub) GetStatus added in v0.3.0 

func (h *Hub) GetStatus() *Status

GetInfo returns the hub status.

func (*Hub) Name added in v0.3.0 

func (h *Hub) Name() string

Name returns a human-readable version of a Hub's name. This name will likely consist of two parts: the given name and the ending of the ID to make it unique.

func (*Hub) RemoveLane added in v0.3.0 

func (h *Hub) RemoveLane(hubID string) error

RemoveLane removes a Lane from the Hub Status.

func (*Hub) Save 

func (hub *Hub) Save() error

Save saves to Hub to the correct scope in the database.

func (*Hub) SelectSignet 

func (h *Hub) SelectSignet() *jess.Signet

SelectSignet selects the public key to use for initiating connections to that Hub.

func (*Hub) String 

func (h *Hub) String() string

String returns a human-readable representation of the Hub.

func (*Hub) StringWithoutLocking added in v0.3.0 

func (h *Hub) StringWithoutLocking() string

String returns a human-readable representation of the Hub without locking it.

func (*Hub) Verified added in v0.3.0 

func (h *Hub) Verified() bool

Verified return whether the Hub has been verified.

type HubMsg 

type HubMsg struct {
	record.Base
	sync.Mutex

	ID   string
	Map  string
	Type MsgType
	Data []byte

	Received int64
}

HubMsg stores raw Hub messages.

func EnsureHubMsg 

func EnsureHubMsg(r record.Record) (*HubMsg, error)

EnsureHubMsg makes sure a database record is a HubMsg.

type Intel added in v0.3.0 

type Intel struct {
	// BootstrapHubs is list of transports that also contain an IP and the Hub's ID.
	BootstrapHubs []string
	// TrustedHubs is a list of Hub IDs that are specially designated for more sensitive tasls, such as handling unencrypted traffic.
	TrustedHubs []string

	// AdviseOnlyTrustedHubs advises to only use trusted Hubs regardless of intended purpose.
	AdviseOnlyTrustedHubs bool
	// AdviseOnlyTrustedHomeHubs advises to only use trusted Hubs for Home Hubs.
	AdviseOnlyTrustedHomeHubs bool
	// AdviseOnlyTrustedDestinationHubs advises to only use trusted Hubs for Destination Hubs.
	AdviseOnlyTrustedDestinationHubs bool

	// HubAdvisory always affects all Hubs.
	HubAdvisory []string
	// HomeHubAdvisory is only taken into account when selecting a Home Hub.
	HomeHubAdvisory []string
	// DestinationHubAdvisory is only taken into account when selecting a Destination Hub.
	DestinationHubAdvisory []string
	// contains filtered or unexported fields
}

Intel holds a collection of various security related data collections on Hubs.

func ParseIntel added in v0.3.0 

func ParseIntel(data []byte) (*Intel, error)

ParseIntel parses Hub intelligence data.

func (*Intel) ParseAdvisories added in v0.3.0 

func (i *Intel) ParseAdvisories() (err error)

ParseAdvisories parses all advisory endpoint lists.

func (*Intel) Parsed added in v0.3.0 

func (i *Intel) Parsed() *ParsedIntel

Parsed returns the collection of parsed intel data.

type Key added in v0.3.0 

type Key struct {
	Scheme  string
	Key     []byte
	Expires int64
}

Key represents a semi-ephemeral public key used for 0-RTT connection establishment.

type Lane added in v0.3.0 

type Lane struct {
	// ID is the Hub ID of the peer.
	ID string

	// Capacity designates the available bandwidth between these Hubs.
	// It is specified in bit/s.
	Capacity int

	// Lateny designates the latency between these Hubs.
	// It is specified in nanoseconds.
	Latency time.Duration
}

Lane represents a connection to another Hub.

func (*Lane) Equal added in v0.3.0 

func (l *Lane) Equal(other *Lane) bool

Equal returns whether the Lane is equal to the given one.

func (*Lane) String added in v0.3.0 

func (l *Lane) String() string

type MsgType added in v0.3.0 

type MsgType string

type ParsedIntel added in v0.3.0 

type ParsedIntel struct {
	// HubAdvisory always affects all Hubs.
	HubAdvisory endpoints.Endpoints

	// HomeHubAdvisory is only taken into account when selecting a Home Hub.
	HomeHubAdvisory endpoints.Endpoints

	// DestinationHubAdvisory is only taken into account when selecting a Destination Hub.
	DestinationHubAdvisory endpoints.Endpoints
}

ParsedIntel holds a collection of parsed intel data.

type Scope 

type Scope uint8

Scope is the network scope a Hub can be in. 

const (
	// ScopeInvalid defines an invalid scope
	ScopeInvalid Scope = 0

	// ScopeLocal identifies local Hubs
	ScopeLocal Scope = 1

	// ScopePublic identifies public Hubs
	ScopePublic Scope = 2

	// ScopeTest identifies Hubs for testing
	ScopeTest Scope = 0xFF
)

func (Scope) String 

func (s Scope) String() string

String returns the string representation of the scope.

type SingleTrustStore 

type SingleTrustStore struct {
	Signet *jess.Signet
}

SingleTrustStore is a simple truststore that always returns the same Signet.

func (*SingleTrustStore) GetSignet 

func (ts *SingleTrustStore) GetSignet(id string, recipient bool) (*jess.Signet, error)

GetSignet implements the truststore interface.

type Status added in v0.3.0 

type Status struct {
	Timestamp int64

	// Version holds the current software version of the Hub.
	Version string

	// Routing Information
	Keys  map[string]*Key // public keys (with type)
	Lanes []*Lane         // Connections to other Hubs.

	// Load describes max(CPU, Memory) in percent, averaged over at least 15
	// minutes. Load is published in fixed steps only.
	Load int
}

Status is the message type used to update changing Hub Information. Changes are made automatically.

func (*Status) Copy added in v0.3.0 

func (s *Status) Copy() (*Status, error)

Copy returns a deep copy of the Status.

func (*Status) Export added in v0.3.0 

func (hs *Status) Export(env *jess.Envelope) ([]byte, error)

Export exports the status with the given signature configuration.

type Transport 

type Transport struct {
	Protocol string
	Domain   string
	Port     uint16
	Path     string
	Option   string
}

Transport represents a "endpoint" that others can connect to. This allows for use of different protocols, ports and infrastructure integration.

func ParseTransport 

func ParseTransport(definition string) (*Transport, error)

ParseTransport parses a transport definition.

func (*Transport) String 

func (t *Transport) String() string

String returns the definition form of the transport.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.