19799ceea4
dev docs: Make some explanation about semver
2023-04-11 19:41:28 +01:00
1c2bc8e92f
dev docs: Make a heading a subheading
2023-04-11 19:33:14 +01:00
ed46998f4a
dev docs: Remove an obsolete comment.
...
I think we've bedded in the new process.
2023-04-11 19:33:07 +01:00
1ff417c020
Update s101 values.
2023-04-11 18:35:56 +02:00
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
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
371da67641
rpc: Fix typos
2023-04-04 14:43:37 +00:00
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
854508d4ca
rpc: Speak of "Arti" rather than "arti"
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889618
2023-04-03 17:59:58 +01:00
b25cb1479c
rpc: State the integer round-trip range limits
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889617
2023-04-03 17:58:06 +01:00
22b1c89344
rpc: Don't talk about "properties" of objects: rather, "members"
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889616
2023-04-03 17:55:09 +01:00
826b85f873
rpc: Move notes about cancellation to right section
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889614
2023-04-03 17:53:17 +01:00
374f76e1df
rpc: Be clearer about updates content
...
You can't parse an update without knowing the request method (this was
already stated elsewhere).
Prompted by
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889613
2023-04-03 17:51:36 +01:00
250bb1aac6
rpc: Change how we talk about objects
...
Use just "object" in the introduction, but be specific that the
abstract data type is I-JSON, even if we later invent other
representations.
Prompted by
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889612
2023-04-03 17:47:09 +01:00
b0a8b272f5
rpc: Right at top, say I-JSON
...
Prompted by
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889612
2023-04-03 17:44:40 +01:00
6fad573921
rpc: Change wording about responses
...
Prompted by
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1078#note_2889611
2023-04-03 17:42:56 +01:00
94ba102a3b
Fix typo
2023-03-24 21:43:32 +02:00
fc53f3ce98
rpc: Start on a list of the differences with JSON-RPC
2023-03-24 18:23:55 +00:00
53dbe74980
rpc: Discuss ordering and buffering
2023-03-24 18:23:55 +00:00
ba4e1b0a1e
rpc: Define term `field`
2023-03-24 18:23:55 +00:00
58fcb77825
rpc: Discuss cancellation request obj
2023-03-24 18:23:55 +00:00
2e0cad46bb
rpc: Clarify what precisely the responses depend on
...
The format of an update or result depends on the *method* but not the
parameters or the subject.
Declare that the format of an error is uniform. (It could have an
enum in it.)
2023-03-24 18:23:55 +00:00
c4b75d9890
rpc: State that we're using I-JSON
2023-03-24 18:23:55 +00:00
c64e44516b
rpc: Forbid troublesome numbers as ids
...
This is a bit sad but I think we should have a conservative JSON
profile.
2023-03-24 18:23:55 +00:00
e52b9ff9b6
rpc: Be more explicit about ignoring JSON fields
2023-03-24 18:23:55 +00:00
657c02c1ce
rpc: Clarify/restate method definition requirements
...
In particular, abolish the notion of a "response type". Since
responses don't come with a discriminant, each method may have only
one success response format (although of course that format might
itself have optional fields or be an enum or something).
2023-03-24 18:23:55 +00:00
131446620a
rpc: Use Object for method targets and JSON object for document objects
2023-03-24 18:23:55 +00:00
094748cc1a
rpc: Make `params` in a request non-optional
...
*If* it is optional that would depend on the request, which is a bit
complicated to specify precisely. And making it mandatory is more
orthogonal.
2023-03-24 18:23:55 +00:00
102a2ab540
rpc-meta-draft: Sketch an even-lower-level API.
2023-03-24 17:28:19 +00:00
a3de60bd86
rpc-draft: Sketch out more commands to add, start sketching APIs
2023-03-24 17:28:19 +00:00
d67dddcc8d
rpc-meta: clarify when "object" means "JSON object".
2023-03-24 17:28:19 +00:00
67ee3b225f
rpc-meta: expand on handle/reference semantics.
2023-03-24 17:28:19 +00:00
273b565b32
rpc-meta: Use "will" for what Arti does, "must" for what client does.
2023-03-24 17:28:19 +00:00
b06d853e12
rpc-meta: Rename intermediate response to "update".
2023-03-24 17:28:19 +00:00
eee5d847be
rpc-meta-draft: consistently say "request" or "method", not "command".
2023-03-24 17:28:19 +00:00
5f9a28d227
rpc-meta-draft: make a number of localized changes from the review.
2023-03-24 17:28:19 +00:00
906b4bb631
Start drafting a dev note about a JSON-based OO RPC design.
2023-03-24 17:28:19 +00:00
18e8ac7cb6
Rename key identifiers that have changed in the spec
...
Generated with perl:
s/K([PS])_hs_intro_tid/K$1_hs_ipt_sid/g;
s/K([PS])_onion_ntor/K$1_ntor/g;
s/K([PS])_hs_intro_ntor/K$1_hss_ntor/g;
s/K([PS])_hs_desc_ephem/K$1_hss_desc_enc/g;
2023-02-08 11:57:51 -05:00
d790ba2776
ffi_rpc_sketch: rearrange.
2023-02-03 08:55:21 -05:00
19346ee891
ffi_rpc_sketch: tweak colors.
2023-02-03 08:54:02 -05:00
49b217486a
Add a sketch for our FFI/RPC architecture
...
I think that this might be the way forward, depending on our current
requirements and our users' current needs. I've traced out some
challenges that would imply.
2023-02-03 08:48:33 -05:00
d41dbc2a46
Update Tor number for s101 o3 (Tor: 2033cc7b5e).
2023-01-27 12:50:06 +01:00
e30ece3532
Fix typo.
2023-01-27 12:46:14 +01:00
79c6881366
exportedapisketc: note that HTTP can be tricky.
2023-01-26 08:29:46 -05:00
51741398b2
Merge branch 'netdoc-builder' into 'main'
...
tor-netdoc: Provide NetdocEncoder (internal)
See merge request tpo/core/arti!984
2023-01-26 11:40:50 +00:00
422e3382aa
New results for heap_and_download_size.md
2023-01-25 14:59:46 -05:00
410d05697f
Try to be less ambigous about "maybe offline"...
...
...by defining "offline" as "maybe online".
@diziet is this what you had in mind?
2023-01-24 11:39:10 -05:00
b667faf5c5
Try to specify which keys are which
...
Use the terminology in the current draft torspec!105 MR.
2023-01-24 11:39:10 -05:00
8764c64564
Add a note about key storage in onion services and clients
2023-01-24 11:39:10 -05:00
16c4fee4b8
netdoc-builder: Move example into implementation doc comment
...
Not actually tested yet
2023-01-24 16:15:17 +00:00
e971d1ad59
netdoc-builder api: Move internal API into actual code file
...
Motion, plus the bare minimum needed to make it compile.
2023-01-24 16:15:17 +00:00
bb5565b800
netdoc-builder api: Remove obsolete proposed `Item` changes
...
We decided against these in !969
2023-01-24 16:15:17 +00:00
99686c61de
netdoc-builder api: Write down the correctness (non)-guarantees
2023-01-20 14:21:17 +00:00
6f17a88b0b
netdoc-builder api: Make object() take self
...
As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/969#note_2869594
2023-01-20 14:21:17 +00:00
694de0e163
netdoc-builder api: Change object multiplicity to 0 or 1
2023-01-20 14:21:17 +00:00
673d13a82b
netdoc-builder api: Provide raw methods
2023-01-20 14:21:17 +00:00
2fdb65287d
netdoc-builder api: Fix typo
2023-01-20 14:21:17 +00:00
3ce394f168
netdoc-builder api: Clarify ItemEncoder.objects content
2023-01-20 14:21:17 +00:00
fa96addf01
netdoc-builder api: In internal notes don't promise not to eagerly add
2023-01-20 14:21:17 +00:00
0755069e5a
netdoc-builder api: Rename internal Builder to Encoder
...
This seems clearer now and also it solves the name clash with the
`NetdocBuilder` trait.
2023-01-20 14:21:17 +00:00
8f2263237b
netdoc-builder api: Get rid of Item, and error rework
2023-01-20 14:21:17 +00:00
46ad6cba06
netdoc-builder api: Add example of use
2023-01-20 14:21:17 +00:00
28b99004d0
NetdocBuilder: Improvements apropos review
2023-01-20 14:21:17 +00:00
760ddbbc5d
Improved pseudocode commentary
2023-01-20 14:21:17 +00:00
7184777559
RFC netdoc builder API
2023-01-20 14:21:17 +00:00
0ad44d2d6f
Update comments based on feedback
2023-01-17 12:21:17 -05:00
b6f5d3da7d
Apply 1 suggestion(s) to 1 file(s)
2023-01-13 16:44:03 +00:00
bf970ba486
Apply 1 suggestion(s) to 1 file(s)
2023-01-13 16:43:48 +00:00
ecff8731cc
Sketch for some options and design issues around FFI/RPC
...
This is just a beginning, but hopefully we can expand it with more
information and options, and then use it to get everybody in our
nascent FFI/RPC working group on the same page.
2023-01-13 09:47:37 -05:00
2ad198784d
Merge branch 'hilev_docs' into 'main'
...
Architecture: More high-level documentation and diagrams.
Closes #624
See merge request tpo/core/arti!963
2023-01-06 19:17:29 +00:00
a0ddf51f77
Architecture.md: Move title outside of diagram
...
Apparently, Mermaid 9.1 did not support this.
2023-01-06 13:37:27 -05:00
fe9bf17937
Add a protocol overview for onion services.
2023-01-06 13:03:50 -05:00
5358339169
Architecture: More high-level documentation and diagrams.
...
Specifically, I'm adding a high-level MDD (simplified for clarity).
I'm also adding a diagram of the object relations among our manager
types. (There are also communications that happen via channels, but
those aren't discussed here.) That part closes #624 .
There is probably more to say here, but this should form a scaffold
we can build on.
2023-01-05 17:11:38 -05:00
4fc70ccacf
doc: update the crate list in Architecture.md
...
This commit updates the crate list in Architecture.md. Because of the
previous commit, which introduced consistency to these files, it was
possible to generate it fairly easy with a tiny Perl script.
2022-12-20 14:33:59 +01:00
77c23b8474
Add another step to the release process
2022-12-10 16:16:42 -05:00
2c240923fc
Move developer-facing documentation into a doc/dev subdir
...
Closes #576 .
2022-12-05 08:58:39 -05:00
9d01c88c8c
Update bridges.md a little
2022-11-30 16:21:50 -05:00
a2f148dc4e
Add a quick "how to use bridges" explanation document.
2022-11-30 16:04:36 -05:00
614cf34284
Check more targets
2022-11-10 13:34:17 +00:00
d092c7fa90
Add September values to heap_and_download_size.md.
2022-10-25 21:52:16 +02:00
2cc1996bb6
Add Methodologies section to our Heap and Download Size document.
2022-10-25 21:51:56 +02:00
7a99555e9d
Add missing data from October from Nick.
2022-10-25 21:51:37 +02:00
a8a2de747b
Update heap and download size metrics for October
...
This patch updates the heap_and_download_size.md file with numbers from
October 2022 for our Sponsor 101 deliverables.
2022-10-25 19:56:35 +02:00
5786637b4f
Fix various typos (using typos tool and hand-inspection)
2022-10-18 15:39:33 -04:00
881f6edd9f
Abolish maint/readmes
...
This is not needed any more
2022-10-12 15:29:04 +01:00
239c1f044f
Add a reminder to remove semver.md after release.
2022-09-07 09:20:30 -04:00
35c2a5dc62
Merge branch 'bridge_writeup' into 'main'
...
Overview of issues with bridges in 1.1.0
See merge request tpo/core/arti!686
2022-08-26 18:20:49 +00:00
8f7149931e
Qualify a few statements about bridges.
2022-08-26 13:42:38 -04:00
7700ee3892
Remove first person: Now my opinions are facts. ;)
2022-08-26 13:38:52 -04:00
063c8fc545
Note tickets for TODO items.
...
Also remove controversial paragraph that is now maybe a bug.
2022-08-25 09:36:08 -04:00
31e3649b3e
Apply 1 suggestion(s) to 1 file(s)
2022-08-25 13:12:33 +00:00
44e56d35aa
First draft of "what is sensitive" document
2022-08-23 15:31:26 -04:00
96d21cf4da
Overview of issues with bridges in 1.1.0
2022-08-23 10:36:03 -04:00
12c5af9b7a
doc/Compatibility.md: tick the box for link protocol 5
...
We do this now. As per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/657#note_2828364
2022-08-17 10:54:41 +01:00
e3cc533853
Merge branch 'zeroize' into 'main'
...
Revise our handling of the zeroize trait
Closes #254
See merge request tpo/core/arti!655
2022-08-04 14:54:21 +00:00
96d1b500a7
ZeroizeStrategy.md: Clarify which list we're referring to.
2022-08-04 10:26:15 -04:00
5eb45de6f8
Fix typos
2022-08-01 23:55:33 +03:00
c83ec273d0
Initial document describing our plans for zeroize
2022-08-01 11:52:23 -04:00
054616c281
Checkpoint metrics and discussions on Sponsor 101 metrics
...
These metrics are primarily concerned about heap usage and download
size. I've worked on them for our latest report, and I want to
check them in someplace so we don't forget them the next time we
want to run these.
2022-07-22 10:21:41 -04:00
c9552220dc
Update semver_status.md with new procedure.
...
Now (per discussion on #471 ) we use one file per crate.
I've tried to be more explicit about the format to use, and what to
add when.
2022-05-27 11:55:29 -04:00
4f7e06fe17
Clear out 0.4.0 semver-status
2022-05-27 11:36:33 -04:00
4bf87d61ca
Merge branch 'config-split' into 'main'
...
Break TorClientConfig out of ArtiConfig and warn on unknown config keys
Closes #459 and #417
See merge request tpo/core/arti!529
2022-05-26 10:40:43 +00:00
bc3c9d475f
Merge branch 'support_policy' into 'main'
...
Initial draft policy on supported platforms and dependencies
Closes #379
See merge request tpo/core/arti!513
2022-05-25 13:14:54 +00:00
112cce10ba
semvar_status: Document config changes
2022-05-24 20:17:23 +01:00
814faf6398
Apply clarifications to SupportPolicy.md from @Diziet
2022-05-24 15:13:54 +00:00
de3c7baa4c
Note that fs-mistrust has broken semver.
2022-05-24 10:54:02 -04:00
6a00b74b0b
Clarify which releases get advisories.
2022-05-20 11:57:03 -04:00
a42a6467a1
SupportPolicy: Add tiers, clarify what "support" means.
2022-05-20 11:52:22 -04:00
8406cc3b7f
Initial draft policy on supported platforms and dependencies
2022-05-18 09:24:46 -04:00
fb432924a3
Merge branch 'main' into 'ticket_466'
...
# Conflicts:
# doc/semver_status.md
2022-05-16 15:10:00 +00:00
4b86818b30
Document semver changes
2022-05-13 12:47:38 +01:00
f0eac61838
Merge branch 'network-config-error' into 'main'
...
Delete tor_dirmgr::Error::BadNetworkConfig
See merge request tpo/core/arti!506
2022-05-12 16:43:26 +00:00
1698a2fea1
Merge branch 'template' into 'main'
...
Make the example config file into a template and move it to arti
See merge request tpo/core/arti!503
2022-05-12 16:34:00 +00:00
d847d49858
Delete tor_dirmgr::Error::BadNetworkConfig
...
This was anomalous, in that it contains &'static str, rather than a
proper nested error (eg a config::ConfigError, maybe).
But in fact it tursn out it is now not constructed. The last
construction site was removed a long time ago in
Use derive_builder for Authority and FallbackDir.
2022-05-12 16:49:06 +01:00
2a5ee2c8c9
Merge branch 'ticket_412_467' into 'main'
...
Teach DirMgr to use slightly untimely directories
Closes #467 and #412
See merge request tpo/core/arti!500
2022-05-12 14:42:51 +00:00
d407ce519b
Add semver note for these changes
2022-05-12 15:24:32 +01:00
0c939d45fc
dirclient: add the ability to reject circuits that are too skewed.
...
This will help implement #466 .
2022-05-11 13:48:55 -04:00
0c05baa68b
Add a channel accessor to ClientCirc.
...
I need this so that I can expose the skew time for the directory
that a circuit will use, when I only have the circuit.
2022-05-11 13:02:36 -04:00
12d1752ad5
tor-netdoc: Add a Lifetime::valid_at method.
2022-05-11 12:11:17 -04:00
775432bee8
Document semver changes to ConfigurationSources etc.
2022-05-11 15:53:17 +01:00
864fd03917
Improve documentation around Cargo features; make Runtime require Debug
...
- arti#445 highlighted the lack of good documentation around Arti's
multiple runtime support, as well as it being difficult to determine
what runtime was actually in use.
- Improve the documentation to solve the first problem.
- To solve the second problem, make Runtime require Debug (which is
arguably a good idea anyway, since it makes them easier to embed in
things), and print out the current runtime's Debug information when
arti is invoked with `--version`.
- (It also prints out other Cargo features, too!)
fixes arti#445
2022-05-11 13:26:35 +01:00
3b0336e841
netdoc: add a new type for Nicknames
...
Relay nicknames are always between 1 and 19 characters long, and
they're always ASCII: That means that storing them in a [u8;19] will
always be possible, and always use less resources than storing them
in a String.
Fortunately, the tinystr crate already helps us with this kind of
thing.
2022-05-09 15:59:38 -04:00
4262e9d0ec
Merge branch 'use-fs-mistrust'
2022-05-09 15:27:25 -04:00
8a62f9ce52
Remove "Mistrust" from the public API of arti-client.
...
I'm doing this per discussion, so that we can have it be part of the
TorConfig later on, and not break stuff as we change the Mistrust
API to have a builder.
This change, unfortunately, results in a little more internal
complexity and duplicated code in arti and arti-client. I've marked
those points with TODOs.
2022-05-09 14:40:29 -04:00
b0f39abe32
arti: use fs-mistrust to validate configuration file locations.
2022-05-09 14:40:29 -04:00
2938268f34
arti-client: Configure and use fs-mistrust.
...
This is derived from the environment, not the configuration file: We
might not want to trust the configuration file until we've decided
whether we like its permissions.
2022-05-09 14:40:29 -04:00
20a85061b6
Update tor-dirmgr to use fs-mistrust.
2022-05-09 14:40:29 -04:00
984190b3a3
tor-persist: Use fs-mistrust to verify state file permissions.
2022-05-09 14:40:29 -04:00
16eeb16b4c
Clear semver_status now that 0.3.0 is coming out.
2022-05-06 10:08:08 -04:00
acf38505ee
semver notes: Fix a missing paren
2022-05-05 10:35:52 +01:00
31ce7f4bc0
semver note about serde attribute changes
2022-05-05 10:35:52 +01:00
a334f17262
Merge branch 'socket-addr-list-builder' into 'main'
...
FallbackDir: orports: Introduce and use VecBuilder
See merge request tpo/core/arti!474
2022-05-04 18:13:45 +00:00
4ad4cae418
FallbackDir: Use VecBuilder for orports
...
And drop the ad-hoc orport() method. This brings FallbackDir's
orports field in line with our list builder API.
The general semver note in "configuation" seems to cover most of this.
2022-05-04 17:18:55 +01:00
4262a440b5
list_builder: Update semver note
2022-05-04 17:18:55 +01:00
c84d60910d
GuardUsage: restrictions Add semver note
2022-05-04 16:19:09 +01:00
1d62d92fb9
Fix spacing
2022-04-27 13:52:43 +01:00
c53818d496
Fix grammar and typos
2022-04-27 13:52:13 +01:00
8509dbc920
Merge branch 'upgrade_dependencies' into 'main'
...
Upgrade various dependencies, now that we are MSRV 1.56
Closes #313 and #334
See merge request tpo/core/arti!476
2022-04-27 12:27:28 +00:00
5484bcc21f
Merge branch 'download-schedule' into 'main'
...
DownloadSchedule: Introduce Builder
See merge request tpo/core/arti!473
2022-04-26 18:47:08 +00:00
aaab6f3812
Upgrade to AES 0.8
...
Now that we require Rust 1.56, we can upgrade to AES 0.8. This
forces us to have some slight API changes.
We require cipher 0.4.1, not cipher 0.4.0, since 0.4.0 has
compatibility issues with Rust 1.56.
2022-04-26 12:16:22 -04:00
20d61dd4d4
DirMgrConfig: Rename two fields that contained a _config
...
This entire struct is config. This is otiose.
2022-04-26 15:29:33 +01:00
d2cc0aa50a
Document breaking changes to DownloadSchedule etc.
2022-04-26 15:19:52 +01:00
c1ea419477
Merge branch 'main' into 'msrv_1_56'
...
# Conflicts:
# crates/tor-config/Cargo.toml
# crates/tor-dirmgr/src/state.rs
# doc/semver_status.md
2022-04-26 12:45:16 +00:00
d1fcd3eeae
Update semver_status to note that all crates have had a breaking change.
2022-04-25 13:31:06 -04:00
3f44078227
Add semver note about added macros in tor-condfig
2022-04-25 18:19:03 +01:00
f6506721ab
Add semver notes for AuthorityListBuilder, PredictedPortsListBuilder
...
These were omitted in the earlier commits.
2022-04-25 18:15:25 +01:00
166af2c3f6
Fix error return type of AuthorityBuilder
2022-04-25 12:41:39 +01:00
79decd4ac8
logfiles: Introduce LogfileListConfigBuilder
...
In
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/462#note_2797697
we decided not to do this.
However, having looked again at the way the FallbackList works, I
think there is a lot of value in making these two things (and anything
else like them[1]) as similar as possible.
[1] At least PreemptiveCircuitConfig.initial_predicted_ports and
NetworkConfig.authorities need the same treatment, and perhaps also
GuardUsage.restrictions (although there is no
GuardRestrictionBuilder).
In the irc discussion I imagined `LogfilesConfigBuilder` as opposed to
`LogfileConfigBuilder` (differing only in the `s`) which would be bad,
but we can use `List` instead.
We do *not* need to abstract away the validated version of the config.
Providing a type alias helps the derive_builder sub_builder DTRT
without needing special overrides.
I have split this commit so that we can drop it, if we conclude it's
not wanted.
2022-04-22 17:48:03 +01:00
962b6c32e1
fallback list: Introduce and use FallbackListBuilder
...
Now the network fallbacks configuration wants to Deserialize
a Vec<FallbackDirBuilder>, rather than validated Vec<FallbackDir>.
Methods on FallbackListBuilder are as per
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/462#note_2797697
mutatis mutandi for the fact that this struct has only fallbacks in it.
2022-04-22 17:48:03 +01:00
d3031b437b
Fix wording in FAQ
2022-04-20 11:48:45 +00:00
Ian Jackson
Alexander Færøy
Nick Mathewson
Ian Jackson
Dimitris Apostolou
eta
Emil Engler
trinity-1686a
Samanta Navarro