secretstream

README

secretstream

A port of secret-handshake to Go.

Provides an encrypted bidirectional stream using two boxstreams. Uses secret-handshake to negotiate the keys and nonces.

Development

If you want to run the compatability tests against the nodejs implementation, run npm ci && go test -tags interop_nodejs on the secrethandshake and boxstream sub-packages.

Documentation

Index

• Constants
• type Addr
  • func (a Addr) Network() string
  • func (a Addr) String() string
• type Client
  • func NewClient(kp secrethandshake.EdKeyPair, appKey []byte) (*Client, error)
  • func (c *Client) ConnWrapper(pubKey []byte) netwrap.ConnWrapper
• type Conn
  • func (conn *Conn) Close() error
  • func (conn *Conn) LocalAddr() net.Addr
  • func (conn *Conn) Read(p []byte) (int, error)
  • func (conn *Conn) RemoteAddr() net.Addr
  • func (conn *Conn) SetDeadline(t time.Time) error
  • func (conn *Conn) SetReadDeadline(t time.Time) error
  • func (conn *Conn) SetWriteDeadline(t time.Time) error
  • func (conn *Conn) Write(p []byte) (int, error)
• type Server
  • func NewServer(keyPair secrethandshake.EdKeyPair, appKey []byte) (*Server, error)
  • func (s *Server) Addr() net.Addr
  • func (s *Server) ConnWrapper() netwrap.ConnWrapper
  • func (s *Server) ListenerWrapper() netwrap.ListenerWrapper

Constants

const NetworkString = "shs-bs"

Types

type Addr

type Addr struct {
	PubKey []byte
}

Addr wrapps a net.Addr and adds the public key

func (Addr) Network

func (a Addr) Network() string

Network returns NetworkString, the network id of this protocol. Can be used with go.cryptoscope.co/netwrap to wrap the underlying connection.

func (Addr) String

func (a Addr) String() string

type Client

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

Client can dial secret-handshake server endpoints

func NewClient

func NewClient(kp secrethandshake.EdKeyPair, appKey []byte) (*Client, error)

NewClient creates a new Client with the passed keyPair and appKey

func (*Client) ConnWrapper

func (c *Client) ConnWrapper(pubKey []byte) netwrap.ConnWrapper

ConnWrapper returns a connection wrapper for the client.

type Conn

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

Conn is a boxstream wrapped net.Conn

func (*Conn) Close

func (conn *Conn) Close() error

Close closes the underlying net.Conn

func (*Conn) LocalAddr

func (conn *Conn) LocalAddr() net.Addr

LocalAddr returns the local net.Addr with the local public key

func (*Conn) Read

func (conn *Conn) Read(p []byte) (int, error)

Read implements io.Reader.

func (*Conn) RemoteAddr

func (conn *Conn) RemoteAddr() net.Addr

RemoteAddr returns the remote net.Addr with the remote public key

func (*Conn) SetDeadline

func (conn *Conn) SetDeadline(t time.Time) error

SetDeadline passes the call to the underlying net.Conn

func (*Conn) SetReadDeadline

func (conn *Conn) SetReadDeadline(t time.Time) error

SetReadDeadline passes the call to the underlying net.Conn

func (*Conn) SetWriteDeadline

func (conn *Conn) SetWriteDeadline(t time.Time) error

SetWriteDeadline passes the call to the underlying net.Conn

func (*Conn) Write

func (conn *Conn) Write(p []byte) (int, error)

Write implements io.Writer.

type Server

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

Server can create net.Listeners

func NewServer

func NewServer(keyPair secrethandshake.EdKeyPair, appKey []byte) (*Server, error)

NewServer returns a Server which uses the passed keyPair and appKey

func (*Server) Addr

func (s *Server) Addr() net.Addr

Addr returns the shs-bs address of the server.

func (*Server) ConnWrapper

func (s *Server) ConnWrapper() netwrap.ConnWrapper

ConnWrapper returns a connection wrapper.

func (*Server) ListenerWrapper

func (s *Server) ListenerWrapper() netwrap.ListenerWrapper

ListenerWrapper returns a listener wrapper.