network

Documentation

Overview

Copyright (c) 2021 - for information on the respective copyright owner see the NOTICE file and/or the repository https://github.com/carbynestack/ephemeral.

SPDX-License-Identifier: Apache-2.0

Copyright (c) 2021-2024 - for information on the respective copyright owner see the NOTICE file and/or the repository https://github.com/carbynestack/ephemeral.

SPDX-License-Identifier: Apache-2.0

Copyright (c) 2021-2024 - for information on the respective copyright owner see the NOTICE file and/or the repository https://github.com/carbynestack/ephemeral.

SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func RetryingDialer(sleep, timeout time.Duration, sideEffect func()) func(addr, port string) (conn net.Conn, err error)
• func RetryingDialerWithContext(sleep time.Duration, timeout time.Duration, l *zap.SugaredLogger) func(ctx context.Context, addr, port string) (conn net.Conn, err error)
• func RetryingDialerWithContextAndLogTimeout(sleep time.Duration, timeout time.Duration, l *zap.SugaredLogger, ...) func(ctx context.Context, addr, port string) (conn net.Conn, err error)
• type AbstractProxy
• type NetworkChecker
• type NoopChecker
  • func (t *NoopChecker) Verify(context.Context, string, string) error
• type PingAwareTarget
  • func (n *PingAwareTarget) HandleConn(conn net.Conn)
  • func (n *PingAwareTarget) WaitUntilStarted(address, port string, timeout time.Duration, ...) (bool, error)
• type Proxy
  • func NewProxy(lg *zap.SugaredLogger, conf *SPDZEngineTypedConfig, checker NetworkChecker) *Proxy
  • func (p *Proxy) Run(ctx *CtxConfig, errCh chan error) error
  • func (p *Proxy) Stop()
• type TCPChecker
  • func NewTCPChecker(conf *TCPCheckerConf) *TCPChecker
  • func (t *TCPChecker) Verify(ctx context.Context, host, port string) error
• type TCPCheckerConf

Constants

const (
	// PingMsg - message received from the clients.
	PingMsg = "ping"
	// PongMsg - message sent back to the clients.
	PongMsg = "pong"
)

Functions

func RetryingDialer

func RetryingDialer(sleep, timeout time.Duration, sideEffect func()) func(addr, port string) (conn net.Conn, err error)

RetryingDialer tries to establish a TCP connection to a socket until the timeout is reached.

func RetryingDialerWithContext

func RetryingDialerWithContext(sleep time.Duration, timeout time.Duration, l *zap.SugaredLogger) func(ctx context.Context, addr, port string) (conn net.Conn, err error)

RetryingDialerWithContext tries to establish a TCP connection to a socket until the timeout is reached or the context is cancelled.

func RetryingDialerWithContextAndLogTimeout

func RetryingDialerWithContextAndLogTimeout(sleep time.Duration, timeout time.Duration, l *zap.SugaredLogger, logPeriod time.Duration) func(ctx context.Context, addr, port string) (conn net.Conn, err error)

RetryingDialerWithContextAndLogTimeout uses an individual log message timer.

Used for testing

Types

type AbstractProxy

type AbstractProxy interface {
	Run(*CtxConfig, chan error) error
	Stop()
}

AbstractProxy is an interface for proxy.

type NetworkChecker

type NetworkChecker interface {
	Verify(context.Context, string, string) error
}

NetworkChecker verifies the network connectivity between the players before starting the computation.

type NoopChecker

type NoopChecker struct {
}

NoopChecker verifies the network for all MPC players is in place.

func (*NoopChecker) Verify

func (t *NoopChecker) Verify(context.Context, string, string) error

Verify checks network connectivity between the players and communicates its results to discovery and players FSM.

type PingAwareTarget

type PingAwareTarget struct {
	Next   tcpproxy.Target
	Logger *zap.SugaredLogger
}

PingAwareTarget is a target that notifies about the start of the listener by means of the ping message.

func (*PingAwareTarget) HandleConn

func (n *PingAwareTarget) HandleConn(conn net.Conn)

HandleConn checks whether the byte stream contains ping. If it is a ping, we respond back with pong indicating the listener has started. The sender of the ping is responsible for closing the connection. In case of no ping, the data is forwarded to the Next Target.

func (*PingAwareTarget) WaitUntilStarted

func (n *PingAwareTarget) WaitUntilStarted(address, port string, timeout time.Duration, dial func(string, string) (net.Conn, error)) (bool, error)

WaitUntilStarted pings a proxy, waits for the pong and closes the connection.

type Proxy

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

Proxy is a wrapper around the tcpproxy and ping aware proxy. It establishes the connection between MPC master and slave.

func NewProxy

func NewProxy(lg *zap.SugaredLogger, conf *SPDZEngineTypedConfig, checker NetworkChecker) *Proxy

NewProxy returns a new instance of ephemeral proxy.

func (*Proxy) Run

func (p *Proxy) Run(ctx *CtxConfig, errCh chan error) error

Run start the tcpproxy, makes sure it has started by means of a ping.

func (*Proxy) Stop

func (p *Proxy) Stop()

Stop closes the underlying tcpproxy and waits for it to finish.

type TCPChecker

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

TCPChecker verifies the network for all MPC players is in place.

func NewTCPChecker

func NewTCPChecker(conf *TCPCheckerConf) *TCPChecker

NewTCPChecker returns an instance of TCPChecker

func (*TCPChecker) Verify

func (t *TCPChecker) Verify(ctx context.Context, host, port string) error

Verify checks network connectivity between the players and communicates its results to discovery and players FSM.

type TCPCheckerConf

type TCPCheckerConf struct {
	DialTimeout  time.Duration
	RetryTimeout time.Duration
	Logger       *zap.SugaredLogger
}

TCPCheckerConf is the configuration of TCPChecker