https://github.com/ooni/2023-05-richer-input
https://github.com/ooni/2023-05-richer-input
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ooni/2023-05-richer-input
- Owner: ooni
- License: gpl-3.0
- Created: 2023-05-23T11:12:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-08T09:22:11.000Z (almost 3 years ago)
- Last Synced: 2025-10-27T12:36:43.843Z (9 months ago)
- Language: Go
- Size: 539 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 2023-05: Richer Input PoC
We define "richer input" as the possibility of delivering to OONI-Probe
nettests complex input. As of 2023-05-30, OONI nettests either do not
take any input or take a string as input.
This repository contains a proof-of-concept redesign of OONI probe,
where we implement richer input and explore how it can simplify the
implementation.
We include a stripped down version of `ooniprobe` that only supports
the `runx` command to support experimental runs. This command only
allows to run nettests given (a) a known probe location and (b) a script
telling the OONI Probe what to do exactly. This is the most basic
functionality that OONI Probe could provide.
See below for examples of how you can invoke the `runx` command.
See [DESIGN.md](DESIGN.md) and [ARCHITECTURE.md](ARCHITECTURE.md)
for more information.
## Reference Issues
The reference issues for this work are:
- [ooni.org#1291](https://github.com/ooni/ooni.org/issues/1291);
- [ooni.org#1292](https://github.com/ooni/ooni.org/issues/1292);
- [ooni.org#1295](https://github.com/ooni/ooni.org/issues/1295);
- [probe#2381](https://github.com/ooni/probe/issues/2381); and
- [probe#2445](https://github.com/ooni/probe/issues/2445).
## Building
Obtain go1.20.5 using these commands:
```console
go get golang.org/dl/go1.20.5@latest
~/go/bin/go1.20.5 download
```
Then build using:
```console
~/go/bin/go1.20.5 build -v ./cmd/ooniprobe
```
## Running
Try:
```console
./ooniprobe runx --log-file LOG.txt \
--location-file testdata/location.jsonc \
--script-file testdata/full.jsonc
```
To run a reasonably complete OONI measurements.