diff --git a/docs/diagrams/dns.msc b/docs/diagrams/dns.msc index bbe75ba..72cf55e 100644 --- a/docs/diagrams/dns.msc +++ b/docs/diagrams/dns.msc @@ -5,8 +5,11 @@ msc { probe=>remote [ label = "Write DNS Query over UDP" ]; probe<=remote [ label = "Read Response" ]; probe box probe [label="Validate IP Match"]; - probe=>remote [ label = "Query Non-matching IPs for Domain over HTTP/S" ]; + probe=>remote [ label = "Query Non-matching IPs for Domain over HTTPS" ]; probe<=remote [ label = "Read Responses" ]; probe box probe [label="Validate response certificate for domain"]; + probe=>remote [ label = "Query Non-matching IPs for Domain over HTTP" ]; + probe<=remote [ label = "Read Responses" ]; + probe box probe [label="Check response content"]; probe box probe [label="Test Complete"]; } \ No newline at end of file diff --git a/docs/diagrams/dns.svg b/docs/diagrams/dns.svg index 31228f4..1a79c4c 100644 --- a/docs/diagrams/dns.svg +++ b/docs/diagrams/dns.svg @@ -1,8 +1,8 @@ @@ -57,9 +57,9 @@ Validate IP Match - - -Query Non-matching IPs for Domain over HTTP/S + + +Query Non-matching IPs for Domain over HTTPS @@ -82,15 +82,42 @@ Validate response certificate for domain - - - - - - - + + + + +Query Non-matching IPs for Domain over HTTP + + + + + + + +Read Responses + + + + + + + + + + +Check response content + + + + + + + + + + Test Complete - - + + diff --git a/docs/outcome.md b/docs/outcome.md index 5d64a40..f879395 100644 --- a/docs/outcome.md +++ b/docs/outcome.md @@ -86,14 +86,14 @@ Mismatch Errors are used when the connection is successful, but the content rece The Satellite data uses its own unique set of outcomes, and does not use stages. The outcomes are based on DNS errors and POSIX TCP/IP socket return codes. -| Outcome | Additional Outcome Information | Explanation | -| ---------------------- | ---------------------- | ----------- | +| Outcome | Additional Outcome Information Included | Explanation | +| ---------------------- | --------------------------------------- | ----------- | | ✅ip.matchip | | The DNS request returned an expected (matching) IP address for the domain | | ✅ip.matchasn | | The DNS request returned an IP address matching the ASN of an expected IP address | -| ❗️ip.invalid | One of `:zero`, `:local_host`, `:local_net` | The DNS request returned an IP that could never be valid. eg. `0.0.0.0`, `127.0.0.1` `10.10.0.0`, `172.16.0.0 | +| ❗️ip.invalid | One of `:zero`, `:local_host`, `:local_net` | The DNS request returned an IP that could never be valid. eg. `0.0.0.0`, `127.0.0.1` `10.10.0.0`, `172.16.0.0`` | | ❗️ip.empty | | The DNS request returned an empty response | | ✅tls.validcert | | An HTTPS connection to a returned IP address returned a valid certificate which matched the expected domain | -| ❗️tls.connerror | `:` eg `:ERTELECOM_DS_AS`
or `:AS` eg `:15169`
or `:missing_as_info` | Attempting to connect to all returned IP addresses failed | +| ❗️tls.connerror | `:` eg `:ERTELECOM_DS_AS`
or `:AS` eg `:AS15169`
or `:missing_as_info` | Attempting to connect to all returned IP addresses failed | | ❗️tls.baddomain | `:` eg. `:dnsfilter.net` | An HTTPS connection to a returned IP returned a certificate for an unexpected domain. Could indicate a MITM attempt | | ❗️tls.badca | `:` eg. `:Fortiguard SDNS Blocked Page` | An HTTPS connection to a returned IP returned an invalid certificate. Could indicate a MITM attempt | | ❗️http.blockpage | `:` eg. `:f_gen_id_1_satellite` | An HTTPS request to the returned IP address failed, but an HTTP request returned a [known blockpage](https://github.com/censoredplanet/censoredplanet-analysis/blob/master/pipeline/metadata/data/blockpage_signatures.json) | diff --git a/docs/satellite_base_table.md b/docs/satellite_base_table.md deleted file mode 100644 index e69de29..0000000