config

Documentation

Overview

Package config represents the global configuration options for a Prio deployment.

Index

• Constants
• type ClientAddress
• type Config
  • func Load(s []byte) (*Config, error)
  • func LoadFile(filename string) *Config
  • func (cfg *Config) NumServers() int
• type Field
• type FieldType
  • func (ft *FieldType) UnmarshalJSON(data []byte) error
• type ServerAddress

Constants

const (
	TypeInt      FieldType = iota
	TypeIntPow             = iota
	TypeBoolOr             = iota
	TypeBoolAnd            = iota
	TypeCountMin           = iota
	TypeLinReg             = iota

	// Used only for performance comparison. There is
	// no need to use these types in practice.
	TypeIntUnsafe = iota
)

Data types that Prio supports.

const DEFAULT_MAX_PENDING_REQS = 64

Each server buffers a certain number of client submissions. This value defines how large that buffer is by default.

const MAX_BUCKETS = 1024 * 128

Maximum sizes for count-min sketch structure.

const MAX_HASHES = 256

Types

type ClientAddress

type ClientAddress string

type Config

type Config struct {
	MaxPendingReqs int
	Circuit        *circuit.Circuit
	Fields         []Field
	Servers        []ServerAddress
	Clients        []ClientAddress
}

var Default *Config

The default configuration.

func Load

func Load(s []byte) (*Config, error)

Load a configuration file from a byte array.

func LoadFile

func LoadFile(filename string) *Config

func (*Config) NumServers

func (cfg *Config) NumServers() int

type Field

type Field struct {
	Name string
	Type FieldType

	IntBits int
	IntPow  int

	CountMinHashes  int
	CountMinBuckets int

	// Each client training example has the form:
	//    (y, x_1, x_2, ..., x_n)
	// where the data has dimension n.
	//
	// The 0th entry is the number of bits in the y value.
	// The rest of the entries represent the number of bits in each x_i.
	LinRegBits []int
}

Definition of a data type that this Prio deployment collects.

type FieldType

type FieldType byte

func (*FieldType) UnmarshalJSON

func (ft *FieldType) UnmarshalJSON(data []byte) error

See: https://talks.golang.org/2015/json.slide#23

type ServerAddress

type ServerAddress struct {
	Public  string `json:"addrPub"`
	Private string `json:"addrPriv"`
}