secureservice

Documentation

Index

• Constants
• Variables
• func CtxAllowAccountCheck(ctx context.Context) context.Context
• func CtxIsAccountCheckAllowed(ctx context.Context) bool
• type Config
• type SecureService
  • func New() SecureService

Constants

const CName = "common.net.secure"

Variables

var (
	// ProtoVersion 0 - first any-sync version with raw tcp connections
	// ProtoVersion 1 - version with yamux over tcp and quic
	// ProtoVersion 2 - acl compatible version
	// ProtoVersion 3 - acl with breaking changes / multiplayer
	// ProtoVersion 4 - new sync compatible version
	// ProtoVersion 5 - sync with no entry space
	CompatibleVersion = uint32(4)
	ProtoVersion      = uint32(5)
)

Functions

func CtxAllowAccountCheck

func CtxAllowAccountCheck(ctx context.Context) context.Context

CtxAllowAccountCheck upgrades the context to allow identity check on handshake

func CtxIsAccountCheckAllowed

func CtxIsAccountCheckAllowed(ctx context.Context) bool

CtxIsAccountCheckAllowed checks if the "allowAccountCheck" flag is set to true in the provided context.

Types

type Config

type Config struct {
	RequireClientAuth bool `yaml:"requireClientAuth"`
}

type SecureService

type SecureService interface {
	SecureOutbound(ctx context.Context, conn net.Conn) (cctx context.Context, err error)
	HandshakeOutbound(ctx context.Context, conn io.ReadWriteCloser, peerId string) (cctx context.Context, err error)
	SecureInbound(ctx context.Context, conn net.Conn) (cctx context.Context, err error)
	HandshakeInbound(ctx context.Context, conn io.ReadWriteCloser, remotePeerId string) (cctx context.Context, err error)
	TlsConfig() (*tls.Config, <-chan crypto.PubKey, error)
	app.Component
}

func New

func New() SecureService