Skip to content

Commit

Permalink
doc(sni-blocking): don't spec real helper FQDN
Browse files Browse the repository at this point in the history
The spec should not say that the experiment will use a specific domain name since
that's clearly too binding. Let us instead just use example.org as an example and let
us the experiment be free to update the real helper depending on its needs.

This change opens up the opportunity of dynamically provisioning the real helper
to the probes depending on the country and on other factors.

Related PR: ooni/probe-engine#1040

Work done in the context of: ooni/probe-engine#622
  • Loading branch information
bassosimone authored Nov 12, 2020
1 parent 6e55317 commit 1d30004
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions nettests/ts-024-sni-blocking.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Specification version number

2020-03-07-002
2020-11-12-001

# Specification name

Expand All @@ -21,7 +21,7 @@ for the SNI/domain to be unreachable/filtered.

# Expected inputs

- `control_sni` (`string`): a SNI to use as control (e.g. `example.com`)
- `control_sni` (`string`): a SNI to use as control (e.g. `example.org`)

- `testhelper` (`endpoint`; optional): endpoint where TLS is enabled
expressed as `IPv4:port`, `[IPv6]:port`, or `domain:port` (e.g. `1.1.1.1:443`)
Expand All @@ -30,9 +30,10 @@ expressed as `IPv4:port`, `[IPv6]:port`, or `domain:port` (e.g. `1.1.1.1:443`)

If `testhelper` is not specified we use `${control_sni}:443`.

The default implementation will use `example.com` as `control_sni`
and the empty string as testhelper endpoint. This will effectively
cause us to use `example.com:443` as testhelper endpoint.
The default implementation will use a domain such as `example.org` as
the `control_sni` and the empty string as testhelper endpoint. This will
effectively cause us to use `example.org:443` (or whatever domain is
actually used on port `443`) as the testhelper endpoint.

A valid `Target` is a valid domain name (e.g. `kernel.org`), a valid IP
address (e.g. `1.1.1.1`), or a valid URL (e.g. `http://x.org`). When the
Expand Down

0 comments on commit 1d30004

Please sign in to comment.