ipam

Documentation

Index

• Constants
• func AliasAllowAll() accessPolicy
• func AliasInternetOnly() accessPolicy
• type Config
• type IPAM
  • func New(cfg Config) (*IPAM, error)
  • func (m *IPAM) Alloc(pol Policy) (xnet.IP, error)
  • func (m *IPAM) Available() (xnet.IP, error)
  • func (m *IPAM) IsAvailable(addr xnet.IP) bool
  • func (m *IPAM) Running() bool
  • func (m *IPAM) Set(addr xnet.IP, pol Policy) error
  • func (m *IPAM) Shutdown() error
  • func (m *IPAM) Unset(addr xnet.IP) error
• type ListMode
  • func (mode ListMode) AllowList() bool
  • func (mode ListMode) BlockList() bool
  • func (mode ListMode) Int() int
  • func (mode ListMode) MarshalText() ([]byte, error)
  • func (mode ListMode) String() string
  • func (mode *ListMode) UnmarshalText(raw []byte) error
• type NetworkAccess
• type Policy
• type PortRange
  • func (rng PortRange) MarshalText() ([]byte, error)
  • func (rng *PortRange) UnmarshalText(raw []byte) error
• type PortRestrictionConfig
  • func DefaultPortRestrictions() *PortRestrictionConfig
• type ProtocolPortConfig
• type Rate
  • func (r Rate) String() string
  • func (r *Rate) UnmarshalText(raw []byte) error
• type RateLimiterConfig

Constants

const (
	AccessPolicyDefault = iota
	// AccessPolicyInternetOnly allows peer to access only
	// internet resources but not its network neighbours.
	AccessPolicyInternetOnly
	// AccessPolicyAllowAll allows peer to access internet resources
	// as well ass connecting to their network neighbours.
	// This is a trusted policy.
	AccessPolicyAllowAll
)

const (
	// Block ports from specified port range, allowing all others
	RestrictionModeBlockList = iota
	// Allow ports from specified port range, blocking all owhers
	RestrictionModeAllowList
)

const (
	Bitps  Rate = 1
	Kbitps      = Bitps * 1000
	Mbitps      = Kbitps * 1000
	Gbitps      = Mbitps * 1000
)

Functions

func AliasAllowAll

func AliasAllowAll() accessPolicy

func AliasInternetOnly

func AliasInternetOnly() accessPolicy

Types

type Config

type Config struct {
	Subnet           *xnet.IPNet
	Interface        string
	AccessPolicy     NetworkAccess
	RateLimiter      *RateLimiterConfig
	PortRestrictions *PortRestrictionConfig
}

type IPAM

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

IPAM implements IP Address Manager and provides the following features:

• assigns IP addresses for peers;
• implements network policies using netfilter rules;
• limits the available bandwidth using traffic control rules;

func New

func New(cfg Config) (*IPAM, error)

func (*IPAM) Alloc

func (m *IPAM) Alloc(pol Policy) (xnet.IP, error)

func (*IPAM) Available

func (m *IPAM) Available() (xnet.IP, error)

func (*IPAM) IsAvailable

func (m *IPAM) IsAvailable(addr xnet.IP) bool

func (*IPAM) Running

func (m *IPAM) Running() bool

func (*IPAM) Set

func (m *IPAM) Set(addr xnet.IP, pol Policy) error

func (*IPAM) Shutdown

func (m *IPAM) Shutdown() error

func (*IPAM) Unset

func (m *IPAM) Unset(addr xnet.IP) error

type ListMode

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

func (ListMode) AllowList

func (mode ListMode) AllowList() bool

func (ListMode) BlockList

func (mode ListMode) BlockList() bool

func (ListMode) Int

func (mode ListMode) Int() int

func (ListMode) MarshalText

func (mode ListMode) MarshalText() ([]byte, error)

func (ListMode) String

func (mode ListMode) String() string

func (*ListMode) UnmarshalText

func (mode *ListMode) UnmarshalText(raw []byte) error

type NetworkAccess

type NetworkAccess struct {
	DefaultPolicy accessPolicy `yaml:"default_policy,omitempty"`
}

type Policy

type Policy struct {
	Access    int
	RateLimit Rate
}

Policy define peer's network access rules. What peer it can talk to, and on what bandwidth.

type PortRange

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

func (PortRange) MarshalText

func (rng PortRange) MarshalText() ([]byte, error)

func (*PortRange) UnmarshalText

func (rng *PortRange) UnmarshalText(raw []byte) error

type PortRestrictionConfig

type PortRestrictionConfig struct {
	UDP ProtocolPortConfig `yaml:"udp,omitempty"`
	TCP ProtocolPortConfig `yaml:"tcp,omitempty"`
}

func DefaultPortRestrictions

func DefaultPortRestrictions() *PortRestrictionConfig

type ProtocolPortConfig

type ProtocolPortConfig struct {
	Mode  ListMode    `yaml:"mode"`
	Ports []PortRange `yaml:"range,omitempty"`
}

type Rate

type Rate uint64

Rate represents the desired bandwidth, keep in mind that values must follow SI, not IEC.

func (Rate) String

func (r Rate) String() string

func (*Rate) UnmarshalText

func (r *Rate) UnmarshalText(raw []byte) error

type RateLimiterConfig

type RateLimiterConfig struct {
	TotalBandwidth Rate `yaml:"total_bandwidth,omitempty"`
}