Gabriela Moldovan
17ff3a6f6a
dev docs: Add a few lines about handling concurrent access.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:25 +01:00
Gabriela Moldovan
5407e599ab
dev docs: Fill out insert/remove APIs.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:20 +01:00
Gabriela Moldovan
67061688a6
dev docs: Remove incoherent waffle.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:16 +01:00
Gabriela Moldovan
a5ff3191e9
dev docs: Update KeyMgr implementation based on latest discussions.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:11 +01:00
Gabriela Moldovan
3202aa33c5
dev docs: Remove unnecessary trait bounds.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:05 +01:00
Gabriela Moldovan
6c6e03ec4a
dev docs: Remove outdated reference to the comment field.
...
We decided against using it.
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:00 +01:00
Gabriela Moldovan
37493b6bd3
dev docs: Add namespacing for client/hs/relay/.. keys.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:56 +01:00
Gabriela Moldovan
0be6e0a4ca
dev docs: Remove KeyIdentityResult.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:47 +01:00
Gabriela Moldovan
9af07e91a2
dev docs: Remove HSM APIs.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:42 +01:00
Gabriela Moldovan
49ff17901b
dev docs: clarify what a "key identity" is.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:38 +01:00
Gabriela Moldovan
28bac87d96
dev docs: Allow multiple key stores to be in use at the same time.
...
The key manager needs to be flexible enough to support loading keys from
one of several key stores. This is because when we add support for smart
cards, users will want to be able to store some keys on the smart card,
and others in one of the disk key stores (for example).
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:31 +01:00
Gabriela Moldovan
fb6d5dc0d9
dev docs: Add some impls for `LocalUserIdentity`.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:22 +01:00
Gabriela Moldovan
dc616d9e07
dev docs: Add key manager API sketch.
...
This is the first draft of the key manager API.
I don't expect this to be the final version of the API, and I'm sure
there are plenty of improvements to be made. This is mostly a request
for comments.
Closes #834
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:05 +01:00
Nick Mathewson
e524f05aa9
rpc spec: define method namespacing.
...
Closes #822
2023-04-13 10:50:30 -04:00
Nick Mathewson
cf00fd8e8a
Merge branch 'rpc_conformance' into 'main'
...
RPC: Terminology and error-handling conformance
Closes #826 and #825
See merge request tpo/core/arti!1136
2023-04-13 13:45:40 +00:00
Nick Mathewson
8dd65dcd5f
rpc, spec: Document current ObjectError, RequestError behavior as correct.
2023-04-13 09:03:52 -04:00
Nick Mathewson
ea77f959fb
rpc: Change `id=<SYNTAX>` to "no id".
...
Now instead of hoping that buggy clients will detect a magic `id`,
we can simply tell them that they will get no `id` at all. If they
can't handle that case, no major harm is done: the connection will
get closed anyway.
2023-04-13 09:03:52 -04:00
Nick Mathewson
99c64abb6a
Merge branch 'devdoc' into 'main'
...
Document some properties of semver
See merge request tpo/core/arti!1129
2023-04-12 20:37:25 +00:00
Nick Mathewson
89568ead54
rpc spec: Allocate a special ID for syntax errors.
2023-04-12 15:17:15 -04:00
Ian Jackson
1d0fae5467
dev docs: Reference semver trick
...
Discussion
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895839
2023-04-12 18:06:30 +01:00
Ian Jackson
5ae7e3c3f8
dev docs: Adding missing footnote
...
Discussion
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895837
2023-04-12 18:06:30 +01:00
Ian Jackson
09c7efe4a4
dev docs: Avoid main-verb-less sentence
...
Discussion
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895835
2023-04-12 18:06:30 +01:00
Ian Jackson
25b89af11c
dev docs: Add missing word
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1129#note_2895834
2023-04-12 18:06:30 +01:00
Nick Mathewson
81368f2b5b
dev docs: Clarify that it's two instances of the crate
2023-04-12 17:04:59 +00:00
Nick Mathewson
72277b902e
dev docs: Clarify wording re who is exporting what
2023-04-12 17:03:46 +00:00
Nick Mathewson
873f9285af
rpc spec: Change arti_kinds => kinds per discussion.
2023-04-12 12:20:24 -04:00
Nick Mathewson
ee5478ed40
rpc: terminology edits around "method" in spec draft
...
Always "method", never "command".
Always "authentication scheme", never "authentication method".
2023-04-12 11:11:01 -04:00
Nick Mathewson
d492e644ab
Merge branch 's101-q1' into 'main'
...
Update s101 values.
See merge request tpo/core/arti!1128
2023-04-12 14:53:36 +00:00
Nick Mathewson
4c020de38c
Add notes on how to test the RPC engine
2023-04-12 07:34:57 -04:00
Nick Mathewson
3648ea08c9
Add notes on how to test the RPC engine
2023-04-12 07:34:57 -04:00
Nick Mathewson
b9b5e9940a
rpc: Fix typos/grammar errors
2023-04-11 20:02:01 +01:00
Ian Jackson
0be641e49a
rpc: Rewrite `data` spec in JSON terms
2023-04-11 20:02:01 +01:00
Ian Jackson
3ac94956ef
rpc: Clarify that error formatting display is indicative
2023-04-11 20:02:01 +01:00
Ian Jackson
1268223cff
Use non-JSON-RPC-reserved values for our own errors
2023-04-11 20:02:01 +01:00
Ian Jackson
1e2a549960
rpc: Fix mistake in "JSON-RPC compatibility" section for errors
2023-04-11 20:02:01 +01:00
Ian Jackson
3d5ef53596
rpc: Discourage use of `code`
2023-04-11 20:02:01 +01:00
Ian Jackson
9c47558b10
rpc: Warn about relying too much about `data`
2023-04-11 20:02:01 +01:00
Ian Jackson
6c5577ab92
rpc: Provide example of an error response
2023-04-11 20:02:01 +01:00
Ian Jackson
ef834a2c0b
rpc: Provide a list of ErrorKind strings
...
Prompted by
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1107#note_2893078
2023-04-11 20:02:01 +01:00
Ian Jackson
9f8ba36814
rpc: Be more explicit about what the string error message is for (typo)
2023-04-11 20:02:01 +01:00
Nick Mathewson
1bc8bb4fb4
rpc: Be more explicit about what the string error message is for
2023-04-11 20:02:01 +01:00
Ian Jackson
fca4535066
rpc: Proposed error format
2023-04-11 20:02:01 +01:00
Ian Jackson
19799ceea4
dev docs: Make some explanation about semver
2023-04-11 19:41:28 +01:00
Ian Jackson
1c2bc8e92f
dev docs: Make a heading a subheading
2023-04-11 19:33:14 +01:00
Ian Jackson
ed46998f4a
dev docs: Remove an obsolete comment.
...
I think we've bedded in the new process.
2023-04-11 19:33:07 +01:00
Alexander Færøy
1ff417c020
Update s101 values.
2023-04-11 18:35:56 +02:00
Nick Mathewson
df0d5054a2
Merge branch 'release' into 'main'
...
doc/dev/Release.md: patch release workflow
See merge request tpo/core/arti!1111
2023-04-05 14:42:03 +00:00
Ian Jackson
d4760f6d50
Merge branch 'rpc' into 'main'
...
Proposed rpc protocol edits and tightenings-up
See merge request tpo/core/arti!1078
2023-04-04 15:15:40 +00:00
Nick Mathewson
371da67641
rpc: Fix typos
2023-04-04 14:43:37 +00:00
Ian Jackson
599e2ffb7d
doc/dev/Release.md: patch release workflow
...
We did roughly this today. We put the CHANGELOG.md change in its own
MR, so it didn't end up in the tor-llcrypto-v0.4.4 tag. It would have
been better to do it the other way so that's what I've documented.
I couldn't test-format this with pandoc because it got tricked by some
of the `$` into trying to run TeX.
2023-04-04 15:41:00 +01:00