Simone Basso c89ecce3e0
feat: support embedding encrypted psiphon config (#285)
We use an optional build tag to hide this configuration. When you
choose this configuration, you need to provide the encrypted config
as well as the corresponding decryption key.

This is not the final design. This is an interim design to start
working and experimenting with this functionality. The general
idea here is to support psiphon in the binaries we build without
committing the psiphon config to the repository itself.

Part of https://github.com/ooni/probe/issues/985
2021-04-02 17:36:06 +02:00
2018-07-11 18:06:27 +02:00

OONI Probe Client Library and CLI

GoDoc Short Tests Status All Tests Status Coverage Status Go Report Card linux-debian-packages GitHub issues by-label

The next generation OONI Probe: client library and Command Line Interface.

User setup

Please, follow the instructions at ooni.org/install/cli to install ooniprobe. If we do not support your use case, please let us know.

Once ooniprobe is installed, try ooniprobe help to get interactive help.

Reporting issues

Please, report issues with this codebase at github.com/ooni/probe. Please, make sure you tag such issues using the ooni/probe-cli label.

Repository organization

Every top-level directory contains an explanatory README file.

Development setup

Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you need Mingw-w64 installed). You can build using:

go build -v ./cmd/ooniprobe

This will generate a binary called ooniprobe in the current directory.

Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Updating dependencies

go get -u -v ./... && go mod tidy

Releasing

Create an issue according to the routine release template and perform any item inside the check-list.

Description
No description provided
Readme 8.8 MiB
Languages
Go 97.6%
Python 1.2%
Shell 0.9%
Makefile 0.3%