Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
arti
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Lunar
arti
Commits
3321d728
Commit
3321d728
authored
4 years ago
by
Nick Mathewson
Browse files
Options
Downloads
Patches
Plain Diff
Document newer modules
parent
ae4e075d
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+27
-7
27 additions, 7 deletions
README.md
with
27 additions
and
7 deletions
README.md
+
27
−
7
View file @
3321d728
...
...
@@ -216,9 +216,14 @@ The current crates are:
`caret`
: A utility for generating enumerations with helpful trait
implementations
`tor-llcrypto`
: Wrappers and re-
im
ports of cryptographic code that Tor needs in
`tor-llcrypto`
: Wrappers and re-
ex
ports of cryptographic code that Tor needs in
various ways. Other crates should use this crate, and not actually
use any crypto crates directly.
use any crypto implementation crates directly. (It's okay to use crates that
define cryptographic traits.)
`tor-rtcompat`
: Wrappers and re-exports of asynchronous runtime
code. Currently it only has async-std, but in the long run we'll want to
support at least tokio too.
`tor-bytes`
: Byte-by-byte encoder and decoder functions and traits. We use
this to safely parse cells, certs, and other byte-oriented things.
...
...
@@ -229,6 +234,12 @@ this to safely parse cells, certs, and other byte-oriented things.
system. Less complete than the one in Tor's current src/rust, but more
simple.
`tor-socksproto`
: Implements the server side of the SOCKS protocol, along
with Tor-specific extensions.
`tor-checkable`
: Defines traits and types used to represent things that you
can't use until verifying their signatures and checking their timeliness.
`tor-netdoc`
: Parsing for Tor's network documents. Underdocumented and too
big.
...
...
@@ -245,12 +256,21 @@ logical.)
`tor-netdir`
: Wraps tor-netdoc to expose a "tor network directory" interface.
Doesn't touch the network itself. Right now it only handles microdesc-based
directories, and reads all its information from disk.
directories.
`tor-chanmgr`
: Creates channels as necessary, returning existing channels
when they already exist.
`tor-circmgr`
: Creates circuits as requested, returning existing circuits
when they already exist.
`tor-dirclient`
: Downloads directory information over a one-hop circuit.
`tor-dirmgr`
: Uses
`tor-dirclient`
to fetch directory information as needed
to download, cache, and maintain an up-to-date network view. Exposes the
network view as an instance of
`tor-netdir::NetDir`
.
`client-demo`
: A simple tor client program. Right now it requires that you
already have a datadir full of directory information. It does a client->relay
handshake, builds a three-hop circuit, fetches http://www.torproject.org:80/,
and exits.
`client-demo`
: A simple Tor client program that can runs as a SOCKS proxy.
## Intended architecture
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment