Skip to content

Commit

Permalink
Docs update - links to analysis pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
ramakrishnansr committed Feb 20, 2022
1 parent 2d0f7a0 commit 5d56787
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/dns.rst
Expand Up @@ -731,12 +731,12 @@ Verify
Notes
*****
While Satellite includes multiple control resolvers intended to avoid false inferences there is still a
possibility that certain measurements are marked as anomalies incorrectly. To confirm censorship, it is
recommended that the raw DNS responses are compared to known blockpage fingerprints. The blockpage fingerprints
possibility that certain measurements are marked as anomalies incorrectly. To confirm censorship, it is critical
that the raw DNS responses are compared to known blockpage fingerprints. The blockpage fingerprints
currently recorded by Censored Planet are available `here <https://assets.censoredplanet.org/blockpage_signatures.json>`_.
Moreover, aggregations can be used to avoid anomalous vantage points and domains.
Please refer to our sample `analysis scripts <https://github.com/censoredplanet/censoredplanet>`_ for a guide on processing
the data.
Please use our `analysis pipeline <https://github.com/censoredplanet/censoredplanet-analysis>_` sample `analysis scripts <https://github.com/censoredplanet/censoredplanet>`_
to process the data before using it.

Censored Planet detects network interference of websites using remote measurements to infrastructural vantage points
within networks (eg. institutions). Note that this raw data cannot determine the entity responsible for the blocking
Expand Down
6 changes: 3 additions & 3 deletions docs/http.rst
Expand Up @@ -273,11 +273,11 @@ Notes
*************
While Hyperquack-v2 includes multiple trials intended to avoid random network errors, there is still a
possibility that certain measurements are marked as anomalies incorrectly. To confirm censorship, it is
recommended that the raw responses are compared to known blockpage fingerprints. The blockpage fingerprints
critical that the raw responses are compared to known blockpage fingerprints. The blockpage fingerprints
currently recorded by Censored Planet are available `here <https://assets.censoredplanet.org/blockpage_signatures.json>`_.
Moreover, network errors (such as TCP handshake and Setup errors) must be filtered out to avoid false inferences.
Please refer to our sample `analysis scripts <https://github.com/censoredplanet/censoredplanet>`_ for a guide on processing
the data.
Please use our `analysis pipeline <https://github.com/censoredplanet/censoredplanet-analysis>_` sample `analysis scripts <https://github.com/censoredplanet/censoredplanet>`_
to process the data before using it.

Censored Planet detects network interference of websites using remote measurements to infrastructural vantage points
within networks (eg. institutions). Note that this raw data cannot determine the entity responsible for the blocking
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Expand Up @@ -19,7 +19,8 @@ Censored Planet data is available to the public through the Censored Planet webs

Figure - Raw data files on the Censored Planet website

Each scan contains a test of all 2,000 websites tested by Censored Planet with a set of vantage points across different countries. The archive files can be downloaded, extracted and analyzed. The data formats change based on the version of the measurement technique. The data formats and tips for analyzing the data for each of the published data files and versions are available below. For more information about using the data, please refer to the `Censored Planet Github <https://github.com/censoredplanet/censoredplanet/tree/master/docs>`_, or email Censored Planet at `censoredplanet@umich.edu <mailto:censoredplanet@umich.edu>`_.
Each scan contains a test of all 2,000 websites tested by Censored Planet with a set of vantage points across different countries. The archive files can be downloaded, extracted and analyzed. The data formats change based on the version of the measurement technique. The data formats and tips for analyzing the data for each of the published data files and versions are available below. It is critical that the raw data produced by Censored Planet is treated as a network observation and analyzed further using our `analysis pipeline <https://github.com/censoredplanet/censoredplanet-analysis>_` sample `analysis scripts <https://github.com/censoredplanet/censoredplanet>`_
before use. For more information about using the data, please refer to the `Censored Planet Github <https://github.com/censoredplanet/censoredplanet>`_, or email Censored Planet at `censoredplanet@umich.edu <mailto:censoredplanet@umich.edu>`_.

********
Contents
Expand Down

0 comments on commit 5d56787

Please sign in to comment.