client

Documentation

Index

• type Client
• type GrpcClient
  • func NewClient(ctx context.Context, addr string, ourPrivateKey wgtypes.Key, tlsEnabled bool) (*GrpcClient, error)
  • func (c *GrpcClient) Close() error
  • func (c *GrpcClient) GetServerPublicKey() (*wgtypes.Key, error)
  • func (c *GrpcClient) Login(serverKey wgtypes.Key) (*proto.LoginResponse, error)
  • func (c *GrpcClient) Register(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)
  • func (c *GrpcClient) Sync(msgHandler func(msg *proto.SyncResponse) error) error
• type MockClient
  • func (m *MockClient) Close() error
  • func (m *MockClient) GetServerPublicKey() (*wgtypes.Key, error)
  • func (m *MockClient) Login(serverKey wgtypes.Key) (*proto.LoginResponse, error)
  • func (m *MockClient) Register(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)
  • func (m *MockClient) Sync(msgHandler func(msg *proto.SyncResponse) error) error

Types

type Client

type Client interface {
	io.Closer
	Sync(msgHandler func(msg *proto.SyncResponse) error) error
	GetServerPublicKey() (*wgtypes.Key, error)
	Register(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)
	Login(serverKey wgtypes.Key) (*proto.LoginResponse, error)
}

type GrpcClient

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

func NewClient

func NewClient(ctx context.Context, addr string, ourPrivateKey wgtypes.Key, tlsEnabled bool) (*GrpcClient, error)

NewClient creates a new client to Management service

func (*GrpcClient) Close

func (c *GrpcClient) Close() error

Close closes connection to the Management Service

func (*GrpcClient) GetServerPublicKey

func (c *GrpcClient) GetServerPublicKey() (*wgtypes.Key, error)

GetServerPublicKey returns server Wireguard public key (used later for encrypting messages sent to the server)

func (*GrpcClient) Login

func (c *GrpcClient) Login(serverKey wgtypes.Key) (*proto.LoginResponse, error)

Login attempts login to Management Server. Takes care of encrypting and decrypting messages.

func (*GrpcClient) Register

func (c *GrpcClient) Register(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)

Register registers peer on Management Server. It actually calls a Login endpoint with a provided setup key Takes care of encrypting and decrypting messages. This method will also collect system info and send it with the request (e.g. hostname, os, etc)

func (*GrpcClient) Sync

func (c *GrpcClient) Sync(msgHandler func(msg *proto.SyncResponse) error) error

Sync wraps the real client's Sync endpoint call and takes care of retries and encryption/decryption of messages Blocking request. The result will be sent via msgHandler callback function

type MockClient

type MockClient struct {
	CloseFunc              func() error
	SyncFunc               func(msgHandler func(msg *proto.SyncResponse) error) error
	GetServerPublicKeyFunc func() (*wgtypes.Key, error)
	RegisterFunc           func(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)
	LoginFunc              func(serverKey wgtypes.Key) (*proto.LoginResponse, error)
}

func (*MockClient) Close

func (m *MockClient) Close() error

func (*MockClient) GetServerPublicKey

func (m *MockClient) GetServerPublicKey() (*wgtypes.Key, error)

func (*MockClient) Login

func (m *MockClient) Login(serverKey wgtypes.Key) (*proto.LoginResponse, error)

func (*MockClient) Register

func (m *MockClient) Register(serverKey wgtypes.Key, setupKey string, info *system.Info) (*proto.LoginResponse, error)

func (*MockClient) Sync

func (m *MockClient) Sync(msgHandler func(msg *proto.SyncResponse) error) error