v1

type AdminConfig struct {
	// Name of the server. Default is "default-stunnerd".
	Name string `json:"name,omitempty"`
	// LogLevel is the desired log verbosity, e.g.: "stunner:TRACE,all:INFO". Default is
	// "all:INFO".
	LogLevel string `json:"loglevel,omitempty"`
	// MetricsEndpoint is the URI in the form `http://address:port/path` at which HTTP metric
	// requests are served. The scheme (`http://`") is mandatory. Default is to expose no
	// metric endpoints.
	MetricsEndpoint string `json:"metrics_endpoint,omitempty"`
	// HealthCheckEndpoint is the URI of the form `http://address:port` exposed for external
	// HTTP health-checking. A liveness probe responder will be exposed on path `/live` and
	// readiness probe on path `/ready`. The scheme (`http://`) is mandatory, and if no port is
	// specified then the default port is 8086. If ignored, then the default is to enable
	// health-checking at `http://:8086`. Set to a pointer to an empty string to disable
	// health-checking.
	HealthCheckEndpoint *string `json:"healthcheck_endpoint,omitempty"`
	// UserQuota defines the number of permitted TURN allocatoins per username. Affects
	// allocation created on any listener. Default is 0, meaning no quota is enforced.
	UserQuota int `json:"user_quota,omitempty"`
	// OffloadEngine defines the dataplane offload mode, either "None", "XDP", "TC", or
	// "Auto". Set to "Auto" to let STUNner find the optimal offload mode. Default is "None".
	OffloadEngine string `json:"offload_engine,omitempty"`
	// OffloadInterfaces explicitly specifies the interfaces on which to enable the offload
	// engine. Empty list means to enable offload on all interfaces (this is the default).
	OffloadInterfaces []string `json:"offload_interfaces,omitempty"`
	// LicenseConfig describes the licensing info to be used to check subscription status with
	// the license server.
	LicenseConfig *LicenseConfig `json:"license_config,omitempty"`
}

type AdminStatus struct {
	Name                string `json:"name,omitempty"`
	LogLevel            string `json:"loglevel,omitempty"`
	MetricsEndpoint     string `json:"metrics_endpoint,omitempty"`
	HealthCheckEndpoint string `json:"healthcheck_endpoint,omitempty"`
	UserQuota           string `json:"quota,omitempty"`
	OffloadStatus       string `json:"offload,omitempty"`
	LicensingInfo       string `json:"licensing_info,omitempty"`
}

type AuthConfig struct {
	// Type of the STUN/TURN authentication mechanism ("static" or "ephemeral"). The deprecated
	// type name "plaintext" is accepted for "static" and the deprecated type name "longterm"
	// is accepted for "ephemeral" for compatibility with older versions.
	Type string `json:"type,omitempty"`
	// Realm defines the STUN/TURN authentication realm.
	Realm string `json:"realm,omitempty"`
	// Credentials specifies the authententication credentials: for "static" at least the keys
	// "username" and "password" must be set, for "ephemeral" the key "secret" specifying the
	// shared authentication secret must be set.
	Credentials map[string]string `json:"credentials"`
}

type AuthStatus = AuthConfig

type AuthType int

type ClusterConfig struct {
	// Name of the cluster. Name is mandatory.
	Name string `json:"name"`
	// Type specifies the cluster address resolution policy, either STATIC or
	// STRICT_DNS. Default is "STATIC".
	Type string `json:"type,omitempty"`
	// Protocol specifies the protocol to be used with the cluster, either UDP (default) or TCP
	// (not implemented yet).
	Protocol string `json:"protocol,omitempty"`
	// Endpoints specifies the peers that can be reached via this cluster.
	Endpoints []string `json:"endpoints,omitempty"`
}

type ClusterProtocol int

type ClusterStatus struct {
	*ClusterConfig
	Stats OffloadDirStat `json:"stats"`
}

type ClusterType int

type Config interface {
	// Validate checks a configuration and injects defaults.
	Validate() error
	// Name returns the name of the object to be configured.
	ConfigName() string
	// DeepEqual compares two configurations.
	DeepEqual(other Config) bool
	// DeepCopyInto copies a configuration.
	DeepCopyInto(dst Config)
	// String stringifies the configuration.
	String() string
}

type ErrRestarted struct {
	Objects []string
}

type LicenseConfig struct {
	// Key is a comma-separated list of unlocked features plus a time-window during which the
	// key is considered valid.
	Key string `json:"key"`
	// HMAC is a hash-based message authentication code for validating the license key.
	HMAC string `json:"hmac"`
}

type LicenseStatus struct {
	EnabledFeatures  []string `json:"enabledFeatures"`
	SubscriptionType string   `json:"subscriptionType"`
	LastUpdated      string   `json:"lastUpdated"`
	LastError        string   `json:"lastError"`
}

type ListenerConfig struct {
	// Name of the listener.
	Name string `json:"name,omitempty"`
	// Protocol is the transport protocol ("UDP", "TCP", "TLS", "DTLS") or the complete L4/L7
	// protocol stack ("TURN-UDP", "TURN-TCP", "TURN-TLS", "TURN-DTLS") used by the listener.
	// The application-layer protocol on top of the transport protocol is always TURN, so "UDP"
	// and "TURN-UDP" are equivalent (and so on for the other protocols). Default is
	// "TURN-UDP".
	Protocol string `json:"protocol,omitempty"`
	// PublicAddr is the Internet-facing public IP address for the listener (ignored by
	// STUNner).
	PublicAddr string `json:"public_address,omitempty"`
	// PublicPort is the Internet-facing public port for the listener (ignored by STUNner).
	PublicPort int `json:"public_port,omitempty"`
	// Addr is the IP address for the listener. Default is localhost.
	Addr string `json:"address,omitempty"`
	// Port is the port for the listener. Default is the standard TURN port (3478).
	Port int `json:"port,omitempty"`
	// Cert is the base64-encoded TLS cert.
	Cert string `json:"cert,omitempty"`
	// Key is the base64-encoded TLS key.
	Key string `json:"key,omitempty"`
	// Routes specifies the list of Routes allowed via a listener.
	Routes []string `json:"routes,omitempty"`
}

type ListenerProtocol int

type ListenerStatus struct {
	*ListenerConfig
	Stats OffloadDirStat `json:"stats"`
}

type OffloadDirStat struct {
	Rx OffloadStatInfo `json:"rx"`
	Tx OffloadStatInfo `json:"tx"`
}

type OffloadMode int

type OffloadStatInfo struct {
	Pkts          uint64 `json:"pkts"`
	Bytes         uint64 `json:"bytes"`
	TimestampLast uint64 `json:"timestamp"`
}

type StatType int

type Status interface {
	// String stringifies the status.
	String() string
}

type StunnerConfig struct {
	// ApiVersion is the version of the STUNner API implemented. Must be set to "v1".
	ApiVersion string `json:"version"`
	// AdminConfig holds administrative configuration.
	Admin AdminConfig `json:"admin,omitempty"`
	// Auth defines the STUN/TURN authentication mechanism.
	Auth AuthConfig `json:"auth"`
	// Listeners defines the server sockets exposed to clients.
	Listeners []ListenerConfig `json:"listeners,omitempty"`
	// Clusters defines the upstream endpoints to which relay transport connections can be made
	// by clients.
	Clusters []ClusterConfig `json:"clusters,omitempty"`
}

type StunnerStatus struct {
	ApiVersion      string            `json:"version"`
	Admin           *AdminStatus      `json:"admin"`
	Auth            *AuthStatus       `json:"auth"`
	Listeners       []*ListenerStatus `json:"listeners"`
	Clusters        []*ClusterStatus  `json:"clusters"`
	AllocationCount int               `json:"allocationCount"`
	Status          string            `json:"status"`
}