Allium is a genus of monocotyledonous flowering plants that includes hundreds of species, including the cultivated onion, garlic, scallion, shallot, leek, and chives. — Wikipedia
Allium is a onion routing library written in Rust. It allows the communication over tunnels constructed with layered encryption across peers chosen from a provided pool. Apart from being used as a Rust library, Allium can also be run as a stand-alone daemon controlled over a unix socket.
Rust and Cargo (version 1.45.0 or newer) are required for building. If not installed already, install both with rustup.
After cloning the repository, build and run the project with:
$ cargo run --release -- [ARGS]
Alternatively the steps of building and running can be done separately with:
$ cargo build --release
$ target/release/allium-daemon [ARGS]
Substitute [ARGS] with the following command line parameters:
* [config file path]: (optional) Specify the path to the configuration file. Defaults to config.ini.
The configuration file must be in *.ini or *.toml format.
Example ini-configuration:
```ini
[onion]
; The address and port on which the onion module is listening for API connections
apiaddress = 127.0.0.1:4200
; The port on which connections from other onion peers are accepted
p2pport = 4201
; The address on which connections from other onion peers are accepted
p2phostname = 127.0.0.1
; The path to a PEM-encoded RSA keypair used for proving this module's identity to peers
hostkey = testkey.pem
; The number of hops (excluding the destination) in each tunnel (should be at least 2)
hops = 2
; Enable or disable cover traffic
covertraffic = true
; Duration of each round in seconds.
round_duration = 120
[rps] ; The address and port the RPS module is listening on api_address = 127.0.0.1:4100 ```
A suitable RSA keypair can be generated with OpenSSL:
$ openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:4096 -out testkey.pkcs8.pem
$ openssl rsa -in testkey.pkcs8.pem -out testkey.pem
The public key supplied in a BUILD message must be in the DER-encoded SubjectPublicKeyInfo format which can be obtained like this:
$ openssl rsa -in testkey.pem -outform DER -pubout -out testkey_pub.der
For testing purposes, a command-line interface is provided which can be run like this:
$ cargo run --example cli
Additionally, the logging level can be specified like this:
$ RUST_LOG=trace cargo run --example cli
Tests can be run with
cargo test
Install the binary to ~/.cargo/bin/ by running the following command inside the cloned directory.
cargo install --path .