https://github.com/ooni/spec

OONI Specifications
https://github.com/ooni/spec

ooni ooni-spec ooniprobe specification

Last synced: about 1 month ago
JSON representation

OONI Specifications

• Host: GitHub
• URL: https://github.com/ooni/spec
• Owner: ooni
• License: bsd-3-clause
• Created: 2013-01-19T18:29:06.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-04-03T13:21:33.000Z (9 months ago)
• Last Synced: 2024-04-14T09:04:44.293Z (8 months ago)
• Topics: ooni, ooni-spec, ooniprobe, specification
• Homepage:
• Size: 2.49 MB
• Stars: 140
• Watchers: 39
• Forks: 66
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# OONI Spec

The OONI testing methodology is openly specified as part of OONI Spec. This

includes all the experiments that we run, the backend components used as part

of test and the data formats.

The way in which we do these specifications is similar to the RFC (Request For

Comments) process.

This makes it possible to have a deep understanding of how OONI tests work,

explain the assumption we make in them and make it possible to create

independent implementations.

To get an introduction of how we operate from the point of view of OONI Probe,

i.e. the software that users can install, please see [the specific

documentation describing that](probe). New developers would ideally want

to be familiar with this document to understand the context.

## Terminology

*Nettests (aka experiments)*

Are network experiments that deliver some meaningful results to end users. See

the [nettests](nettests) directory.

*OONI Probe (aka the Probe)*

The software that users run to perform nettests. See the [probe](probe) directory.

*Techniques*

Are strategies that we follow for implementing nettests, hypothesis we are

interested in testing and implementation details for each target platform. See

the [techniques](techniques) directory.

*Data formats*

Define how data is presented to end users or analysts. See the

[data-formats](data-formats) directory.

*Backends*

Are core OONI infrastructure components that are necessary to carry out experiments. See

the [backends](backends) directory.

## Contributing

Please, see [CONTRIBUTING.md](CONTRIBUTING.md).