tlsping

package
v3.31.0 Latest Latest
Warning

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

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

Documentation

Overview

Package tlsping is the experimental tlsping experiment.

See https://github.com/ooni/spec/blob/master/nettests/ts-033-tlsping.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 *tlsping.Config.

Types

type Config

type Config struct {
	// ALPN allows to specify which ALPN or ALPNs to send.
	ALPN string `json:"alpn,omitempty" ooni:"space separated list of ALPNs to use"`

	// Delay is the delay between each repetition (in milliseconds).
	Delay int64 `json:"delay,omitempty" ooni:"number of milliseconds to wait before sending each ping"`

	// Repetitions is the number of repetitions for each ping.
	Repetitions int64 `json:"repetitions,omitempty" ooni:"number of times to repeat the measurement"`

	// SNI is the SNI value to use.
	SNI string `json:"sni,omitempty" ooni:"the SNI value to use"`
}

Config contains the experiment configuration.

type Measurer

type Measurer struct{}

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) Run

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

Run implements ExperimentMeasurer.Run.

type SinglePing

type SinglePing struct {
	NetworkEvents []*model.ArchivalNetworkEvent           `json:"network_events"`
	TCPConnect    *model.ArchivalTCPConnectResult         `json:"tcp_connect"`
	TLSHandshake  *model.ArchivalTLSOrQUICHandshakeResult `json:"tls_handshake"`
}

SinglePing contains the results of a single ping.

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 {
	Pings []*SinglePing `json:"pings"`
}

TestKeys contains the experiment results.

Jump to

Keyboard shortcuts

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