logic

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: Feb 11, 2026 License: Apache-2.0 Imports: 58 Imported by: 6

Documentation

Overview

package for logicing client and server code

Index

Constants

View Source 
const (
	DashboardApp       = "dashboard"
	NetclientApp       = "netclient"
	NetmakerDesktopApp = "netmaker-desktop"
)
View Source 
const (
	// RELAY_NODE_ERR - error to return if relay node is unfound
	RELAY_NODE_ERR = "could not find relay for node"
	// NodePurgeTime time to wait for node to response to a NODE_DELETE actions
	NodePurgeTime = time.Second * 10
	// NodePurgeCheckTime is how often to check nodes for Pending Delete
	NodePurgeCheckTime = time.Second * 30
)
View Source 
const (
	MasterUser       = "masteradministrator"
	Forbidden_Msg    = "forbidden"
	Forbidden_Err    = models.Error(Forbidden_Msg)
	Unauthorized_Msg = "unauthorized"
	Unauthorized_Err = models.Error(Unauthorized_Msg)
)
View Source 
const (
	// ZOMBIE_TIMEOUT - timeout in hours for checking zombie status
	ZOMBIE_TIMEOUT = 6
	// ZOMBIE_DELETE_TIME - timeout in minutes for zombie node deletion
	ZOMBIE_DELETE_TIME = 10
)
View Source 
const (
	GooglePublicNameserverName = "Google Public DNS"
)
View Source 
const KUBERNETES_LISTEN_PORT = 31821

KUBERNETES_LISTEN_PORT - starting port for Kubernetes in order to use NodePort range

View Source 
const KUBERNETES_SERVER_MTU = 1024

KUBERNETES_SERVER_MTU - ideal mtu for kubernetes deployments right now

View Source 
const MinVersion = "v0.17.0"

Variables

View Source 
var (
	CreateDefaultTags = func(netID models.NetworkID) {}

	DeleteAllNetworkTags = func(networkID models.NetworkID) {}

	IsUserAllowedToCommunicate = func(userName string, peer models.Node) (bool, []models.Acl) {
		return false, []models.Acl{}
	}

	RemoveUserFromAclPolicy = func(userName string) {}
)
View Source 
var (
	// DenyClientNodeAccess - function to handle adding a node to an ext client's denied node set
	DenyClientNodeAccess = func(ec *models.ExtClient, clientOrNodeID string) bool {
		return true
	}
	// IsClientNodeAllowed - function to check if an ext client's denied node set contains a node ID
	IsClientNodeAllowed = func(ec *models.ExtClient, clientOrNodeID string) bool {
		return true
	}
	// AllowClientNodeAccess - function to handle removing a node ID from ext client's denied nodes, thus allowing it
	AllowClientNodeAccess = func(ec *models.ExtClient, clientOrNodeID string) bool {
		return true
	}
	SetClientDefaultACLs = func(ec *models.ExtClient) error {

		if !GetServerSettings().OldAClsSupport {
			ec.DeniedACLs = make(map[string]struct{})
			return nil
		}
		networkAcls := acls.ACLContainer{}
		networkAcls, err := networkAcls.Get(acls.ContainerID(ec.Network))
		if err != nil {
			slog.Error("failed to get network acls", "error", err)
			return err
		}
		networkAcls[acls.AclID(ec.ClientID)] = make(acls.ACL)
		for objId := range networkAcls {
			if networkAcls[objId] == nil {
				networkAcls[objId] = make(acls.ACL)
			}
			networkAcls[objId][acls.AclID(ec.ClientID)] = acls.Allowed
			networkAcls[acls.AclID(ec.ClientID)][objId] = acls.Allowed
		}
		delete(networkAcls[acls.AclID(ec.ClientID)], acls.AclID(ec.ClientID))
		if _, err = networkAcls.Save(acls.ContainerID(ec.Network)); err != nil {
			slog.Error("failed to update network acls", "error", err)
			return err
		}
		return nil
	}
	SetClientACLs = func(ec *models.ExtClient, newACLs map[string]struct{}) {
	}
	UpdateProNodeACLs = func(node *models.Node) error {
		return nil
	}
)
View Source 
var (
	IPv4Network = "0.0.0.0/0"
	IPv6Network = "::/0"
)
View Source 
var (
	// ErrHostExists error indicating that host exists when trying to create new host
	ErrHostExists error = errors.New("host already exists")
	// ErrInvalidHostID
	ErrInvalidHostID error = errors.New("invalid host id")
)
View Source 
var (
	// ResetFailOver - function to reset failOvered peers on this node
	ResetFailOver = func(failOverNode *models.Node) error {
		return nil
	}
	// ResetFailedOverPeer - removes failed over node from network peers
	ResetFailedOverPeer = func(failedOverNode *models.Node) error {
		return nil
	}
	// FailOverExists - check if failover node existed or not
	FailOverExists = func(network string) (failOverNode models.Node, exists bool) {
		return failOverNode, exists
	}
	// GetFailOverPeerIps - gets failover peerips
	GetFailOverPeerIps = func(peer, node *models.Node) []net.IPNet {
		return []net.IPNet{}
	}
	// CreateFailOver - creates failover in a network
	CreateFailOver = func(node models.Node) error {
		return nil
	}
)
View Source 
var (
	// ResetAutoRelay - function to reset autorelayed peers on this node
	ResetAutoRelay = func(autoRelayNode *models.Node) error {
		return nil
	}
	// ResetAutoRelayedPeer - removes relayed peers for node
	ResetAutoRelayedPeer = func(failedOverNode *models.Node) error {
		return nil
	}
	// GetAutoRelayPeerIps - gets autorelay peerips
	GetAutoRelayPeerIps = func(peer, node *models.Node) []net.IPNet {
		return []net.IPNet{}
	}
	// SetAutoRelay - sets autorelay flag on the node
	SetAutoRelay = func(node *models.Node) {
		node.IsAutoRelay = false
	}
)
View Source 
var (
	// NetworksLimit - dummy var for community
	NetworksLimit = 1000000000
	// UsersLimit - dummy var for community
	UsersLimit = 1000000000
	// MachinesLimit - dummy var for community
	MachinesLimit = 1000000000
	// IngressesLimit - dummy var for community
	IngressesLimit = 1000000000
	// EgressesLimit - dummy var for community
	EgressesLimit = 1000000000
	// FreeTier - specifies if free tier
	FreeTier = false
	// DefaultTrialEndDate - is a placeholder date for not applicable trial end dates
	DefaultTrialEndDate, _ = time.Parse("2006-Jan-02", "2021-Apr-01")

	GetTrialEndDate = func() (time.Time, error) {
		return DefaultTrialEndDate, nil
	}
)
View Source 
var (
	ErrInvalidJwtValidityDuration = errors.New("invalid jwt validity duration")
	ErrFlowLogsNotSupported       = errors.New("flow logs not supported")
	ErrInvalidIPDetectionInterval = errors.New("invalid ip detection interval (must be greater than or equal to 15s)")
)
View Source 
var AddGlobalNetRolesToAdmins = func(u *models.User) {}
View Source 
var AdminPermissionTemplate = models.UserRolePermissionTemplate{
	ID:         models.AdminRole,
	Default:    true,
	FullAccess: true,
}
View Source 
var AssignVirtualRangeToEgress = func(nw *models.Network, eg *schema.Egress) error {
	return nil
}
View Source 
var CheckIfAnyPolicyisUniDirectional = func(targetNode models.Node, acls []models.Acl) bool {
	return false
}
View Source 
var CheckJITAccess = func(string, string) (bool, *schema.JITGrant, error) {
	return true, nil, nil
}
View Source 
var CheckPostureViolations = func(d models.PostureCheckDeviceInfo, network models.NetworkID) (v []models.Violation, level models.Severity) {
	return []models.Violation{}, models.SeverityUnknown
}
View Source 
var CreateDefaultNetworkRolesAndGroups = func(netID models.NetworkID) {}
View Source 
var CreateDefaultUserPolicies = func(netID models.NetworkID) {
	if netID.String() == "" {
		return
	}
	if !IsAclExists(fmt.Sprintf("%s.%s", netID, "all-users")) {
		defaultUserAcl := models.Acl{
			ID:          fmt.Sprintf("%s.%s", netID, "all-users"),
			Default:     true,
			Name:        "All Users",
			MetaData:    "This policy gives access to everything in the network for an user",
			NetworkID:   netID,
			Proto:       models.ALL,
			ServiceType: models.Any,
			Port:        []string{},
			RuleType:    models.UserPolicy,
			Src: []models.AclPolicyTag{
				{
					ID:    models.UserAclID,
					Value: "*",
				},
			},
			Dst: []models.AclPolicyTag{{
				ID:    models.NodeTagID,
				Value: "*",
			}},
			AllowedDirection: models.TrafficDirectionUni,
			Enabled:          true,
			CreatedBy:        "auto",
			CreatedAt:        time.Now().UTC(),
		}
		InsertAcl(defaultUserAcl)
	}
}
View Source 
var CreateRole = func(r models.UserRolePermissionTemplate) error {
	return nil
}
View Source 
var DeleteMetrics = func(string) error {
	return nil
}
View Source 
var DeleteNetworkRoles = func(netID string) {}
View Source 
var (
	DeleteNodesCh = make(chan *models.Node, 100)
)
View Source 
var DeleteRole = func(r models.UserRoleID, force bool) error {
	return nil
}
View Source 
var EmailInit = func() {}
View Source 
var EnrollmentErrors = struct {
	InvalidCreate      error
	NoKeyFound         error
	InvalidKey         error
	NoUsesRemaining    error
	FailedToTokenize   error
	FailedToDeTokenize error
}{
	InvalidCreate:      fmt.Errorf("failed to create enrollment key. paramters invalid"),
	NoKeyFound:         fmt.Errorf("no enrollmentkey found"),
	InvalidKey:         fmt.Errorf("invalid key provided"),
	NoUsesRemaining:    fmt.Errorf("no uses remaining"),
	FailedToTokenize:   fmt.Errorf("failed to tokenize"),
	FailedToDeTokenize: fmt.Errorf("failed to detokenize"),
}

EnrollmentErrors - struct for holding EnrollmentKey error messages

View Source 
var EnterpriseCheckFuncs []func(ctx context.Context, wg *sync.WaitGroup)

EnterpriseCheckFuncs - can be set to run functions for EE

View Source 
var FilterNetworksByRole = func(allnetworks []models.Network, user models.User) []models.Network {
	return allnetworks
}
View Source 
var GetDeploymentMode = func() string {

	return "self-hosted"
}
View Source 
var GetEgressUserRulesForNode = func(targetnode *models.Node,
	rules map[string]models.AclRule) map[string]models.AclRule {
	return rules
}
View Source 
var GetFeatureFlags = func() models.FeatureFlags {
	return models.FeatureFlags{}
}
View Source 
var GetFilteredNodesByUserAccess = func(user models.User, nodes []models.Node) (filteredNodes []models.Node) {
	return
}
View Source 
var GetFwRulesForNodeAndPeerOnGw = getFwRulesForNodeAndPeerOnGw
View Source 
var GetFwRulesForUserNodesOnGw = func(node models.Node, nodes []models.Node) (rules []models.FwRule) { return }
View Source 
var GetMetrics = func(string) (*models.Metrics, error) {
	var metrics models.Metrics
	return &metrics, nil
}
View Source 
var GetNameserversForHost = getNameserversForHost
View Source 
var GetNameserversForNode = getNameserversForNode
View Source 
var GetNodeStatus = getNodeCheckInStatus
View Source 
var GetPostureCheckDeviceInfoByNode = func(node *models.Node) (d models.PostureCheckDeviceInfo) {
	return
}
View Source 
var GetTagMapWithNodesByNetwork = getTagMapWithNodesByNetwork
View Source 
var GetUserAclRulesForNode = func(targetnode *models.Node,
	rules map[string]models.AclRule) map[string]models.AclRule {
	return rules
}
View Source 
var GetUserGroup = func(groupId models.UserGroupID) (userGrps models.UserGroup, err error) { return }
View Source 
var GetUserGroupsInNetwork = func(netID models.NetworkID) (networkGrps map[models.UserGroupID]models.UserGroup) { return }
View Source 
var GlobalNsList = map[string]GlobalNs{
	"Google": {
		ID: "Google",
		IPs: []string{
			"8.8.8.8",
			"8.8.4.4",
			"2001:4860:4860::8888",
			"2001:4860:4860::8844",
		},
	},
	"Cloudflare": {
		ID: "Cloudflare",
		IPs: []string{
			"1.1.1.1",
			"1.0.0.1",
			"2606:4700:4700::1111",
			"2606:4700:4700::1001",
		},
	},
	"Quad9": {
		ID: "Quad9",
		IPs: []string{
			"9.9.9.9",
			"149.112.112.112",
			"2620:fe::fe",
			"2620:fe::9",
		},
	},
}
View Source 
var GlobalPermissionsCheck = func(username string, r *http.Request) error { return nil }
View Source 
var HookCommandCh = make(chan models.HookCommand, 10)

HookCommandCh - channel to send commands to hooks (reset/stop)

View Source 
var HookManagerCh = make(chan models.HookDetails, 3)

HookManagerCh - channel to add any new hooks

View Source 
var InitialiseRoles = userRolesInit
View Source 
var IntialiseGroups = func() {}
View Source 
var IsAclPolicyValid = func(acl models.Acl) (err error) {

	if acl.AllowedDirection == models.TrafficDirectionUni {
		return errors.New("uni traffic flow not allowed on CE")
	}
	switch acl.RuleType {

	case models.DevicePolicy:
		for _, srcI := range acl.Src {
			if srcI.Value == "*" {
				continue
			}
			if srcI.ID == models.NodeTagID && srcI.Value == fmt.Sprintf("%s.%s", acl.NetworkID.String(), models.GwTagName) {
				continue
			}
			if err = checkIfAclTagisValid(acl, srcI, true); err != nil {
				return err
			}
		}
		for _, dstI := range acl.Dst {

			if dstI.Value == "*" {
				continue
			}
			if dstI.ID == models.NodeTagID && dstI.Value == fmt.Sprintf("%s.%s", acl.NetworkID.String(), models.GwTagName) {
				continue
			}
			if err = checkIfAclTagisValid(acl, dstI, false); err != nil {
				return
			}
		}
	default:
		return errors.New("unknown acl policy type " + string(acl.RuleType))
	}
	return nil
}
View Source 
var IsGroupValid = func(groupID models.UserGroupID) error {
	return nil
}
View Source 
var IsGroupsValid = func(groups map[models.UserGroupID]struct{}) error {
	return nil
}
View Source 
var IsNetworkRolesValid = func(networkRoles map[models.NetworkID]map[models.UserRoleID]struct{}) error {
	return nil
}
View Source 
var IsOAuthConfigured = func() bool { return false }
View Source 
var IsPeerAllowed = func(node, peer models.Node, checkDefaultPolicy bool) bool {
	var nodeId, peerId string

	if node.IsStatic {
		nodeId = node.StaticNode.ClientID
		node = node.StaticNode.ConvertToStaticNode()
	} else {
		nodeId = node.ID.String()
	}
	if peer.IsStatic {
		peerId = peer.StaticNode.ClientID
		peer = peer.StaticNode.ConvertToStaticNode()
	} else {
		peerId = peer.ID.String()
	}

	peerTags := make(map[models.TagID]struct{})
	nodeTags := make(map[models.TagID]struct{})
	nodeTags[models.TagID(nodeId)] = struct{}{}
	peerTags[models.TagID(peerId)] = struct{}{}
	if peer.IsGw {
		peerTags[models.TagID(fmt.Sprintf("%s.%s", peer.Network, models.GwTagName))] = struct{}{}
	}
	if node.IsGw {
		nodeTags[models.TagID(fmt.Sprintf("%s.%s", node.Network, models.GwTagName))] = struct{}{}
	}
	if checkDefaultPolicy {

		defaultPolicy, err := GetDefaultPolicy(models.NetworkID(node.Network), models.DevicePolicy)
		if err == nil {
			if defaultPolicy.Enabled {
				return true
			}
		}

	}

	policies := ListDevicePolicies(models.NetworkID(peer.Network))
	srcMap := make(map[string]struct{})
	dstMap := make(map[string]struct{})
	defer func() {
		srcMap = nil
		dstMap = nil
	}()
	for _, policy := range policies {
		if !policy.Enabled {
			continue
		}

		srcMap = ConvAclTagToValueMap(policy.Src)
		dstMap = ConvAclTagToValueMap(policy.Dst)
		for _, dst := range policy.Dst {
			if dst.ID == models.EgressID {
				e := schema.Egress{ID: dst.Value}
				err := e.Get(db.WithContext(context.TODO()))
				if err == nil && e.Status {
					for nodeID := range e.Nodes {
						dstMap[nodeID] = struct{}{}
					}
				}
			}
		}
		if CheckTagGroupPolicy(srcMap, dstMap, node, peer, nodeTags, peerTags) {
			return true
		}

	}
	return false
}
View Source 
var ListUserGroups = func() ([]models.UserGroup, error) { return nil, nil }
View Source 
var LogEvent = func(a *models.Event) {}
View Source 
var MigrateToGws = func() {

	nodes, err := GetAllNodes()
	if err != nil {
		return
	}
	for _, node := range nodes {
		if node.IsIngressGateway || node.IsRelay || node.IsInternetGateway {
			node.IsGw = true
			node.IsIngressGateway = true
			node.IsRelay = true
			if node.Tags == nil {
				node.Tags = make(map[models.TagID]struct{})
			}
			UpsertNode(&node)
		}
	}

}
View Source 
var MigrateToUUIDs = func() {}
View Source 
var MigrateUserRoleAndGroups = func(u models.User) models.User {
	return u
}
View Source 
var NetworkHook models.HookFunc = func(params ...interface{}) error {
	networks, err := GetNetworks()
	if err != nil {
		return err
	}
	allNodes, err := GetAllNodes()
	if err != nil {
		return err
	}
	for _, network := range networks {
		if network.AutoRemove == "false" || network.AutoRemoveThreshold == 0 {
			continue
		}
		nodes := GetNetworkNodesMemory(allNodes, network.NetID)
		for _, node := range nodes {
			if !node.Connected {
				continue
			}
			exists := false
			for _, tagI := range network.AutoRemoveTags {
				if tagI == "*" {
					exists = true
					break
				}
				if _, ok := node.Tags[models.TagID(tagI)]; ok {
					exists = true
					break
				}
			}
			if !exists {
				continue
			}
			if time.Since(node.LastCheckIn) > time.Duration(network.AutoRemoveThreshold)*time.Minute {
				if err := DeleteNode(&node, true); err != nil {
					continue
				}
				node.PendingDelete = true
				node.Action = models.NODE_DELETE
				DeleteNodesCh <- &node
				host, err := GetHost(node.HostID.String())
				if err == nil && len(host.Nodes) == 0 {
					RemoveHostByID(host.ID.String())
				}
			}
		}
	}
	return nil
}
View Source 
var NetworkPermissionsCheck = func(username string, r *http.Request) error { return nil }
View Source 
var ResetAuthProvider = func() {}
View Source 
var ResetIDPSyncHook = func() {}
View Source 
var ServerSettingsDBKey = "server_cfg"
View Source 
var SettingsMutex = &sync.RWMutex{}
View Source 
var StartFlowCleanupLoop = func() {}
View Source 
var StopFlowCleanupLoop = func() {}
View Source 
var SuperAdminPermissionTemplate = models.UserRolePermissionTemplate{
	ID:         models.SuperAdminRole,
	Default:    true,
	FullAccess: true,
}

Pre-Define Permission Templates for default Roles

View Source 
var UpdateMetrics = func(string, *models.Metrics) error {
	return nil
}
View Source 
var UpdateRole = func(r models.UserRolePermissionTemplate) error { return nil }
View Source 
var UpdateUserGwAccess = func(currentUser, changeUser models.User) {}
View Source 
var ValidateEgressReq = validateEgressReq
View Source 
var ValidateNameserverReq = validateNameserverReq

Functions

func AddEgressInfoToPeerByAccess added in v0.99.0 

func AddEgressInfoToPeerByAccess(node, targetNode *models.Node, eli []schema.Egress, acls []models.Acl, isDefaultPolicyActive bool)

func AddHook 

func AddHook(ifaceToAdd interface{})

AddHook - adds a hook function to run every 24hrs

func AddIpToAllocatedIpMap added in v0.25.0 

func AddIpToAllocatedIpMap(networkName string, ip net.IP)

func AddNetworkToAllocatedIpMap added in v0.25.0 

func AddNetworkToAllocatedIpMap(networkName string)

AddNetworkToAllocatedIpMap - add network to allocated ip map when network is added

func AddStaticNodestoList added in v0.26.0 

func AddStaticNodestoList(nodes []models.Node) []models.Node

func AddStatusToNodes added in v0.30.0 

func AddStatusToNodes(nodes []models.Node, statusCall bool) (nodesWithStatus []models.Node)

func AssociateNodeToHost 

func AssociateNodeToHost(n *models.Node, h *models.Host) error

AssociateNodeToHost - associates and creates a node with a given host should be the only way nodes get created as of 0.18

func AutoUpdateEnabled added in v0.99.0 

func AutoUpdateEnabled() bool

AutoUpdateEnabled returns a boolean indicating whether netclient auto update is enabled or disabled default is enabled

func BaseDomain added in v1.2.0 

func BaseDomain(host string) string

func CheckAndRemoveLegacyNode 

func CheckAndRemoveLegacyNode(nodeID string) bool

CheckAndRemoveLegacyNode - checks for legacy node and removes

func CheckEndpoint 

func CheckEndpoint(endpoint string) bool

CheckEndpoint - checks if an endpoint is valid

func CheckHostPorts 

func CheckHostPorts(h *models.Host) (changed bool)

CheckHostPort checks host endpoints to ensures that hosts on the same server with the same endpoint have different listen ports in the case of 64535 hosts or more with same endpoint, ports will not be changed

func CheckIfFileExists 

func CheckIfFileExists(filePath string) bool

CheckIfFileExists - checks if file exists or not in the given path

func CheckTagGroupPolicy added in v0.99.0 

func CheckTagGroupPolicy(srcMap, dstMap map[string]struct{}, node, peer models.Node,
	nodeTags, peerTags map[models.TagID]struct{}) bool

func CheckZombies 

func CheckZombies(newnode *models.Node)

CheckZombies - checks if new node has same hostid as existing node if so, existing node is added to zombie node quarantine list also cleans up nodes past their expiration date

func CleanVersion added in v1.4.0 

func CleanVersion(raw string) string

CleanVersion normalizes a version string safely for storage. - removes "v" or "V" prefix - trims whitespace - strips invalid trailing characters - preserves semver, prerelease, and build metadata

func ClearAllocatedIpMap added in v0.25.0 

func ClearAllocatedIpMap()

ClearAllocatedIpMap - set allocatedIpMap to nil

func ClearNodeCache 

func ClearNodeCache()

func CompareIfaceSlices added in v1.1.0 

func CompareIfaceSlices(a, b []models.Iface) bool

CompareIfaceSlices compares two slices of Iface for deep equality (order-sensitive)

func CompareMaps added in v0.99.0 

func CompareMaps[K comparable, V any](a, b map[K]V) bool

Compare any two maps with any key and value types

func ContainsCIDR added in v0.24.3 

func ContainsCIDR(net1, net2 string) bool

func ContinueIfUserMatch 

func ContinueIfUserMatch(next http.Handler) http.HandlerFunc

func ConvAclTagToValueMap added in v0.99.0 

func ConvAclTagToValueMap(acltags []models.AclPolicyTag) map[string]struct{}

func ConvHostPassToHash 

func ConvHostPassToHash(hostPass string) string

ConvHostPassToHash - converts password to md5 hash

func CreateDNS 

func CreateDNS(entry models.DNSEntry) (models.DNSEntry, error)

CreateDNS - creates a DNS entry

func CreateDefaultAclNetworkPolicies added in v0.26.0 

func CreateDefaultAclNetworkPolicies(netID models.NetworkID)

CreateDefaultAclNetworkPolicies - create default acl network policies

func CreateEgressGateway 

func CreateEgressGateway(gateway models.EgressGatewayRequest) (models.Node, error)

CreateEgressGateway - creates an egress gateway

func CreateEnrollmentKey 

func CreateEnrollmentKey(uses int, expiration time.Time, networks,
	tags []string, groups []models.TagID, unlimited bool, relay uuid.UUID,
	defaultKey, autoEgress, autoAssignGw bool) (*models.EnrollmentKey, error)

CreateEnrollmentKey - creates a new enrollment key in db

func CreateExtClient 

func CreateExtClient(extclient *models.ExtClient) error

CreateExtClient - creates and saves an extclient

func CreateFallbackNameserver added in v1.4.0 

func CreateFallbackNameserver(networkID string) error

func CreateHost 

func CreateHost(h *models.Host) error

CreateHost - creates a host if not exist

func CreateIngressGateway 

func CreateIngressGateway(netid string, nodeid string, ingress models.IngressRequest) (models.Node, error)

CreateIngressGateway - creates an ingress gateway

func CreateJWT 

func CreateJWT(uuid string, macAddress string, network string) (response string, err error)

CreateJWT func will used to create the JWT while signing in and signing out

func CreateNetwork 

func CreateNetwork(network models.Network) (models.Network, error)

CreateNetwork - creates a network in database

func CreatePreAuthToken added in v1.0.0 

func CreatePreAuthToken(username string) (string, error)

CreatePreAuthToken generate a jwt token to be used as intermediate token after primary-factor authentication but before secondary-factor authentication.

func CreateRelay added in v0.90.0 

func CreateRelay(relay models.RelayRequest) ([]models.Node, models.Node, error)

CreateRelay - creates a relay

func CreateSuperAdmin 

func CreateSuperAdmin(u *models.User) error

CreateSuperAdmin - creates an super admin user

func CreateUser 

func CreateUser(user *models.User) error

CreateUser - creates a user

func CreateUserAccessJwtToken added in v0.99.0 

func CreateUserAccessJwtToken(username string, role models.UserRoleID, d time.Time, tokenID string) (response string, err error)

CreateUserJWT - creates a user jwt token

func CreateUserJWT 

func CreateUserJWT(username string, role models.UserRoleID, appName string) (response string, err error)

CreateUserJWT - creates a user jwt token

func DeTokenize 

func DeTokenize(b64Token string) (*models.EnrollmentKey, error)

DeTokenize - detokenizes a base64 encoded string and finds the associated enrollment key

func DeleteAcl added in v0.26.0 

func DeleteAcl(a models.Acl) error

DeleteAcl - deletes acl policy

func DeleteDNS 

func DeleteDNS(domain string, network string) error

DeleteDNS - deletes a DNS entry

func DeleteEgressGateway 

func DeleteEgressGateway(network, nodeid string) (models.Node, error)

DeleteEgressGateway - deletes egress from node

func DeleteEnrollmentKey 

func DeleteEnrollmentKey(value string, force bool) error

DeleteEnrollmentKey - delete's a given enrollment key by value

func DeleteExpiredNodes 

func DeleteExpiredNodes(ctx context.Context)

DeleteExpiredNodes - goroutine which deletes nodes which are expired

func DeleteExtClient 

func DeleteExtClient(network string, clientid string, isUpdate bool) error

DeleteExtClient - deletes an existing ext client

func DeleteExtClientAndCleanup added in v0.24.1 

func DeleteExtClientAndCleanup(extClient models.ExtClient) error

DeleteExtClientAndCleanup - deletes an existing ext client and update ACLs

func DeleteGatewayExtClients 

func DeleteGatewayExtClients(gatewayID string, networkName string) error

DeleteGatewayExtClients - deletes ext clients based on gateway (mac) of ingress node and network

func DeleteIngressGateway 

func DeleteIngressGateway(nodeid string) (models.Node, []models.ExtClient, error)

DeleteIngressGateway - deletes an ingress gateway

func DeleteNetwork 

func DeleteNetwork(network string, force bool, done chan struct{}) error

DeleteNetwork - deletes a network

func DeleteNetworkNameservers added in v1.4.0 

func DeleteNetworkNameservers(networkID string) error

func DeleteNetworkPolicies added in v0.90.0 

func DeleteNetworkPolicies(netId models.NetworkID)

DeleteNetworkPolicies - deletes all default network acl policies

func DeleteNode 

func DeleteNode(node *models.Node, purge bool) error

DeleteNode - marks node for deletion (and adds to zombie list) if called by UI or deletes node if called by node

func DeleteNodeByID added in v0.21.2 

func DeleteNodeByID(node *models.Node) error

DeleteNodeByID - deletes a node from database

func DeletePendingUser added in v0.24.0 

func DeletePendingUser(username string) error

func DeleteRelay added in v0.90.0 

func DeleteRelay(network, nodeid string) ([]models.Node, models.Node, error)

DeleteRelay - deletes a relay

func DeleteUser 

func DeleteUser(user string) error

DeleteUser - deletes a given user

func DeleteUserInvite added in v0.25.0 

func DeleteUserInvite(email string) error

func DeleteUserSettings added in v1.1.0 

func DeleteUserSettings(userID string) error

func DisassociateAllNodesFromHost 

func DisassociateAllNodesFromHost(hostID string) error

DisassociateAllNodesFromHost - deletes all nodes of the host

func DissasociateNodeFromHost 

func DissasociateNodeFromHost(n *models.Node, h *models.Host) error

DissasociateNodeFromHost - deletes a node and removes from host nodes should be the only way nodes are deleted as of 0.18

func DoesHostExistinTheNetworkAlready added in v1.1.0 

func DoesHostExistinTheNetworkAlready(h *models.Host, network models.NetworkID) bool

func DoesNodeHaveAccessToEgress added in v0.99.0 

func DoesNodeHaveAccessToEgress(node *models.Node, e *schema.Egress, acls []models.Acl) bool

func DoesUserHaveAccessToEgress added in v1.1.0 

func DoesUserHaveAccessToEgress(user *models.User, e *schema.Egress, acls []models.Acl) bool

func EgressDNs added in v1.1.0 

func EgressDNs(network string) (entries []models.DNSEntry)

func EnterpriseCheck 

func EnterpriseCheck(ctx context.Context, wg *sync.WaitGroup)

EnterpriseCheck - Runs enterprise functions if presented

func FetchAuthSecret 

func FetchAuthSecret() (string, error)

FetchAuthSecret - manages secrets for oauth

func FetchJWTSecret 

func FetchJWTSecret() (string, error)

FetchJWTSecret - fetches jwt secret from db

func FetchPassValue added in v0.25.0 

func FetchPassValue(newValue string) (string, error)

func FetchTelemetryData added in v0.23.0 

func FetchTelemetryData() telemetryData

FetchTelemetryData - fetches telemetry data: count of various object types in DB

func FetchTelemetryRecord added in v0.23.0 

func FetchTelemetryRecord() (models.Telemetry, error)

FetchTelemetryRecord - get the existing UUID and Timestamp from the DB

func FileExists 

func FileExists(f string) bool

FileExists - checks if local file exists

func FilterOutIPs added in v1.2.0 

func FilterOutIPs(ips []string, filters map[string]bool) []string

FilterOutIPs removes ips in the filters map from the ips slice.

func FindRelay 

func FindRelay(node *models.Node) *models.Node

FindRelay - returns the node that is the relay for a relayed node

func FormatError 

func FormatError(err error, errType ApiErrorType) models.ErrorResponse

FormatError - takes ErrorResponse and uses correct code

func GenerateNodeName added in v0.30.0 

func GenerateNodeName(network string) (string, error)

GenerateNodeName - generates a random node name

func GenerateOTPAuthURLSignature added in v1.0.0 

func GenerateOTPAuthURLSignature(url string) string

func GetAcl added in v0.26.0 

func GetAcl(aID string) (models.Acl, error)

GetAcl - gets acl info by id

func GetAclRuleForInetGw added in v0.99.0 

func GetAclRuleForInetGw(targetnode models.Node) (rules map[string]models.AclRule)

func GetAclRulesForNode added in v0.30.0 

func GetAclRulesForNode(targetnodeI *models.Node) (rules map[string]models.AclRule)

func GetAllDNS 

func GetAllDNS() ([]models.DNSEntry, error)

GetAllDNS - gets all dns entries

func GetAllEgresses 

func GetAllEgresses() ([]models.Node, error)

GetAllEgresses - gets all the nodes that are egresses

func GetAllEnrollmentKeys 

func GetAllEnrollmentKeys() ([]models.EnrollmentKey, error)

GetAllEnrollmentKeys - fetches all enrollment keys from DB

func GetAllExtClients 

func GetAllExtClients() ([]models.ExtClient, error)

GetAllExtClients - gets all ext clients from DB

func GetAllExtClientsWithStatus added in v0.99.0 

func GetAllExtClientsWithStatus(status models.NodeStatus) ([]models.ExtClient, error)

GetAllExtClientsWithStatus - returns all external clients with given status.

func GetAllFailOvers added in v0.24.0 

func GetAllFailOvers() ([]models.Node, error)

GetAllFailOvers - gets all the nodes that are failovers

func GetAllHosts 

func GetAllHosts() ([]models.Host, error)

GetAllHosts - returns all hosts in flat list or error

func GetAllHostsAPI 

func GetAllHostsAPI(hosts []models.Host) []models.ApiHost

GetAllHostsAPI - get's all the hosts in an API usable format

func GetAllHostsWithStatus added in v0.99.0 

func GetAllHostsWithStatus(status models.NodeStatus) ([]models.Host, error)

GetAllHostsWithStatus - returns all hosts with at least one node with given status.

func GetAllIngresses 

func GetAllIngresses() ([]models.Node, error)

GetAllIngresses - gets all the nodes that are ingresses

func GetAllNodes 

func GetAllNodes() ([]models.Node, error)

GetAllNodes - returns all nodes in the DB

func GetAllNodesAPI 

func GetAllNodesAPI(nodes []models.Node) []models.ApiNode

GetAllNodesAPI - get all nodes for api usage

func GetAllNodesAPIWithLocation added in v1.0.0 

func GetAllNodesAPIWithLocation(nodes []models.Node) []models.ApiNode

GetAllNodesAPI - get all nodes for api usage

func GetAllRsrcIDForRsrc added in v1.1.0 

func GetAllRsrcIDForRsrc(rsrc models.RsrcType) models.RsrcID

func GetAllowedEmailDomains added in v0.99.0 

func GetAllowedEmailDomains() string

GetAllowedEmailDomains - gets the allowed email domains for oauth signup

func GetAllowedIPs 

func GetAllowedIPs(node, peer *models.Node, metrics *models.Metrics) []net.IPNet

GetAllowedIPs - calculates the wireguard allowedip field for a peer of a node based on the peer and node settings

func GetAllowedIpForInetNodeClient added in v0.23.0 

func GetAllowedIpForInetNodeClient(node, peer *models.Node) []net.IPNet

GetAllowedIpForInetNodeClient - get inet cidr for node using a inet gw

func GetAllowedIpsForRelayed 

func GetAllowedIpsForRelayed(relayed, relay *models.Node) (allowedIPs []net.IPNet)

GetAllowedIpsForRelayed - returns the peerConfig for a node relayed by relay

func GetAuthProviderInfo added in v0.99.0 

func GetAuthProviderInfo(settings models.ServerSettings) (pi []string)

GetAuthProviderInfo = gets the oauth provider info

func GetAzureTenant added in v0.99.0 

func GetAzureTenant() string

GetAzureTenant - retrieve the azure tenant ID from env variable or config file

func GetClientIP added in v1.0.0 

func GetClientIP(r *http.Request) string

func GetCurrentServerUsage added in v1.2.0 

func GetCurrentServerUsage() (limits models.Usage)

func GetCustomDNS 

func GetCustomDNS(network string) ([]models.DNSEntry, error)

GetCustomDNS - gets the custom DNS of a network

func GetDNS 

func GetDNS(network string) ([]models.DNSEntry, error)

GetDNS - gets the DNS of a current network

func GetDNSEntryNum 

func GetDNSEntryNum(domain string, network string) (int, error)

GetDNSEntryNum - gets which entry the dns was

func GetDefaultDomain added in v0.99.0 

func GetDefaultDomain() string

GetDefaultDomain - get the default domain

func GetDefaultHosts 

func GetDefaultHosts() []models.Host

GetDefaultHosts - retrieve all hosts marked as default from DB

func GetDefaultPolicy added in v0.26.0 

func GetDefaultPolicy(netID models.NetworkID, ruleType models.AclPolicyType) (models.Acl, error)

GetDefaultPolicy - fetches default policy in the network by ruleType

func GetDeletedNodeByID 

func GetDeletedNodeByID(uuid string) (models.Node, error)

GetDeletedNodeByID - get a deleted node

func GetEgressDomainNSForNode added in v1.4.0 

func GetEgressDomainNSForNode(node *models.Node) (returnNsLi []models.Nameserver)

func GetEgressDomainsByAccessForUser added in v1.4.0 

func GetEgressDomainsByAccessForUser(user *models.User, network models.NetworkID) (domains []string)

func GetEgressIPs 

func GetEgressIPs(peer *models.Node) []net.IPNet

func GetEgressRanges added in v0.90.0 

func GetEgressRanges(netID models.NetworkID) (map[string][]string, map[string]struct{}, error)

func GetEgressRangesOnNetwork 

func GetEgressRangesOnNetwork(client *models.ExtClient) ([]string, error)

ExtClient.GetEgressRangesOnNetwork - returns the egress ranges on network of ext client

func GetEgressRulesForNode added in v0.90.0 

func GetEgressRulesForNode(targetnode models.Node) (rules map[string]models.AclRule)

func GetEmaiSenderPassword added in v0.99.0 

func GetEmaiSenderPassword() string

func GetEnrollmentKey 

func GetEnrollmentKey(value string) (key models.EnrollmentKey, err error)

GetEnrollmentKey - fetches a single enrollment key returns nil and error if not found

func GetExtClient 

func GetExtClient(clientid string, network string) (models.ExtClient, error)

GetExtClient - gets a single ext client on a network

func GetExtClientByName 

func GetExtClientByName(ID string) (models.ExtClient, error)

GetExtClientByName - gets an ext client by name

func GetExtClientByPubKey 

func GetExtClientByPubKey(publicKey string, network string) (*models.ExtClient, error)

GetExtClient - gets a single ext client on a network

func GetExtClientsByID 

func GetExtClientsByID(nodeid, network string) ([]models.ExtClient, error)

GetExtClientsByID - gets the clients of attached gateway

func GetExtPeers added in v0.24.2 

func GetExtPeers(node, peer *models.Node, addressIdentityMap map[string]models.PeerIdentity) ([]wgtypes.PeerConfig, []models.IDandAddr, []models.EgressNetworkRoutes, error)

func GetExtclientAllowedIPs added in v0.22.0 

func GetExtclientAllowedIPs(client models.ExtClient) (allowedIPs []string)

func GetExtclientDNS added in v0.22.0 

func GetExtclientDNS() []models.DNSEntry

GetExtclientDNS - gets all extclients dns entries

func GetFwRulesOnIngressGateway added in v0.26.0 

func GetFwRulesOnIngressGateway(node models.Node) (rules []models.FwRule)

func GetGwDNS added in v1.1.0 

func GetGwDNS(node *models.Node) string

func GetGwExtclients added in v0.21.2 

func GetGwExtclients(nodeID, network string) []models.ExtClient

GetGwExtclients - return all ext clients attached to the passed gw id

func GetHost 

func GetHost(hostid string) (*models.Host, error)

GetHost - gets a host from db given id

func GetHostByNodeID 

func GetHostByNodeID(id string) *models.Host

GetHostByNodeID - returns a host if found to have a node's ID, else nil

func GetHostByPubKey added in v0.22.0 

func GetHostByPubKey(hostPubKey string) (*models.Host, error)

GetHostByPubKey - gets a host from db given pubkey

func GetHostNetworks 

func GetHostNetworks(hostID string) []string

GetHostNetworks - fetches all the networks

func GetHostNodes 

func GetHostNodes(host *models.Host) []models.Node

GetHostNodes - fetches all nodes part of the host

func GetHostPeerInfo added in v0.90.0 

func GetHostPeerInfo(host *models.Host) (models.HostPeerInfo, error)

GetHostPeerInfo - fetches required peer info per network

func GetHostsMap 

func GetHostsMap() (map[string]models.Host, error)

GetHostsMap - gets all the current hosts on machine in a map

func GetIDPSyncInterval added in v0.99.0 

func GetIDPSyncInterval() time.Duration

GetIDPSyncInterval returns the interval at which the netmaker should sync data from IDP.

func GetIngressGwUsers 

func GetIngressGwUsers(node models.Node) (models.IngressGwUsers, error)

GetIngressGwUsers - lists the users having to access to ingressGW

func GetInternetGateways 

func GetInternetGateways() ([]models.Node, error)

GetInternetGateways - gets all the nodes that are internet gateways

func GetJwtValidityDuration added in v0.99.0 

func GetJwtValidityDuration() time.Duration

GetJwtValidityDuration - returns the JWT validity duration in minutes

func GetJwtValidityDurationForClients added in v1.1.0 

func GetJwtValidityDurationForClients() time.Duration

GetJwtValidityDurationForClients returns the JWT validity duration in minutes for clients.

func GetManageDNS added in v0.99.0 

func GetManageDNS() bool

GetManageDNS - if manage DNS enabled or not

func GetMetricInterval added in v0.99.0 

func GetMetricInterval() string

GetMetricInterval - get the publish metric interval

func GetMetricIntervalInMinutes added in v0.99.0 

func GetMetricIntervalInMinutes() time.Duration

GetMetricInterval - get the publish metric interval

func GetMetricsPort added in v0.99.0 

func GetMetricsPort() int

GetMetricsPort - get metrics port

func GetNetwork 

func GetNetwork(networkname string) (models.Network, error)

GetNetwork - gets a network from database

func GetNetworkByNode 

func GetNetworkByNode(node *models.Node) (models.Network, error)

GetNetworkByNode - gets the network model from a node

func GetNetworkExtClients 

func GetNetworkExtClients(network string) ([]models.ExtClient, error)

GetNetworkExtClients - gets the ext clients of given network

func GetNetworkNodes 

func GetNetworkNodes(network string) ([]models.Node, error)

GetNetworkNodes - gets the nodes of a network

func GetNetworkNodesMemory 

func GetNetworkNodesMemory(allNodes []models.Node, network string) []models.Node

GetNetworkNodesMemory - gets all nodes belonging to a network from list in memory

func GetNetworkNonServerNodeCount 

func GetNetworkNonServerNodeCount(networkName string) (int, error)

GetNetworkNonServerNodeCount - get number of network non server nodes

func GetNetworkSettings 

func GetNetworkSettings(networkname string) (models.Network, error)

GetNetworkSettings - get parent network

func GetNetworks 

func GetNetworks() ([]models.Network, error)

GetNetworks - returns all networks from database

func GetNodeByHostRef added in v0.21.2 

func GetNodeByHostRef(hostid, network string) (node models.Node, err error)

GetNodeByHostRef - gets the node by host id and network

func GetNodeByID 

func GetNodeByID(uuid string) (models.Node, error)

func GetNodeDNS 

func GetNodeDNS(network string) ([]models.DNSEntry, error)

GetNodeDNS - gets the DNS of a network node

func GetNodeEgressInfo added in v0.99.0 

func GetNodeEgressInfo(targetNode *models.Node, eli []schema.Egress, acls []models.Acl)

func GetNodesStatusAPI added in v0.90.0 

func GetNodesStatusAPI(nodes []models.Node) map[string]models.ApiNodeStatus

GetNodesStatusAPI - gets nodes status

func GetParentNetwork 

func GetParentNetwork(networkname string) (models.Network, error)

GetParentNetwork - get parent network

func GetPeerListenPort 

func GetPeerListenPort(host *models.Host) int

GetPeerListenPort - given a host, retrieve it's appropriate listening port

func GetPeerUpdateForHost 

func GetPeerUpdateForHost(network string, host *models.Host, allNodes []models.Node,
	deletedNode *models.Node, deletedClients []models.ExtClient) (models.HostPeerUpdate, error)

GetPeerUpdateForHost - gets the consolidated peer update for the host from all networks

func GetRacRestrictToSingleNetwork added in v0.99.0 

func GetRacRestrictToSingleNetwork() bool

GetRacRestrictToSingleNetwork - returns whether the feature to allow simultaneous network connections via RAC is enabled

func GetRecordKey 

func GetRecordKey(id string, network string) (string, error)

GetRecordKey - get record key depricated

func GetRelatedHosts 

func GetRelatedHosts(hostID string) []models.Host

GetRelatedHosts - fetches related hosts of a given host

func GetRelays 

func GetRelays() ([]models.Node, error)

GetRelays - gets all the nodes that are relays

func GetReturnUser 

func GetReturnUser(username string) (models.ReturnUser, error)

GetReturnUser - gets a user

func GetRole added in v0.25.0 

func GetRole(roleID models.UserRoleID) (models.UserRolePermissionTemplate, error)

GetRole - fetches role template by id

func GetRunningHooks added in v1.4.0 

func GetRunningHooks() []string

GetRunningHooks - returns a list of currently running hook IDs

func GetSenderEmail added in v0.99.0 

func GetSenderEmail() string

func GetSenderUser added in v0.99.0 

func GetSenderUser() string

func GetServerConfig added in v0.99.0 

func GetServerConfig() config.ServerConfig

GetServerConfig - gets the server config into memory from file or env

func GetServerInfo added in v0.99.0 

func GetServerInfo() models.ServerConfig

GetServerInfo - gets the server config into memory from file or env

func GetServerSettings added in v0.99.0 

func GetServerSettings() (s models.ServerSettings)

func GetServerSettingsFromEnv added in v0.99.0 

func GetServerSettingsFromEnv() (s models.ServerSettings)

func GetSmtpHost added in v0.99.0 

func GetSmtpHost() string

func GetSmtpPort added in v0.99.0 

func GetSmtpPort() int

func GetState 

func GetState(state string) (*models.SsoState, error)

GetState - gets an SsoState from DB, if expired returns error

func GetStaticNodeIps added in v0.26.0 

func GetStaticNodeIps(node models.Node) (ips []net.IP)

func GetStaticNodesByNetwork added in v0.26.0 

func GetStaticNodesByNetwork(network models.NetworkID, onlyWg bool) (staticNode []models.Node)

func GetStunServers added in v0.99.0 

func GetStunServers() string

func GetSuperAdmin 

func GetSuperAdmin() (models.ReturnUser, error)

GetSuperAdmin - fetches superadmin user

func GetUser 

func GetUser(username string) (*models.User, error)

GetUser - gets a user TODO support "masteradmin"

func GetUserInvite added in v0.25.0 

func GetUserInvite(email string) (in models.UserInvite, err error)

func GetUserMap added in v0.25.0 

func GetUserMap() (map[string]models.User, error)

func GetUserNameFromToken added in v0.25.0 

func GetUserNameFromToken(authtoken string) (username string, err error)

func GetUserSettings added in v1.1.0 

func GetUserSettings(userID string) models.UserSettings

func GetUsers 

func GetUsers() ([]models.ReturnUser, error)

GetUsers - gets users

func GetUsersDB added in v0.21.2 

func GetUsersDB() ([]models.User, error)

GetUsersDB - gets users

func GetVerbosity added in v0.99.0 

func GetVerbosity() int32

func HasSuperAdmin 

func HasSuperAdmin() (bool, error)

HasSuperAdmin - checks if server has an superadmin/owner

func HostExists 

func HostExists(h *models.Host) bool

HostExists - checks if given host already exists

func IfaceDelta 

func IfaceDelta(currentNode *models.Node, newNode *models.Node) bool

IfaceDelta - checks if the new node causes an interface change

func InitNetworkHooks added in v1.4.0 

func InitNetworkHooks()

func InitializeZombies 

func InitializeZombies()

InitializeZombies - populates the zombie quarantine list (should be called from initialization)

func InsertAcl added in v0.26.0 

func InsertAcl(a models.Acl) error

InsertAcl - creates acl policy

func InsertPendingUser added in v0.24.0 

func InsertPendingUser(u *models.User) error

func InsertUserInvite added in v0.25.0 

func InsertUserInvite(invite models.UserInvite) error

func IsAclExists added in v0.26.0 

func IsAclExists(aclID string) bool

IsAclExists - checks if acl exists

func IsAddressInCIDR 

func IsAddressInCIDR(address net.IP, cidr string) bool

IsAddressInCIDR - util to see if an address is in a cidr or not

func IsBase64 

func IsBase64(s string) bool

IsBase64 - checks if a string is in base64 format This is used to validate public keys (make sure they're base64 encoded like all public keys should be).

func IsBasicAuthEnabled added in v0.99.0 

func IsBasicAuthEnabled() bool

IsBasicAuthEnabled - checks if basic auth has been configured to be turned off

func IsDNSEntryValid added in v0.30.0 

func IsDNSEntryValid(d string) bool

IsNetworkNameValid - checks if a netid of a network uses valid characters

func IsEndpointDetectionEnabled added in v0.99.0 

func IsEndpointDetectionEnabled() bool

IsEndpointDetectionEnabled - returns true if endpoint detection enabled

func IsFQDN added in v1.1.0 

func IsFQDN(domain string) bool

IsFQDN checks if the given string is a valid Fully Qualified Domain Name (FQDN)

func IsIPUnique 

func IsIPUnique(network string, ip string, tableName string, isIpv6 bool) bool

IsIPUnique - checks if an IP is unique

func IsInternetGw added in v0.22.0 

func IsInternetGw(node models.Node) bool

IsInternetGw - checks if node is acting as internet gw

func IsLegacyNode 

func IsLegacyNode(nodeID string) bool

IsLegacyNode - checks if a node is legacy or not

func IsMFAEnforced added in v1.0.0 

func IsMFAEnforced() bool

IsMFAEnforced returns whether MFA has been enforced.

func IsNetworkCIDRUnique added in v0.21.2 

func IsNetworkCIDRUnique(cidr4 *net.IPNet, cidr6 *net.IPNet) bool

func IsNetworkNameUnique 

func IsNetworkNameUnique(network *models.Network) (bool, error)

IsNetworkNameUnique - checks to see if any other networks have the same name (id)

func IsNodeAllowedToCommunicate added in v0.26.0 

func IsNodeAllowedToCommunicate(node, peer models.Node, checkDefaultPolicy bool) (bool, []models.Acl)

IsNodeAllowedToCommunicate - check node is allowed to communicate with the peer // ADD ALLOWED DIRECTION - 0 => node -> peer, 1 => peer-> node,

func IsNodeAllowedToCommunicateWithAllRsrcs added in v1.1.0 

func IsNodeAllowedToCommunicateWithAllRsrcs(node models.Node) bool

func IsNodeIDUnique 

func IsNodeIDUnique(node *models.Node) (bool, error)

IsNodeIDUnique - checks if node id is unique

func IsOauthUser added in v0.25.0 

func IsOauthUser(user *models.User) error

IsOauthUser - returns

func IsPendingUser added in v0.24.0 

func IsPendingUser(username string) bool

func IsSlicesEqual added in v0.22.0 

func IsSlicesEqual(a, b []string) bool

IsSlicesEqual tells whether a and b contain the same elements. A nil argument is equivalent to an empty slice.

func IsStateValid 

func IsStateValid(state string) (string, bool)

IsStateValid - checks if given state is valid or not deletes state after call is made to clean up, should only be called once per sign-in

func IsStunEnabled added in v0.99.0 

func IsStunEnabled() bool

IsStunEnabled - returns true if STUN set to on

func IsSyncEnabled added in v0.99.0 

func IsSyncEnabled() bool

IsSyncEnabled returns whether auth provider sync is enabled.

func IsUserAllowedAccessToExtClient 

func IsUserAllowedAccessToExtClient(username string, client models.ExtClient) bool

IsUserAllowedAccessToExtClient - checks if user has permission to access extclient

func IsValidMatchDomain added in v1.1.0 

func IsValidMatchDomain(s string) bool

IsValidMatchDomain reports whether s is a valid "match domain". Rules (simple/ASCII):

  • "~." is allowed (match all).
  • Optional leading "~" allowed (e.g., "~example.com").
  • Optional single trailing "." allowed (FQDN form).
  • No wildcards "*", no leading ".", no underscores.
  • Labels: letters/digits/hyphen (LDH), 1–63 chars, no leading/trailing hyphen.
  • Total length (without trailing dot) ≤ 253.

func IsValidVersion added in v1.4.0 

func IsValidVersion(raw string) bool

IsValidVersion returns true if the version string can be parsed as semantic version.

func IsVersionCompatible added in v0.24.1 

func IsVersionCompatible(ver string) bool

IsVersionCompatible checks that the version passed is compabtible (>=) with MinVersion

func ListAcls added in v0.26.0 

func ListAcls() (acls []models.Acl)

func ListAclsByNetwork added in v0.30.0 

func ListAclsByNetwork(netID models.NetworkID) ([]models.Acl, error)

ListAcls - lists all acl policies

func ListAllByRoutingNodeWithDomain added in v1.1.0 

func ListAllByRoutingNodeWithDomain(egs []schema.Egress, nodeID string) (egWithDomain []models.EgressDomain)

func ListDevicePolicies added in v0.99.0 

func ListDevicePolicies(netID models.NetworkID) []models.Acl

ListDevicePolicies - lists all device policies in a network

func ListEgressAcls added in v0.99.0 

func ListEgressAcls(eID string) ([]models.Acl, error)

ListEgressAcls - list egress acl policies

func ListPendingReturnUsers added in v0.99.0 

func ListPendingReturnUsers() ([]models.ReturnUser, error)

func ListPendingUsers added in v0.24.0 

func ListPendingUsers() ([]models.User, error)

func ListPlatformRoles added in v0.25.0 

func ListPlatformRoles() ([]models.UserRolePermissionTemplate, error)

ListPlatformRoles - lists user platform roles permission templates

func ListUserInvites added in v0.25.0 

func ListUserInvites() ([]models.UserInvite, error)

func ListUserPolicies added in v0.26.0 

func ListUserPolicies(netID models.NetworkID) []models.Acl

ListUserPolicies - lists all user policies in a network

func ManageZombies 

func ManageZombies(ctx context.Context)

ManageZombies - goroutine which adds/removes/deletes nodes from the zombie node quarantine list

func Mask added in v0.99.0 

func Mask() string

func MigrateAclPolicies added in v0.30.0 

func MigrateAclPolicies()

func NetIDInNetworkCharSet 

func NetIDInNetworkCharSet(network *models.Network) bool

NetIDInNetworkCharSet - checks if a netid of a network uses valid characters

func NetworkExists 

func NetworkExists(name string) (bool, error)

NetworkExists - check if network exists

func NormalizeCIDR 

func NormalizeCIDR(address string) (string, error)

NormalizeCIDR - returns the first address of CIDR

func NormalizeOSName added in v1.4.0 

func NormalizeOSName(raw string) string

func OSFamily added in v1.4.0 

func OSFamily(osName string) string

OSFamily returns a normalized OS family string. Examples: "linux-debian", "linux-redhat", "linux-arch", "linux-other", "windows", "darwin"

func ParseNetwork 

func ParseNetwork(value string) (models.Network, error)

ParseNetwork - parses a network into a model

func PreAuthCheck added in v1.0.0 

func PreAuthCheck(next http.Handler) http.HandlerFunc

func RandomString 

func RandomString(length int) string

RandomString - returns a random string in a charset

func RelayUpdates 

func RelayUpdates(currentNode, newNode *models.Node) bool

func RelayedAllowedIPs 

func RelayedAllowedIPs(peer, node *models.Node) []net.IPNet

func RemoveAllFromSlice added in v1.2.0 

func RemoveAllFromSlice[T comparable](s []T, val T) []T

RemoveAllFromSlice removes every occurrence of val from s (stable order).

func RemoveAllLegacyNodes 

func RemoveAllLegacyNodes() error

RemoveAllLegacyNodes - fetches all legacy nodes from DB and removes

func RemoveHost 

func RemoveHost(h *models.Host, forceDelete bool) error

RemoveHost - removes a given host from server

func RemoveHostByID 

func RemoveHostByID(hostID string) error

RemoveHostByID - removes a given host by id from server

func RemoveIpFromAllocatedIpMap added in v0.25.0 

func RemoveIpFromAllocatedIpMap(networkName string, ip string)

func RemoveNetworkFromAllocatedIpMap added in v0.25.0 

func RemoveNetworkFromAllocatedIpMap(networkName string)

RemoveNetworkFromAllocatedIpMap - remove network from allocated ip map when network is deleted

func RemoveNodeFromAclPolicy added in v0.90.0 

func RemoveNodeFromAclPolicy(node models.Node)

func RemoveNodeFromEgress added in v0.99.0 

func RemoveNodeFromEgress(node models.Node)

func RemoveStringSlice 

func RemoveStringSlice(slice []string, i int) []string

RemoveStringSlice - removes an element at given index i from a given string slice

func RemoveTagFromEnrollmentKeys added in v0.26.0 

func RemoveTagFromEnrollmentKeys(deletedTagID models.TagID)

func ResetHook added in v1.4.0 

func ResetHook(hookID string)

ResetHook - resets the timer for a hook with the given ID

func RestartHook added in v1.4.0 

func RestartHook(hookID string, newInterval time.Duration)

RestartHook - restarts a hook with the given ID (stops and starts again with same configuration) If newInterval is 0, uses the existing interval. Otherwise, uses the new interval.

func RetrievePrivateTrafficKey 

func RetrievePrivateTrafficKey() ([]byte, error)

RetrievePrivateTrafficKey - retrieves private key of server

func RetrievePublicTrafficKey 

func RetrievePublicTrafficKey() ([]byte, error)

RetrievePublicTrafficKey - retrieves public key of server

func ReturnErrorResponse 

func ReturnErrorResponse(response http.ResponseWriter, request *http.Request, errorMessage models.ErrorResponse)

ReturnErrorResponse - processes error and adds header

func ReturnErrorResponseWithJson added in v1.4.0 

func ReturnErrorResponseWithJson(response http.ResponseWriter, request *http.Request, msg interface{}, errorMessage models.ErrorResponse)

ReturnErrorResponseWithJson - processes error with body and adds header

func ReturnSuccessResponse 

func ReturnSuccessResponse(response http.ResponseWriter, request *http.Request, message string)

ReturnSuccessResponse - processes message and adds header

func ReturnSuccessResponseWithJson added in v0.22.0 

func ReturnSuccessResponseWithJson(response http.ResponseWriter, request *http.Request, res interface{}, message string)

ReturnSuccessResponseWithJson - processes message and adds header

func SaveExtClient 

func SaveExtClient(extclient *models.ExtClient) error

SaveExtClient - saves an ext client to database

func SaveNetwork 

func SaveNetwork(network *models.Network) error

SaveNetwork - save network struct to database

func SecurityCheck 

func SecurityCheck(reqAdmin bool, next http.Handler) http.HandlerFunc

SecurityCheck - Check if user has appropriate permissions

func SetAllocatedIpMap added in v0.25.0 

func SetAllocatedIpMap() error

SetAllocatedIpMap - set allocated ip map for networks

func SetAuthSecret added in v0.24.0 

func SetAuthSecret(secret string) error

func SetCorefile 

func SetCorefile(domains string) error

SetCorefile - sets the core file of the system

func SetDNS 

func SetDNS() error

SetDNS - sets the dns on file

func SetDNSOnWgConfig added in v1.1.0 

func SetDNSOnWgConfig(gwNode *models.Node, extclient *models.ExtClient)

func SetDefaultGw added in v0.23.0 

func SetDefaultGw(node models.Node, peerUpdate models.HostPeerUpdate) models.HostPeerUpdate

func SetDefaultGwForRelayedUpdate added in v0.23.0 

func SetDefaultGwForRelayedUpdate(relayed, relay models.Node, peerUpdate models.HostPeerUpdate) models.HostPeerUpdate

func SetFreeTierForTelemetry 

func SetFreeTierForTelemetry(freeTierFlag bool)

setFreeTierForTelemetry - store free tier flag without having an import cycle when used for telemetry (as the pro package needs the logic package as currently written).

func SetFreeTierLimits 

func SetFreeTierLimits()

SetFreeTierLimits - sets limits for free tier

func SetInternetGw added in v0.22.0 

func SetInternetGw(node *models.Node, req models.InetNodeReq)

SetInternetGw - sets the node as internet gw based on flag bool

func SetJWTSecret 

func SetJWTSecret()

SetJWTSecret - sets the jwt secret on server startup

func SetNetworkNodesLastModified 

func SetNetworkNodesLastModified(networkName string) error

SetNetworkNodesLastModified - sets the network nodes last modified

func SetNodeDefaults 

func SetNodeDefaults(node *models.Node, resetConnected bool)

SetNodeDefaults - sets the defaults of a node to avoid empty fields

func SetRelayedNodes 

func SetRelayedNodes(setRelayed bool, relay string, relayed []string) []models.Node

SetRelayedNodes- sets and saves node as relayed

func SetState 

func SetState(appName, state string) error

SetState - sets a state with new expiration

func SetUserDefaults 

func SetUserDefaults(user *models.User)

SetUserDefaults - sets the defaults of a user to avoid empty fields

func SetVerbosity added in v0.90.0 

func SetVerbosity(logLevel int)

func SortAclEntrys added in v0.26.0 

func SortAclEntrys(acls []models.Acl)

SortTagEntrys - Sorts slice of Tag entries by their id

func SortApiHosts 

func SortApiHosts(unsortedHosts []models.ApiHost)

SortApiHosts - Sorts slice of ApiHosts by their ID alphabetically with numbers first

func SortApiNodes 

func SortApiNodes(unsortedNodes []models.ApiNode)

SortApiNodes - Sorts slice of ApiNodes by their ID alphabetically with numbers first

func SortDNSEntrys 

func SortDNSEntrys(unsortedDNSEntrys []models.DNSEntry)

SortDNSEntrys - Sorts slice of DNSEnteys by their Address alphabetically with numbers first

func SortExtClient 

func SortExtClient(unsortedExtClient []models.ExtClient)

SortExtClient - Sorts slice of ExtClients by their ClientID alphabetically with numbers first

func SortNetworks 

func SortNetworks(unsortedNetworks []models.Network)

SortNetworks - Sorts slice of Networks by their NetID alphabetically with numbers first

func SortUsers 

func SortUsers(unsortedUsers []models.ReturnUser)

SortUsers - Sorts slice of Users by username

func StartCPUProfiling added in v0.26.0 

func StartCPUProfiling() *os.File

func StartHookManager 

func StartHookManager(ctx context.Context, wg *sync.WaitGroup)

StartHookManager - listens on `HookManagerCh` to run any hook and `HookCommandCh` for commands

func StartMemProfiling added in v0.30.0 

func StartMemProfiling()

func StopCPUProfiling added in v0.26.0 

func StopCPUProfiling(f *os.File)

func StopHook added in v1.4.0 

func StopHook(hookID string)

StopHook - stops a hook with the given ID

func StoreJWTSecret 

func StoreJWTSecret(privateKey string) error

StoreJWTSecret - stores server jwt secret if needed

func StringDifference 

func StringDifference(a, b []string) []string

StringDifference - returns the elements in `a` that aren't in `b`.

func StringSliceContains 

func StringSliceContains(slice []string, item string) bool

StringSliceContains - sees if a string slice contains a string element

func Telemetry added in v0.99.0 

func Telemetry() string

Telemetry - checks if telemetry data should be sent

func TimerCheckpoint 

func TimerCheckpoint() error

TimerCheckpoint - Checks if 24 hours has passed since telemetry was last sent. If so, sends telemetry data to posthog

func ToReturnUser 

func ToReturnUser(user models.User) models.ReturnUser

ToReturnUser - gets a user as a return user

func ToggleExtClientConnectivity 

func ToggleExtClientConnectivity(client *models.ExtClient, enable bool) (models.ExtClient, error)

ToggleExtClientConnectivity - enables or disables an ext client

func Tokenize 

func Tokenize(k *models.EnrollmentKey, serverAddr string) error

Tokenize - tokenizes an enrollment key to be used via registration and attaches it to the Token field on the struct

func TryToUseEnrollmentKey 

func TryToUseEnrollmentKey(k *models.EnrollmentKey) bool

TryToUseEnrollmentKey - checks first if key can be decremented returns true if it is decremented or isvalid

func UniqueAclPolicyTags added in v0.99.0 

func UniqueAclPolicyTags(tags []models.AclPolicyTag) []models.AclPolicyTag

func UniqueAddress 

func UniqueAddress(networkName string, reverse bool) (net.IP, error)

func UniqueAddress6 

func UniqueAddress6(networkName string, reverse bool) (net.IP, error)

func UniqueAddress6Cache added in v0.90.0 

func UniqueAddress6Cache(networkName string, reverse bool) (net.IP, error)

UniqueAddress6Cache - see if ipv6 address is unique using cache

func UniqueAddress6DB added in v0.90.0 

func UniqueAddress6DB(networkName string, reverse bool) (net.IP, error)

UniqueAddress6DB - see if ipv6 address is unique

func UniqueAddressCache added in v0.90.0 

func UniqueAddressCache(networkName string, reverse bool) (net.IP, error)

UniqueAddress - get a unique ipv4 address

func UniqueAddressDB added in v0.90.0 

func UniqueAddressDB(networkName string, reverse bool) (net.IP, error)

UniqueAddress - get a unique ipv4 address

func UniqueIPNetList added in v0.90.0 

func UniqueIPNetList(ipnets []net.IPNet) []net.IPNet

func UniqueIPNetStrList added in v0.99.0 

func UniqueIPNetStrList(ipnets []string) []string

UniqueIPNetList deduplicates and sorts a list of CIDR strings.

func UniquePolicies added in v0.99.0 

func UniquePolicies(items []models.Acl) []models.Acl

func UniqueStrings added in v1.0.0 

func UniqueStrings(input []string) []string

func UnlinkNetworkAndTagsFromEnrollmentKeys added in v0.90.0 

func UnlinkNetworkAndTagsFromEnrollmentKeys(network string, delete bool) error

func UnsetInternetGw added in v0.23.0 

func UnsetInternetGw(node *models.Node)

func UpdateAcl added in v0.26.0 

func UpdateAcl(newAcl, acl models.Acl) error

UpdateAcl - updates allowed fields on acls and commits to DB

func UpdateEnrollmentKey added in v0.21.2 

func UpdateEnrollmentKey(keyId string, updates *models.APIEnrollmentKey) (*models.EnrollmentKey, error)

UpdateEnrollmentKey - updates an existing enrollment key's associated relay

func UpdateExtClient 

func UpdateExtClient(old *models.ExtClient, update *models.CustomExtClient) models.ExtClient

UpdateExtClient - updates an ext client with new values

func UpdateHost 

func UpdateHost(newHost, currentHost *models.Host)

UpdateHost - updates host data by field

func UpdateHostFromClient 

func UpdateHostFromClient(newHost, currHost *models.Host) (sendPeerUpdate bool)

UpdateHostFromClient - used for updating host on server with update recieved from client

func UpdateHostNetwork 

func UpdateHostNetwork(h *models.Host, network string, add bool) (*models.Node, error)

UpdateHostNetwork - adds/deletes host from a network

func UpdateHostNode added in v1.2.0 

func UpdateHostNode(h *models.Host, newNode *models.Node) (publishDeletedNodeUpdate, publishPeerUpdate bool)

UpdateHostNode - handles updates from client nodes

func UpdateNetwork 

func UpdateNetwork(currentNetwork *models.Network, newNetwork *models.Network) error

UpdateNetwork - updates a network with another network's fields

func UpdateNode 

func UpdateNode(currentNode *models.Node, newNode *models.Node) error

UpdateNode - takes a node and updates another node with it's values

func UpdateNodeCheckin 

func UpdateNodeCheckin(node *models.Node) error

UpdateNodeCheckin - updates the checkin time of a node

func UpdateRelayNodes added in v1.2.0 

func UpdateRelayNodes(relay string, oldNodes []string, newNodes []string) []models.Node

UpdateRelayNodes - updates relay nodes

func UpdateRelayed 

func UpdateRelayed(currentNode, newNode *models.Node)

UpdateRelayed - updates a relay's relayed nodes, and sends updates to the relayed nodes over MQ

func UpdateUser 

func UpdateUser(userchange, user *models.User) (*models.User, error)

UpdateUser - updates a given user

func UpsertAcl added in v0.26.0 

func UpsertAcl(acl models.Acl) error

UpsertAcl - upserts acl

func UpsertHost 

func UpsertHost(h *models.Host) error

UpsertHost - upserts into DB a given host model, does not check for existence*

func UpsertNetwork added in v1.1.0 

func UpsertNetwork(network models.Network) error

func UpsertNode 

func UpsertNode(newNode *models.Node) error

UpsertNode - updates node in the DB

func UpsertServerSettings added in v0.99.0 

func UpsertServerSettings(s models.ServerSettings) error

func UpsertUser 

func UpsertUser(user models.User) error

UpsertUser - updates user in the db

func UpsertUserSettings added in v1.1.0 

func UpsertUserSettings(userID string, userSettings models.UserSettings) error

func UserPermissions 

func UserPermissions(reqAdmin bool, token string) (string, error)

UserPermissions - checks token stuff

func ValidateAndApproveUserInvite added in v0.25.0 

func ValidateAndApproveUserInvite(email, code string) error

func ValidateCreateAclReq added in v0.26.0 

func ValidateCreateAclReq(req models.Acl) error

ValidateCreateAclReq - validates create req for acl

func ValidateDNSCreate 

func ValidateDNSCreate(entry models.DNSEntry) error

ValidateDNSCreate - checks if an entry is valid

func ValidateDNSUpdate 

func ValidateDNSUpdate(change models.DNSEntry, entry models.DNSEntry) error

ValidateDNSUpdate - validates a DNS update

func ValidateDomain added in v0.99.0 

func ValidateDomain(domain string) bool

func ValidateEgressGateway 

func ValidateEgressGateway(gateway models.EgressGatewayRequest) error

ValidateEgressGateway - validates the egress gateway model

func ValidateEgressRange added in v0.24.3 

func ValidateEgressRange(netID string, ranges []string) error

func ValidateInetGwReq added in v1.0.0 

func ValidateInetGwReq(inetNode models.Node, req models.InetNodeReq, update bool) error

func ValidateNetwork 

func ValidateNetwork(network *models.Network, isUpdate bool) error

Validate - validates fields of an network struct

func ValidateNewSettings added in v0.99.0 

func ValidateNewSettings(req models.ServerSettings) error

func ValidateNode 

func ValidateNode(node *models.Node, isUpdate bool) error

ValidateNode - validates node values

func ValidateNodeIp added in v0.30.0 

func ValidateNodeIp(currentNode *models.Node, newNode *models.ApiNode) error

func ValidateParams added in v0.23.0 

func ValidateParams(nodeid, netid string) (models.Node, error)

func ValidateRelay added in v0.24.0 

func ValidateRelay(relay models.RelayRequest, update bool) error

ValidateRelay - checks if relay is valid

func ValidateUser 

func ValidateUser(user *models.User) error

ValidateUser - validates a user model

func VerifyAuthRequest 

func VerifyAuthRequest(authRequest models.UserAuthParams, appName string) (string, error)

VerifyAuthRequest - verifies an auth request

func VerifyHostToken 

func VerifyHostToken(tokenString string) (hostID string, mac string, network string, err error)

VerifyHostToken - [hosts] Only

func VerifyOTPAuthURL added in v1.0.0 

func VerifyOTPAuthURL(url, signature string) bool

func VerifyUserToken 

func VerifyUserToken(tokenString string) (username string, issuperadmin, isadmin bool, err error)

VerifyUserToken func will used to Verify the JWT Token while using APIS

func VersionLessThan added in v0.30.0 

func VersionLessThan(v1, v2 string) (bool, error)

VersionLessThan checks if v1 < v2 semantically dev is the latest version

func WrapHook added in v1.4.0 

func WrapHook(hook func() error) models.HookFunc

WrapHook - wraps a parameterless hook function to be compatible with HookFunc This allows backward compatibility with existing hooks that don't accept parameters

Types

type ApiErrorType added in v0.99.0 

type ApiErrorType string
const (
	Internal     ApiErrorType = "internal"
	BadReq       ApiErrorType = "badrequest"
	NotFound     ApiErrorType = "notfound"
	UnAuthorized ApiErrorType = "unauthorized"
	Forbidden    ApiErrorType = "forbidden"
)

type GlobalNs added in v1.1.0 

type GlobalNs struct {
	ID  string   `json:"id"`
	IPs []string `json:"ips"`
}

type MetricsMonitor added in v1.2.0 

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

func GetMetricsMonitor added in v1.2.0 

func GetMetricsMonitor() *MetricsMonitor

func (*MetricsMonitor) Start added in v1.2.0 

func (m *MetricsMonitor) Start()

func (*MetricsMonitor) Stop added in v1.2.0 

func (m *MetricsMonitor) Stop()

type OSInfo added in v1.4.0 

type OSInfo struct {
	OS            string `json:"os"`             // e.g. "ubuntu", "windows", "macos"
	OSFamily      string `json:"os_family"`      // e.g. "linux-debian", "windows"
	OSVersion     string `json:"os_version"`     // e.g. "22.04", "10.0.22631"
	KernelVersion string `json:"kernel_version"` // e.g. "6.8.0"
}

func GetOSInfo added in v1.4.0 

func GetOSInfo() OSInfo

GetOSInfo returns OS, OSFamily, OSVersion and KernelVersion for the current platform.

Source Files

View all Source files

Directories

Path Synopsis
nodeacls
pro
netcache

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.