psiphon

package
v3.31.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2026 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Overview

Package psiphon implements the psiphon network experiment. This implements, in particular, v0.2.0 of the spec.

See https://github.com/ooni/spec/blob/master/nettests/ts-015-psiphon.md

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrInputRequired indicates that no richer-input target was provided.
	ErrInputRequired = targetloading.ErrInputRequired

	// ErrInvalidInputType indicates that the richer-input target has the wrong type.
	ErrInvalidInputType = targetloading.ErrInvalidInputType
)

Functions

func NewExperimentMeasurer

func NewExperimentMeasurer() model.ExperimentMeasurer

NewExperimentMeasurer creates a new ExperimentMeasurer.

func NewLoader added in v3.31.0

func NewLoader(loader *targetloading.Loader, gopts any) model.ExperimentTargetLoader

NewLoader constructs a new model.ExperimentTargetLoader instance.

This function PANICS if options is not an instance of *psiphon.Config.

Types

type Config

type Config struct{}

Config contains the experiment's configuration.

type Measurer

type Measurer struct {
	BeforeGetHook func(g urlgetter.Getter)
}

Measurer is the psiphon measurer.

func (*Measurer) ExperimentName

func (m *Measurer) ExperimentName() string

ExperimentName returns the experiment name

func (*Measurer) ExperimentVersion

func (m *Measurer) ExperimentVersion() string

ExperimentVersion returns the experiment version

func (*Measurer) Run

func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error

Run runs the measurement

type SummaryKeys

type SummaryKeys struct {
	BootstrapTime float64 `json:"bootstrap_time"`
	Failure       string  `json:"failure"`
	IsAnomaly     bool    `json:"-"`
}

SummaryKeys contains summary keys for this experiment.

func (*SummaryKeys) Anomaly added in v3.21.0

func (sk *SummaryKeys) Anomaly() bool

Anomaly implements model.MeasurementSummaryKeys.

type Target added in v3.31.0

type Target struct {
	// Config contains the configuration.
	Config *Config

	// URL is the input URL.
	URL string
}

Target is a richer-input target that this experiment should measure.

func (*Target) Category added in v3.31.0

func (t *Target) Category() string

Category implements model.ExperimentTarget.

func (*Target) Country added in v3.31.0

func (t *Target) Country() string

Country implements model.ExperimentTarget.

func (*Target) Input added in v3.31.0

func (t *Target) Input() string

Input implements model.ExperimentTarget.

func (*Target) Options added in v3.31.0

func (t *Target) Options() []string

Options implements model.ExperimentTarget.

func (*Target) String added in v3.31.0

func (t *Target) String() string

String implements model.ExperimentTarget.

type TestKeys

type TestKeys struct {
	urlgetter.TestKeys
	MaxRuntime float64 `json:"max_runtime"`
}

TestKeys contains the experiment's result.

func (*TestKeys) MeasurementSummaryKeys added in v3.21.0

func (tk *TestKeys) MeasurementSummaryKeys() model.MeasurementSummaryKeys

MeasurementSummaryKeys implements model.MeasurementSummaryKeysProvider.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL