Commit Graph

332 Commits

Author SHA1 Message Date
Dimitris Apostolou c466edaa07
Fix typos 2023-07-25 21:17:18 +03:00
Nick Mathewson 2833648bfb Merge branch 'ipts' into 'main'
dev notes: Draft IPT algorithm

See merge request tpo/core/arti!1429
2023-07-25 16:29:38 +00:00
Nick Mathewson 6f841d0fb8 Merge branch 'onion-service-notes-v1' into 'main'
Initial notes about onion service structs and APIs

See merge request tpo/core/arti!1422
2023-07-25 16:29:28 +00:00
gabi-250 e3d2e12624 Merge branch 'keymgr-keygen-key-list' into 'main'
keymgr-doc: Document the list of keys the keymgr needs to generate.

See merge request tpo/core/arti!1413
2023-07-25 10:51:01 +00:00
Nick Mathewson 7347a25ab1 Change keyid to nickname 2023-07-24 12:22:46 -04:00
Nick Mathewson 4f5fb5c011 Mention anti-DOS options. 2023-07-24 12:19:43 -04:00
Nick Mathewson 75038d8348 Mention ob_config. Not sure we will want to build it like this. 2023-07-24 12:18:21 -04:00
Nick Mathewson 7166c9e5b5 Add `doc/safer_build.md` to explain path anonymization
Otherwise our default build instructions will lead people
to build binaries that include their home directory.

Closes #957 for now.
2023-07-24 09:34:40 -04:00
Dimitris Apostolou 947ddfff0c
Fix typos 2023-07-22 10:10:34 +03:00
Ian Jackson a92627418d dev notes: Draft IPT algorithm 2023-07-21 13:20:34 +01:00
Gabriela Moldovan a030c3dbda
keymgr-doc: Add columns with additional details about the keys. 2023-07-20 18:59:21 +01:00
Gabriela Moldovan 58baa2af9e
keymgr-doc: Rename ambiguous `--onion` flag to `--service`. 2023-07-20 18:52:10 +01:00
Gabriela Moldovan bcea3967ac
keymgr-doc: Add note about the key names. 2023-07-20 15:38:32 +01:00
Nick Mathewson 9330c70ebe Initial notes about onion service structs and APIs 2023-07-19 16:34:06 -04:00
Gabriela Moldovan 8941d5772d
keymgr-doc: Document the list of keys the keymgr needs to generate. 2023-07-18 11:19:39 +01:00
Alexander Færøy 590c72eb03 Update s101 stats. 2023-07-10 14:35:27 +02:00
Nick Mathewson 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
Nick Mathewson 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
Nick Mathewson 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
Nick Mathewson 451306df72 Release.md: Write a tools section. 2023-06-30 12:18:00 -04:00
Nick Mathewson 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
Nick Mathewson de3d415a81 Release.md: Add subheadings for "how to release." 2023-06-30 11:23:49 -04:00
Nick Mathewson a939b19479 rpc: update rpc-meta-draft with new behavior. 2023-05-24 10:15:56 -04:00
Nick Mathewson d75b4af0f1 key-management.md: Add a note deprecating unescorted ed secrets 2023-05-18 14:18:53 -04:00
gabi-250 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
Gabriela Moldovan 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
Nick Mathewson 9c7680d1f8 rpc: Clarify how authentication works. 2023-05-16 09:08:25 -04:00
Nick Mathewson c89fac9c3c rpc: Clarify some object ID docs and remove impl details. 2023-05-16 09:08:25 -04:00
Nick Mathewson 585554d954 rpc: Revise example in documentation 2023-05-16 09:08:25 -04:00
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Gabriela Moldovan 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
Nick Mathewson 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
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