4bf87d61ca
Break TorClientConfig out of ArtiConfig and warn on unknown config keys Closes #459 and #417 See merge request tpo/core/arti!529 |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
README.md
arti
A minimal command line program for connecting to the tor network
(If you want a more general Tor client library interface, use [arti_client].)
This crate is the primary command-line interface for Arti, a project to implement Tor in Rust. Many other crates in Arti depend on it.
Note that Arti is a work in progress; although we've tried to write all the critical security components, you probably shouldn't use Arti in production until it's a bit more mature.
More documentation will follow as this program improves. For now, just know that it can run as a simple SOCKS proxy over the Tor network. It will listen on port 9150 by default, but you can override this in the configuration.
Command-line interface
(This is not stable; future versions will break this.)
arti uses the clap crate for command-line
argument parsing; run arti help to get it to print its documentation.
The only currently implemented subcommand is arti proxy; try
arti help proxy for a list of options you can pass to it.
Configuration
By default, arti looks for its configuration files in a
platform-dependent location.
| OS | Configuration File |
|---|---|
| Unix | ~/.config/arti/arti.toml |
| macOS | ~/Library/Application Support/arti/arti.toml |
| Windows | \Users\<USERNAME>\AppData\Roaming\arti\arti.toml |
The configuration file is TOML. (We do not guarantee its stability.)
For an example see arti_defaults.toml.
Compile-time features
tokio (default): Use the tokio runtime library as our backend.
async-std: Use the async-std runtime library as our backend.
This feature has no effect unless building with --no-default-features
to disable tokio.
native-tls -- Build with support for the native_tls TLS
backend. (default)
rustls -- Build with support for the rustls TLS backend.
static -- Link with static versions of your system dependencies,
including sqlite and/or openssl. (⚠ Warning ⚠: this feature will
include a dependency on native-tls, even if you weren't planning
to use native-tls. If you only want to build with a static sqlite
library, enable the static-sqlite feature. We'll look for
better solutions here in the future.)
static-sqlite -- Link with a static version of sqlite.
static-native-tls -- Link with a static version of native-tls.
Enables native-tls.
Limitations
There are many missing features. Among them: there's no onion service support yet. There's no anti-censorship support. You can't be a relay. There isn't any kind of proxy besides SOCKS.
See the README file for a more complete list of missing features.
Library for building command-line client
This library crate contains code useful for making
a command line program similar to arti.
The API should not be considered stable.
License: MIT OR Apache-2.0