Ian Jackson
8d98982bb2
arti-client: Rename hs feature to onion-service-client
...
Rationale as per #756 .
This is the same name as in the `arti` crate.
2023-06-16 12:34:47 +01:00
Gabriela Moldovan
bed1ae6304
arti-client: Use a dummy key manager if the keymgr feature is disabled.
...
TorClient now only uses the tor_keymgr::KeyMgr implementation if the
keymgr experimental feature is enabled. If the feature is disabled, a
dummy key manager implementation is used.
The new `keymgr` feature depends on `onion-client`, because the key
manager is only used for HS client auth.
2023-06-15 18:16:34 +01:00
Nick Mathewson
b19eb8648f
Merge branch 'pt-snowflake' into 'main'
...
add documentation for configuring snowflake pt
Closes #879 and #875
See merge request tpo/core/arti!1216
2023-06-11 20:59:31 +00:00
trinity-1686a
a74bb8d4d8
add a few more comments on PTs
2023-06-09 20:15:25 +02:00
trinity-1686a
b3c8004f8d
change link for more information on pts
2023-06-08 09:20:07 +02:00
Saksham Mittal
6e97b9df1f
Rephrase error handling to reporting
2023-06-08 10:26:52 +05:30
Saksham Mittal
3f7709f98d
Add error handling section in README
2023-06-08 10:26:52 +05:30
trinity-1686a
925ac7f9d7
complement general documentation on bridges and pt
2023-06-07 23:59:03 +02:00
Nick Mathewson
56cb2d2a10
Make a top-level API for connecting to onion services.
...
Fortunately, it adds very little to the arti-client API surface.
2023-01-12 09:28:58 -05:00
Nick Mathewson
f1f6005474
arti-client: Mark "bridge-client" and "pt-client" as non-experimental
2022-11-18 08:53:47 -05:00
trinity-1686a
614cf34284
Check more targets
2022-11-10 13:34:17 +00:00
Ian Jackson
ac1c0bf8fb
README doctests: fix arti-client
...
Add ,ignore to ignore three examples that don't actually compile.
cargo readme would add these annotations to lib.rs, but the doc
include doesn't do stuff like that. pandoc seems to still render the
result just fine.
2022-10-12 14:56:37 +01:00
Ian Jackson
ffcc548163
Add pt-client and bridge-client features to arti and arti-client
2022-10-12 13:50:29 +01:00
Ian Jackson
52d9b8103a
READMEs: Run maint/readmes (to update READMEs from lib.rs)
2022-09-02 17:08:08 +01:00
Ian Jackson
c0189e02b7
READMEs: arti-client: Remove caveats and add some xrefs
2022-09-02 14:51:31 +01:00
Nick Mathewson
8b6f4cc69d
Update README.md files with "readmes" tool.
2022-08-31 11:08:03 -04:00
Nick Mathewson
ce4d062c09
Update README.md files from rustdoc.
2022-06-24 08:02:56 -04:00
Nick Mathewson
9447e69355
Update README.md files (automated).
2022-05-06 09:51:11 -04:00
Samanta Navarro
c53818d496
Fix grammar and typos
2022-04-27 13:52:13 +01:00
Nick Mathewson
6d7dcdc621
Update README.md files using readmes script
2022-03-29 13:30:17 -04:00
solanav
d90d1c00a7
Fixed typo on arti-client README.md
2022-03-24 21:50:27 +01:00
Nick Mathewson
5735222691
Update README.md files from rustdoc.
2022-03-01 08:30:53 -05:00
Ian Jackson
f8d17bce83
Add missing documentation for TLS features to two readmes
2022-02-23 13:53:45 +00:00
Ian Jackson
2101dd5e39
errors: Introduce error_detail feature
...
Right now we must always expose the `Error` type since we haven't
converted everything.
2022-02-04 14:42:37 +00:00
Nick Mathewson
5187b05c19
Use script to update README.md files.
2022-01-28 08:36:34 -05:00
Ian Jackson
aa4d8de16e
StreamPrefs: rename from ConnectPrefs
...
The docs even say this is about stream.
As @nickm writes in
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/252#note_2771289
we generally call end-to-end connections that are tunneled over Tor
"Streams" to distinguish them from everything else in the Tor
protocols that could possibly be called a "Connection".
That seems to apply here too.
2022-01-21 11:07:15 +00:00
Nick Mathewson
c5f50b7d41
Update README.md files (automated)
2022-01-11 09:37:45 -05:00
dagon
0162ea8210
Example needs to be the same as the readme
2021-11-30 09:09:42 -05:00
dagon
bd1c37fe8a
MR review feedback
2021-11-30 09:09:42 -05:00
dagon
e0489328f6
fix arti-client doc example
2021-11-30 09:09:42 -05:00
dagon
d5c48c616f
run ./maint/readmes.sh
2021-11-29 21:29:28 +10:00
Nick Mathewson
9d3256ec83
Update README.md files
2021-10-29 09:37:15 -04:00
Nick Mathewson
672335ccf6
Update README.md files
2021-10-28 19:59:22 -04:00
Nick Mathewson
134c04a67a
Update our disclaimers and limitations sections.
2021-10-27 11:13:46 -04:00
Nick Mathewson
b477f12d83
s/arti-arti-client/arti-client/ and regenerate readme files
2021-10-25 08:40:00 -04:00
Nick Mathewson
7c7a388e28
Rename tor_client/arti_tor_client to arti_client.
...
Solves a name conflict with the existing tor_client create.
Closes #130 .
2021-10-21 14:22:11 -04:00