# Functions
FormatBool converts a boolean to a [yes|no] string.
GenerateNodeName - generates a random node name.
No description provided by the author
No description provided by the author
IsIpv4Net - check for valid IPv4 address Note: We dont handle IPv6 AT ALL!!!!! This definitely is needed at some point But for iteration 1, lets just stick to IPv4.
ParseBool parses a [yes|no] string to boolean value.
RetrieveLogo - retrieves the ascii art logo for Netmaker.
SetLogo - sets the logo ascii art.
StringWithCharset - returns random string inside defined charset.
# Constants
Acknowledgement - ACK response for hosts.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CheckIn - update last check in times and public address and interfaces.
ConnNegotiation - action to negotiate connection between peers.
DefaultExpDuration - the default expiration time of SsoState.
WIREGUARD_INTERFACE name of wireguard interface.
DeleteHost - constant for host delete action.
DNSDeleteByIP delete the dns entry.
DNSDeleteByName delete the dns entry.
DNSInsert insert a new dns entry.
DNSReplaceIP resplace the dns entry.
DNSReplaceName replace the dns entry.
No description provided by the author
No description provided by the author
EnrollmentKeyLength - the length of an enrollment key - 62^16 unique possibilities.
No description provided by the author
No description provided by the author
No description provided by the author
FIREWALL_IPTABLES - indicates that iptables is the firewall in use.
FIREWALL_NFTABLES - indicates nftables is in use (Linux only).
FIREWALL_NONE - indicates that no supported firewall in use.
No description provided by the author
No description provided by the author
JoinHostToNetwork - constant for host network join action.
MAX_NAME_LENGTH - max name length of node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
== ACTIONS == (can only be set by server) NODE_DELETE - delete node action.
NODE_FORCE_UPDATE - indicates a node should pull all changes.
NODE_IS_PENDING - node pending status.
NODE_NOOP - node no op action.
NODE_SERVER_NAME - the default server name.
PLACEHOLDER_KEY_TEXT - access key placeholder text if option turned off.
PLACEHOLDER_TOKEN_TEXT - access key token placeholder text if option turned off.
No description provided by the author
RelayME - action to relay the peer.
No description provided by the author
No description provided by the author
RequestAck - request an ACK.
RequestPull - request a pull from a host.
No description provided by the author
No description provided by the author
SignalHost - const for host signal action.
SignalPull - request a pull from a host without restart.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UpdateHost - constant for host update action.
UpdateKeys - update wireguard private/public keys.
UpdateMetrics - updates metrics data.
Upgrade - const to request host to update it's client.
No description provided by the author
No description provided by the author
WIREGUARD_INTERFACE name of wireguard interface.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NAMES - list of names 4-7 chars in length.
NAT_Types - the type of NAT in which a HOST currently resides (simplified).
No description provided by the author
OS_Types - list of OS types Netmaker cares about.
No description provided by the author
SMALL_NAMES - list of small (4 char or less) names.
# Structs
AccessToken - token used to access netmaker.
APIEnrollmentKey - used to create enrollment keys via API.
ApiHost - the host struct for API usage.
ApiIface - the interface struct for API usage The original Iface struct contains a net.Address, which does not get marshalled correctly.
ApiNode is a stripped down Node DTO that exposes only required fields to external systems.
AuthParams - struct for auth params.
CheckInResponse - checkin response.
Claims is a struct that will be encoded to a JWT.
ClientConfig - the config of the client.
CommonNode - represents a commonn node data elements shared by netmaker and netclient.
No description provided by the author
CustomExtClient - struct for CustomExtClient params.
No description provided by the author
DisplayKey - what is displayed for key.
DNSEntry - a DNS entry represented as struct.
DNSError error struct capable of holding multiple error messages.
DNSUpdate data for updating entries in /etc/hosts.
EgressGatewayRequest - egress gateway request.
EgressInfo - struct for egress info.
EgressNetworkRoutes - struct for egress network routes for adding routes to peer's interface.
EnrollmentKey - the key used to register hosts and join them to specific networks.
EnrollmentToken - the tokenized version of an enrollmentkey; to be used for host registration.
ErrorResponse is struct for error.
ExtClient - struct for external clients.
ExtClientInfo - struct for ext.
ExtPeersResponse - ext peers response.
FailOverMeReq - struct for failover req.
No description provided by the author
FwUpdate - struct for firewall updates.
No description provided by the author
GlobalConfig - global config.
HookDetails - struct to hold hook info.
Host - represents a host on the network.
HostNetworkInfo - holds info related to host networking (used for client side peer calculations).
HostPeerUpdate - struct for host peer updates.
HostPull - response of a host's pull.
HostRelayRequest - struct for host relay creation.
HostTurnRegister - struct for host turn registration.
HostUpdate - struct for host update.
IDandAddr - struct to hold ID and primary Address.
Iface struct for local interfaces of a node.
InetNodeReq - exit node request struct.
IngressGwUsers - struct to hold users on a ingress gw.
IngressInfo - struct for ingress info.
IngressRequest - ingress request struct.
No description provided by the author
No description provided by the author
JoinData - struct to hold data required for node to join a network on server.
KeyUpdate - key update struct.
LegacyNode - legacy struct for node model.
LicenseLimits - struct license limits.
No description provided by the author
Metric - holds a metric for data between nodes.
Metrics - metrics struct.
MigrationData struct needed to create new v0.18.0 node from v.0.17.X node.
Network Struct - contains info for a given unique network At some point, need to replace all instances of Name with something else like Identifier.
NetworkMetrics - metrics model for all nodes in a network.
Node - a model of a network node.
NodeAuth - struct for node auth.
NodeCheckin - struct for node checkins with server.
NodeGet - struct for a single node get response.
NodeJoinResponse data returned to node in response to join.
PeerRouteInfo - struct for peer info for an ext.
PeersResponse - peers response.
RegisterMsg - login message struct for hosts to join via SSO login.
RegisterResponse - the response to a successful enrollment register.
RelayRequest - relay request struct.
ReturnUser - return user struct.
No description provided by the author
No description provided by the author
No description provided by the author
SaveData - sensitive fields of a network that should be kept the same.
ServerAddr - to pass to clients to tell server addresses and if it's the leader or not.
ServerConfig - struct for dealing with the server information for a netclient.
ServerIDs - struct to hold server ids.
ServerUpdateData - contains data to configure server and if it should set peers.
Signal - struct for signalling peer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SsoState - holds SSO sign-in session data.
SuccessfulLoginResponse is struct to send the request response.
SuccessfulUserLoginResponse - successlogin struct.
SuccessResponse is struct for sending error message with code.
Telemetry - contains UUID of the server and timestamp of last send to posthog also contains assymetrical encryption pub/priv keys for any server traffic.
No description provided by the author
TrafficKeys - struct to hold public keys.
User struct - struct for Users.
UserAuthParams - user auth params struct.
UserClaims - user claims struct.
No description provided by the author
UserInvite - model for user invite.
UserRemoteGws - struct to hold user's remote gws.
UserRemoteGwsReq - struct to hold user remote acccess gws req.
No description provided by the author
# Type aliases
No description provided by the author
DNSUpdateAction identifies the action to be performed with the dns update data.
No description provided by the author
No description provided by the author
HostInfoMap - map of host public keys to host networking info.
HostMqAction - type for host update action.
KeyType - the type of enrollment key.
MetricsMap - map for holding multiple metrics in memory.
No description provided by the author
NodesArray - used for node sorting.
PeerMap - peer map for ids and addresses in metrics.
No description provided by the author
No description provided by the author
SignalAction - turn peer signal action.
No description provided by the author
No description provided by the author