registry

package

Go to main page

Versions in this module

v1

v1.7.2

Apr 10, 2026

Changes in this version

type DashboardStats

+ Daily []StatsSample

+ Hourly []StatsSample

+ type NetworkSampleEntry struct

+ ID uint16

+ Members int

+ Name string

+ Online int

+ Requests int64

+ Timestamp int64

+ type NetworkStats struct

+ Daily []NetworkSampleEntry

+ Hourly []NetworkSampleEntry

+ ID uint16

+ Members int

+ Name string

+ Online int

+ Requests int64

+ TrustLinks int

type Server

+ func (s *Server) GetDashboardStatsExtended() DashboardStats

+ func (s *Server) GetDashboardStatsWithHistory() DashboardStats

+ func (s *Server) SetDashboardToken(token string)

+ func (s *Server) SetMaxNodes(n int)

+ type StatsSample struct

+ OnlineNodes int

+ Timestamp int64

+ TotalNodes int

+ TotalRequests int64

+ TrustLinks int

v1.7.1

Apr 9, 2026

Changes in this version

type DashboardStats

+ Versions map[string]int

v1.7.0

Apr 9, 2026

Changes in this version

type NodeInfo

+ Version string

v1.6.2

Apr 9, 2026

v1.6.1

Apr 9, 2026

v1.6.0

Apr 9, 2026

Changes in this version

+ func AllowedPortsToPolicy(ports []uint16) (json.RawMessage, error)

+ func RulesToPolicy(r *NetworkRules) (json.RawMessage, error)

+ func ValidateRules(r *NetworkRules) error

+ type BinaryClient struct

+ func DialBinary(addr string) (*BinaryClient, error)

+ func (c *BinaryClient) Addr() string

+ func (c *BinaryClient) Close() error

+ func (c *BinaryClient) Heartbeat(nodeID uint32, sig []byte) (unixTime int64, keyExpiryWarning bool, err error)

+ func (c *BinaryClient) Lookup(nodeID uint32) (*WireLookupResult, error)

+ func (c *BinaryClient) Resolve(nodeID, requesterID uint32, sig []byte) (*WireResolveResult, error)

+ func (c *BinaryClient) SendJSON(msg map[string]interface{}) (map[string]interface{}, error)

type Client

+ func (c *Client) CreateManagedNetwork(nodeID uint32, name, joinRule, token, adminToken string, enterprise bool, ...) (map[string]interface{}, error)

+ func (c *Client) GetExprPolicy(networkID uint16) (map[string]interface{}, error)

+ func (c *Client) GetMemberTags(netID uint16, targetNodeID uint32) (map[string]interface{}, error)

+ func (c *Client) SetExprPolicy(networkID uint16, policyJSON json.RawMessage, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetMemberTags(netID uint16, targetNodeID uint32, tags []string, adminToken string) (map[string]interface{}, error)

+ type DeltaEntry struct

+ Data json.RawMessage

+ NodeID uint32

+ SeqNo uint64

+ Type DeltaType

+ type DeltaType uint8

+ const DeltaDeregister

+ const DeltaHeartbeat

+ const DeltaHostname

+ const DeltaKeyRotation

+ const DeltaNetworkCreate

+ const DeltaNetworkJoin

+ const DeltaNetworkLeave

+ const DeltaRegister

+ const DeltaTags

+ const DeltaTaskExec

+ const DeltaTrustAdd

+ const DeltaTrustRevoke

+ const DeltaVisibility

type NetworkInfo

+ ExprPolicy json.RawMessage

+ MemberTags map[uint32][]string

+ Rules *NetworkRules

+ type NetworkRules struct

+ Cycle string

+ Fill int

+ FillHow string

+ Grace string

+ Links int

+ Prune int

+ PruneBy string

+ func ParseRules(raw string) (*NetworkRules, error)

type Server

+ func (s *Server) SetWebhookRetryBackoff(d time.Duration)

+ type WAL struct

+ func NewWAL(path string) (*WAL, error)

+ func (w *WAL) Append(entry DeltaEntry) error

+ func (w *WAL) Close() error

+ func (w *WAL) Replay(fn func(DeltaEntry) error) (int, error)

+ func (w *WAL) Size() int64

+ func (w *WAL) Truncate() error

+ type WireLookupResult struct

+ ExternalID string

+ Hostname string

+ Networks []uint16

+ NodeID uint32

+ PoloScore int

+ PubKey []byte

+ Public bool

+ RealAddr string

+ Tags []string

+ TaskExec bool

+ type WireResolveResult struct

+ KeyAgeDays int

+ LANAddrs []string

+ NodeID uint32

+ RealAddr string

v1.5.1

Apr 6, 2026

Changes in this version

+ func ValidateBlueprint(bp *NetworkBlueprint) error

+ type AuditEntry struct

+ Action string

+ Details string

+ NetworkID uint16

+ NodeID uint32

+ Timestamp string

+ type AuditExporter struct

+ func (ae *AuditExporter) Close()

+ func (ae *AuditExporter) Export(entry *AuditEntry)

+ func (ae *AuditExporter) Stats() (exported, dropped uint64)

+ type BlueprintAuditExport struct

+ Endpoint string

+ Format string

+ Index string

+ Source string

+ Token string

+ type BlueprintIdentityProvider struct

+ ClientID string

+ Domain string

+ Issuer string

+ TenantID string

+ Type string

+ URL string

+ type BlueprintPolicy struct

+ AllowedPorts []uint16

+ Description string

+ MaxMembers int

+ type BlueprintRole struct

+ ExternalID string

+ Role string

+ type BlueprintWebhooks struct

+ AuditURL string

+ IdentityURL string

type Client

+ func (c *Client) ClearKeyExpiryAdmin(nodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) DeleteNetwork(networkID uint16, adminToken string, nodeID ...uint32) (map[string]interface{}, error)

+ func (c *Client) DemoteMember(networkID uint16, nodeID, targetNodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) DeregisterAdmin(nodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) DirectoryStatus(networkID uint16, adminToken string) (map[string]interface{}, error)

+ func (c *Client) DirectorySync(networkID uint16, entries []map[string]interface{}, removeUnlisted bool, ...) (map[string]interface{}, error)

+ func (c *Client) GetAuditExport(adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetAuditLog(networkID uint16, adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetIDPConfig(adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetIdentity(nodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetKeyInfo(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) GetMemberRole(networkID uint16, targetNodeID uint32) (map[string]interface{}, error)

+ func (c *Client) GetNetworkPolicy(networkID uint16) (map[string]interface{}, error)

+ func (c *Client) GetProvisionStatus(adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetWebhook(adminToken string) (map[string]interface{}, error)

+ func (c *Client) GetWebhookDLQ(adminToken string) (map[string]interface{}, error)

+ func (c *Client) InviteToNetwork(networkID uint16, inviterID, targetNodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) KickMember(networkID uint16, nodeID, targetNodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) PollInvites(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) PromoteMember(networkID uint16, nodeID, targetNodeID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) ProvisionNetwork(blueprint map[string]interface{}, adminToken string) (map[string]interface{}, error)

+ func (c *Client) RenameNetwork(networkID uint16, name, adminToken string, nodeID ...uint32) (map[string]interface{}, error)

+ func (c *Client) RespondInvite(nodeID uint32, networkID uint16, accept bool) (map[string]interface{}, error)

+ func (c *Client) SetAuditExport(format, endpoint, token, index, source, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetExternalID(nodeID uint32, externalID, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetHostnameAdmin(nodeID uint32, hostname, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetIDPConfig(idpType, url, issuer, clientID, tenantID, domain, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetIdentityWebhook(url, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetKeyExpiry(nodeID uint32, expiresAt time.Time) (map[string]interface{}, error)

+ func (c *Client) SetKeyExpiryAdmin(nodeID uint32, expiresAt time.Time, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetNetworkEnterprise(networkID uint16, enterprise bool, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetNetworkPolicy(networkID uint16, policy map[string]interface{}, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetTagsAdmin(nodeID uint32, tags []string, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetTaskExecAdmin(nodeID uint32, enabled bool, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetVisibilityAdmin(nodeID uint32, public bool, adminToken string) (map[string]interface{}, error)

+ func (c *Client) SetWebhook(url, adminToken string) (map[string]interface{}, error)

+ func (c *Client) TransferOwnership(networkID uint16, ownerNodeID, newOwnerID uint32, adminToken string) (map[string]interface{}, error)

+ func (c *Client) ValidateToken(token, adminToken string) (map[string]interface{}, error)

+ type DirectoryEntry struct

+ Disabled bool

+ DisplayName string

+ Email string

+ ExternalID string

+ Groups []string

+ Role string

+ type DirectorySyncRequest struct

+ Entries []DirectoryEntry

+ NetworkID uint16

+ RemoveUnlisted bool

+ type DirectorySyncResult struct

+ Actions []string

+ Disabled int

+ Mapped int

+ Unmapped int

+ Updated int

+ type KeyInfo struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ RotateCount int

+ RotatedAt time.Time

+ type NetworkBlueprint struct

+ AuditExport *BlueprintAuditExport

+ Enterprise bool

+ IdentityProvider *BlueprintIdentityProvider

+ JoinRule string

+ JoinToken string

+ Name string

+ NetworkAdminToken string

+ Policy *BlueprintPolicy

+ Roles []BlueprintRole

+ Webhooks *BlueprintWebhooks

+ func LoadBlueprint(path string) (*NetworkBlueprint, error)

type NetworkInfo

+ AdminToken string

+ Enterprise bool

+ MemberRoles map[uint32]Role

+ Policy NetworkPolicy

+ type NetworkInvite struct

+ InviterID uint32

+ NetworkID uint16

+ Timestamp time.Time

+ type NetworkPolicy struct

+ AllowedPorts []uint16

+ Description string

+ MaxMembers int

type NodeInfo

+ ExternalID string

+ KeyMeta KeyInfo

+ LANAddrs []string

+ type OperationRateLimiter struct

+ func NewOperationRateLimiter() *OperationRateLimiter

+ func (orl *OperationRateLimiter) AddCategory(name string, rate int, window time.Duration)

+ func (orl *OperationRateLimiter) Allow(category, ip string) bool

+ func (orl *OperationRateLimiter) Cleanup()

+ func (orl *OperationRateLimiter) SetClock(fn func() time.Time)

+ type ProvisionResult struct

+ Actions []string

+ Created bool

+ Name string

+ NetworkID uint16

+ type RegistryWebhookEvent struct

+ Action string

+ Details map[string]interface{}

+ EventID uint64

+ Timestamp time.Time

+ type Role string

+ const RoleAdmin

+ const RoleMember

+ const RoleOwner

type Server

+ func (s *Server) ApplyBlueprint(bp *NetworkBlueprint, adminToken string) (*ProvisionResult, error)

+ func (s *Server) ConnCount() int64

+ func (s *Server) GetAuditExportConfig() *BlueprintAuditExport

+ func (s *Server) GetIdentityProviderConfig() *BlueprintIdentityProvider

+ func (s *Server) SetIdentityWebhookURL(url string)

+ func (s *Server) SetMaxConnections(max int64)

+ func (s *Server) SetOperationRateLimiterClock(fn func() time.Time)

+ func (s *Server) SetWebhookURL(url string)

+ func (s *Server) SyncTimestamp(netID uint16) time.Time

+ type SplunkHECEvent struct

+ Event map[string]interface{}

+ Host string

+ Index string

+ Source string

+ SourceType string

+ Time int64

v1.5.0-rc1

Mar 27, 2026

v1.4.1

Mar 25, 2026

v1.4.0

Mar 24, 2026

Changes in this version

type Client

+ func (c *Client) CheckTrust(nodeA, nodeB uint32) (bool, error)

+ func (c *Client) ResolveHostnameAs(requesterID uint32, hostname string) (map[string]interface{}, error)

type Server

+ func (s *Server) Reap()

+ func (s *Server) SetClock(fn func() time.Time)

v1.3.0

Mar 15, 2026

Changes in this version

type Client

+ func (c *Client) GetPoloScore(nodeID uint32) (int, error)

+ func (c *Client) SetPoloScore(nodeID uint32, poloScore int) (map[string]interface{}, error)

+ func (c *Client) UpdatePoloScore(nodeID uint32, delta int) (map[string]interface{}, error)

type DashboardNetwork

+ OnlineMembers int

type DashboardNode

+ PoloScore int

type NodeInfo

+ PoloScore int

type Server

+ func (s *Server) TriggerSnapshot() error

v1.2.2

Feb 17, 2026

Changes in this version

+ type Client struct

+ func Dial(addr string) (*Client, error)

+ func DialTLS(addr string, tlsConfig *tls.Config) (*Client, error)

+ func DialTLSPinned(addr, fingerprint string) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) CreateNetwork(nodeID uint32, name, joinRule, token, adminToken string) (map[string]interface{}, error)

+ func (c *Client) Deregister(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) Heartbeat(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) JoinNetwork(nodeID uint32, networkID uint16, token string, inviterID uint32, ...) (map[string]interface{}, error)

+ func (c *Client) LeaveNetwork(nodeID uint32, networkID uint16, adminToken string) (map[string]interface{}, error)

+ func (c *Client) ListNetworks() (map[string]interface{}, error)

+ func (c *Client) ListNodes(networkID uint16) (map[string]interface{}, error)

+ func (c *Client) Lookup(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) PollHandshakes(nodeID uint32) (map[string]interface{}, error)

+ func (c *Client) Punch(requesterID, nodeA, nodeB uint32) (map[string]interface{}, error)

+ func (c *Client) Register(listenAddr string) (map[string]interface{}, error)

+ func (c *Client) RegisterWithKey(listenAddr, publicKeyB64, owner string) (map[string]interface{}, error)

+ func (c *Client) RegisterWithOwner(listenAddr, owner string) (map[string]interface{}, error)

+ func (c *Client) ReportTrust(nodeID, peerID uint32) (map[string]interface{}, error)

+ func (c *Client) RequestHandshake(fromNodeID, toNodeID uint32, justification, signatureB64 string) (map[string]interface{}, error)

+ func (c *Client) Resolve(nodeID, requesterID uint32) (map[string]interface{}, error)

+ func (c *Client) ResolveHostname(hostname string) (map[string]interface{}, error)

+ func (c *Client) RespondHandshake(nodeID, peerID uint32, accept bool, signatureB64 string) (map[string]interface{}, error)

+ func (c *Client) RevokeTrust(nodeID, peerID uint32) (map[string]interface{}, error)

+ func (c *Client) RotateKey(nodeID uint32, signatureB64, newPubKeyB64 string) (map[string]interface{}, error)

+ func (c *Client) Send(msg map[string]interface{}) (map[string]interface{}, error)

+ func (c *Client) SetHostname(nodeID uint32, hostname string) (map[string]interface{}, error)

+ func (c *Client) SetSigner(fn func(challenge string) string)

+ func (c *Client) SetTags(nodeID uint32, tags []string) (map[string]interface{}, error)

+ func (c *Client) SetTaskExec(nodeID uint32, enabled bool) (map[string]interface{}, error)

+ func (c *Client) SetVisibility(nodeID uint32, public bool) (map[string]interface{}, error)

+ type DashboardEdge struct

+ Source string

+ Target string

+ type DashboardNetwork struct

+ ID uint16

+ Members int

+ Name string

+ type DashboardNode struct

+ Address string

+ Online bool

+ Tags []string

+ TaskExec bool

+ TrustLinks int

+ type DashboardStats struct

+ ActiveNodes int

+ Edges []DashboardEdge

+ Networks []DashboardNetwork

+ Nodes []DashboardNode

+ TaskExecutors int

+ TotalNodes int

+ TotalRequests int64

+ TotalTrustLinks int

+ UniqueTags int

+ UptimeSecs int64

+ type HandshakeRelayMsg struct

+ FromNodeID uint32

+ Justification string

+ Timestamp time.Time

+ type HandshakeResponseMsg struct

+ Accept bool

+ FromNodeID uint32

+ Timestamp time.Time

+ type NetworkInfo struct

+ Created time.Time

+ ID uint16

+ JoinRule string

+ Members []uint32

+ Name string

+ Token string

+ type NodeInfo struct

+ Hostname string

+ ID uint32

+ LastSeen time.Time

+ Networks []uint16

+ Owner string

+ Public bool

+ PublicKey []byte

+ RealAddr string

+ Tags []string

+ TaskExec bool

+ type RateLimiter struct

+ func NewRateLimiter(rate int, window time.Duration) *RateLimiter

+ func (rl *RateLimiter) Allow(ip string) bool

+ func (rl *RateLimiter) BucketCount() int

+ func (rl *RateLimiter) Cleanup()

+ func (rl *RateLimiter) HasBucket(ip string) bool

+ func (rl *RateLimiter) SetClock(fn func() time.Time)

+ type Server struct

+ func New(beaconAddr string) *Server

+ func NewWithStore(beaconAddr, storePath string) *Server

+ func (s *Server) Addr() net.Addr

+ func (s *Server) Close() error

+ func (s *Server) GetDashboardStats() DashboardStats

+ func (s *Server) IsStandby() bool

+ func (s *Server) ListenAndServe(addr string) error

+ func (s *Server) Ready() <-chan struct{}

+ func (s *Server) RunStandby(primaryAddr string)

+ func (s *Server) ServeDashboard(addr string) error

+ func (s *Server) SetAdminToken(token string)

+ func (s *Server) SetReplicationToken(token string)

+ func (s *Server) SetStandby(primary string)

+ func (s *Server) SetTLS(certFile, keyFile string) error

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