wireguard

package
v3.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package wireguard contains generated bindings for API file wireguard.api.

Contents: - 1 enum - 2 structs - 17 messages

Index

Constants

View Source
const (
	APIFile    = "wireguard"
	APIVersion = "1.3.0"
	VersionCrc = 0x5d8f9252
)

Variables

View Source
var (
	WireguardPeerFlags_name = map[uint8]string{
		1: "WIREGUARD_PEER_STATUS_DEAD",
		2: "WIREGUARD_PEER_ESTABLISHED",
	}
	WireguardPeerFlags_value = map[string]uint8{
		"WIREGUARD_PEER_STATUS_DEAD": 1,
		"WIREGUARD_PEER_ESTABLISHED": 2,
	}
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type RPCService

RPCService defines RPC service wireguard.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type RPCService_WireguardInterfaceDumpClient

type RPCService_WireguardInterfaceDumpClient interface {
	Recv() (*WireguardInterfaceDetails, error)
	api.Stream
}

type RPCService_WireguardPeersDumpClient

type RPCService_WireguardPeersDumpClient interface {
	Recv() (*WireguardPeersDetails, error)
	api.Stream
}

type WantWireguardPeerEvents

type WantWireguardPeerEvents struct {
	SwIfIndex     interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
	PeerIndex     uint32                         `binapi:"u32,name=peer_index,default=4294967295" json:"peer_index,omitempty"`
	EnableDisable uint32                         `binapi:"u32,name=enable_disable" json:"enable_disable,omitempty"`
	PID           uint32                         `binapi:"u32,name=pid" json:"pid,omitempty"`
}

Register for wireguard peer events

  • sw_if_index - index of the interface to dump peer info on, ~0 if on all
  • peer_index - index of the peer to dump info on, ~0 if on all
  • enable_disable - 1 => register for events, 0 => cancel registration
  • pid - sender's pid

WantWireguardPeerEvents defines message 'want_wireguard_peer_events'.

func (*WantWireguardPeerEvents) GetCrcString

func (*WantWireguardPeerEvents) GetCrcString() string

func (*WantWireguardPeerEvents) GetMessageName

func (*WantWireguardPeerEvents) GetMessageName() string

func (*WantWireguardPeerEvents) GetMessageType

func (*WantWireguardPeerEvents) GetMessageType() api.MessageType

func (*WantWireguardPeerEvents) Marshal

func (m *WantWireguardPeerEvents) Marshal(b []byte) ([]byte, error)

func (*WantWireguardPeerEvents) Reset

func (m *WantWireguardPeerEvents) Reset()

func (*WantWireguardPeerEvents) Size

func (m *WantWireguardPeerEvents) Size() (size int)

func (*WantWireguardPeerEvents) Unmarshal

func (m *WantWireguardPeerEvents) Unmarshal(b []byte) error

type WantWireguardPeerEventsReply

type WantWireguardPeerEventsReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WantWireguardPeerEventsReply defines message 'want_wireguard_peer_events_reply'.

func (*WantWireguardPeerEventsReply) GetCrcString

func (*WantWireguardPeerEventsReply) GetCrcString() string

func (*WantWireguardPeerEventsReply) GetMessageName

func (*WantWireguardPeerEventsReply) GetMessageName() string

func (*WantWireguardPeerEventsReply) GetMessageType

func (*WantWireguardPeerEventsReply) GetMessageType() api.MessageType

func (*WantWireguardPeerEventsReply) Marshal

func (m *WantWireguardPeerEventsReply) Marshal(b []byte) ([]byte, error)

func (*WantWireguardPeerEventsReply) Reset

func (m *WantWireguardPeerEventsReply) Reset()

func (*WantWireguardPeerEventsReply) Size

func (m *WantWireguardPeerEventsReply) Size() (size int)

func (*WantWireguardPeerEventsReply) Unmarshal

func (m *WantWireguardPeerEventsReply) Unmarshal(b []byte) error

type WgSetAsyncMode

type WgSetAsyncMode struct {
	AsyncEnable bool `binapi:"bool,name=async_enable,default=false" json:"async_enable,omitempty"`
}

Wireguard Set Async mode

  • async_enable - wireguard async mode on or off, default off

WgSetAsyncMode defines message 'wg_set_async_mode'.

func (*WgSetAsyncMode) GetCrcString

func (*WgSetAsyncMode) GetCrcString() string

func (*WgSetAsyncMode) GetMessageName

func (*WgSetAsyncMode) GetMessageName() string

func (*WgSetAsyncMode) GetMessageType

func (*WgSetAsyncMode) GetMessageType() api.MessageType

func (*WgSetAsyncMode) Marshal

func (m *WgSetAsyncMode) Marshal(b []byte) ([]byte, error)

func (*WgSetAsyncMode) Reset

func (m *WgSetAsyncMode) Reset()

func (*WgSetAsyncMode) Size

func (m *WgSetAsyncMode) Size() (size int)

func (*WgSetAsyncMode) Unmarshal

func (m *WgSetAsyncMode) Unmarshal(b []byte) error

type WgSetAsyncModeReply

type WgSetAsyncModeReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WgSetAsyncModeReply defines message 'wg_set_async_mode_reply'.

func (*WgSetAsyncModeReply) GetCrcString

func (*WgSetAsyncModeReply) GetCrcString() string

func (*WgSetAsyncModeReply) GetMessageName

func (*WgSetAsyncModeReply) GetMessageName() string

func (*WgSetAsyncModeReply) GetMessageType

func (*WgSetAsyncModeReply) GetMessageType() api.MessageType

func (*WgSetAsyncModeReply) Marshal

func (m *WgSetAsyncModeReply) Marshal(b []byte) ([]byte, error)

func (*WgSetAsyncModeReply) Reset

func (m *WgSetAsyncModeReply) Reset()

func (*WgSetAsyncModeReply) Size

func (m *WgSetAsyncModeReply) Size() (size int)

func (*WgSetAsyncModeReply) Unmarshal

func (m *WgSetAsyncModeReply) Unmarshal(b []byte) error

type WireguardInterface

type WireguardInterface struct {
	UserInstance uint32                         `binapi:"u32,name=user_instance,default=4294967295" json:"user_instance,omitempty"`
	SwIfIndex    interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	PrivateKey   []byte                         `binapi:"u8[32],name=private_key" json:"private_key,omitempty"`
	PublicKey    []byte                         `binapi:"u8[32],name=public_key" json:"public_key,omitempty"`
	Port         uint16                         `binapi:"u16,name=port" json:"port,omitempty"`
	SrcIP        ip_types.Address               `binapi:"address,name=src_ip" json:"src_ip,omitempty"`
}

WireguardInterface defines type 'wireguard_interface'.

type WireguardInterfaceCreate

type WireguardInterfaceCreate struct {
	Interface   WireguardInterface `binapi:"wireguard_interface,name=interface" json:"interface,omitempty"`
	GenerateKey bool               `binapi:"bool,name=generate_key" json:"generate_key,omitempty"`
}

Create an Wireguard interface WireguardInterfaceCreate defines message 'wireguard_interface_create'.

func (*WireguardInterfaceCreate) GetCrcString

func (*WireguardInterfaceCreate) GetCrcString() string

func (*WireguardInterfaceCreate) GetMessageName

func (*WireguardInterfaceCreate) GetMessageName() string

func (*WireguardInterfaceCreate) GetMessageType

func (*WireguardInterfaceCreate) GetMessageType() api.MessageType

func (*WireguardInterfaceCreate) Marshal

func (m *WireguardInterfaceCreate) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceCreate) Reset

func (m *WireguardInterfaceCreate) Reset()

func (*WireguardInterfaceCreate) Size

func (m *WireguardInterfaceCreate) Size() (size int)

func (*WireguardInterfaceCreate) Unmarshal

func (m *WireguardInterfaceCreate) Unmarshal(b []byte) error

type WireguardInterfaceCreateReply

type WireguardInterfaceCreateReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Add Wireguard interface interface response

  • retval - return status
  • sw_if_index - sw_if_index of new interface (for successful add)

WireguardInterfaceCreateReply defines message 'wireguard_interface_create_reply'.

func (*WireguardInterfaceCreateReply) GetCrcString

func (*WireguardInterfaceCreateReply) GetCrcString() string

func (*WireguardInterfaceCreateReply) GetMessageName

func (*WireguardInterfaceCreateReply) GetMessageName() string

func (*WireguardInterfaceCreateReply) GetMessageType

func (*WireguardInterfaceCreateReply) GetMessageType() api.MessageType

func (*WireguardInterfaceCreateReply) Marshal

func (m *WireguardInterfaceCreateReply) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceCreateReply) Reset

func (m *WireguardInterfaceCreateReply) Reset()

func (*WireguardInterfaceCreateReply) Size

func (m *WireguardInterfaceCreateReply) Size() (size int)

func (*WireguardInterfaceCreateReply) Unmarshal

func (m *WireguardInterfaceCreateReply) Unmarshal(b []byte) error

type WireguardInterfaceDelete

type WireguardInterfaceDelete struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

WireguardInterfaceDelete defines message 'wireguard_interface_delete'.

func (*WireguardInterfaceDelete) GetCrcString

func (*WireguardInterfaceDelete) GetCrcString() string

func (*WireguardInterfaceDelete) GetMessageName

func (*WireguardInterfaceDelete) GetMessageName() string

func (*WireguardInterfaceDelete) GetMessageType

func (*WireguardInterfaceDelete) GetMessageType() api.MessageType

func (*WireguardInterfaceDelete) Marshal

func (m *WireguardInterfaceDelete) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceDelete) Reset

func (m *WireguardInterfaceDelete) Reset()

func (*WireguardInterfaceDelete) Size

func (m *WireguardInterfaceDelete) Size() (size int)

func (*WireguardInterfaceDelete) Unmarshal

func (m *WireguardInterfaceDelete) Unmarshal(b []byte) error

type WireguardInterfaceDeleteReply

type WireguardInterfaceDeleteReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WireguardInterfaceDeleteReply defines message 'wireguard_interface_delete_reply'.

func (*WireguardInterfaceDeleteReply) GetCrcString

func (*WireguardInterfaceDeleteReply) GetCrcString() string

func (*WireguardInterfaceDeleteReply) GetMessageName

func (*WireguardInterfaceDeleteReply) GetMessageName() string

func (*WireguardInterfaceDeleteReply) GetMessageType

func (*WireguardInterfaceDeleteReply) GetMessageType() api.MessageType

func (*WireguardInterfaceDeleteReply) Marshal

func (m *WireguardInterfaceDeleteReply) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceDeleteReply) Reset

func (m *WireguardInterfaceDeleteReply) Reset()

func (*WireguardInterfaceDeleteReply) Size

func (m *WireguardInterfaceDeleteReply) Size() (size int)

func (*WireguardInterfaceDeleteReply) Unmarshal

func (m *WireguardInterfaceDeleteReply) Unmarshal(b []byte) error

type WireguardInterfaceDetails

type WireguardInterfaceDetails struct {
	Interface WireguardInterface `binapi:"wireguard_interface,name=interface" json:"interface,omitempty"`
}

WireguardInterfaceDetails defines message 'wireguard_interface_details'.

func (*WireguardInterfaceDetails) GetCrcString

func (*WireguardInterfaceDetails) GetCrcString() string

func (*WireguardInterfaceDetails) GetMessageName

func (*WireguardInterfaceDetails) GetMessageName() string

func (*WireguardInterfaceDetails) GetMessageType

func (*WireguardInterfaceDetails) GetMessageType() api.MessageType

func (*WireguardInterfaceDetails) Marshal

func (m *WireguardInterfaceDetails) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceDetails) Reset

func (m *WireguardInterfaceDetails) Reset()

func (*WireguardInterfaceDetails) Size

func (m *WireguardInterfaceDetails) Size() (size int)

func (*WireguardInterfaceDetails) Unmarshal

func (m *WireguardInterfaceDetails) Unmarshal(b []byte) error

type WireguardInterfaceDump

type WireguardInterfaceDump struct {
	ShowPrivateKey bool                           `binapi:"bool,name=show_private_key" json:"show_private_key,omitempty"`
	SwIfIndex      interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

WireguardInterfaceDump defines message 'wireguard_interface_dump'.

func (*WireguardInterfaceDump) GetCrcString

func (*WireguardInterfaceDump) GetCrcString() string

func (*WireguardInterfaceDump) GetMessageName

func (*WireguardInterfaceDump) GetMessageName() string

func (*WireguardInterfaceDump) GetMessageType

func (*WireguardInterfaceDump) GetMessageType() api.MessageType

func (*WireguardInterfaceDump) Marshal

func (m *WireguardInterfaceDump) Marshal(b []byte) ([]byte, error)

func (*WireguardInterfaceDump) Reset

func (m *WireguardInterfaceDump) Reset()

func (*WireguardInterfaceDump) Size

func (m *WireguardInterfaceDump) Size() (size int)

func (*WireguardInterfaceDump) Unmarshal

func (m *WireguardInterfaceDump) Unmarshal(b []byte) error

type WireguardPeer

type WireguardPeer struct {
	PeerIndex           uint32                         `binapi:"u32,name=peer_index" json:"peer_index,omitempty"`
	PublicKey           []byte                         `binapi:"u8[32],name=public_key" json:"public_key,omitempty"`
	Port                uint16                         `binapi:"u16,name=port" json:"port,omitempty"`
	PersistentKeepalive uint16                         `binapi:"u16,name=persistent_keepalive" json:"persistent_keepalive,omitempty"`
	TableID             uint32                         `binapi:"u32,name=table_id" json:"table_id,omitempty"`
	Endpoint            ip_types.Address               `binapi:"address,name=endpoint" json:"endpoint,omitempty"`
	SwIfIndex           interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Flags               WireguardPeerFlags             `binapi:"wireguard_peer_flags,name=flags" json:"flags,omitempty"`
	NAllowedIps         uint8                          `binapi:"u8,name=n_allowed_ips" json:"-"`
	AllowedIps          []ip_types.Prefix              `binapi:"prefix[n_allowed_ips],name=allowed_ips" json:"allowed_ips,omitempty"`
}

WireguardPeer defines type 'wireguard_peer'.

type WireguardPeerAdd

type WireguardPeerAdd struct {
	Peer WireguardPeer `binapi:"wireguard_peer,name=peer" json:"peer,omitempty"`
}

Create new peer

  • peer - peer to create

WireguardPeerAdd defines message 'wireguard_peer_add'.

func (*WireguardPeerAdd) GetCrcString

func (*WireguardPeerAdd) GetCrcString() string

func (*WireguardPeerAdd) GetMessageName

func (*WireguardPeerAdd) GetMessageName() string

func (*WireguardPeerAdd) GetMessageType

func (*WireguardPeerAdd) GetMessageType() api.MessageType

func (*WireguardPeerAdd) Marshal

func (m *WireguardPeerAdd) Marshal(b []byte) ([]byte, error)

func (*WireguardPeerAdd) Reset

func (m *WireguardPeerAdd) Reset()

func (*WireguardPeerAdd) Size

func (m *WireguardPeerAdd) Size() (size int)

func (*WireguardPeerAdd) Unmarshal

func (m *WireguardPeerAdd) Unmarshal(b []byte) error

type WireguardPeerAddReply

type WireguardPeerAddReply struct {
	Retval    int32  `binapi:"i32,name=retval" json:"retval,omitempty"`
	PeerIndex uint32 `binapi:"u32,name=peer_index" json:"peer_index,omitempty"`
}

Create new peer

  • retval - return status
  • peer_index - Created or existing peer pool index

WireguardPeerAddReply defines message 'wireguard_peer_add_reply'.

func (*WireguardPeerAddReply) GetCrcString

func (*WireguardPeerAddReply) GetCrcString() string

func (*WireguardPeerAddReply) GetMessageName

func (*WireguardPeerAddReply) GetMessageName() string

func (*WireguardPeerAddReply) GetMessageType

func (*WireguardPeerAddReply) GetMessageType() api.MessageType

func (*WireguardPeerAddReply) Marshal

func (m *WireguardPeerAddReply) Marshal(b []byte) ([]byte, error)

func (*WireguardPeerAddReply) Reset

func (m *WireguardPeerAddReply) Reset()

func (*WireguardPeerAddReply) Size

func (m *WireguardPeerAddReply) Size() (size int)

func (*WireguardPeerAddReply) Unmarshal

func (m *WireguardPeerAddReply) Unmarshal(b []byte) error

type WireguardPeerEvent

type WireguardPeerEvent struct {
	PID       uint32             `binapi:"u32,name=pid" json:"pid,omitempty"`
	PeerIndex uint32             `binapi:"u32,name=peer_index" json:"peer_index,omitempty"`
	Flags     WireguardPeerFlags `binapi:"wireguard_peer_flags,name=flags" json:"flags,omitempty"`
}

Interface Event generated by want_wireguard_peer_events

  • pid - client pid registered to receive notification
  • peer_index - index of the peer for this event
  • deleted - interface was deleted

WireguardPeerEvent defines message 'wireguard_peer_event'.

func (*WireguardPeerEvent) GetCrcString

func (*WireguardPeerEvent) GetCrcString() string

func (*WireguardPeerEvent) GetMessageName

func (*WireguardPeerEvent) GetMessageName() string

func (*WireguardPeerEvent) GetMessageType

func (*WireguardPeerEvent) GetMessageType() api.MessageType

func (*WireguardPeerEvent) Marshal

func (m *WireguardPeerEvent) Marshal(b []byte) ([]byte, error)

func (*WireguardPeerEvent) Reset

func (m *WireguardPeerEvent) Reset()

func (*WireguardPeerEvent) Size

func (m *WireguardPeerEvent) Size() (size int)

func (*WireguardPeerEvent) Unmarshal

func (m *WireguardPeerEvent) Unmarshal(b []byte) error

type WireguardPeerFlags

type WireguardPeerFlags uint8

WireguardPeerFlags defines enum 'wireguard_peer_flags'.

const (
	WIREGUARD_PEER_STATUS_DEAD WireguardPeerFlags = 1
	WIREGUARD_PEER_ESTABLISHED WireguardPeerFlags = 2
)

func (WireguardPeerFlags) String

func (x WireguardPeerFlags) String() string

type WireguardPeerRemove

type WireguardPeerRemove struct {
	PeerIndex uint32 `binapi:"u32,name=peer_index" json:"peer_index,omitempty"`
}

Remove peer

  • peer_index - peer to be removed

WireguardPeerRemove defines message 'wireguard_peer_remove'.

func (*WireguardPeerRemove) GetCrcString

func (*WireguardPeerRemove) GetCrcString() string

func (*WireguardPeerRemove) GetMessageName

func (*WireguardPeerRemove) GetMessageName() string

func (*WireguardPeerRemove) GetMessageType

func (*WireguardPeerRemove) GetMessageType() api.MessageType

func (*WireguardPeerRemove) Marshal

func (m *WireguardPeerRemove) Marshal(b []byte) ([]byte, error)

func (*WireguardPeerRemove) Reset

func (m *WireguardPeerRemove) Reset()

func (*WireguardPeerRemove) Size

func (m *WireguardPeerRemove) Size() (size int)

func (*WireguardPeerRemove) Unmarshal

func (m *WireguardPeerRemove) Unmarshal(b []byte) error

type WireguardPeerRemoveReply

type WireguardPeerRemoveReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

WireguardPeerRemoveReply defines message 'wireguard_peer_remove_reply'.

func (*WireguardPeerRemoveReply) GetCrcString

func (*WireguardPeerRemoveReply) GetCrcString() string

func (*WireguardPeerRemoveReply) GetMessageName

func (*WireguardPeerRemoveReply) GetMessageName() string

func (*WireguardPeerRemoveReply) GetMessageType

func (*WireguardPeerRemoveReply) GetMessageType() api.MessageType

func (*WireguardPeerRemoveReply) Marshal

func (m *WireguardPeerRemoveReply) Marshal(b []byte) ([]byte, error)

func (*WireguardPeerRemoveReply) Reset

func (m *WireguardPeerRemoveReply) Reset()

func (*WireguardPeerRemoveReply) Size

func (m *WireguardPeerRemoveReply) Size() (size int)

func (*WireguardPeerRemoveReply) Unmarshal

func (m *WireguardPeerRemoveReply) Unmarshal(b []byte) error

type WireguardPeersDetails

type WireguardPeersDetails struct {
	Peer WireguardPeer `binapi:"wireguard_peer,name=peer" json:"peer,omitempty"`
}

Dump peer details

  • peer - peer details

WireguardPeersDetails defines message 'wireguard_peers_details'.

func (*WireguardPeersDetails) GetCrcString

func (*WireguardPeersDetails) GetCrcString() string

func (*WireguardPeersDetails) GetMessageName

func (*WireguardPeersDetails) GetMessageName() string

func (*WireguardPeersDetails) GetMessageType

func (*WireguardPeersDetails) GetMessageType() api.MessageType

func (*WireguardPeersDetails) Marshal

func (m *WireguardPeersDetails) Marshal(b []byte) ([]byte, error)

func (*WireguardPeersDetails) Reset

func (m *WireguardPeersDetails) Reset()

func (*WireguardPeersDetails) Size

func (m *WireguardPeersDetails) Size() (size int)

func (*WireguardPeersDetails) Unmarshal

func (m *WireguardPeersDetails) Unmarshal(b []byte) error

type WireguardPeersDump

type WireguardPeersDump struct {
	PeerIndex uint32 `binapi:"u32,name=peer_index,default=4294967295" json:"peer_index,omitempty"`
}

Dump all peers

  • peer_index - peer index to be dumped. If 0xFFFFFFFF dumps all peers

WireguardPeersDump defines message 'wireguard_peers_dump'.

func (*WireguardPeersDump) GetCrcString

func (*WireguardPeersDump) GetCrcString() string

func (*WireguardPeersDump) GetMessageName

func (*WireguardPeersDump) GetMessageName() string

func (*WireguardPeersDump) GetMessageType

func (*WireguardPeersDump) GetMessageType() api.MessageType

func (*WireguardPeersDump) Marshal

func (m *WireguardPeersDump) Marshal(b []byte) ([]byte, error)

func (*WireguardPeersDump) Reset

func (m *WireguardPeersDump) Reset()

func (*WireguardPeersDump) Size

func (m *WireguardPeersDump) Size() (size int)

func (*WireguardPeersDump) Unmarshal

func (m *WireguardPeersDump) Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL