spokes

type APIKey struct {
	ID          UID       `json:"id"`
	Created     time.Time `json:"created"`
	Modified    time.Time `json:"modified"`
	Active      bool      `json:"active"`
	Description string    `json:"description"`
	Value       string    `json:"value"`
}

type AuthPageOptions struct {
	Title   string `json:"title,omitempty"`
	LogoURL string `json:"logoURL,omitempty"`
	SiteURL string `json:"siteURL,omitempty"`
}

type AuthRequest struct {
	Key     string `json:"key"`
	Version string `json:"version,omitempty"`
	OS      string `json:"os,omitempty"`
	Arch    string `json:"arch,omitempty"`
}

type BandwidthRequest struct {
	UserID UID `json:"userID"`
	Max    int `json:"max"` // MB, e.g. 1000 == 1 Gigabyte
}

type BasicResponse struct {
	Status  bool   `json:"status"`
	Message string `json:"message,omitempty"`
	Error   string `json:"error,omitempty"`
}

type ByteSize int64

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

type ConnMetric struct {
	ID          UID       `json:"id"`
	TunnelID    UID       `json:"tunID"`
	ServiceID   UID       `json:"serviceID"` // unique ID for http/port service
	Service     uint16    `json:"service"`   // indicates the service type
	Address     string    `json:"address"`   // ip address of client
	Bandwidth   int64     `json:"bandwidth"` // read + write
	Established time.Time `json:"established"`
	Closed      time.Time `json:"closed"`

	// Runtime field
	ServerName string `json:"-"`
	Port       uint16 `json:"-"`
}

type CreateTokenRequest struct {
	Description string `json:"description"`
	Active      bool   `json:"active"`
}

type CreateTunRequest struct {
	UserID   UID    `json:"userID"`
	TunID    UID    `json:"tunID"`
	Name     string `json:"name"`
	Hostname string `json:"hostname"`
}

type DataUsage struct {
	Daily   ByteSize `json:"daily"`   // bytes
	Monthly ByteSize `json:"monthly"` // bytes
}

type DomainLimits struct {
	Allowed []string `json:"allowed"`
}

type DomainRequest struct {
	UserID  UID      `json:"userID"`
	Domains []string `json:"domains"`
}

type DomainResponse struct {
	Status  bool     `json:"status"`
	Error   string   `json:"error,omitempty"`
	Domains []string `json:"domains"`
}

type EditTokenRequest struct {
	TokenID     UID    `json:"tokenID"`
	Description string `json:"description"`
	Active      bool   `json:"active"`
}

type FwRule struct {
	Sequence int    `json:"sequence"`
	Action   string `json:"action"`
	Network  string `json:"network"`
}

type FwRuleList []FwRule

type Http struct {
	Domain           string           `json:"domain,omitempty"`           // domain request, e.g. example.com
	Secure           bool             `json:"secure,omitempty"`           // indicates http (80) and/or https (443)
	Destination      string           `json:"destination,omitempty"`      // forward to this host/address
	Port             int              `json:"port,omitempty"`             // port to forward on
	TLS              int              `json:"tls,omitempty"`              // port to forward to for TLS
	UpstreamURL      string           `json:"upstreamURL,omitempty"`      // upstream service addressed w/URL, e.g. http://127.0.0.1:8080
	WebRoot          string           `json:"webRoot,omitempty"`          // static document root to serve content
	UseLetsEnc       bool             `json:"useLetsEnc,omitempty"`       // use lets-encrypt for TLS certificates
	CA               string           `json:"ca,omitempty"`               // path to custom certificate authority
	PrivateKey       string           `json:"privateKey,omitempty"`       // path to custom privacy key
	Firewall         FwRuleList       `json:"firewall,omitempty"`         // list of firewall rules
	Redirect         bool             `json:"redirect,omitempty"`         // redirect to https
	Password         string           `json:"password,omitempty"`         // salted-hash of password to permit traffic
	Requires2FA      bool             `json:"requires2FA,omitempty"`      // indicates 2FA is used for authentication
	BasicHTTPAuth    string           `json:"basicHttpAuth,omitempty"`    // salted-hash of user:password (HTTP basic auth) to permit traffic
	RedirectURL      string           `json:"redirectURL,omitempty"`      // redirect all requests to URL
	RewriteHost      string           `json:"rewriteHost,omitempty"`      // modify host header with this value
	InsecureUpstream bool             `json:"insecureUpstream,omitempty"` // accept insecure TLS upstream servers
	AuthPageOpts     *AuthPageOptions `json:"authPageOpts,omitempty"`     // customization options for authentication pages
}

type HttpService struct {
	ID         UID       `json:"id"`
	UserID     UID       `json:"userID"`
	TunID      UID       `json:"tunID"`
	Active     bool      `json:"active"`
	Available  bool      `json:"available"`
	Secure     bool      `json:"secure"` // true == https, false == http
	DomainName string    `json:"domainName"`
	Bandwidth  DataUsage `json:"bandwidth"`
}

type LicenseInfoResponse struct {
	Status     bool      `json:"status"`
	Error      string    `json:"error,omitempty"`
	MaxTunnels int       `json:"maxTunnels"`
	Expires    time.Time `json:"expires"`
}

type Port struct {
	Port        int        `json:"port,omitempty"`        // port used by servers, e.g. 22001 (for ssh)
	Destination string     `json:"destination,omitempty"` // forward to this host/address
	DstPort     int        `json:"dstPort,omitempty"`     // port to forward to
	Firewall    FwRuleList `json:"firewall,omitempty"`    // list of firewall rules
}

type PortMap struct {
	ListenPort  int    `json:"listenPort"`
	DstPort     int    `json:"dstPort"`
	Destination string `json:"destination"`     // hostname, IP address
	Transport   string `json:"transport"`       // tcp, udp
	Label       string `json:"label,omitempty"` // e.g. ssh, smtp, docker
	HTTP        bool   `json:"http,omitempty"`  // flag indicates http traffic
}

type PortRange struct {
	Begin int `json:"begin"`
	End   int `json:"end"`
}

type PortRangeResponse struct {
	Status bool      `json:"status"`
	Error  string    `json:"error,omitempty"`
	Range  PortRange `json:"range"`
}

type PortResponse struct {
	Status bool       `json:"status"`
	Error  string     `json:"error,omitempty"`
	Ports  []*PortTun `json:"ports"`
}

type PortService struct {
	ID        UID       `json:"id"`
	UserID    UID       `json:"userID"`
	TunID     UID       `json:"tunID"`
	Active    bool      `json:"active"`
	Available bool      `json:"available"`
	Protocol  uint16    `json:"protocol"`  // tcp/udp
	Port      int       `json:"port"`      // port used by servers, e.g. 22001 (for ssh)
	Bandwidth DataUsage `json:"bandwidth"` // bandwidth stats
	Label     string    `json:"label"`     // e.g. ssh, smtp, docker
}

type PortTun struct {
	Port  int `json:"port"`
	TunID UID `json:"tunID"`
}

type RemoveHTTPRequest struct {
	Domains []string `json:"domains"`
}

type RemovePortMapRequest struct {
	ListenPorts []int `json:"listenPorts"`
}

type ResetPortRequest struct {
	Ports []int `json:"ports"`
}

type SearchTunRequest struct {
	Term    string `json:"term"`
	OS      string `json:"os"`
	Arch    string `json:"arch"`
	Version string `json:"version"`
}

type ServerInfoResponse struct {
	Status            bool      `json:"status"`
	Message           string    `json:"message,omitempty"`
	Error             string    `json:"error,omitempty"`
	Version           string    `json:"version"`
	Uptime            int       `json:"uptime"`
	Alerts            int       `json:"alerts"`
	ActiveTuns        int       `json:"activeTuns"`
	OnlineTuns        int       `json:"onlineTuns"`
	MaxTuns           int       `json:"maxTuns"`
	LicenseExpiration time.Time `json:"licenseExpires,omitempty"`
}

type TokenRequest struct {
	TokenID UID `json:"tokenID"`
}

type TokenResponse struct {
	Status bool   `json:"status"`
	Error  string `json:"error,omitempty"`

	// List token operations (registration, auth)
	Tokens []*APIKey `json:"tokens,omitempty"`

	// Create (registration, authtoken token response
	Token *APIKey `json:"token,omitempty"`
}

type TunConfig struct {
	// Extra fields that exist in the client configuration so we can
	// rebuild client configurations when required.
	Hostname   string `json:"hostname,omitempty"`
	ServerKey  string `json:"serverKey,omitempty"`
	ServerHost string `json:"serverHost,omitempty"`
	Unmanaged  bool   `json:"unmanaged,omitempty"`
	Key        string `json:"key,omitempty"`

	// Original fields in the Spokes Admin API.
	Version      string     `json:"version,omitempty"`
	OS           string     `json:"os,omitempty"`
	Arch         string     `json:"arch,omitempty"`
	Https        []*Http    `json:"https,omitempty"`
	Ports        []*Port    `json:"ports,omitempty"`
	PortMappings []*PortMap `json:"portmaps,omitempty"`
}

type TunConfigResponse struct {
	Status bool       `json:"status"`
	Error  string     `json:"error,omitempty"`
	Config *TunConfig `json:"config"`
}

type TunRequest struct {
	TunID UID `json:"tunnelID"`
}

type TunRespLink struct {
	UID   string `json:"uid"`
	Order int    `json:"order"`
	Count int    `json:"count"`
	URL   string `json:"url"`
}

type TunResponse struct {
	Status bool   `json:"status"`
	Error  string `json:"error"`

	// List of tunnels (all, active, online)
	Total   int            `json:"total,omitempty"`
	Tunnels []*Tunnel      `json:"tunnels,omitempty"`
	Links   []*TunRespLink `json:"links,omitempty"`

	// Detailed single tunnel response
	Tunnel *Tunnel `json:"tunnel,omitempty"`

	// Authentication Token (used during creation
	Token *APIKey `json:"token,omitempty"`
}

type TunService struct {
	Tun       *Tunnel      `json:"tunnel"`
	HTTP      *HttpService `json:"http,omitempty"`
	Port      *PortService `json:"port,omitempty"`
	Available bool         `json:"available"`
	Timestamp time.Time    `json:"timestamp"`
}

type Tunnel struct {
	ID         UID           `json:"id"`
	UserID     UID           `json:"userID"`
	Created    time.Time     `json:"created"`
	LastActive time.Time     `json:"lastActive"`
	State      uint16        `json:"state"`
	Uptime     time.Duration `json:"uptime"` // value is saved in seconds
	Bandwidth  DataUsage     `json:"bandwidth"`
	Name       string        `json:"name"`
	Hostname   string        `json:"hostname"` // domain assigned to tunnel
	Address    string        `json:"address"`  // ip address of client
	Version    string        `json:"version"`  // client version (most recent session)
	OS         string        `json:"os"`       // operating system
	Arch       string        `json:"arch"`     // architecture

	// Used during runtime
	Https []*HttpService `json:"https,omitempty"`
	Ports []*PortService `json:"ports,omitempty"`
}

type UID [UIDLen]byte

type UpdateHTTPRequest struct {
	Sites []*Http `json:"sites"`
}

type UpdatePortMapRequest struct {
	PortMappings []*PortMap `json:"portmaps"`
}

type UpdatePortRequest struct {
	Ports []*Port `json:"ports"`
}

type User struct {
	ID           UID       `json:"id"`
	Created      time.Time `json:"created"`
	Modified     time.Time `json:"modified"`
	Active       bool      `json:"active"`
	Fullname     string    `json:"fullname"`
	Email        string    `json:"email"`
	Phone        string    `json:"phone"`
	Bandwidth    int       `json:"bandwidth"`    // monthly limit (MB)
	MaxBandwidth bool      `json:"maxBandwidth"` // flag indicates max bandwidth limit hit for user
	CheckDomains bool      `json:"checkDomains"` // flag indicates a validation check should be performed on HTTP rules
	MaxPorts     int       `json:"maxPorts"`     // max number of port allocations/rules for user
	CheckPorts   bool      `json:"checkPorts"`   // flag indicates max ports limit should be enforced

	// Runtime field...
	Domains *DomainLimits `json:"-"`
}

type UserRequest struct {
	UserID       UID    `json:"userID"`
	Email        string `json:"email,omitempty"`
	Fullname     string `json:"fullname,omitempty"`
	Phone        string `json:"phone,omitempty"`
	Active       bool   `json:"active,omitempty`
	Bandwidth    int    `json:"bandwidth,omitempty"`
	MaxBandwidth bool   `json:"maxBandwidth,omitempty"`
	CheckDomains bool   `json:"checkDomains,omitempty"`
	MaxPorts     int    `json:"maxPorts,omitempty"`
	CheckPorts   bool   `json:"checkPorts,omitempty"`
}

type UserResponse struct {
	Status bool   `json:"status"`
	Error  string `json:"error,omitempty"`

	// List of all (basic) users on the system
	Users []*User `json:"users,omitempty"`

	// User object for creation, import
	User *User `json:"user,omitempty"`
}