kimchi

README

Run tests with the "WarpedEpoch" build time flag set to "true" to decrease epochtime.Period to 2 minutes and the pki recheck interval to 20 seconds.

Pass this flag at test time like this:

go test -timeout 0 -ldflags "-X github.com/katzenpost/kimchi/vendor/github.com/katzenpost/core/epochtime.WarpedEpoch=true -X github.com/katzenpost/kimchi/vendor/github.com/katzenpost/server/internal/pki.WarpedEpoch=true"

You can specify a specific test to run with the -run option, e.g.

go test -timeout 0 -ldflags "-X github.com/katzenpost/kimchi/vendor/github.com/katzenpost/core/epochtime.WarpedEpoch=true -X github.com/katzenpost/kimchi/vendor/github.com/katzenpost/server/internal/pki.WarpedEpoch=true" -run TestAuthorityJoinConsensus

Documentation

Index

• type Kimchi
  • func NewKimchi(basePort int, baseDir string, parameters *Parameters, voting bool, ...) *Kimchi
  • func (k *Kimchi) GetCatshadowConfig() (*csConfig.Config, error)
  • func (k *Kimchi) GetClientConfig() (*cConfig.Config, string, *ecdh.PrivateKey, error)
  • func (k *Kimchi) GetClientNetconfig() (*cConfig.Config, error)
  • func (k *Kimchi) KillAMix() bool
  • func (k *Kimchi) KillAnAuth() bool
  • func (k *Kimchi) LogTailer(prefix, path string)
  • func (k *Kimchi) PKIClient() (pki.Client, error)
  • func (k *Kimchi) Run()
  • func (k *Kimchi) RunWithDelayedAuthority(delay time.Duration)
  • func (k *Kimchi) Shutdown()
• type Parameters

Types

type Kimchi

type Kimchi struct {
	sync.Mutex
	sync.WaitGroup
	// contains filtered or unexported fields
}

func NewKimchi

func NewKimchi(basePort int, baseDir string, parameters *Parameters, voting bool, nVoting, nProvider, nMix int) *Kimchi

NewKimchi returns an initialized kimchi

func (*Kimchi) GetCatshadowConfig

func (k *Kimchi) GetCatshadowConfig() (*csConfig.Config, error)

GetCatshadowConfig returns a catshadow client configuration

func (*Kimchi) GetClientConfig

func (k *Kimchi) GetClientConfig() (*cConfig.Config, string, *ecdh.PrivateKey, error)

GetClientConfig returns a client.Config and configures the client Account

func (*Kimchi) GetClientNetconfig

func (k *Kimchi) GetClientNetconfig() (*cConfig.Config, error)

GetClientNetconfig returns a client.Config populated with PKI information

func (*Kimchi) KillAMix

func (k *Kimchi) KillAMix() bool

Shutdown a mix

func (*Kimchi) KillAnAuth

func (k *Kimchi) KillAnAuth() bool

Shutdown an authority

func (*Kimchi) LogTailer

func (k *Kimchi) LogTailer(prefix, path string)

func (*Kimchi) PKIClient

func (k *Kimchi) PKIClient() (pki.Client, error)

func (*Kimchi) Run

func (k *Kimchi) Run()

func (*Kimchi) RunWithDelayedAuthority

func (k *Kimchi) RunWithDelayedAuthority(delay time.Duration)

func (*Kimchi) Shutdown

func (k *Kimchi) Shutdown()

type Parameters

type Parameters struct {
	vConfig.Parameters
}