vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Stream the following services https://gitlab.torproject.org/tpo/core/arti.git
1,605 Commits 3 Branches 23 Tags 19 MiB
Rust 97.8%
Shell 0.8%
RenderScript 0.8%
Python 0.5%
Go to file
eta 4fa0122dde Improve and future-proof the `arti` CLI 
This switches out `arti`'s argument-parsing library with `clap`, which
is a lot more featureful (and very widely used within the Rust
ecosystem). We also now use a lot of `clap`'s features to improve the
CLI experience:

- The CLI now expects a subcommand (currently, either "help", or "proxy"
  for the existing SOCKS proxy behaviour). This should let us add
  additional non-SOCKS-proxy features to arti in future.
- `clap` supports default values determined at runtime, so the way the
  default config file is loaded was changed: now, we determine the
  OS-specific path for said file before invoking `clap`, so the help
  command can show it properly.
  - The behaviour of `tor_config` was also changed; now, one simply
    specifies a list of configuration files to load, together with
    whether they're required.
  - That function also way overused generics; this has been fixed.
- Instead of using the ARTI_LOG environment variable to configure
  logging, one now uses the `-l, --log-level` CLI option.
  (The intent is for this option to be more discoverable by users.)
- The `proxy` subcommand allows the user to override the SOCKS port used
  on the CLI without editing the config file.
 		2021-10-27 19:11:48 +01:00
.gitlab/issue_templates Adds issue creation templates for bugs, features, proposals and documentation. 2020-12-17 13:57:06 -03:00
arti-corpora@f6f889d3d3 Latest arti-corpora. 2021-09-07 15:51:10 -04:00
crates Improve and future-proof the `arti` CLI 2021-10-27 19:11:48 +01:00
doc Fix typos and cleanup 2021-10-25 19:58:42 +03:00
maint Fix typos and cleanup 2021-10-25 19:58:42 +03:00
.gitignore add reproducible builds for MacOS 2021-09-20 17:48:12 +02:00
.gitlab-ci.yml Improve and future-proof the `arti` CLI 2021-10-27 19:11:48 +01:00
.gitmodules use https submodule 2021-08-30 16:22:38 +02:00
.typos.toml Fix some typos in comments. 2021-10-19 10:40:32 -04:00
CODE_OF_CONDUCT Fix typos and cleanup 2021-10-25 19:58:42 +03:00
CONTRIBUTING.md Improve and future-proof the `arti` CLI 2021-10-27 19:11:48 +01:00
Cargo.lock Improve and future-proof the `arti` CLI 2021-10-27 19:11:48 +01:00
Cargo.toml Rename tor_client/arti_tor_client to arti_client. 2021-10-21 14:22:11 -04:00
README.md Improve and future-proof the `arti` CLI 2021-10-27 19:11:48 +01:00
WANT_FROM_OTHER_CRATES Upgrade to latest fslock and use its per-fd exclusion feature. 2021-08-11 07:15:08 -04:00

README.md

Arti: reimplementing Tor in Rust

Arti is a project to produce an embeddable, production-quality implementation of the Tor anonymity protocols in the Rust programming language.

Arti is not ready for production use; see below for more information.

Links:

Why rewrite Tor in Rust?

Rust is more secure than C. Despite our efforts, it's all too simple to mess up when using a language that does not enforce memory safety. We estimate that at least half of our tracked security vulnerabilities would have been impossible in Rust, and many of the others would have been very unlikely.

Rust enables faster development than C. Because of Rust's expressiveness and strong guarantees, we've found that we can be far more efficient and confident writing code in Rust. We hope that in the long run this will improve the pace of our software development.

Arti is more flexible than our C tor implementation. Unlike our C tor, which was designed as SOCKS proxy originally, and whose integration features were later "bolted on", Arti is designed from the ground up to work as a modular, embeddable library that other applications can use.

Arti is cleaner than our C tor implementation. Although we've tried to develop C tor well, we've learned a lot since we started it back in 2002. There are lots of places in the current C codebase where complicated "spaghetti" relationships between different pieces of code make our software needlessly hard to understand and improve.

Current status

Arti is a work-in-progress. It can connect to the Tor network, bootstrap a view of the Tor directory, and make anonymized connections over the network.

We're not aware of any critical security features missing in Arti; but however, since Arti is comparatively new software, you should probably be cautious about using it in production.

There are no guarantees about API stability yet: if you write code that uses Arti, you should expect it to break with future versions. If you write an a configuration file for Arti, it might stop working in the future.

Trying it out today

Arti can act as a SOCKS proxy that uses the Tor network. It knows how to download directory information and how to load it from cache, but it doesn't try to download more than one directory per run.

To try it out, run the demo program in arti as follows. It will open a SOCKS proxy on port 9150.

% cargo run --release -- proxy

Again, do not use this program yet if you seriously need anonymity, privacy, security, or stability.

Minimum supported Rust Version

Arti should always build with the most recent stable Rust release, and may build with one or two older Rust releases. Eventually, we may declare some long-term Minimum Supported Rust Version (MSRV), but while Arti is still in its early stages, you'll need to stay up-to-date.

As of this writing (24 August 2021), Arti works with Rust 1.53 and later.

Helping out

Have a look at our contributor guidelines.

Roadmap

Thanks to a generous grant from Zcash Open Major Grants (ZOMG), we're able to devote some significant time to Arti in the years 2021-2022. Here is our rough set of plans for what we hope to deliver when.

The goal times below are complete imagination, based on broad assumptions about developer availability. Please don't take them too seriously until we can get our project manager to sign off on them.

  • Arti 0.0.1: Minimal Secure Client (Goal: end of October 2021??)

    • Target audience: developers
    • Guard support
    • Stream Isolation
    • High test coverage
    • Draft APIs for basic usage
    • Code cleanups
    • and more...

  • Arti 0.1.0: Okay for experimental embedding (Goal: Mid March, 2022??)

    • Target audience: beta testers
    • Performance: preemptive circuit construction
    • Performance: circuit build timeout inference
    • API support for embedding
    • API support for status reporting
    • Correct timeout behavior
    • and more...

  • Arti 1.0.0: Initial stable release (Goal: Mid September, 2022??)

    • Target audience: initial users
    • Security audit
    • Stable API
    • Stable CLI
    • Stable configuration format
    • Automatic detection and response of more kinds of network problems
    • More performance work
    • and more...

  • Arti 1.1.0: Anti-censorship features (Goal: End of October, 2022?)

    • Target audience: censored users
    • Bridges
    • Pluggable transports
    • and more...?

  • Arti 1.2.0: Onion service support (not funded, timeframe TBD)

  • Arti 2.0.0: Feature parity with C tor as a client (not funded, timeframe TBD)

  • Arti ?.?.?: Relay support

How can I help out?

See CONTRIBUTING.md for a few ideas for how to get started.

License

This code is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

(The above notice, or something like it, seems to be pretty standard in Rust projects, so I'm using it here too. This instance of it is copied from the RustCrypto project's README.md file.)