summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* rpc-meta-draft.md: correct some minor typosJim Newsome2024-09-251-7/+7
|
* arti: Clarify what the client is supposed to do with the hsc key output.Gabriela Moldovan2024-09-191-0/+8
|
* arti: Document that "arti hsc" is experimental.Gabriela Moldovan2024-09-191-0/+3
|
* arti: Omit the optional --key-type argument from the docs.Gabriela Moldovan2024-09-191-1/+1
| | | | | | By default `--key-type` is set to `restricted-discovery` so it can omitted from these examples (omitting it makes the usage a bit clearer IMO).
* arti: Document the commands for key removal and rotation.Gabriela Moldovan2024-09-191-1/+41
|
* arti: Add hsc key subcommand, deprecate hsc get-key.Gabriela Moldovan2024-09-181-5/+5
| | | | | | | | | | I am deprecating the old `hsc get-key` subcommand in favor of the new `hsc key get` subcommand. This is because I plan to implement the rest of the key management functionality (key deletion, rotation, etc.) as subcommands of the `hsc key` command. The alternative would be to add a new distinct top-level `hsc rotate-key`, `hsc remove-key`, etc. subcommand alongside the existing `hsc get-key` command (which IMO is less nice than the alternative I'm proposing).
* Merge branch 'mq-tidy' into 'main'David Goulet2024-09-171-172/+8
|\ | | | | | | | | memquota: be more firm about avoiding panics, and tidy up docs See merge request tpo/core/arti!2404
| * memory-limit.md: Make the rubric accurateIan Jackson2024-09-101-8/+4
| | | | | | | | And remove the rest of the now-obsolete text.
| * tor-memquota: Use clippy::arithmetic_side_effects, against panicsIan Jackson2024-09-101-6/+0
| | | | | | | | | | | | This detect possibly-panicking operations. Empirically this lint seems rather better now.
| * memory-limit: Fix heading depth for cache discussionsIan Jackson2024-09-101-4/+4
| |
| * memory-limit.md: Remove obsolete overview docsIan Jackson2024-09-101-31/+0
| | | | | | | | All of this is now documented in the lib.rs.
| * tor-memquota: Move some information into the proper docsIan Jackson2024-09-101-2/+0
| | | | | | | | | | This sentence is very important piece of overall explanation, but didn't make it into the crate level docs.
| * memory-limit.md: Remove obsolete docs of implemented channel facilityIan Jackson2024-09-101-121/+0
| | | | | | | | All of this is now implemented. Delete the obsolete sketch.
* | Merge branch 's101-2024-q2' into 'main'Alexander Hansen Færøy2024-09-171-0/+26
|\ \ | | | | | | | | | | | | Update s101 numbers for Q2 2024 See merge request tpo/core/arti!2245
| * | Update s101 numbers for Q2 2024Alexander Færøy2024-07-081-0/+26
| | |
* | | rpc-draft: move cancel method to connection object.Nick Mathewson2024-09-111-1/+1
| | |
* | | rpc: Add a "client implementation strategies" section.Nick Mathewson2024-09-111-1/+24
| | |
* | | rpc: Document pipelining and concurrency.Nick Mathewson2024-09-111-2/+15
| | |
* | | rpc: Add a "Cancelled" code to our docs.Nick Mathewson2024-09-111-0/+1
| | |
* | | rpc: Replace strong/weak objectIds with reference/handle againNick Mathewson2024-09-111-5/+18
| | | | | | | | | | | | | | | Diziet prefers this terminology; we'll defer a reckoning here till #849 is resolved.
* | | rpc-draft: Adopt a stricter-but-looser rule for anti-framing defenseNick Mathewson2024-09-111-13/+46
| | | | | | | | | | | | | | | | | | | | | Instead of saying "no errors before authentication", we now say "no syntax errors ever." This should be easier to implement.
* | | rpc-draft: A few more tweaks based on review.Nick Mathewson2024-09-111-10/+12
| | |
* | | Several rpc-draft suggestions from diziet.Nick Mathewson2024-09-111-11/+22
| | |
* | | rpc-meta: Note that the appendix is obsolete.Nick Mathewson2024-09-111-0/+3
| | |
* | | rpc-meta: Note that most listed requests are hypotheticalNick Mathewson2024-09-111-0/+4
| | |
* | | rpc-meta: remove example apis sectionNick Mathewson2024-09-111-58/+0
| | | | | | | | | | | | (This is obsoleted by arti-rpc-client-core.)
* | | rpc-meta: update cancellation to latest thinkingNick Mathewson2024-09-111-16/+6
| | |
* | | rpc-meta: Tweaks to "authentication" section.Nick Mathewson2024-09-111-5/+10
| | |
* | | rpc-meta: clarify current method name rules.Nick Mathewson2024-09-111-8/+9
| | | | | | | | | | | | | | | | | | | | | | | | Notably, identifiers SHOULD be C identifiers, and everything has a namespace. Reserve "rpc" as a namespace for things that were previously unnamespaced.
* | | rpc-meta: Light edits to parameter description.Nick Mathewson2024-09-111-3/+3
| | |
* | | rpc-meta: Rewrite and move documentation on object semantics.Nick Mathewson2024-09-111-32/+117
| | | | | | | | | | | | | | | This is probably still far too informal, but it is better than our previous documentation.
* | | rpc-meta: clarify status of Sessions.Nick Mathewson2024-09-111-0/+7
| | | | | | | | | | | | | | | (Note what isn't implemented, and one more kind of authentication we'll likely build someday.)
* | | rpc-meta: rewrite front matterNick Mathewson2024-09-111-29/+38
| | |
* | | rpc-meta: Add a top-level heading, and shift other headingsNick Mathewson2024-09-111-35/+37
| |/ |/| | | | | (Markdown convention deprecates having more than one top-level heading.)
* | Fix typosDimitris Apostolou2024-09-032-3/+3
| |
* | Sponsor 101 -> Project 101.Alexander Færøy2024-09-021-2/+2
| | | | | | | | See: tpo/team#313.
* | Merge branch 'torclient-doc' into 'main'gabi-2502024-08-151-0/+111
|\ \ | | | | | | | | | | | | doc/dev/notes: keymgr-porcelain: Add note about moving keymgr functions out of TorClient. See merge request tpo/core/arti!2314
| * | doc/dev/notes: keymgr-porcelain: Add note about alternative API.Gabriela Moldovan2024-08-141-0/+12
| | |
| * | doc/dev/notes: keymgr-porcelain: Add note about moving keymgr functions out ↵Gabriela Moldovan2024-08-061-0/+99
| | | | | | | | | | | | | | | | | | of TorClient. This would a possible long-term fix for #1496.
* | | dov/dev/notes: Add note about live reloads in restricted discovery mode.Gabriela Moldovan2024-08-121-0/+243
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This describes a couple of options for extending the config reloading logic to support watching for changes in the `restricted_disovery.key_dirs` directories. Note: the options we have here are, in a sense, two extremes * one is about refactoring some of the existing code into a reusable component, and leaving most of the configuration logic unchanged * the other involves rethinking the entire config watching/reloading mechanism to support watching for changes in arbitrary directories I am leaning towards the simpler option, because I'm not sure the other one is worth the added complexity (we currently only have a single use case for it).
* | doc: Add arti hsc subcommand docs to doc/hsc.md.Gabriela Moldovan2024-08-051-0/+28
| | | | | | | | | | This also makes the `tests/testcases/hsc/hsc.md` test case a symlink to `doc/hsc.md`.
* | rpc: Remove RpcError data field and use ReportNick Mathewson2024-07-251-26/+44
| | | | | | | | | | | | | | | | | | | | | | | | Per discussion, this field isn't really specified in a way that lets us fill it sensibly at the moment. So for now, we're going to just omit it. Additionally, we said that we'd Report on our errors; this branch changes the implementation of RpcError to do that. Question: Will the blanket implementation for Into<RpcError> make it harder to re-add a Data field later on if we want to do so?
* | rpc: split "method not found"Nick Mathewson2024-07-251-1/+2
| | | | | | | | | | We've wanted separate error codes for "no such method exists" and "this method exists, but this object doesn't have it."
* | Merge branch 'arti-hyper-cleanup' into 'main'Ian Jackson2024-07-161-1/+0
|\ \ | | | | | | | | | | | | Remove arti-hyper from the list of crates in Architecture.md See merge request tpo/core/arti!2268
| * | Remove arti-hyper from the list of crates in Architecture.mdIan Jackson2024-07-161-1/+0
| |/ | | | | | | | | | | | | Possibly we should have a CI job to check that this file is kept up to date, but let's not do that now. I filed #1484.
* / Tests and documentation about NULs in the RPC stream.Nick Mathewson2024-07-161-0/+4
|/
* maint/tag-arti-releaes: New scriptIan Jackson2024-06-271-4/+2
|
* Release.md: Say to run maint/update-md-linksIan Jackson2024-06-271-9/+7
| | | | Not the raw gen_md_links utility.
* maint/changelog-syntax-fiddle: New scriptIan Jackson2024-06-271-0/+3
|
* doc/dev/notes: vanguards: Make client rend circuits be STUB+.Gabriela Moldovan2024-06-251-1/+1
| | | | | | | | | According to the [vanguards spec], client rendezvous circuits should be STUB+: * lite: `C -> G -> L2 -> Rend` * full: `C -> G -> L2 -> L3 -> Rend` [vanguards spec]: https://gitlab.torproject.org/tpo/core/torspec/-/blob/e5ace3667dcbbf893c6b632fd4e3f16114fd2a0e/spec/vanguards-spec/index.md
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-26 19:20:09 +0000