models

Documentation

Index

• Variables
• type AllServers
  • func (a *AllServers) Count() (count int)
  • func (a *AllServers) MarshalJSON() (data []byte, err error)
  • func (a *AllServers) UnmarshalJSON(data []byte) (err error)
• type BuildInformation
• type Connection
  • func (c *Connection) Equal(other Connection) bool
  • func (c *Connection) UpdateEmptyWith(ip netip.Addr, port uint16, protocol string)
• type FilterChoices
• type LoopStatus
  • func (ls LoopStatus) String() string
• type PublicIP
  • func (p *PublicIP) Copy() (publicIPCopy PublicIP)
• type Server
  • func (s *Server) Equal(other Server) (equal bool)
  • func (s *Server) HasMinimumInformation() (err error)
  • func (s *Server) Key() (key string)
  • func (s *Server) ToMarkdown(headers ...string) (markdown string)
• type Servers
  • func (s *Servers) Format(vpnProvider, format string) (formatted string, err error)
• type SortableServers
  • func (s SortableServers) Len() int
  • func (s SortableServers) Less(i, j int) bool
  • func (s SortableServers) Swap(i, j int)

Variables

var (
	ErrVPNFieldEmpty           = errors.New("vpn field is empty")
	ErrHostnameFieldEmpty      = errors.New("hostname field is empty")
	ErrIPsFieldEmpty           = errors.New("ips field is empty")
	ErrNoNetworkProtocol       = errors.New("both TCP and UDP fields are false for OpenVPN")
	ErrNetworkProtocolSet      = errors.New("no network protocol should be set")
	ErrWireguardPublicKeyEmpty = errors.New("wireguard public key field is empty")
)

var ErrMarkdownHeadersNotDefined = errors.New("markdown headers not defined")

var ErrServersFormatNotSupported = errors.New("servers format not supported")

Types

type AllServers

type AllServers struct {
	Version           uint16 // used for migration of the top level scheme
	ProviderToServers map[string]Servers
}

func (*AllServers) Count

func (a *AllServers) Count() (count int)

func (*AllServers) MarshalJSON

func (a *AllServers) MarshalJSON() (data []byte, err error)

MarshalJSON marshals all servers to JSON. Note you need to use a pointer to all servers for it to work with native json methods such as json.Marshal.

func (*AllServers) UnmarshalJSON

func (a *AllServers) UnmarshalJSON(data []byte) (err error)

type BuildInformation

type BuildInformation struct {
	Version string `json:"version"`
	Commit  string `json:"commit"`
	Created string `json:"created"`
}

type Connection

type Connection struct {
	// Type is the connection type and can be "openvpn" or "wireguard"
	Type string `json:"type"`
	// IP is the VPN server IP address.
	IP netip.Addr `json:"ip"`
	// Port is the VPN server port.
	Port uint16 `json:"port"`
	// Protocol can be "tcp" or "udp".
	Protocol string `json:"protocol"`
	// Hostname is used for IPVanish, IVPN, Privado
	// and Windscribe for TLS verification.
	Hostname string `json:"hostname"`
	// PubKey is the public key of the VPN server,
	// used only for Wireguard.
	PubKey string `json:"pubkey"`
	// ServerName is used for PIA for port forwarding
	ServerName string `json:"server_name,omitempty"`
	// PortForward is used for PIA and ProtonVPN for port forwarding
	PortForward bool `json:"port_forward"`
}

func (*Connection) Equal

func (c *Connection) Equal(other Connection) bool

func (*Connection) UpdateEmptyWith

func (c *Connection) UpdateEmptyWith(ip netip.Addr, port uint16, protocol string)

UpdateEmptyWith updates each field of the connection where the value is not set using the value given as arguments.

type FilterChoices

type FilterChoices struct {
	Countries  []string
	Regions    []string
	Cities     []string
	Categories []string
	ISPs       []string
	Names      []string
	Hostnames  []string
}

type LoopStatus

type LoopStatus string

LoopStatus status such as stopped or running.

func (LoopStatus) String

func (ls LoopStatus) String() string

type PublicIP

type PublicIP struct {
	IP           netip.Addr `json:"public_ip,omitempty"`
	Region       string     `json:"region,omitempty"`
	Country      string     `json:"country,omitempty"`
	City         string     `json:"city,omitempty"`
	Hostname     string     `json:"hostname,omitempty"`
	Location     string     `json:"location,omitempty"`
	Organization string     `json:"organization,omitempty"`
	PostalCode   string     `json:"postal_code,omitempty"`
	Timezone     string     `json:"timezone,omitempty"`
}

func (*PublicIP) Copy

func (p *PublicIP) Copy() (publicIPCopy PublicIP)

type Server

type Server struct {
	VPN string `json:"vpn,omitempty"`
	// Surfshark: country is also used for multi-hop
	Country     string       `json:"country,omitempty"`
	Region      string       `json:"region,omitempty"`
	City        string       `json:"city,omitempty"`
	ISP         string       `json:"isp,omitempty"`
	Categories  []string     `json:"categories,omitempty"`
	Owned       bool         `json:"owned,omitempty"`
	Number      uint16       `json:"number,omitempty"`
	ServerName  string       `json:"server_name,omitempty"`
	Hostname    string       `json:"hostname,omitempty"`
	TCP         bool         `json:"tcp,omitempty"`
	UDP         bool         `json:"udp,omitempty"`
	OvpnX509    string       `json:"x509,omitempty"`
	RetroLoc    string       `json:"retroloc,omitempty"` // TODO remove in v4
	MultiHop    bool         `json:"multihop,omitempty"`
	WgPubKey    string       `json:"wgpubkey,omitempty"`
	Free        bool         `json:"free,omitempty"` // TODO v4 create a SubscriptionTier struct
	Premium     bool         `json:"premium,omitempty"`
	Stream      bool         `json:"stream,omitempty"` // TODO v4 create a Features struct
	SecureCore  bool         `json:"secure_core,omitempty"`
	Tor         bool         `json:"tor,omitempty"`
	PortForward bool         `json:"port_forward,omitempty"`
	Keep        bool         `json:"keep,omitempty"`
	IPs         []netip.Addr `json:"ips,omitempty"`
}

func (*Server) Equal

func (s *Server) Equal(other Server) (equal bool)

func (*Server) HasMinimumInformation

func (s *Server) HasMinimumInformation() (err error)

func (*Server) Key

func (s *Server) Key() (key string)

func (*Server) ToMarkdown

func (s *Server) ToMarkdown(headers ...string) (markdown string)

type Servers

type Servers struct {
	Version   uint16   `json:"version"`
	Timestamp int64    `json:"timestamp"`
	Servers   []Server `json:"servers,omitempty"`
}

func (*Servers) Format

func (s *Servers) Format(vpnProvider, format string) (formatted string, err error)

type SortableServers

type SortableServers []Server

func (SortableServers) Len

func (s SortableServers) Len() int

func (SortableServers) Less

func (s SortableServers) Less(i, j int) bool

func (SortableServers) Swap

func (s SortableServers) Swap(i, j int)