vpn

type IPSecTunnelConfig struct {

	// DeviceName represents the name of the network link that will be created for ipsec.
	DeviceName string `json:"deviceName" yaml:"deviceName"`
}

type L2TPTunnelConfig struct {

	// DeviceName represents the name of the network link that will be created for l2tp.
	DeviceName string `json:"deviceName" yaml:"deviceName"`
}

type OpenVPNTunnelConfig struct {
}

type VPNTunnel struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`

	// Standard object metadata.
	// Utilizes the Kubernetes metadata object spec for now.
	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Spec VPNTunnelSpec `json:"spec" yaml:"spec"`

	Status VPNTunnelStatus `json:"status" yaml:"status"`
}

type VPNTunnelList struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`

	// +optional
	metav1.ListMeta

	// Items represents an array of VPN tunnels
	Items []VPNTunnel `json:"items" yaml:"items"`
}

type VPNTunnelSpec struct {

	// Wireguard is optional configuration for a wireguard tunnel that will be represented by this spec.
	//
	// +optional
	Wireguard WireguardTunnelConfig `json:"wireguard" yaml:"wireguard"`

	// OpenVPN is optional configuration for an OpenVPN tunnel that will be represented by this spec.
	// NOTE: Requires the openvpn service to be installed on the host and running.
	//
	// +optional
	OpenVPN OpenVPNTunnelConfig `json:"openvpn" yaml:"openvpn"`

	// L2TP is optional configuration for an L2TP tunnel that will be represented by this spec.
	//
	// +optional
	L2TP L2TPTunnelConfig `json:"l2tp" yaml:"l2tp"`

	// IPSEC is optional configuration for an IPSec tunnel that will be represented by this spec.
	//
	// +optional
	IPSEC IPSecTunnelConfig `json:"ipsec" yaml:"ipsec"`
}

type VPNTunnelStatus struct {

	// IsUp denotes whether the tunnel has been established with the remote peer.
	IsUp bool `json:"up" yaml:"up"`

	// ReceiveBytes represents the number of bytes that have been received by this tunnel from a peer.
	ReceiveBytes int64 `json:"receiveBytes" yaml:"receiveBytes"`

	// SendBytes represents the number of bytes that have been sent through this tunnel to a peer.
	SendBytes int64 `json:"sendBytes" yaml:"sendBytes"`
}

type WireguardPeer struct {
}

type WireguardTunnelConfig struct {

	// DeviceName represents the name of the network link that will be created for wireguard.
	DeviceName string `json:"deviceName" yaml:"deviceName"`

	// ListenPort specifies the port that the device should listen on for incoming Wireguard connections.
	// The port will always be a UDP listen port that is initialized.
	ListenPort uint16 `json:"listenPort" yaml:"listenPort"`

	// KeyRef represents the local secret object that contains the public/private key
	// to be used by this tunnel for establishing secure connections with the remote peer.
	//
	// The controller will look for two k/v pairs within said secret:
	// - wg.privateKey : This should have as the value that represents the private key that should
	// be used for said link.
	// - wg.publicKey : This should have another string as the value that represents the corresponding
	// public key of the afformentioned private key.
	KeyRef *core.LocalObjectReference `json:"keyRef" yaml:"keyRef"`

	// Peers represents the array of peers that the wireguard will looks for
	// and accept incoming connections from/to.
	Peers []WireguardPeer `json:"peers" yaml:"peers"`
}