aboutsummaryrefslogtreecommitdiff
path: root/crates/tor-circmgr/src
Commit message (Collapse)AuthorAgeFilesLines
...
* Merge remote-tracking branch 'origin/mr/112'Nick Mathewson2021-10-291-3/+37
|\
| * Improve docs of more (potentially re-exported) arti-client typeseta2021-10-291-3/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Most of the structs in `arti-client` have example code now, to give a clearer idea of how they're used. Annoyingly, a lot of the types exposed in `arti-client` are actually re-exports, which makes documentation a bit harder: example code that references other parts of `arti-client` can't actually be run as a doctest, since the crate it's in is a dependency of `arti-client`. We might be able to fix this in future by doing the documentation in `arti-client` itself, but rustdoc seems to have some weird behaviours there that need to be investigated first (for example, it seems to merge the re-export and original documentation, and also put the re-export documentation on the `impl` block for some reason). For now, though, this commit just writes the docs from the point of view of an `arti-client` consumer, removing notes specific to the crate in which they're defined. It's not ideal, but at least the end user experience is decent.
* | Improve some documentation linksNick Mathewson2021-10-291-1/+2
|/ | | | | | | | | Instead of putting a fully qualified name in the text, in most cases we should just use the short name of the type or function we're referring to. In other words, instead of saying [`crate::module::Foo`], we should typically say [`Foo`](crate::module::Foo).
* Try writing a bit more documentation for configuration types.Nick Mathewson2021-10-281-3/+9
|
* Fix clippy warnings in tests.Nick Mathewson2021-10-281-5/+5
|
* Merge remote-tracking branch 'origin/mr/110'Nick Mathewson2021-10-281-136/+233
|\
| * tor_circmgr: Refactor and re-enable build_timeout() testNick Mathewson2021-10-271-136/+233
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The previous version of this test used the old, racy version of wait_for (see #149). The new version is refactored so that simulated time is only allowed to advance after each step is done, so that we can actually be sure that each step in the process will happen as it should. In order to get the time-advances to proceed properly, and avoid polluting state between tests, I've had to introduce some machinery to encode the proper amount for time to advance. It isn't something I'd want to use for a whole bunch of tests, but for just one set, it's fine. These tests now pass reliably for me. I wonder if a discrete-event-simulation approach (hello, Shadow) would let us write tests like these to our hearts' content?
* | Mark request_retried test as ignoredNick Mathewson2021-10-281-0/+1
|/
* Update our disclaimers and limitations sections.Nick Mathewson2021-10-271-4/+0
|
* Add #[serde(flatten)] HashMap fields to serializable objectseta2021-10-271-2/+8
| | | | | | | | | | As per arti#175, we'd like to be able to handle newer Arti versions storing additional state in the persisted state files, without dropping this data on the floor when we write out changes to these files. Use the #[serde(flatten)] mechanism to achieve this, by adding catch-all HashMap<String, JsonValue> fields to all structs that are at risk of this happening to them.
* Fix some clippy-nightly warnings.Nick Mathewson2021-10-261-0/+4
| | | | These are my fault; I merged the wrong version of !102. :p
* circmgr: Split request_timeout test into two.Nick Mathewson2021-10-261-0/+7
| | | | | | | There seems to be some issue here with the new WaitFor code, where using the same MockSleepProvider with both of these wait_for() calls gives questionable behavior under some circumstances (like when running under Tarpaulin with the wrong set of flags).
* Merge remote-tracking branch 'origin/mr/102'Nick Mathewson2021-10-263-15/+79
|\
| * Overhaul the way WaitFor and the MockSleepProvider worketa2021-10-263-15/+79
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Instead of racily advancing time forward, this commit attempts to rework how WaitFor works, such that it makes advances when all sleeper futures that have been created have been polled (by handing the MockSleepRuntime a Waker with which to wake up the WaitFor). The above described mechanics work well enough for the double timeout test, but fail in the presence of code that spawns asynchronous / background tasks that must make progress before time is advanced for the test to work properly. In order to deal with these cases, a set of APIs are introduced in order to block time from being advanced until some code has run, and a carveout added in order to permit small advances in time where required. (In some cases, code needed to be hacked up a bit in order to be made properly testable using these APIs; the `MockablePlan` trait included in here is somewhat unfortunate.) This should fix arti#149.
* | Merge branch 'pb_lite_squashed'Nick Mathewson2021-10-261-1/+11
|\ \
| * | Do not blame a guard for failures on non-random circuits.Nick Mathewson2021-10-261-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | We must not apply our new path-bias behavior (where we blame a guard if it gives us too many indeterminate circuit failures) if the path was not chosen at random. If too many random paths fail, we know that's suspicious, since the other relays are a random sample. But if a bunch of user-provided paths fail, that could simply be because the user's chosen exit is down.
* | | Turn StreamIsolation into a separate type.Nick Mathewson2021-10-252-39/+91
|/ / | | | | | | | | | | | | | | | | Now that we have two kinds of isolation tokens (those set on a stream, and those set by the stream's associated TorClient), we need a more sophisticated kind of isolation. This fixes the bug introduced with the previous commit, where per-stream tokens would override per-TorClient tokens.
* | s/arti-arti-client/arti-client/ and regenerate readme filesNick Mathewson2021-10-251-1/+1
| |
* | Fix a typo in a comment.Nick Mathewson2021-10-251-1/+1
| |
* | Run "cargo fix --edition-idioms=2018".Nick Mathewson2021-10-221-1/+1
| |
* | Replace references to arti-client in the documentation.Nick Mathewson2021-10-213-4/+4
| |
* | Remove #![allow(dead_code)] in timeouts.rsNick Mathewson2021-10-212-2/+3
| |
* | Merge branch 'share_state'Nick Mathewson2021-10-217-221/+461
|\ \ | |/ |/|
| * Implement the guard side of shared state directories.Nick Mathewson2021-10-211-1/+10
| |
| * Finish the timeout-inference side of shared state.Nick Mathewson2021-10-203-30/+94
| |
| * Add a timeout estimator to take estimates from another process.Nick Mathewson2021-10-204-42/+93
| |
| * Allow type of timeout estimator to change at runtime.Nick Mathewson2021-10-204-201/+289
| | | | | | | | | | | | This is a big change, but it does simplify the type of Builder a little, and isolates locking across different (potential) timeout estimator types.
| * Replace the return type of StorageMgr::try_lock with a tristateNick Mathewson2021-10-201-1/+9
| | | | | | | | | | It's useful to know now only if we now have the lock, but also if we just got it for the first time.
| * Initial work on periodically reloading state.Nick Mathewson2021-10-192-2/+11
| | | | | | | | | | We can use this in the case where we don't get the lock on the state file, because another process is running.
* | Implement the "request_loyalty" configuration optionNick Mathewson2021-10-191-2/+1
| |
* | Fix most warnings from nightly.Nick Mathewson2021-10-191-14/+3
| | | | | | | | (One represents code that I forgot to write.)
* | tor-client: refactor TorClient::bootstrap's args into a config objecteta2021-10-191-1/+1
|/ | | | | | | | | | | | | The three arguments TorClient::bootstrap requires by way of configuration have been factored into a new TorClientConfig object. This object gains two associated functions: one which uses `tor_config`'s `CfgPath` machinery to generate sane defaults for the state and cache directories, and one that accepts said directories in order to create a config object with those inserted. (this commit was inspired by trying to use arti as a library and being somewhat overwhelmed by the amount of config stuff there was to do :p)
* Use better reporting for guard status.Nick Mathewson2021-10-133-22/+119
| | | | | | | | | | | | | The previous code would report all failures to build a circuit as failures of the guard. But of course that's not right: If we fail to extend to the second or third hop, that might or might not be the guard's fault. Now we use the "pending status" feature of the GuardMonitor type so that an early failure is attributed to the guard, but a later failure is attributed as "Indeterminate". Only a complete circuit is called a success. We use a new "GuardStatusHandle" type here so that we can report the status early if there is a timeout.
* Implement guards for multihop paths.Nick Mathewson2021-10-133-26/+87
| | | | There are some limitations here, as noted in the comments.
* Actually select guards for directory circuits.Nick Mathewson2021-10-133-12/+25
|
* Pass the guard manager down to the path selection functions.Nick Mathewson2021-10-114-14/+36
|
* WIPNick Mathewson2021-10-114-13/+19
|
* Integrate GuardUsability and GuardMonitor into CircuitBuilder.Nick Mathewson2021-10-103-11/+73
| | | | | | (When we're building a path with a guard, we need to tell the guard manager whether the path succeeded, and we need to wait to hear whether the guard is usable.)
* Notify guard manager on network change and state flush.Nick Mathewson2021-10-102-2/+20
|
* Add a GuardMgr member to CircuitBuilderNick Mathewson2021-10-103-3/+19
|
* Re-export configuration types from tor-client.Nick Mathewson2021-10-092-0/+9
|
* enable checked_conversions lint.Nick Mathewson2021-10-092-4/+11
|
* Initial backend implementation for guard node manager.Nick Mathewson2021-10-071-0/+1
| | | | | | | There are some missing parts here (like persistence and tests) and some incorrect parts (I am 90% sure that the "exploratory circuit" flag is bogus). Also it is not integrated with the circuit manager code.
* Use StorageHandle in tor_circmgr.Nick Mathewson2021-09-303-70/+15
|
* Do not use set_ prefix on derive_builder settersJani Monoses2021-09-162-5/+5
|
* fix/silence clippy lints in test modulesDaniel Eades2021-09-089-12/+22
|
* More tests in pareto.rsNick Mathewson2021-09-081-9/+47
|
* Use same defaults for abandon and close times in timeout code.Nick Mathewson2021-09-071-6/+4
| | | | | | | | | | | On torspec!40, Mike says: I don't think there is a practical difference here. As per Section 2.4.5, if 60 seconds is not enough and causes the liveness test to fail due to too many timeouts, we will double the initial timeout. This makes our behavior the same as C tor.
* Stop making abandoned/successful circuit counts persistentNick Mathewson2021-09-071-22/+1
| | | | | | | | | | | | | | The C Tor implementation doesn't do this, and Mike says: I think it is a reasonable enough assumption that if Tor has restarted, this kind data is no longer fresh enough to be accurate for this purpose. This is also only 20 circuits here, and typical timeouts are now around 1-2 seconds or less.. So a restarted client with a timeout that is too low for a new internet connection will figure this out pretty quickly. I think that is OK. (from torspec!40)
* A little more test coverage in tor-circmgr::mgrNick Mathewson2021-09-072-6/+36
|