pb

package
v0.3.10 Latest Latest
Warning

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

 Go to latest Published: Sep 12, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

Documentation

Overview

Package pb provides protobuf definitions for the SideroLink API.

Index

Constants

View Source 
const (
	ProvisionService_Provision_FullMethodName = "/sidero.link.ProvisionService/Provision"
)
View Source 
const (
	WireGuardOverGRPCService_CreateStream_FullMethodName = "/sidero.link.WireGuardOverGRPCService/CreateStream"
)

Variables

View Source 
var File_siderolink_provision_proto protoreflect.FileDescriptor
View Source 
var File_siderolink_wireguard_proto protoreflect.FileDescriptor
View Source 
var ProvisionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sidero.link.ProvisionService",
	HandlerType: (*ProvisionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Provision",
			Handler:    _ProvisionService_Provision_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "siderolink/provision.proto",
}

ProvisionService_ServiceDesc is the grpc.ServiceDesc for ProvisionService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var WireGuardOverGRPCService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sidero.link.WireGuardOverGRPCService",
	HandlerType: (*WireGuardOverGRPCServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "CreateStream",
			Handler:       _WireGuardOverGRPCService_CreateStream_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "siderolink/wireguard.proto",
}

WireGuardOverGRPCService_ServiceDesc is the grpc.ServiceDesc for WireGuardOverGRPCService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func MakeEndpoints added in v0.3.3 

func MakeEndpoints(endpoints ...string) []string

MakeEndpoints sets the endpoints.

func RegisterProvisionServiceServer 

func RegisterProvisionServiceServer(s grpc.ServiceRegistrar, srv ProvisionServiceServer)

func RegisterWireGuardOverGRPCServiceServer added in v0.3.5 

func RegisterWireGuardOverGRPCServiceServer(s grpc.ServiceRegistrar, srv WireGuardOverGRPCServiceServer)

Types

type PeerPacket added in v0.3.5 

type PeerPacket struct {
	Data []byte `protobuf:"bytes,2,opt,name=Data,proto3" json:"Data,omitempty"`
	// contains filtered or unexported fields
}

PeerPacket is a packet sent between "server" and client.

func (*PeerPacket) CloneMessageVT added in v0.3.5 

func (m *PeerPacket) CloneMessageVT() proto.Message

func (*PeerPacket) CloneVT added in v0.3.5 

func (m *PeerPacket) CloneVT() *PeerPacket

func (*PeerPacket) Descriptor deprecated added in v0.3.5 

func (*PeerPacket) Descriptor() ([]byte, []int)

Deprecated: Use PeerPacket.ProtoReflect.Descriptor instead.

func (*PeerPacket) EqualMessageVT added in v0.3.5 

func (this *PeerPacket) EqualMessageVT(thatMsg proto.Message) bool

func (*PeerPacket) EqualVT added in v0.3.5 

func (this *PeerPacket) EqualVT(that *PeerPacket) bool

func (*PeerPacket) GetData added in v0.3.5 

func (x *PeerPacket) GetData() []byte

func (*PeerPacket) MarshalToSizedBufferVT added in v0.3.5 

func (m *PeerPacket) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*PeerPacket) MarshalToVT added in v0.3.5 

func (m *PeerPacket) MarshalToVT(dAtA []byte) (int, error)

func (*PeerPacket) MarshalVT added in v0.3.5 

func (m *PeerPacket) MarshalVT() (dAtA []byte, err error)

func (*PeerPacket) ProtoMessage added in v0.3.5 

func (*PeerPacket) ProtoMessage()

func (*PeerPacket) ProtoReflect added in v0.3.5 

func (x *PeerPacket) ProtoReflect() protoreflect.Message

func (*PeerPacket) Reset added in v0.3.5 

func (x *PeerPacket) Reset()

func (*PeerPacket) SizeVT added in v0.3.5 

func (m *PeerPacket) SizeVT() (n int)

func (*PeerPacket) String added in v0.3.5 

func (x *PeerPacket) String() string

func (*PeerPacket) UnmarshalVT added in v0.3.5 

func (m *PeerPacket) UnmarshalVT(dAtA []byte) error

type ProvisionRequest 

type ProvisionRequest struct {

	// Node UUID as string.
	NodeUuid string `protobuf:"bytes,1,opt,name=node_uuid,json=nodeUuid,proto3" json:"node_uuid,omitempty"`
	// Wireguard public key (as string) of the node.
	NodePublicKey string `protobuf:"bytes,2,opt,name=node_public_key,json=nodePublicKey,proto3" json:"node_public_key,omitempty"`
	// Join token (as string) of the node.
	JoinToken *string `protobuf:"bytes,3,opt,name=join_token,json=joinToken,proto3,oneof" json:"join_token,omitempty"`
	// Unique token (as string) of the node. Needed in case node provided node_uuid with all zeroes.
	// Or two and more nodes have the same node_uuid.
	NodeUniqueToken *string `protobuf:"bytes,4,opt,name=node_unique_token,json=nodeUniqueToken,proto3,oneof" json:"node_unique_token,omitempty"`
	// Talos Version (as string) of the node.
	TalosVersion *string `protobuf:"bytes,5,opt,name=talos_version,json=talosVersion,proto3,oneof" json:"talos_version,omitempty"`
	// Wireguard over GRPC tunnel request
	WireguardOverGrpc *bool `protobuf:"varint,6,opt,name=wireguard_over_grpc,json=wireguardOverGrpc,proto3,oneof" json:"wireguard_over_grpc,omitempty"`
	// contains filtered or unexported fields
}

func (*ProvisionRequest) CloneMessageVT added in v0.3.2 

func (m *ProvisionRequest) CloneMessageVT() proto.Message

func (*ProvisionRequest) CloneVT added in v0.3.2 

func (m *ProvisionRequest) CloneVT() *ProvisionRequest

func (*ProvisionRequest) Descriptor deprecated 

func (*ProvisionRequest) Descriptor() ([]byte, []int)

Deprecated: Use ProvisionRequest.ProtoReflect.Descriptor instead.

func (*ProvisionRequest) EqualMessageVT added in v0.3.2 

func (this *ProvisionRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*ProvisionRequest) EqualVT added in v0.3.2 

func (this *ProvisionRequest) EqualVT(that *ProvisionRequest) bool

func (*ProvisionRequest) GetJoinToken 

func (x *ProvisionRequest) GetJoinToken() string

func (*ProvisionRequest) GetNodePublicKey 

func (x *ProvisionRequest) GetNodePublicKey() string

func (*ProvisionRequest) GetNodeUniqueToken added in v0.3.2 

func (x *ProvisionRequest) GetNodeUniqueToken() string

func (*ProvisionRequest) GetNodeUuid 

func (x *ProvisionRequest) GetNodeUuid() string

func (*ProvisionRequest) GetTalosVersion added in v0.3.2 

func (x *ProvisionRequest) GetTalosVersion() string

func (*ProvisionRequest) GetWireguardOverGrpc added in v0.3.5 

func (x *ProvisionRequest) GetWireguardOverGrpc() bool

func (*ProvisionRequest) MarshalToSizedBufferVT 

func (m *ProvisionRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ProvisionRequest) MarshalToVT 

func (m *ProvisionRequest) MarshalToVT(dAtA []byte) (int, error)

func (*ProvisionRequest) MarshalVT 

func (m *ProvisionRequest) MarshalVT() (dAtA []byte, err error)

func (*ProvisionRequest) ProtoMessage 

func (*ProvisionRequest) ProtoMessage()

func (*ProvisionRequest) ProtoReflect 

func (x *ProvisionRequest) ProtoReflect() protoreflect.Message

func (*ProvisionRequest) Reset 

func (x *ProvisionRequest) Reset()

func (*ProvisionRequest) SizeVT 

func (m *ProvisionRequest) SizeVT() (n int)

func (*ProvisionRequest) String 

func (x *ProvisionRequest) String() string

func (*ProvisionRequest) UnmarshalVT 

func (m *ProvisionRequest) UnmarshalVT(dAtA []byte) error

type ProvisionResponse 

type ProvisionResponse struct {

	// Server Wireguard endpoint IP and port.
	ServerEndpoint []string `protobuf:"bytes,1,rep,name=server_endpoint,json=serverEndpoint,proto3" json:"server_endpoint,omitempty"`
	// Server public Wireguard key encoded as string.
	ServerPublicKey string `protobuf:"bytes,3,opt,name=server_public_key,json=serverPublicKey,proto3" json:"server_public_key,omitempty"`
	// Node address with prefix on the Wireguard tunnel.
	NodeAddressPrefix string `protobuf:"bytes,4,opt,name=node_address_prefix,json=nodeAddressPrefix,proto3" json:"node_address_prefix,omitempty"`
	// Server address on the Wireguard tunnel.
	ServerAddress string `protobuf:"bytes,5,opt,name=server_address,json=serverAddress,proto3" json:"server_address,omitempty"`
	// Virtual peer address:port in case of Wireguard over GRPC.
	GrpcPeerAddrPort string `protobuf:"bytes,6,opt,name=grpc_peer_addr_port,json=grpcPeerAddrPort,proto3" json:"grpc_peer_addr_port,omitempty"`
	// contains filtered or unexported fields
}

func (*ProvisionResponse) CloneMessageVT added in v0.3.2 

func (m *ProvisionResponse) CloneMessageVT() proto.Message

func (*ProvisionResponse) CloneVT added in v0.3.2 

func (m *ProvisionResponse) CloneVT() *ProvisionResponse

func (*ProvisionResponse) Descriptor deprecated 

func (*ProvisionResponse) Descriptor() ([]byte, []int)

Deprecated: Use ProvisionResponse.ProtoReflect.Descriptor instead.

func (*ProvisionResponse) EqualMessageVT added in v0.3.2 

func (this *ProvisionResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*ProvisionResponse) EqualVT added in v0.3.2 

func (this *ProvisionResponse) EqualVT(that *ProvisionResponse) bool

func (*ProvisionResponse) GetEndpoints added in v0.3.3 

func (m *ProvisionResponse) GetEndpoints() []string

GetEndpoints returns the endpoints.

func (*ProvisionResponse) GetGrpcPeerAddrPort added in v0.3.5 

func (x *ProvisionResponse) GetGrpcPeerAddrPort() string

func (*ProvisionResponse) GetNodeAddressPrefix 

func (x *ProvisionResponse) GetNodeAddressPrefix() string

func (*ProvisionResponse) GetServerAddress 

func (x *ProvisionResponse) GetServerAddress() string

func (*ProvisionResponse) GetServerEndpoint 

func (x *ProvisionResponse) GetServerEndpoint() []string

func (*ProvisionResponse) GetServerPublicKey 

func (x *ProvisionResponse) GetServerPublicKey() string

func (*ProvisionResponse) MarshalToSizedBufferVT 

func (m *ProvisionResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ProvisionResponse) MarshalToVT 

func (m *ProvisionResponse) MarshalToVT(dAtA []byte) (int, error)

func (*ProvisionResponse) MarshalVT 

func (m *ProvisionResponse) MarshalVT() (dAtA []byte, err error)

func (*ProvisionResponse) ProtoMessage 

func (*ProvisionResponse) ProtoMessage()

func (*ProvisionResponse) ProtoReflect 

func (x *ProvisionResponse) ProtoReflect() protoreflect.Message

func (*ProvisionResponse) Reset 

func (x *ProvisionResponse) Reset()

func (*ProvisionResponse) SizeVT 

func (m *ProvisionResponse) SizeVT() (n int)

func (*ProvisionResponse) String 

func (x *ProvisionResponse) String() string

func (*ProvisionResponse) UnmarshalVT 

func (m *ProvisionResponse) UnmarshalVT(dAtA []byte) error

type ProvisionServiceClient 

type ProvisionServiceClient interface {
	Provision(ctx context.Context, in *ProvisionRequest, opts ...grpc.CallOption) (*ProvisionResponse, error)
}

ProvisionServiceClient is the client API for ProvisionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewProvisionServiceClient 

func NewProvisionServiceClient(cc grpc.ClientConnInterface) ProvisionServiceClient

type ProvisionServiceServer 

type ProvisionServiceServer interface {
	Provision(context.Context, *ProvisionRequest) (*ProvisionResponse, error)
	// contains filtered or unexported methods
}

ProvisionServiceServer is the server API for ProvisionService service. All implementations must embed UnimplementedProvisionServiceServer for forward compatibility

type UnimplementedProvisionServiceServer 

type UnimplementedProvisionServiceServer struct {
}

UnimplementedProvisionServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedProvisionServiceServer) Provision 

func (UnimplementedProvisionServiceServer) Provision(context.Context, *ProvisionRequest) (*ProvisionResponse, error)

type UnimplementedWireGuardOverGRPCServiceServer added in v0.3.5 

type UnimplementedWireGuardOverGRPCServiceServer struct {
}

UnimplementedWireGuardOverGRPCServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedWireGuardOverGRPCServiceServer) CreateStream added in v0.3.5 

func (UnimplementedWireGuardOverGRPCServiceServer) CreateStream(WireGuardOverGRPCService_CreateStreamServer) error

type UnsafeProvisionServiceServer 

type UnsafeProvisionServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeProvisionServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ProvisionServiceServer will result in compilation errors.

type UnsafeWireGuardOverGRPCServiceServer added in v0.3.5 

type UnsafeWireGuardOverGRPCServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeWireGuardOverGRPCServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WireGuardOverGRPCServiceServer will result in compilation errors.

type WireGuardOverGRPCServiceClient added in v0.3.5 

type WireGuardOverGRPCServiceClient interface {
	// CreateStream creates a new stream for sending and receiving WireGuard packets.
	// It should contain 'x-siderolink-ipv6-addr' metadata with the virtual IPv6 address of the peer, which
	// was provided by the server when the peer was added.
	CreateStream(ctx context.Context, opts ...grpc.CallOption) (WireGuardOverGRPCService_CreateStreamClient, error)
}

WireGuardOverGRPCServiceClient is the client API for WireGuardOverGRPCService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewWireGuardOverGRPCServiceClient added in v0.3.5 

func NewWireGuardOverGRPCServiceClient(cc grpc.ClientConnInterface) WireGuardOverGRPCServiceClient

type WireGuardOverGRPCServiceServer added in v0.3.5 

type WireGuardOverGRPCServiceServer interface {
	// CreateStream creates a new stream for sending and receiving WireGuard packets.
	// It should contain 'x-siderolink-ipv6-addr' metadata with the virtual IPv6 address of the peer, which
	// was provided by the server when the peer was added.
	CreateStream(WireGuardOverGRPCService_CreateStreamServer) error
	// contains filtered or unexported methods
}

WireGuardOverGRPCServiceServer is the server API for WireGuardOverGRPCService service. All implementations must embed UnimplementedWireGuardOverGRPCServiceServer for forward compatibility

type WireGuardOverGRPCService_CreateStreamClient added in v0.3.5 

type WireGuardOverGRPCService_CreateStreamClient interface {
	Send(*PeerPacket) error
	Recv() (*PeerPacket, error)
	grpc.ClientStream
}

type WireGuardOverGRPCService_CreateStreamServer added in v0.3.5 

type WireGuardOverGRPCService_CreateStreamServer interface {
	Send(*PeerPacket) error
	Recv() (*PeerPacket, error)
	grpc.ServerStream
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.