client

README

.. image:: https://travis-ci.org/katzenpost/registration_client.svg?branch=master
  :target: https://travis-ci.org/katzenpost/registration_client

.. image:: https://godoc.org/github.com/katzenpost/registration_client?status.svg
  :target: https://godoc.org/github.com/katzenpost/registration_client

Client Registration Library
===========================

This library is meant to be used by mixnet clients to register
an account on a Provider which is associated with a link layer
authentication key and optionally an identity key.



license
=======

AGPL: see LICENSE file for details.


supported by
============

.. image:: https://katzenpost.mixnetworks.org/_static/images/eu-flag-tiny.jpg

This project has received funding from the European Union’s Horizon 2020
research and innovation programme under the Grant Agreement No 653497, Privacy
and Accountability in Networks via Optimized Randomized Mix-nets (Panoramix).

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.