vpnswitch

README

vpnswitch: A VPN Switcher Library for Go

Uses OpenVPN to connect to and switch VPNs.

Caveats

Requires sudo.

Example

package main

import (
	"log"
	"time"

	"github.com/abemedia/vpnswitch"
	"github.com/abemedia/vpnswitch/providers/nordvpn"
)

func main() {
	s, err := nordvpn.New("user", "password", "udp")
	if err != nil {
		log.Fatal(err)
	}

	c := new(vpnswitch.Client)
	c.Add(s...)
    
	err = c.Start() // connect to VPN
	if err != nil {
		log.Fatal(err)
	}

	time.Sleep(10 * time.Second)
    
	err = c.Next()// switch to next VPN server
	if err != nil {
		log.Fatal(err)
	}

	time.Sleep(10 * time.Second)
    
	err = c.Stop()// disconnect
	if err != nil {
		log.Fatal(err)
	}
}

Documentation

Index

• Variables
• type Client
  • func (c *Client) Add(s ...Server)
  • func (c *Client) Next() error
  • func (c *Client) Refresh() error
  • func (c *Client) Start() error
  • func (c *Client) Stop() error
• type ConfigOption
• type Credentials
• type Option
  • func WithProto(proto string) Option
  • func WithRemote(host string, port int) Option
• type Provider
  • func NewProvider(config string, port int, auth *Credentials, options ...Option) *Provider
  • func (p *Provider) Add(name, host string)
  • func (p *Provider) Servers() []Server
• type Server
  • func NewServer(config string, auth *Credentials, options ...Option) (Server, error)
  • func NewServerFromURL(configURL string, auth *Credentials, options ...Option) (Server, error)

Variables

var (
	DefaultTimeout = 10 * time.Second
)

Types

type Client

type Client struct {
	Timeout    time.Duration
	MaxLatency time.Duration
	MaxRetries int
	// contains filtered or unexported fields
}

func (*Client) Add

func (c *Client) Add(s ...Server)

Add adds more VPN servers

func (*Client) Next

func (c *Client) Next() error

Next switches to the next VPN

func (*Client) Refresh

func (c *Client) Refresh() error

Refresh pings the servers to update the latency values

func (*Client) Start

func (c *Client) Start() error

Start connects to VPN

func (*Client) Stop

func (c *Client) Stop() error

Stop disconnects from VPN

type ConfigOption

type ConfigOption func(*strings.Builder)

type Credentials

type Credentials struct {
	Username string
	Password string
}

type Option

type Option interface{}

func WithProto

func WithProto(proto string) Option

func WithRemote

func WithRemote(host string, port int) Option

type Provider

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

func NewProvider

func NewProvider(config string, port int, auth *Credentials, options ...Option) *Provider

func (*Provider) Add

func (p *Provider) Add(name, host string)

func (*Provider) Servers

func (p *Provider) Servers() []Server

type Server

type Server interface {
	Config() string
	Host() string
	Name() string
	Credentials() Credentials
}

func NewServer

func NewServer(config string, auth *Credentials, options ...Option) (Server, error)

func NewServerFromURL

func NewServerFromURL(configURL string, auth *Credentials, options ...Option) (Server, error)