ncutils

Documentation

Overview

Package ncutils contains utility functions

Index

• Constants
• func CheckFirewall()
• func CheckIPAddress(ip string) error
• func CheckWG()
• func ConvHostPassToHash(hostPass string) string
• func ConvertBytesToKey(data []byte) (*[32]byte, error)
• func ConvertKeyToBytes(key *[32]byte) ([]byte, error)
• func Copy(src, dst string) error
• func DNSFormatString(input string) string
• func FileExists(f string) bool
• func GetEmbedded() error
• func GetFileAsString(path string) (string, error)
• func GetFileWithRetry(path string, retryCount int) ([]byte, error)
• func GetFreePort(rangestart, currListenPort int, init bool) (int, error)
• func GetFreeTCPPort() (string, error)
• func GetHomeDirWindows() string
• func GetHostname() string
• func GetIPNetFromString(ip string) (net.IPNet, error)
• func GetInterfaceName() string
• func GetLocalIP(localrange net.IPNet) (*net.IPNet, error)
• func GetMacAddr() ([]net.HardwareAddr, error)
• func GetNetworkIPMask(networkstring string) (string, string, error)
• func GetNewIface(dir string) (string, error)
• func GetPublicIP(api string) (net.IP, error)
• func GetPublicIPv6() (net.IP, error)
• func GetSeparator() string
• func GetWireGuard() string
• func HasWG() bool
• func HasWgQuick() bool
• func IPIsPrivate(ipnet net.IP) bool
• func InterfaceExists(ifaceName string) (bool, error)
• func IsBridgeNetwork(ifaceName string) bool
• func IsEmptyRecord(err error) bool
• func IsFreeBSD() bool
• func IsIPTablesPresent() bool
• func IsKernel() bool
• func IsLinux() bool
• func IsMac() bool
• func IsNFTablesPresent() bool
• func IsPortFree(port int) (free bool)
• func IsWindows() bool
• func RandomMacAddress() net.HardwareAddr
• func RandomString(length int) string
• func ReadPID() (int, error)
• func RunCmd(command string, printerr bool) (string, error)
• func RunCmdFormatted(command string, printerr bool) (string, error)
• func RunCmds(commands []string, printerr bool) error
• func SavePID() error
• func ServerAddrSliceContains(slice []models.ServerAddr, item models.ServerAddr) bool
• func SetInterfaceName(iface string)
• func ShortenString(input string, length int) string
• type WindowsPIDError
  • func (*WindowsPIDError) Error() string

Constants

const DefaultGCPercent = 10

DefaultGCPercent - garbage collection percent

const KeySize = 2048

KeySize = ideal length for keys

const MaxNameLength = 62

MaxNameLength - maximum node name length

const NetclientDefaultPort = 51821

NetclientDefaultPort - default port

const NoDBRecord = "no result found"

NoDBRecord - error message result

const NoDBRecords = "could not find any records"

NoDBRecords - error record result

const PidFile = "/var/run/netclient.pid"

PidFile - path/name of pid file

const WindowsSvcName = "netclient"

WindowsSvcName - service name

Functions

func CheckFirewall

func CheckFirewall()

CheckFirewall - checks if iptables of nft install, if not exit

func CheckIPAddress

func CheckIPAddress(ip string) error

func CheckWG

func CheckWG()

CheckWG - Checks if WireGuard is installed. If not, exit

func ConvHostPassToHash

func ConvHostPassToHash(hostPass string) string

ConvHostPassToHash - converts password to md5 hash

func ConvertBytesToKey

func ConvertBytesToKey(data []byte) (*[32]byte, error)

ConvertBytesToKey - util to convert bytes to a key to use elsewhere

func ConvertKeyToBytes

func ConvertKeyToBytes(key *[32]byte) ([]byte, error)

ConvertKeyToBytes - util to convert a key to bytes to use elsewhere

func Copy

func Copy(src, dst string) error

Copy - copies a src file to dest

func DNSFormatString

func DNSFormatString(input string) string

DNSFormatString - Formats a string with correct usage for DNS

func FileExists

func FileExists(f string) bool

FileExists - checks if file exists locally

func GetEmbedded

func GetEmbedded() error

GetEmbedded - if files required for linux, put here

func GetFileAsString

func GetFileAsString(path string) (string, error)

GetFileAsString - returns the string contents of a given file

func GetFileWithRetry

func GetFileWithRetry(path string, retryCount int) ([]byte, error)

GetFileWithRetry - retry getting file X number of times before failing

func GetFreePort

func GetFreePort(rangestart, currListenPort int, init bool) (int, error)

GetFreePort - gets free port of machine

func GetFreeTCPPort

func GetFreeTCPPort() (string, error)

GetFreeTCPPort - gets free TCP port

func GetHomeDirWindows

func GetHomeDirWindows() string

GetHomeDirWindows - gets home directory in windows

func GetHostname

func GetHostname() string

GetHostname - Gets hostname of machine

func GetIPNetFromString

func GetIPNetFromString(ip string) (net.IPNet, error)

func GetInterfaceName

func GetInterfaceName() string

GetInterfaceName - fetches the interface name

func GetLocalIP

func GetLocalIP(localrange net.IPNet) (*net.IPNet, error)

GetLocalIP - gets local ip of machine returns first interface that is up, is not a loopback and is

func GetMacAddr

func GetMacAddr() ([]net.HardwareAddr, error)

GetMacAddr - get's mac address

func GetNetworkIPMask

func GetNetworkIPMask(networkstring string) (string, string, error)

GetNetworkIPMask - Pulls the netmask out of the network

func GetNewIface

func GetNewIface(dir string) (string, error)

GetNewIface - Gets the name of the real interface created on Mac

func GetPublicIP

func GetPublicIP(api string) (net.IP, error)

GetPublicIP - gets public ip

func GetPublicIPv6

func GetPublicIPv6() (net.IP, error)

GetPublicIPv6 - gets public ipv6 address

func GetSeparator

func GetSeparator() string

GetSeparator - gets the separator for OS

func GetWireGuard

func GetWireGuard() string

GetWireGuard - checks if wg is installed

func HasWG

func HasWG() bool

HasWG - returns true if wg command exists

func HasWgQuick

func HasWgQuick() bool

HasWgQuick - checks if WGQuick command is present

func IPIsPrivate

func IPIsPrivate(ipnet net.IP) bool

func InterfaceExists

func InterfaceExists(ifaceName string) (bool, error)

InterfaceExists - checks if iface exists already

func IsBridgeNetwork

func IsBridgeNetwork(ifaceName string) bool

IsBridgeNetwork - check if the interface is a bridge type

func IsEmptyRecord

func IsEmptyRecord(err error) bool

IsEmptyRecord - repeat from database

func IsFreeBSD

func IsFreeBSD() bool

IsFreeBSD - checks if is freebsd

func IsIPTablesPresent

func IsIPTablesPresent() bool

IsIPTablesPresent - returns true if iptables is present, false otherwise Does not consider OS, up to the caller to determine if the OS supports iptables/whether this check is valid.

func IsKernel

func IsKernel() bool

IsKernel - checks if running kernel WireGuard

func IsLinux

func IsLinux() bool

IsLinux - checks if is linux

func IsMac

func IsMac() bool

IsMac - checks if is a mac

func IsNFTablesPresent

func IsNFTablesPresent() bool

IsNFTablesPresent - returns true if nftables is present, false otherwise. Does not consider OS, up to the caller to determine if the OS supports nftables/whether this check is valid.

func IsPortFree

func IsPortFree(port int) (free bool)

IsPortFree - checks if port is free

func IsWindows

func IsWindows() bool

IsWindows - checks if is windows

func RandomMacAddress

func RandomMacAddress() net.HardwareAddr

RandomMacAddress returns a random macaddress

func RandomString

func RandomString(length int) string

RandomString - returns a random string in a charset

func ReadPID

func ReadPID() (int, error)

ReadPID - reads a previously saved pid from disk

func RunCmd

func RunCmd(command string, printerr bool) (string, error)

RunCmd - runs a local command

func RunCmdFormatted

func RunCmdFormatted(command string, printerr bool) (string, error)

RunCmdFormatted - does nothing for linux

func RunCmds

func RunCmds(commands []string, printerr bool) error

RunCmds - runs cmds

func SavePID

func SavePID() error

SavePID - saves the pid of running program to disk

func ServerAddrSliceContains

func ServerAddrSliceContains(slice []models.ServerAddr, item models.ServerAddr) bool

ServerAddrSliceContains - sees if a string slice contains a string element

func SetInterfaceName

func SetInterfaceName(iface string)

func ShortenString

func ShortenString(input string, length int) string

ShortenString - Brings string down to specified length. Stops names from being too long

Types

type WindowsPIDError

type WindowsPIDError struct{}

WindowsPIDError - error returned from pid function on windows

func (*WindowsPIDError) Error

func (*WindowsPIDError) Error() string

Error generates error for windows os