node

package

Go to main page

Versions in this module

v0

v0.2.4

Apr 9, 2026

v0.2.3

Apr 8, 2026

v0.2.2

Apr 8, 2026

Changes in this version

+ func IOURingAvailable() bool

+ type ExportIOURing struct — linux/amd64

+ func NewIOURingForTest(fd int, entries uint32) (*ExportIOURing, error)

+ func (e *ExportIOURing) AcquireBuffer() int

+ func (e *ExportIOURing) BufCount() int

+ func (e *ExportIOURing) Close() error

+ func (e *ExportIOURing) ReleaseBuffer(idx int)

type NodeConfig

+ IOURing bool

v0.2.1

Apr 8, 2026

Changes in this version

+ func ExportFECFrameWrite(w io.Writer, frameType byte, groupID uint16, index byte, payload []byte) error

+ func FECGroupSizeForLoss(lossRate float64) int

type PeerEntry

+ MetaVersion uint64

type TunDevice

+ UpdateMeshCIDR func(newCIDR string) bool

v0.2.0

Apr 8, 2026

Changes in this version

+ func MeshIPFromNodeIDWithCIDR(nodeID, cidr string) net.IP

+ func SaveNodeState(dataDir string, snc SignedNodeConfig) error

+ func SetupLogFile(path string) error

+ func VerifyNodeConfig(snc SignedNodeConfig, pub ed25519.PublicKey) error

type NetworkConfig

+ MeshCIDR string

type Node

+ func (n *Node) SendRemoteCmd(targetNodeID string, cmd string, config map[string]string) error

+ type NodeConfig struct

+ DNSEnabled bool

+ ExitCIDRs []string

+ ExitEnabled bool

+ FECEnabled bool

+ LogLevel string

+ MeshCIDR string

+ MeshIP string

+ SocksEnabled bool

+ TunEnabled bool

+ TunQueues int

+ Version int64

type NodeMeta

+ MeshIP string

+ PinnedVia string

type PeerEntry

+ Version string

+ type RotatingWriter struct

+ func NewRotatingWriter(path string) (*RotatingWriter, error)

+ func (w *RotatingWriter) Write(p []byte) (int, error)

type Scribe

+ func (s *Scribe) BuildNodeConfigForPeer(nodeID string) NodeConfig

+ func (s *Scribe) DeleteTemplate(pattern string)

+ func (s *Scribe) GetTemplates() map[string]NodeConfig

+ func (s *Scribe) Groups() map[string]int

+ func (s *Scribe) NodesByTagPattern(pattern string) []string

+ func (s *Scribe) PinRoute(nodeID, viaNodeID string)

+ func (s *Scribe) PushNodeConfig(nodeID string, cfg NodeConfig)

+ func (s *Scribe) SetMeshIP(nodeID, meshIP string)

+ func (s *Scribe) SetTemplate(pattern string, cfg NodeConfig)

+ func (s *Scribe) UnpinRoute(nodeID string)

+ type SignedNodeConfig struct

+ Config NodeConfig

+ ScribeID string

+ Signature []byte

+ func LoadNodeState(dataDir string) (*SignedNodeConfig, error)

+ func SignNodeConfig(cfg NodeConfig, priv ed25519.PrivateKey, scribeID string) (SignedNodeConfig, error)

v0.1.9

Apr 5, 2026

v0.1.8

Apr 5, 2026

Changes in this version

type CA

+ Events *EventLog

+ type CumulativeStats struct

+ BytesIn int64

+ BytesOut int64

+ type EventEntry struct

+ Detail string

+ Error string

+ NodeID string

+ Timestamp time.Time

+ Type EventType

+ func ReadFiltered(path string, opts FilterOpts) ([]EventEntry, error)

+ type EventLog struct

+ func OpenEventLog(path string) (*EventLog, error)

+ func (l *EventLog) Close() error

+ func (l *EventLog) Emit(e EventEntry)

+ func (l *EventLog) Flush()

+ func (l *EventLog) Subscribe() chan EventEntry

+ func (l *EventLog) Unsubscribe(ch chan EventEntry)

+ type EventType string

+ const EventACLChanged

+ const EventCertExpiryWarning

+ const EventCertIssued

+ const EventCertRenew

+ const EventCertRevoked

+ const EventDNSChanged

+ const EventJoinAttempted

+ const EventJoinFailed

+ const EventLinkDown

+ const EventLinkUp

+ const EventNATPunchFail

+ const EventNATPunchSuccess

+ const EventNetconfigBroadcast

+ const EventNodeRevoked

+ const EventShutdown

+ const EventStartup

+ const EventTagChanged

+ type FilterOpts struct

+ Node string

+ Since time.Time

+ Type EventType

type Prober

+ OnLinkDead func(nodeID string)

+ type StatsRing struct

+ func NewStatsRing() *StatsRing

+ func (s *StatsRing) AllLatest() map[string]StatsSnapshot

+ func (s *StatsRing) Get(nodeID string) []StatsSnapshot

+ func (s *StatsRing) LoadCumulative(path string) error

+ func (s *StatsRing) Record(nodeID string, snap StatsSnapshot)

+ func (s *StatsRing) SaveCumulative(path string) error

+ type StatsSnapshot struct

+ ActiveConns int

+ BytesIn int64

+ BytesOut int64

+ LatencyMS float64

+ LossRate float64

+ Timestamp time.Time

type Table

+ OnPrune func(nodeID string)

v0.1.7

Apr 5, 2026

v0.1.6

Apr 5, 2026

Changes in this version

+ func BridgeDirectCounted(a, b net.Conn, tc *TrafficCounters)

type NATManager

+ func (m *NATManager) HandlePunchStart(ctx context.Context, conn interface{ ... }, ...)

type PeerEntry

+ LinkType string

type PeerLink

+ ViaNAT bool

type Scribe

+ func (s *Scribe) Stats() map[string]NodeStats

+ type TrafficCounters struct

+ ActiveConns atomic.Int64

+ BytesIn atomic.Int64

+ BytesOut atomic.Int64

v0.1.5

Apr 5, 2026

v0.1.4

Apr 5, 2026

v0.1.3

Apr 5, 2026

v0.1.2

Apr 5, 2026

v0.1.1

Apr 4, 2026

Changes in this version

+ func ClientTLSConfig(nodeCert tls.Certificate, caPool *x509.CertPool) *tls.Config

+ func Debugf(format string, args ...any)

+ func Errorf(format string, args ...any)

+ func FECFrameRead(r io.Reader) (frameType byte, groupID uint16, index byte, payload []byte, err error)

+ func FormatPortRanges(ports []PortRange) string

+ func HandleRelayStream(stream net.Conn, reader *bufio.Reader, req TunnelRequest, selfID string, ...)

+ func Infof(format string, args ...any)

+ func LinkScore(e PeerEntry) float64

+ func LoadCAPool(caCertPEM []byte) (*x509.CertPool, error)

+ func LoadNodePubKey(path string) (ed25519.PublicKey, error)

+ func MatchesNode(pattern, nodeID string, meta NodeMeta) bool

+ func MeshIPFromNodeID(nodeID string) net.IP

+ func NewFECDecoder() *fecDecoder

+ func NewFECEncoder() *fecEncoder

+ func RegisterService(table *Table, selfID, addr string, pubKey []byte, isCA bool, svc ServiceRecord)

+ func SavePeers(dataDir string, entries []PeerEntry) error

+ func ServeTCP(listenAddr string, router *Router, aclTable *ACLTable, selfID string, ...) error

+ func SetLogLevel(l LogLevel)

+ func StoreJoinResult(dir string, resp JoinResponse) error

+ func VerifyNetConfig(snc SignedNetConfig, pub ed25519.PublicKey) error

+ func Warnf(format string, args ...any)

+ type ACLRule struct

+ Action string

+ DstPattern string

+ Ports []PortRange

+ SrcPattern string

+ type ACLTable struct

+ func NewACLTable() *ACLTable

+ func (t *ACLTable) Check(callerID, destNodeID string, port uint16, lookup MetaLookup) error

+ func (t *ACLTable) Get(nodeID string) NodeACL

+ func (t *ACLTable) MergeFrom(acls []NodeACL)

+ func (t *ACLTable) Snapshot() []NodeACL

+ func (t *ACLTable) Upsert(a NodeACL)

+ type AuditEntry struct

+ Error string

+ NodeID string

+ Op AuditOp

+ RemoteAddr string

+ Timestamp time.Time

+ type AuditLog struct

+ func OpenAuditLog(path string) (*AuditLog, error)

+ func (a *AuditLog) Close() error

+ func (a *AuditLog) ReadAll() ([]AuditEntry, error)

+ func (a *AuditLog) ReadByNode(nodeID string) ([]AuditEntry, error)

+ func (a *AuditLog) ReadSince(t time.Time) ([]AuditEntry, error)

+ func (a *AuditLog) Write(e AuditEntry) error

+ type AuditOp string

+ const AuditCertIssued

+ const AuditCertRevoked

+ const AuditJoinAttempted

+ const AuditJoinFailed

+ type CA struct

+ Audit *AuditLog

+ Cert *x509.Certificate

+ CertPEM []byte

+ JoinToken string

+ OnTokenUsed func(string)

+ Pool *x509.CertPool

+ PrivKey ed25519.PrivateKey

+ func InitCA(dir string, joinToken string) (*CA, error)

+ func LoadCA(dir string, joinToken string) (*CA, error)

+ func (ca *CA) HandleJoin(req JoinRequest) JoinResponse

+ func (ca *CA) IsRevoked(nodeID string) bool

+ func (ca *CA) RevokeNode(nodeID string)

+ func (ca *CA) ServerTLSConfig(nodeCert tls.Certificate) *tls.Config

+ func (ca *CA) SignIdentity(pub ed25519.PublicKey, nodeID string) (JoinResponse, error)

+ func (ca *CA) SyncRevokedIDs(ids []string)

+ func (ca *CA) SyncTokens(tokens []JoinToken)

+ type CIDRRoute struct

+ AutoLearn bool

+ CIDR string

+ NodeID string

+ type ControlServer struct

+ func NewControlServer(socketPath string, n *Node) *ControlServer

+ func (s *ControlServer) ListenAndServe(ctx context.Context) error

+ type DNSServer struct

+ func NewDNSServer(addr string, table *Table, extraZones func() []DNSZone) *DNSServer

+ func (d *DNSServer) ListenAndServe(ctx context.Context) error

+ func (d *DNSServer) ServeDNS(w dns.ResponseWriter, r *dns.Msg)

+ type DNSZone struct

+ Name string

+ TTL uint32

+ Type string

+ Value string

+ type ExitRouteTable struct

+ func NewExitRouteTable(path string) *ExitRouteTable

+ func (t *ExitRouteTable) Add(cidr, nodeID string) error

+ func (t *ExitRouteTable) Load() error

+ func (t *ExitRouteTable) Lookup(ip net.IP) string

+ func (t *ExitRouteTable) Remove(cidr string)

+ func (t *ExitRouteTable) Save() error

+ func (t *ExitRouteTable) Snapshot() []CIDRRoute

+ func (t *ExitRouteTable) SyncFromGossip(exitNodes []PeerEntry)

+ type Identity struct

+ CAPool *x509.CertPool

+ Joined bool

+ NodeID string

+ PrivateKey ed25519.PrivateKey

+ PublicKey ed25519.PublicKey

+ TLSCert tls.Certificate

+ func LoadOrCreateIdentity(dir string) (*Identity, error)

+ type JoinRequest struct

+ PublicKey []byte

+ Token string

+ type JoinResponse struct

+ CACert string

+ Error string

+ NodeID string

+ SignedCert string

+ func Join(ctx context.Context, relayAddr string, req JoinRequest) (*JoinResponse, error)

+ func SignIdentityFromKeyFile(keyPath string, ca *CA) (JoinResponse, string, error)

+ type JoinToken struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ MaxUses int

+ UseCount int

+ Value string

+ func GenerateToken(ttl time.Duration, maxUses int) JoinToken

+ func (t *JoinToken) IsExhausted() bool

+ func (t *JoinToken) IsExpired() bool

+ func (t *JoinToken) IsValid() bool

+ type LinkRegistry struct

+ func NewLinkRegistry() *LinkRegistry

+ func (r *LinkRegistry) Add(link *PeerLink)

+ func (r *LinkRegistry) All() []*PeerLink

+ func (r *LinkRegistry) Get(nodeID string) (*PeerLink, bool)

+ func (r *LinkRegistry) Has(nodeID string) bool

+ func (r *LinkRegistry) Remove(nodeID string)

+ func (r *LinkRegistry) SessionOwner(s Session) string

+ type LinkStats struct

+ func (s *LinkStats) LatencyMS() float64

+ func (s *LinkStats) LossRate() float64

+ type LogLevel int32

+ const LevelDebug

+ const LevelError

+ const LevelInfo

+ const LevelWarn

+ func ParseLogLevel(s string) LogLevel

+ type MetaLookup func(nodeID string) NodeMeta

+ type MultipathSession struct

+ func NewMultipathSession(sessions []Session, scores []float64) *MultipathSession

+ func (m *MultipathSession) Accept() (net.Conn, error)

+ func (m *MultipathSession) Close() error

+ func (m *MultipathSession) IsClosed() bool

+ func (m *MultipathSession) Open() (net.Conn, error)

+ func (m *MultipathSession) Transport() string

+ type NATManager struct

+ func NewNATManager(selfID string, table *Table, registry *LinkRegistry, router *Router, ...) *NATManager

+ func (m *NATManager) HandlePunchRequest(ctx context.Context, peerNodeID, peerPublicAddr, token string, ...)

+ func (m *NATManager) Run(ctx context.Context)

+ type NetworkConfig struct

+ DNSZones []DNSZone

+ GlobalACLs []NodeACL

+ JoinTokens []JoinToken

+ NodeMeta map[string]NodeMeta

+ RevokedIDs []string

+ Version int64

+ type Node struct

+ func New(cfg *config.Config, ca *CA) (*Node, error)

+ func (n *Node) ReloadIdentity() error

+ func (n *Node) Run(ctx context.Context) error

+ func (n *Node) Stop()

+ type NodeACL struct

+ Allow []ACLRule

+ NodeID string

+ Version int64

+ func (a NodeACL) Check(srcNodeID, destNodeID string, port uint16, lookup MetaLookup) error

+ type NodeMeta struct

+ Name string

+ Tags []string

+ type NodeStats struct

+ ActiveConns int

+ BytesIn int64

+ BytesOut int64

+ NodeID string

+ ReportedAt time.Time

+ type PeerEntry struct

+ ACL *NodeACL

+ Addr string

+ ExitCIDRs []string

+ HopCount int

+ IsCA bool

+ IsExit bool

+ IsScribe bool

+ LastSeen time.Time

+ LatencyMS float64

+ LossRate float64

+ MeshIP string

+ Name string

+ NodeID string

+ PublicAddr string

+ PublicKey []byte

+ ScribeAPIAddr string

+ Services []ServiceRecord

+ Tags []string

+ func LoadPeers(dataDir string) ([]PeerEntry, error)

+ type PeerLink struct

+ NodeID string

+ func (p *PeerLink) Close() error

+ func (p *PeerLink) IsClosed() bool

+ func (p *PeerLink) Open() (net.Conn, error)

+ func (p *PeerLink) Transport() string

+ type PortRange struct

+ High uint16

+ Low uint16

+ func ParsePortRanges(s string) ([]PortRange, error)

+ func (r PortRange) Contains(port uint16) bool

+ type Prober struct

+ func NewProber(registry *LinkRegistry, table *Table) *Prober

+ func (p *Prober) Run(ctx interface{ ... })

+ type Router struct

+ func NewRouter(table *Table, registry *LinkRegistry) *Router

+ func (r *Router) Resolve(destNodeID string) (Session, error)

+ type SOCKSServer struct

+ func NewSOCKSServer(addr string, router *Router, table *Table, exitRoutes *ExitRouteTable, ...) *SOCKSServer

+ func (s *SOCKSServer) ListenAndServe(ctx context.Context) error

+ type Scribe struct

+ func NewScribe(n *Node) *Scribe

+ func (s *Scribe) AcceptStats(stats NodeStats)

+ func (s *Scribe) AddACLRule(ctx context.Context, rule ACLRule)

+ func (s *Scribe) AddDNSZone(ctx context.Context, zone DNSZone) error

+ func (s *Scribe) CreateToken(ctx context.Context, ttl time.Duration, maxUses int) JoinToken

+ func (s *Scribe) GlobalACLRules() []ACLRule

+ func (s *Scribe) IncrementTokenUse(tokenValue string)

+ func (s *Scribe) ListTokens() []JoinToken

+ func (s *Scribe) PushTo(session Session)

+ func (s *Scribe) RemoveACLRule(ctx context.Context, index int) error

+ func (s *Scribe) RemoveDNSZone(ctx context.Context, name, recType string) error

+ func (s *Scribe) RemoveTag(ctx context.Context, nodeID, tag string)

+ func (s *Scribe) Revoke(ctx context.Context, nodeID string)

+ func (s *Scribe) RevokeToken(ctx context.Context, prefix string) error

+ func (s *Scribe) Run(ctx context.Context)

+ func (s *Scribe) SetName(ctx context.Context, nodeID, name string)

+ func (s *Scribe) SetTag(ctx context.Context, nodeID, tag string)

+ type ServiceRecord struct

+ Name string

+ Port uint16

+ Priority uint16

+ type Session interface

+ Accept func() (net.Conn, error)

+ Close func() error

+ IsClosed func() bool

+ Open func() (net.Conn, error)

+ Transport func() string

+ type SignedNetConfig struct

+ Config NetworkConfig

+ ScribeID string

+ Signature []byte

+ func SignNetConfig(cfg NetworkConfig, priv ed25519.PrivateKey, scribeID string) (SignedNetConfig, error)

+ type Table struct

+ func NewTable() *Table

+ func (t *Table) ExitNodes() []PeerEntry

+ func (t *Table) FindCA() (PeerEntry, bool)

+ func (t *Table) FindScribe() (PeerEntry, bool)

+ func (t *Table) Get(nodeID string) (PeerEntry, bool)

+ func (t *Table) MergeFrom(entries []PeerEntry, selfID string)

+ func (t *Table) PruneStale(selfID string)

+ func (t *Table) RunPruner(ctx context.Context, selfID string)

+ func (t *Table) Snapshot() []PeerEntry

+ func (t *Table) SnapshotSince(minVersion uint64) []PeerEntry

+ func (t *Table) Upsert(e PeerEntry)

+ func (t *Table) UpsertForce(e PeerEntry)

+ func (t *Table) Version() uint64

+ type TunDevice interface

+ HandleInbound func(conn net.Conn)

+ RefreshMeshIPs func()

+ Run func(ctx context.Context)

+ RunPipe func(nodeID string, conn net.Conn)

+ func NewTunDevice(n *Node, devName, meshCIDR string) (TunDevice, error)

+ type TunnelRequest struct

+ DestAddr string

+ DestNodeID string

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