tlstool

Documentation

Overview

Package tlstool contains a TLS tool that we are currently using for running quick and dirty experiments. This tool will change without notice and may be removed without notice.

Caveats

In particular, this experiment MAY panic when passed incorrect input. This is acceptable because this is not production ready code.

Index

• func NewExperimentMeasurer(config Config) model.ExperimentMeasurer
• type Config
• type ExperimentKeys
• type Measurer
  • func (m Measurer) ExperimentName() string
  • func (m Measurer) ExperimentVersion() string
  • func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error)
  • func (m Measurer) Run(ctx context.Context, sess model.ExperimentSession, ...) error
• type SummaryKeys
• type TestKeys

Functions

func NewExperimentMeasurer

func NewExperimentMeasurer(config Config) model.ExperimentMeasurer

NewExperimentMeasurer creates a new ExperimentMeasurer.

Types

type Config

type Config struct {
	Delay int64  `ooni:"Milliseconds to wait between writes"`
	SNI   string `ooni:"Force using the specified SNI"`
}

Config contains the experiment configuration.

type ExperimentKeys

type ExperimentKeys struct {
	Failure *string `json:"failure"`
}

ExperimentKeys contains the specific experiment results.

type Measurer

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

Measurer performs the measurement.

func (Measurer) ExperimentName

func (m Measurer) ExperimentName() string

ExperimentName implements ExperimentMeasurer.ExperiExperimentName.

func (Measurer) ExperimentVersion

func (m Measurer) ExperimentVersion() string

ExperimentVersion implements ExperimentMeasurer.ExperimentVersion.

func (Measurer) GetSummaryKeys

func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error)

GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.

func (Measurer) Run

func (m Measurer) Run(
	ctx context.Context,
	sess model.ExperimentSession,
	measurement *model.Measurement,
	callbacks model.ExperimentCallbacks,
) error

Run implements ExperimentMeasurer.Run.

type SummaryKeys

type SummaryKeys struct {
	IsAnomaly bool `json:"-"`
}

SummaryKeys contains summary keys for this experiment.

Note that this structure is part of the ABI contract with probe-cli therefore we should be careful when changing it.

type TestKeys

type TestKeys struct {
	Experiment map[string]*ExperimentKeys `json:"experiment"`
}

TestKeys contains the experiment results.