gluetun/internal/models/connection.go

package models

import (
	"fmt"
	"net"
)

type Connection struct {
	// Type is the connection type and can be "openvpn"
	Type string `json:"type"`
	// IP is the VPN server IP address.
	IP net.IP `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"`
}

func (c *Connection) Equal(other Connection) bool {
	return c.IP.Equal(other.IP) && c.Port == other.Port &&
		c.Protocol == other.Protocol && c.Hostname == other.Hostname
}

func (c Connection) OpenVPNRemoteLine() (line string) {
	return "remote " + c.IP.String() + " " + fmt.Sprint(c.Port)
}

func (c Connection) OpenVPNProtoLine() (line string) {
	return "proto " + c.Protocol
}

// UpdateEmptyWith updates each field of the connection where the
// value is not set using the value given as arguments.
func (c *Connection) UpdateEmptyWith(ip net.IP, port uint16, protocol string) {
	if c.IP == nil {
		c.IP = ip
	}
	if c.Port == 0 {
		c.Port = port
	}
	if c.Protocol == "" {
		c.Protocol = protocol
	}
}