networking

Documentation

Overview

Package networking contains interfaces to the database models for Network ACLs and Routes.

Package networking contains interfaces to the database models for Network ACLs and Routes.

Index

• Constants
• Variables
• func IsSystemNetworkACL(name string) bool
• type ACL
  • func (a *ACL) DestinationPrefixes() []netip.Prefix
  • func (a *ACL) Expand(ctx context.Context) error
  • func (acl *ACL) Matches(ctx context.Context, action Action) bool
  • func (a *ACL) Proto() *v1.NetworkACL
  • func (a *ACL) SourcePrefixes() []netip.Prefix
• type ACLs
  • func (a ACLs) Accept(ctx context.Context, action Action) bool
  • func (a ACLs) AllowNodesToCommunicate(ctx context.Context, nodeA, nodeB peergraph.MeshNode) bool
  • func (a ACLs) Expand(ctx context.Context) error
  • func (a ACLs) Len() int
  • func (a ACLs) Less(i, j int) bool
  • func (a ACLs) Proto() []*v1.NetworkACL
  • func (a ACLs) Sort(direction SortDirection)
  • func (a ACLs) Swap(i, j int)
• type Action
  • func (a *Action) DestinationPrefix() netip.Prefix
  • func (a *Action) Proto() *v1.NetworkAction
  • func (a *Action) SourcePrefix() netip.Prefix
• type AdjacencyMap
• type Networking
  • func New(st storage.MeshStorage) Networking
• type NodeGetter
• type SortDirection

Constants

const (
	// BootstrapNodesNetworkACLName is the name of the bootstrap nodes NetworkACL.
	BootstrapNodesNetworkACLName = "bootstrap-nodes"
	// NetworkACLsPrefix is where NetworkACLs are stored in the database.
	NetworkACLsPrefix = storage.RegistryPrefix + "network-acls"
	// RoutesPrefix is where Routes are stored in the database.
	RoutesPrefix = storage.RegistryPrefix + "routes"
	// GroupReference is the prefix of a node name that indicates it is a group reference.
	GroupReference = "group:"
)

Variables

var ErrACLNotFound = errors.New("network acl not found")

ErrACLNotFound is returned when a NetworkACL is not found.

var ErrRouteNotFound = errors.New("route not found")

ErrRouteNotFound is returned when a Route is not found.

Functions

func IsSystemNetworkACL

func IsSystemNetworkACL(name string) bool

IsSystemNetworkACL returns true if the NetworkACL is a system NetworkACL.

Types

type ACL

type ACL struct {
	*v1.NetworkACL
	// contains filtered or unexported fields
}

ACL is a Network ACL.

func (*ACL) DestinationPrefixes

func (a *ACL) DestinationPrefixes() []netip.Prefix

DestinationPrefixes returns the destination prefixes for the ACL. Invalid prefixes will be ignored.

func (*ACL) Expand

func (a *ACL) Expand(ctx context.Context) error

Expand expands any group references in the ACL.

func (*ACL) Matches

func (acl *ACL) Matches(ctx context.Context, action Action) bool

Matches checks if an action matches this ACL.

func (*ACL) Proto

func (a *ACL) Proto() *v1.NetworkACL

Proto returns the protobuf representation of the ACL.

func (*ACL) SourcePrefixes

func (a *ACL) SourcePrefixes() []netip.Prefix

SourcePrefixes returns the source prefixes for the ACL. Invalid prefixes will be ignored.

type ACLs

type ACLs []*ACL

ACLs is a list of Network ACLs. It contains methods for evaluating actions against contained permissions. It also allows for sorting by priority.

func (ACLs) Accept

func (a ACLs) Accept(ctx context.Context, action Action) bool

Accept evaluates an action against the ACLs in the list. It assumes the ACLs are sorted by priority. The first ACL that matches the action will be used. If no ACL matches, the action is denied.

func (ACLs) AllowNodesToCommunicate

func (a ACLs) AllowNodesToCommunicate(ctx context.Context, nodeA, nodeB peergraph.MeshNode) bool

AllowNodesToCommunicate checks if the given nodes are allowed to communicate.

func (ACLs) Expand

func (a ACLs) Expand(ctx context.Context) error

Expand expands any group references in the ACLs.

func (ACLs) Len

func (a ACLs) Len() int

Len returns the length of the ACLs list.

func (ACLs) Less

func (a ACLs) Less(i, j int) bool

Less returns whether the ACL at index i should be sorted before the ACL at index j.

func (ACLs) Proto

func (a ACLs) Proto() []*v1.NetworkACL

Proto returns the protobuf representation of the ACLs.

func (ACLs) Sort

func (a ACLs) Sort(direction SortDirection)

Sort sorts the ACLs by priority.

func (ACLs) Swap

func (a ACLs) Swap(i, j int)

Swap swaps the ACLs at the given indices.

type Action

type Action struct {
	*v1.NetworkAction
}

Action wraps a NetworkAction.

func (*Action) DestinationPrefix

func (a *Action) DestinationPrefix() netip.Prefix

DestinationPrefix returns the destination prefix for the action if it is valid.

func (*Action) Proto

func (a *Action) Proto() *v1.NetworkAction

Proto returns the protobuf representation of the action.

func (*Action) SourcePrefix

func (a *Action) SourcePrefix() netip.Prefix

SourcePrefix returns the source prefix for the action if it is valid.

type AdjacencyMap

type AdjacencyMap map[string]map[string]graph.Edge[string]

AdjacencyMap is a map of node names to a map of node names to edges.

type Networking

type Networking interface {
	// PutNetworkACL creates or updates a NetworkACL.
	PutNetworkACL(ctx context.Context, acl *v1.NetworkACL) error
	// GetNetworkACL returns a NetworkACL by name.
	GetNetworkACL(ctx context.Context, name string) (*ACL, error)
	// DeleteNetworkACL deletes a NetworkACL by name.
	DeleteNetworkACL(ctx context.Context, name string) error
	// ListNetworkACLs returns a list of NetworkACLs.
	ListNetworkACLs(ctx context.Context) (ACLs, error)

	// PutRoute creates or updates a Route.
	PutRoute(ctx context.Context, route *v1.Route) error
	// GetRoute returns a Route by name.
	GetRoute(ctx context.Context, name string) (*v1.Route, error)
	// GetRoutesByNode returns a list of Routes for a given Node.
	GetRoutesByNode(ctx context.Context, nodeName string) ([]*v1.Route, error)
	// GetRoutesByCIDR returns a list of Routes for a given CIDR.
	GetRoutesByCIDR(ctx context.Context, cidr string) ([]*v1.Route, error)
	// DeleteRoute deletes a Route by name.
	DeleteRoute(ctx context.Context, name string) error
	// ListRoutes returns a list of Routes.
	ListRoutes(ctx context.Context) ([]*v1.Route, error)

	// FilterGraph filters the adjacency map in the given graph for the given node name according
	// to the current network ACLs. If the ACL list is nil, an empty adjacency map is returned. An
	// error is returned on faiure building the initial map or any database error.
	FilterGraph(ctx context.Context, getter NodeGetter, peerGraph peergraph.Graph, node peergraph.MeshNode) (AdjacencyMap, error)
}

Networking is the interface to the database models for network resources.

func New

func New(st storage.MeshStorage) Networking

New returns a new Networking interface.

type NodeGetter

type NodeGetter interface {
	Get(ctx context.Context, id string) (peergraph.MeshNode, error)
}

NodeGetter is an interface that can resolve a node ID to a MeshNode.

type SortDirection

type SortDirection int

SortDirection is the direction to sort ACLs.

const (
	// SortDescending sorts ACLs in descending order.
	SortDescending SortDirection = iota
	// SortAscending sorts ACLs in ascending order.
	SortAscending
)