99ec7ffca9
Since https://github.com/ooni/probe-cli/pull/527, if an experiment returns an error, the corresponding measurement is not submitted since the semantics of returning an error is that something fundamental went wrong (e.g., we could not parse the input URL). This diff ensures that all experiments only return and error when something fundamental was wrong and return nil otherwise. Reference issue: https://github.com/ooni/probe/issues/1808.
134 lines
5.0 KiB
Go
134 lines
5.0 KiB
Go
// Package urlgetter implements a nettest that fetches a URL.
|
|
//
|
|
// See https://github.com/ooni/spec/blob/master/nettests/ts-027-urlgetter.md.
|
|
package urlgetter
|
|
|
|
import (
|
|
"context"
|
|
"crypto/x509"
|
|
"time"
|
|
|
|
"github.com/ooni/probe-cli/v3/internal/engine/netx/archival"
|
|
"github.com/ooni/probe-cli/v3/internal/model"
|
|
)
|
|
|
|
const (
|
|
testName = "urlgetter"
|
|
testVersion = "0.2.0"
|
|
)
|
|
|
|
// Config contains the experiment's configuration.
|
|
type Config struct {
|
|
// not settable from command line
|
|
CertPool *x509.CertPool
|
|
Timeout time.Duration
|
|
|
|
// settable from command line
|
|
DNSCache string `ooni:"Add 'DOMAIN IP...' to cache"`
|
|
DNSHTTPHost string `ooni:"Force using specific HTTP Host header for DNS requests"`
|
|
DNSTLSServerName string `ooni:"Force TLS to using a specific SNI for encrypted DNS requests"`
|
|
DNSTLSVersion string `ooni:"Force specific TLS version used for DoT/DoH (e.g. 'TLSv1.3')"`
|
|
FailOnHTTPError bool `ooni:"Fail HTTP request if status code is 400 or above"`
|
|
HTTP3Enabled bool `ooni:"use http3 instead of http/1.1 or http2"`
|
|
HTTPHost string `ooni:"Force using specific HTTP Host header"`
|
|
Method string `ooni:"Force HTTP method different than GET"`
|
|
NoFollowRedirects bool `ooni:"Disable following redirects"`
|
|
NoTLSVerify bool `ooni:"Disable TLS verification"`
|
|
RejectDNSBogons bool `ooni:"Fail DNS lookup if response contains bogons"`
|
|
ResolverURL string `ooni:"URL describing the resolver to use"`
|
|
TLSServerName string `ooni:"Force TLS to using a specific SNI in Client Hello"`
|
|
TLSVersion string `ooni:"Force specific TLS version (e.g. 'TLSv1.3')"`
|
|
Tunnel string `ooni:"Run experiment over a tunnel, e.g. psiphon"`
|
|
UserAgent string `ooni:"Use the specified User-Agent"`
|
|
}
|
|
|
|
// TestKeys contains the experiment's result.
|
|
type TestKeys struct {
|
|
// The following fields are part of the typical JSON emitted by OONI.
|
|
Agent string `json:"agent"`
|
|
BootstrapTime float64 `json:"bootstrap_time,omitempty"`
|
|
DNSCache []string `json:"dns_cache,omitempty"`
|
|
FailedOperation *string `json:"failed_operation"`
|
|
Failure *string `json:"failure"`
|
|
NetworkEvents []archival.NetworkEvent `json:"network_events"`
|
|
Queries []archival.DNSQueryEntry `json:"queries"`
|
|
Requests []archival.RequestEntry `json:"requests"`
|
|
SOCKSProxy string `json:"socksproxy,omitempty"`
|
|
TCPConnect []archival.TCPConnectEntry `json:"tcp_connect"`
|
|
TLSHandshakes []archival.TLSHandshake `json:"tls_handshakes"`
|
|
Tunnel string `json:"tunnel,omitempty"`
|
|
|
|
// The following fields are not serialised but are useful to simplify
|
|
// analysing the measurements in telegram, whatsapp, etc.
|
|
HTTPResponseStatus int64 `json:"-"`
|
|
HTTPResponseBody string `json:"-"`
|
|
HTTPResponseLocations []string `json:"-"`
|
|
}
|
|
|
|
// RegisterExtensions registers the extensions used by the urlgetter
|
|
// experiment into the provided measurement.
|
|
func RegisterExtensions(m *model.Measurement) {
|
|
archival.ExtHTTP.AddTo(m)
|
|
archival.ExtDNS.AddTo(m)
|
|
archival.ExtNetevents.AddTo(m)
|
|
archival.ExtTCPConnect.AddTo(m)
|
|
archival.ExtTLSHandshake.AddTo(m)
|
|
archival.ExtTunnel.AddTo(m)
|
|
}
|
|
|
|
// Measurer performs the measurement.
|
|
type Measurer struct {
|
|
Config
|
|
}
|
|
|
|
// ExperimentName implements model.ExperimentSession.ExperimentName
|
|
func (m Measurer) ExperimentName() string {
|
|
return testName
|
|
}
|
|
|
|
// ExperimentVersion implements model.ExperimentSession.ExperimentVersion
|
|
func (m Measurer) ExperimentVersion() string {
|
|
return testVersion
|
|
}
|
|
|
|
// Run implements model.ExperimentSession.Run
|
|
func (m Measurer) Run(
|
|
ctx context.Context, sess model.ExperimentSession,
|
|
measurement *model.Measurement, callbacks model.ExperimentCallbacks,
|
|
) error {
|
|
// When using the urlgetter experiment directly, there is a nonconfigurable
|
|
// default timeout that applies. When urlgetter is used as a library, it's
|
|
// instead the responsibility of the user of urlgetter to set timeouts. Note
|
|
// that this code is indeed only called when using urlgetter directly.
|
|
if m.Config.Timeout <= 0 {
|
|
m.Config.Timeout = 45 * time.Second
|
|
}
|
|
RegisterExtensions(measurement)
|
|
g := Getter{
|
|
Config: m.Config,
|
|
Session: sess,
|
|
Target: string(measurement.Input),
|
|
}
|
|
tk, _ := g.Get(ctx) // ignore error since we have the testkeys and we wanna submit them
|
|
measurement.TestKeys = &tk
|
|
return nil
|
|
}
|
|
|
|
// NewExperimentMeasurer creates a new ExperimentMeasurer.
|
|
func NewExperimentMeasurer(config Config) model.ExperimentMeasurer {
|
|
return Measurer{Config: config}
|
|
}
|
|
|
|
// 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 SummaryKeys struct {
|
|
IsAnomaly bool `json:"-"`
|
|
}
|
|
|
|
// GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.
|
|
func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error) {
|
|
return SummaryKeys{IsAnomaly: false}, nil
|
|
}
|