bitmask

Documentation

Index

• func ConfigureProvider(opts *ProviderOpts)
• type Bitmask
  • func InitializeBitmask(conf *config.Config) (Bitmask, error)
• type ProviderInfo
  • func GetConfiguredProvider() *ProviderInfo
• type ProviderOpts

Functions

func ConfigureProvider

func ConfigureProvider(opts *ProviderOpts)

Types

type Bitmask

type Bitmask interface {
	GetStatusCh() <-chan string
	GetSnowflakeCh() <-chan *snowflake.StatusEvent
	Close()
	Version() (string, error)
	StartVPN(provider string) error
	CanStartVPN() bool
	StopVPN() error
	Reconnect() error
	GetStatus() (string, error)
	VPNCheck() (helpers bool, priviledge bool, err error)
	GetLocationQualityMap(protocol string) map[string]float64
	GetLocationLabels(protocol string) map[string][]string
	GetBestLocation(protocol string) string
	UseGateway(name string)
	UseAutomaticGateway()
	SetProvider(string)
	GetTransport() string
	SetTransport(string) error
	UseUDP(bool)
	UseSnowflake(bool) error
	OffersUDP() bool
	GetCurrentGateway() string
	GetCurrentLocation() string
	GetCurrentCountry() string
	IsManualLocation() bool
	NeedsCredentials() bool
	DoLogin(username, password string) (bool, error)
	CanUpgrade() bool
	GetMotd() string
}

func InitializeBitmask

func InitializeBitmask(conf *config.Config) (Bitmask, error)

type ProviderInfo

type ProviderInfo struct {
	Provider string
	AppName  string
}

func GetConfiguredProvider

func GetConfiguredProvider() *ProviderInfo

type ProviderOpts

type ProviderOpts struct {
	Provider             string   `json:"name"`
	AppName              string   `json:"applicationName"`
	BinaryName           string   `json:"binaryName"`
	Auth                 string   `json:"auth"`
	AuthEmptyPass        bool     `json:"authEmptyPass"`
	ProviderURL          string   `json:"providerURL"`
	DonateURL            string   `json:"donateURL"`
	ApiURL               string   `json:"apiURL"`
	TosURL               string   `json:"tosURL"`
	HelpURL              string   `json:"helpURL"`
	GeolocationURL       string   `json:"geolocationAPI"`
	AskForDonations      bool     `json:"askForDonations"`
	CaCert               string   `json:"caCertString"`
	ApiVersion           int      `json:"apiVersion"`
	STUNServers          []string `json:"STUNServers"`
	CountryCodeLookupURL string   `json:"countryCodeLookupURL"`
}