Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BlueprintResult ¶
type BrowserGatewayTarget ¶
type Config ¶
type Config struct {
// Build info
Version string
Platform string
Agent string
AgentVersion string
// Logging
LogLevel string
// Connection
Endpoint string
ID string
Secret string
ProvisioningKey string
NewtName string
ConfigFile string
// Network
MTU int
DNS string
InterfaceName string
Port uint16
UseNativeInterface bool
UseNativeMainInterface bool
NativeMainInterfaceName string
NoCloud bool
PreferEndpoint string
LocalEndpointInterfaces []string
// Timing
PingInterval time.Duration
PingTimeout time.Duration
UDPProxyIdleTimeout time.Duration
// Features
DisableClients bool
DisableSSH bool
EnforceHealthcheckCert bool
HealthFile string
BlueprintFile string
ProvisioningBlueprintFile string
UpdownScript string
// Docker
DockerSocket string
DockerEnforceNetworkValidation bool
// Auth daemon
AuthDaemonKey string
AuthDaemonPrincipalsFile string
AuthDaemonCACertPath string
AuthDaemonGenerateRandomPassword bool
// TLS (mTLS)
TLSClientCert string
TLSClientKey string
TLSClientCAs []string
TLSPrivateKey string
// Metrics/observability
MetricsEnabled bool
OTLPEnabled bool
AdminAddr string
Region string
MetricsAsyncBytes bool
PprofEnabled bool
// Callbacks
OnRestart func() error
}
Config holds all runtime configuration for a Newt instance.
type ExitNode ¶
ExitNodeData, ExitNode and ExitNodePingResult are aliases for the shared exit-node ping dance types in package exitnode, kept here so existing code in this package can keep referring to them unqualified.
type ExitNodeData ¶
type ExitNodeData = exitnode.ExitNodeData
ExitNodeData, ExitNode and ExitNodePingResult are aliases for the shared exit-node ping dance types in package exitnode, kept here so existing code in this package can keep referring to them unqualified.
type ExitNodePingResult ¶
type ExitNodePingResult = exitnode.ExitNodePingResult
ExitNodeData, ExitNode and ExitNodePingResult are aliases for the shared exit-node ping dance types in package exitnode, kept here so existing code in this package can keep referring to them unqualified.
type Newt ¶
type Newt struct {
// contains filtered or unexported fields
}
Newt holds all runtime state for a newt tunnel instance.
func Init ¶
Init creates and initialises a Newt instance. It sets up the websocket client, generates WireGuard keys, and starts the auth daemon if enabled. Callers should invoke Start after any additional setup (telemetry, etc.).
func (*Newt) Close ¶
func (n *Newt) Close()
Close performs an emergency shutdown: closes the tunnel, clients, health monitor, and websocket connection. Typically used before re-exec.
func (*Newt) GetTLSClientOpt ¶
func (n *Newt) GetTLSClientOpt() websocket.ClientOption
GetTLSClientOpt returns the websocket TLS option, so callers can reuse the same TLS configuration for other HTTP clients (e.g. self-update).
type SyncData ¶
type SyncData struct {
Targets TargetsByType `json:"proxyTargets"`
HealthCheckTargets []healthcheck.Config `json:"healthCheckTargets"`
RemoteExitNodeSubnets []string `json:"remoteExitNodeSubnets"`
Peers []wgclients.Peer `json:"peers"`
ClientTargets []wgclients.Target `json:"clientTargets"`
Certs []wgclients.CertData `json:"certs"`
BrowserGatewayTargets []BrowserGatewayTarget `json:"browserGatewayTargets"`
}
Define the sync data structure
type TargetData ¶
type TargetData struct {
Targets []string `json:"targets"`
}
type TargetsByType ¶
type WgData ¶
type WgData struct {
Endpoint string `json:"endpoint"`
RelayPort uint16 `json:"relayPort"`
PublicKey string `json:"publicKey"`
ServerIP string `json:"serverIP"`
TunnelIP string `json:"tunnelIP"`
Targets TargetsByType `json:"targets"`
HealthCheckTargets []healthcheck.Config `json:"healthCheckTargets"`
BrowserGatewayTargets []BrowserGatewayTarget `json:"browserGatewayTargets"`
RemoteExitNodeSubnets []string `json:"remoteExitNodeSubnets"`
ChainId string `json:"chainId"`
}