a849213b59
This diff breaks the circular dependency between session and tunnel, by introducing the concept of early session. An early session is a session that is able to fetch the psiphon configuration file _only_ if it's embedded in the binary. This breaks `miniooni --tunnel=psiphon` for users who have access to the OONI backend. They are not the users we are writing this feature for, though, so I think this is reasonable. At the same time, this opens up the possibility of creating a psiphon tunnel when constructing a session, which is the approach I was following in https://github.com/ooni/probe-cli/pull/286. This work is part of https://github.com/ooni/probe/issues/985. Once this diff is in, I can land https://github.com/ooni/probe-cli/pull/286.
OONI Probe Client Library and CLI
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.