spec README

The project's README from github.com/ooni/spec. As one markdown file: README.md.

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. 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 directory.

OONI Probe (aka the Probe)

The software that users run to perform nettests. See the 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 directory.

Data formats

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

Backends

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

Contributing

Please, see CONTRIBUTING.md.

spec (ooni/spec)

Searching Database…

204 ·GitHub
这是什么?这是 OONI Spec,OONI 在这个仓库里公开规定自己的检测方法:包括它运行的网络实验(nettests)、用于检测的后端组件,以及结果的存储格式。
这是一个我能运行的程序,还是书面文档?是书面文档:一组参照互联网 RFC 流程维护的规范文档,不是可以安装或运行的软件。
我应该从哪里开始读?先读 README,然后再读单独的介绍文档,它从 OONI Probe 的角度说明 OONI 是如何运作的;README 推荐新从这里入门。
这些规范是写给谁看的?主要是新加入的 OONI 开发者,建议他们阅读以了解背景;另外任何想自行实现 OONI 测试的人也适合阅读。
什么是 nettest?nettest(也叫 experiment,即实验)是一类网络实验,能产出对最终用户有实际意义的结果;OONI Probe 检测网络连接时实际运行的就是它们。
这个仓库里有什么?规范分为五个部分:nettests(网络实验)、probe(面向用户的检测软件)、techniques(实现策略、假设和各平台的细节)、data-formats(结果如何呈现给用户和分析人员)、backends(负责执行实验的核心基础设施)。
OONI 为什么要写正式的规范,而不只是直接发布代码?采用类似 RFC 的流程,是为了让人深入理解每个测试的原理,把各种假设明确写出来,并让任何人都能独立实现这套检测方法。
OONI Probe 本身是什么?它是用户用来运行 nettest 的软件;本仓库的 probe 目录就是对它的规范说明,至于安装和使用,OONI 另有面向用户的独立文档。
Creator
ooni
Size
2.6 MB
Stars
204
Updated
CommitSep 29
Age
13y
Commits · 90 Days