mirrors/arti.git/crates/tor-guardmgr/src/lib.rs, branch tor-dirmgr-v0.5.1

Run maint/add_warning crates/*/src/{lib,main}.rs

2022-06-23T18:15:42Z

Update all lint blocks

Rename guardset-selection function.

2022-06-17T12:47:57Z

Also, improve its documentation.

Rename pick_guard, pick_guard_ext.

2022-06-17T12:47:57Z

Now the primary exposed function is `pick_guard` again. This commit is just function renaming.

Refactor and document issues with modify_hop.

2022-06-17T12:47:57Z

At the site of modify_hop, we now have a comment explaining the internal-error issue. To make the internal error less likely, we lower the modify_hop call in lib.rs into GuardSet, where it can make sure it's looking at the same filter as was used to select the guard. The function name "pick_guard_ext" is not permanent; I'm going to rename it in the next commit.

API-fix for extend_sample_as_needed.

2022-06-17T12:47:57Z

Previously, the API said "you need to call this in a loop till it returns false". We did that in one place, but not another. With the introduction of filters, forgetting to loop here becomes a bug: so instead, change the behavior of extend_sample_as_needed so it handles looping itself.

Remove some outdated comments.

2022-06-17T12:47:57Z

These all say, in one form or another, "there is no guard filtering; there is only one selection". That's now false.

Tweak parameters in guardmgr tests to improve testnet behavior.

2022-06-17T12:47:57Z

The fake network we construct for these tests is small in ways that can sometimes cause weird behavior with guard filters. We fix this by adjusting the parameters of the guard selection algorithm accordingly in the tests. With these new parameters, #491 no longer occurs. This commit also adds comments to explain why the parameters are set as they are. Closes #491.

GuardMgr: Support for multiple guard sets

2022-06-17T12:47:57Z

guard-spec.txt specifies that we have multiple separate samples of guards that we can use depending on whether the filter is restrictive or not. Here we implement the rules for switching between samples.

Move set_filter into GuardMgrInner.

2022-06-17T12:47:57Z

Convert its argument type to Option<&NetDir> to better match the rest of the API.

GuardMgr: Also apply filters to fallback directories.

2022-06-17T12:46:16Z