95bcd17705
The idea behind this is that we may want to start exporting more pieces of c-tor as Rust crates so that Arti can perform cross compatibility and comparison testing using Rust tooling. This turns the 'tor' repo into a Cargo workspace, and adds one crate to start with: "tor-c-equix", rooted in src/ext/equix. This actually includes both Equi-X itself and HashX, since there's less overall duplication if we package these together instead of packaging HashX separately. This patch adds a basic safe Rust interface, but doesn't expose any additional internals for testing purposes. No changes to the C code here or the normal Tor build system. Signed-off-by: Micah Elizabeth Scott <beth@torproject.org> |
||
|---|---|---|
| .. | ||
| android | ||
| tracing | ||
| CircuitPaddingDevelopment.md | ||
| CircuitPaddingQuickStart.md | ||
| CodingStandards.md | ||
| Fuzzing.md | ||
| GettingStarted.md | ||
| HelpfulTools.md | ||
| HowToReview.md | ||
| Maintaining.md | ||
| Module.md | ||
| README.1st.md | ||
| ReleaseSeriesLifecycle.md | ||
| ReleasingTor.md | ||
| ReleasingTor.md.old | ||
| Rust.md | ||
| WritingTests.md | ||
README.1st
In this directory
This directory has helpful information about what you need to know to hack on Tor!
First, read GettingStarted.md to learn how to get a start in Tor
development.
If you've decided to write a patch, CodingStandards.md will give you a bunch
of information about how we structure our code.
It's important to get the code right! Reading WritingTests.md will
tell you how to write and run tests in the Tor codebase.
There are a bunch of other programs we use to help maintain and
develop the codebase: HelpfulTools.md can tell you how to use them
with Tor.
If it's your job to put out Tor releases, see ReleasingTor.md so
that you don't miss any steps!
Additional Information
For full information on how Tor is supposed to work, look at the files in Tor specification.
For an explanation of how to change Tor's design to work differently, look at the Tor proposal process.
For the latest version of the code, get a copy of git, and
$ git clone https://gitlab.torproject.org/tpo/core/tor.git
For a copy of Tor's original design paper, see here. Note that Tor has changed in many ways since 2004.
For a large collection of security papers, many of which are related to Tor, see Anonbib's Selected Papers in Anonymity.
Stay in touch
We talk about Tor on the tor-talk mailing list. Design proposals and
discussion belong on the tor-dev mailing list. We hang around on
irc.oftc.net, with general discussion happening on #tor and development
happening on #tor-dev.
The other files in this HACKING directory may also be useful as you
get started working with Tor.
Happy hacking!