590c72eb03
Update s101 stats.
2023-07-10 14:35:27 +02:00
92daa577c2
Release.md: Add an extra semver-checks to the process.
...
(We didn't do this previously, but it is a good idea.)
2023-06-30 12:30:44 -04:00
2f005a1047
Release.md: Revise the release sections
...
* Remove instructions to sleep
* Explain how to tag
* Remind myself about the workaround for
Fedora's delightful gpg/yubikey configuration.
* Note that we should update "pages" till the blog post is up.
2023-06-30 12:21:48 -04:00
d0e00e4f4e
Release.md: document preparation sections
...
I've split this into
"what I do in the days leading up to the release" and
"what I do right before the release".
There's a lot more detail now, including:
* up-to-date invocations for `cargo upgrade`
* up-to-date changelog instructions
* our current version-bumping instructions
* possible side-effects from version bumps.
2023-06-30 12:18:57 -04:00
451306df72
Release.md: Write a tools section.
2023-06-30 12:18:00 -04:00
a8dffab1d1
Release.md: Write the "are we ready to release" section.
...
* Remove references to a couple of things
that our CI now does for us
(`cargo_audit` and `check_licenses`).
* Mention ~Blocker issues and MRs.
* Mention that some of our CI steps are allowed-to-fail,
but failures should be examined.
* Mention that some of our tools have exception lists
that should get reviewed.
* Mention `semver-checks` and `fixup-features`.
2023-06-30 12:17:39 -04:00
de3d415a81
Release.md: Add subheadings for "how to release."
2023-06-30 11:23:49 -04:00
a939b19479
rpc: update rpc-meta-draft with new behavior.
2023-05-24 10:15:56 -04:00
d75b4af0f1
key-management.md: Add a note deprecating unescorted ed secrets
2023-05-18 14:18:53 -04:00
3c34c84f3f
Merge branch 'key-mgmt-api-updates-v2' into 'main'
...
dev docs: key-management.md updates and clarifications
See merge request tpo/core/arti!1185
2023-05-16 15:53:57 +00:00
80ec4d01ae
dev docs: The key store version file should specify a minimum supported version.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 15:46:59 +01:00
9c7680d1f8
rpc: Clarify how authentication works.
2023-05-16 09:08:25 -04:00
c89fac9c3c
rpc: Clarify some object ID docs and remove impl details.
2023-05-16 09:08:25 -04:00
585554d954
rpc: Revise example in documentation
2023-05-16 09:08:25 -04:00
601f307fdd
dev docs: Remove unused arguments.
...
There are several places where he `KeyType` isn't needed anymore.
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:38:00 +01:00
47f15c8df5
dev docs: Clarify how C Tor key store loads keys from multiple different key dirs.
...
This also moves the `extension` function out of `KeyType` because for
the C Tor key store, a key's file extension depends on the role/user of
the key, which isn't known by `KeyType` (`KeyType` is a tor-agnostic key
type such as `Ed25519Private`).
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:37:55 +01:00
4315d2e106
dev docs: Distinguish between arti_extension and ctor_extension.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:32:45 +01:00
20e1e3004b
dev docs: Clarify that ArtiPath/CTorPath are relative to the key store root.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:32:42 +01:00
d518a1c1d8
dev docs: Add note about key store versioning.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:32:38 +01:00
6b417fbbf9
dev docs: Add note about C Tor store configuration.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 11:32:31 +01:00
6a1427db6f
dev docs: Move the key passphrases subsection to the Arti store section.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 10:59:36 +01:00
4b95a8ac4e
dev docs: Create a separate section for the C tor key store discussion.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 10:59:33 +01:00
702dfbddb0
dev docs: Rename {Key, HsClient}Identity.
...
This renames `KeyIdentity` to `KeySpecifier` so it doesn't get confused
with the concept of an "identity key". `HsClientIdentity` is also
renamed for consistency.
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-05-16 10:59:23 +01:00
ca74fb448b
Merge branch 'api-sketch' into 'main'
...
Add a sketch for our FFI/RPC architecture
See merge request tpo/core/arti!1005
2023-05-03 14:05:29 +00:00
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
5407e599ab
dev docs: Fill out insert/remove APIs.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:20 +01:00
67061688a6
dev docs: Remove incoherent waffle.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:16 +01:00
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
3202aa33c5
dev docs: Remove unnecessary trait bounds.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:54:05 +01:00
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
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
0be6e0a4ca
dev docs: Remove KeyIdentityResult.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:47 +01:00
9af07e91a2
dev docs: Remove HSM APIs.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:42 +01:00
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
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
fb6d5dc0d9
dev docs: Add some impls for `LocalUserIdentity`.
...
Signed-off-by: Gabriela Moldovan <gabi@torproject.org>
2023-04-25 18:53:22 +01:00
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
e524f05aa9
rpc spec: define method namespacing.
...
Closes #822
2023-04-13 10:50:30 -04:00
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
8dd65dcd5f
rpc, spec: Document current ObjectError, RequestError behavior as correct.
2023-04-13 09:03:52 -04:00
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
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
89568ead54
rpc spec: Allocate a special ID for syntax errors.
2023-04-12 15:17:15 -04:00
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
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
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
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
81368f2b5b
dev docs: Clarify that it's two instances of the crate
2023-04-12 17:04:59 +00:00
72277b902e
dev docs: Clarify wording re who is exporting what
2023-04-12 17:03:46 +00:00
873f9285af
rpc spec: Change arti_kinds => kinds per discussion.
2023-04-12 12:20:24 -04:00
Alexander Færøy
Nick Mathewson
gabi-250
Ian Jackson