client

README

migrated to monorepo https://github.com/katzenpost/katzenpost/issues/1

(and later removed from it, as this is no longer used)

Documentation

Overview

Package client provides a library for registering Katzenpost clients with a specific mixnet Provider.

Index

• type Client
  • func New(address string, options *Options) (*Client, error)
  • func (c *Client) RegisterAccountWithIdentityAndLinkKey(user string, linkKey *ecdh.PublicKey, identityKey *ecdh.PublicKey) error
  • func (c *Client) RegisterAccountWithLinkKey(user string, linkKey *ecdh.PublicKey) error
• type Options

Types

type Client

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

Client handles mixnet Provider account registration.

func New

func New(address string, options *Options) (*Client, error)

New creates a new Client with the provided configuration.

func (*Client) RegisterAccountWithIdentityAndLinkKey

func (c *Client) RegisterAccountWithIdentityAndLinkKey(user string, linkKey *ecdh.PublicKey, identityKey *ecdh.PublicKey) error

func (*Client) RegisterAccountWithLinkKey

func (c *Client) RegisterAccountWithLinkKey(user string, linkKey *ecdh.PublicKey) error

type Options

type Options struct {
	// Scheme selects the HTTP scheme
	// which is either HTTP or HTTPS
	Scheme string

	// UseSocks is set to true if the specified
	// SOCKS proxy is to be used for dialing.
	UseSocks bool

	// SocksNetwork is the network that the
	// optional SOCKS port is listening on
	// which is usually "unix" or "tcp".
	SocksNetwork string

	// SocksAddress is the address of the SOCKS port.
	SocksAddress string
}

Options are optional parameters to configure the registration client. Default values are used when a nil Options pointer is passed to New.