1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
//! `tor-guardmgr`: guard node selection for Tor network clients.
//!
//! # Overview
//!
//! This crate is part of
//! [Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to
//! implement [Tor](https://www.torproject.org/) in Rust.
//!
//! "Guard nodes" are mechanism that Tor clients uses to limit the
//! impact of hostile relays. Approximately: each client chooses a
//! small set of relays to use as its "guards". Later, when the
//! client picks its paths through network, rather than choosing a
//! different first hop randomly for every path, it chooses the best
//! "guard" as the first hop.
//!
//! This crate provides [`GuardMgr`], an object that manages a set of
//! guard nodes, and helps the `tor-circmgr` crate know when to use
//! them.
//!
//! Guard nodes are persistent across multiple process invocations.
//!
//! More Arti users won't need to use this crate directly.
//!
//! # Motivation
//!
//! What's the point? By restricting their first hops to a small set,
//! clients increase their odds against traffic-correlation attacks.
//! Since we assume that an adversary who controls both ends of a
//! circuit can correlate its traffic, choosing many circuits with
//! random entry points will eventually cause a client to eventually
//! pick an attacker-controlled circuit, with probability approaching
//! 1 over time. If entry nodes are restricted to a small set,
//! however, then the client has a chance of never picking an
//! attacker-controlled circuit.
//!
//! (The actual argument is a little more complicated here, and it
//! relies on the assumption that, since the attacker knows
//! statistics, exposing _any_ of your traffic is nearly as bad as
//! exposing _all_ of your traffic.)
//!
//! # Complications
//!
//! The real algorithm for selecting and using guards can get more
//! complicated because of a variety of factors.
//!
//! - In reality, we can't just "pick a few guards at random" and use
//! them forever: relays can appear and disappear, relays can go
//! offline and come back online, and so on. What's more, keeping
//! guards for too long can make targeted attacks against those
//! guards more attractive.
//!
//! - Further, we may have particular restrictions on where we can
//! connect. (For example, we might be restricted to ports 80 and
//! 443, but only when we're on a commuter train's wifi network.)
//!
//! - We need to resist attacks from local networks that block all but a
//! small set of guard relays, to force us to choose those.
//!
//! - We need to give good, reliable performance while using the
//! guards that we prefer.
//!
//! These needs complicate our API somewhat. Instead of simply asking
//! the `GuardMgr` for a guard, the circuit-management code needs to
//! be able to tell the `GuardMgr` that a given guard has failed (or
//! succeeded), and that it needs a different guard in the future (or
//! not).
//!
//! Further, the `GuardMgr` code needs to be able to hand out
//! _provisional guards_, in effect saying "You can try building a
//! circuit with this guard, but please don't actually _use_ that
//! circuit unless I tell you it's safe."
//!
//! For details on the exact algorithm, see `guard-spec.txt` (link
//! below) and comments and internal documentation in this crate.
//!
//! # Limitations
//!
//! * Our circuit blocking algorithm is simplified from the one that Tor uses.
//! See comments in `GuardSet::circ_usability_status` for more information.
//! See also [proposal 337](https://gitlab.torproject.org/tpo/core/torspec/-/blob/main/proposals/337-simpler-guard-usability.md).
//!
//! # References
//!
//! Guard nodes were first proposes (as "helper nodes") in "Defending
//! Anonymous Communications Against Passive Logging Attacks" by
//! Matthew Wright, Micah Adler, Brian N. Levine, and Clay Shields in
//! the Proceedings of the 2003 IEEE Symposium on Security and
//! Privacy. (See <https://www.freehaven.net/anonbib/#wright03>)
//!
//! Tor's current guard selection algorithm is described in Tor's
//! [`guard-spec.txt`](https://gitlab.torproject.org/tpo/core/torspec/-/raw/main/guard-spec.txt)
//! document.
// @@ begin lint list maintained by maint/add_warning @@
#![deny(missing_docs)]
#![warn(noop_method_call)]
#![deny(unreachable_pub)]
#![warn(clippy::all)]
#![deny(clippy::await_holding_lock)]
#![deny(clippy::cargo_common_metadata)]
#![deny(clippy::cast_lossless)]
#![deny(clippy::checked_conversions)]
#![warn(clippy::cognitive_complexity)]
#![deny(clippy::debug_assert_with_mut_call)]
#![deny(clippy::exhaustive_enums)]
#![deny(clippy::exhaustive_structs)]
#![deny(clippy::expl_impl_clone_on_copy)]
#![deny(clippy::fallible_impl_from)]
#![deny(clippy::implicit_clone)]
#![deny(clippy::large_stack_arrays)]
#![warn(clippy::manual_ok_or)]
#![deny(clippy::missing_docs_in_private_items)]
#![deny(clippy::missing_panics_doc)]
#![warn(clippy::needless_borrow)]
#![warn(clippy::needless_pass_by_value)]
#![warn(clippy::option_option)]
#![warn(clippy::rc_buffer)]
#![deny(clippy::ref_option_ref)]
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::trait_duplication_in_bounds)]
#![deny(clippy::unnecessary_wraps)]
#![warn(clippy::unseparated_literal_suffix)]
#![deny(clippy::unwrap_used)]
#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
// Glossary:
// Primary guard
// Sample
// confirmed
// filtered
use educe::Educe;
use futures::channel::mpsc;
use futures::task::SpawnExt;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet};
use std::net::SocketAddr;
use std::sync::{Arc, Mutex, Weak};
use std::time::{Duration, Instant, SystemTime};
use tor_netdir::NetDirProvider;
use tor_proto::ClockSkew;
use tracing::{debug, info, trace, warn};
use tor_config::impl_standard_builder;
use tor_config::{define_list_builder_accessors, define_list_builder_helper};
use tor_llcrypto::pk;
use tor_netdir::{params::NetParameters, NetDir, Relay};
use tor_persist::{DynStorageHandle, StateMgr};
use tor_rtcompat::Runtime;
mod daemon;
mod dirstatus;
mod err;
mod events;
pub mod fallback;
mod filter;
mod guard;
mod ids;
mod pending;
mod sample;
mod skew;
mod util;
pub use err::{GuardMgrError, PickGuardError};
pub use events::ClockSkewEvents;
pub use filter::GuardFilter;
pub use ids::FirstHopId;
pub use pending::{GuardMonitor, GuardStatus, GuardUsable};
pub use skew::SkewEstimate;
use pending::{PendingRequest, RequestId};
use sample::GuardSet;
use crate::ids::FirstHopIdInner;
/// A "guard manager" that selects and remembers a persistent set of
/// guard nodes.
///
#[derive(Clone)]
pub struct GuardMgr<R: Runtime> {
/// An asynchronous runtime object.
///
/// GuardMgr uses this runtime for timing, timeouts, and spawning
/// tasks.
runtime: R,
/// Internal state for the guard manager.
inner: Arc<Mutex<GuardMgrInner>>,
}
/// Helper type that holds the data used by a [`GuardMgr`].
///
/// This would just be a [`GuardMgr`], except that it needs to sit inside
/// a `Mutex` and get accessed by daemon tasks.
struct GuardMgrInner {
/// Last time when marked all of our primary guards as retriable.
///
/// We keep track of this time so that we can rate-limit
/// these attempts.
last_primary_retry_time: Instant,
/// Persistent guard manager state.
///
/// This object remembers one or more persistent set of guards that we can
/// use, along with their relative priorities and statuses.
guards: GuardSets,
/// The current filter that we're using to decide which guards are
/// supported.
//
// TODO: This field is duplicated in the current active [`GuardSet`]; we
// should fix that.
filter: GuardFilter,
/// Configuration values derived from the consensus parameters.
///
/// This is updated whenever the consensus parameters change.
params: GuardParams,
/// A mpsc channel, used to tell the task running in
/// [`daemon::report_status_events`] about a new event to monitor.
///
/// This uses an `UnboundedSender` so that we don't have to await
/// while sending the message, which in turn allows the GuardMgr
/// API to be simpler. The risk, however, is that there's no
/// backpressure in the event that the task running
/// [`daemon::report_status_events`] fails to read from this
/// channel.
ctrl: mpsc::UnboundedSender<daemon::Msg>,
/// Information about guards that we've given out, but where we have
/// not yet heard whether the guard was successful.
///
/// Upon leaning whether the guard was successful, the pending
/// requests in this map may be either moved to `waiting`, or
/// discarded.
///
/// There can be multiple pending requests corresponding to the
/// same guard.
pending: HashMap<RequestId, PendingRequest>,
/// A list of pending requests for which we have heard that the
/// guard was successful, but we have not yet decided whether the
/// circuit may be used.
///
/// There can be multiple waiting requests corresponding to the
/// same guard.
waiting: Vec<PendingRequest>,
/// A list of fallback directories used to access the directory system
/// when no other directory information is yet known.
// TODO: reconfigure when the configuration changes.
fallbacks: fallback::FallbackState,
/// Location in which to store persistent state.
storage: DynStorageHandle<GuardSets>,
/// A sender object to publish changes in our estimated clock skew.
send_skew: postage::watch::Sender<Option<SkewEstimate>>,
/// A receiver object to hand out to observers who want to know about
/// changes in our estimated clock skew.
recv_skew: events::ClockSkewEvents,
/// A netdir provider that we can use for adding new guards when
/// insufficient guards are available.
///
/// This has to be an Option so it can be initialized from None: at the
/// time a GuardMgr is created, there is no NetDirProvider for it to use.
netdir_provider: Option<Weak<dyn NetDirProvider>>,
}
/// A selector that tells us which [`GuardSet`] of several is currently in use.
#[derive(Clone, Debug, Eq, PartialEq, Educe)]
#[educe(Default)]
enum GuardSetSelector {
/// The default guard set is currently in use: that's the one that we use
/// when we have no filter installed, or the filter permits most of the
/// guards on the network.
#[educe(Default)]
Default,
/// A "restrictive" guard set is currently in use: that's the one that we
/// use when we have a filter that excludes a large fraction of the guards
/// on the network.
Restricted,
}
/// Persistent state for a guard manager, as serialized to disk.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
struct GuardSets {
/// Which set of guards is currently in use?
#[serde(skip)]
active_set: GuardSetSelector,
/// The default set of guards to use.
///
/// We use this one when there is no filter, or the filter permits most of the
/// guards on the network.
default: GuardSet,
/// A guard set to use when we have a restrictive filter.
#[serde(default)]
restricted: GuardSet,
/// Unrecognized fields, including (possibly) other guard sets.
#[serde(flatten)]
remaining: HashMap<String, tor_persist::JsonValue>,
}
/// The key (filename) we use for storing our persistent guard state in the
/// `StateMgr`.
///
/// We used to store this in a different format in a filename called
/// "default_guards" (before Arti 0.1.0).
const STORAGE_KEY: &str = "guards";
impl<R: Runtime> GuardMgr<R> {
/// Create a new "empty" guard manager and launch its background tasks.
///
/// It won't be able to hand out any guards until
/// [`GuardMgr::update_network`] has been called.
pub fn new<S>(
runtime: R,
state_mgr: S,
fallbacks: fallback::FallbackList,
) -> Result<Self, GuardMgrError>
where
S: StateMgr + Send + Sync + 'static,
{
let (ctrl, rcv) = mpsc::unbounded();
let storage: DynStorageHandle<GuardSets> = state_mgr.create_handle(STORAGE_KEY);
// TODO(nickm): We should do something about the old state in
// `default_guards`. Probably it would be best to delete it. We could
// try to migrate it instead, but that's beyond the stability guarantee
// that we're getting at this stage of our (pre-0.1) development.
let state = storage.load()?.unwrap_or_default();
let (send_skew, recv_skew) = postage::watch::channel();
let recv_skew = ClockSkewEvents { inner: recv_skew };
let inner = Arc::new(Mutex::new(GuardMgrInner {
guards: state,
filter: GuardFilter::unfiltered(),
last_primary_retry_time: runtime.now(),
params: GuardParams::default(),
ctrl,
pending: HashMap::new(),
waiting: Vec::new(),
fallbacks: fallbacks.into(),
storage,
send_skew,
recv_skew,
netdir_provider: None,
}));
{
let weak_inner = Arc::downgrade(&inner);
let rt_clone = runtime.clone();
runtime
.spawn(daemon::report_status_events(rt_clone, weak_inner, rcv))
.map_err(|e| GuardMgrError::from_spawn("guard status event reporter", e))?;
}
{
let rt_clone = runtime.clone();
let weak_inner = Arc::downgrade(&inner);
runtime
.spawn(daemon::run_periodic(rt_clone, weak_inner))
.map_err(|e| GuardMgrError::from_spawn("periodic guard updater", e))?;
}
Ok(GuardMgr { runtime, inner })
}
/// Install a [`NetDirProvider`] for use by this guard manager.
///
/// It will be used to keep the guards up-to-date with changes from the
/// network directory, and to find new guards when no NetDir is provided to
/// select_guard().
///
/// TODO: we should eventually return some kind of a task handle from this
/// task, even though it is not strictly speaking periodic.
pub fn install_netdir_provider(
&self,
provider: &Arc<dyn NetDirProvider>,
) -> Result<(), GuardMgrError> {
let weak_provider = Arc::downgrade(provider);
{
let mut inner = self.inner.lock().expect("Poisoned lock");
inner.netdir_provider = Some(weak_provider.clone());
}
let weak_inner = Arc::downgrade(&self.inner);
let rt_clone = self.runtime.clone();
self.runtime
.spawn(daemon::keep_netdir_updated(
rt_clone,
weak_inner,
weak_provider,
))
.map_err(|e| GuardMgrError::from_spawn("periodic guard netdir updater", e))?;
Ok(())
}
/// Flush our current guard state to the state manager, if there
/// is any unsaved state.
pub fn store_persistent_state(&self) -> Result<(), GuardMgrError> {
let inner = self.inner.lock().expect("Poisoned lock");
trace!("Flushing guard state to disk.");
inner.storage.store(&inner.guards)?;
Ok(())
}
/// Reload state from the state manager.
///
/// We only call this method if we _don't_ have the lock on the state
/// files. If we have the lock, we only want to save.
pub fn reload_persistent_state(&self) -> Result<(), GuardMgrError> {
let mut inner = self.inner.lock().expect("Poisoned lock");
if let Some(new_guards) = inner.storage.load()? {
let now = self.runtime.wallclock();
inner.replace_guards_with(new_guards, now);
}
Ok(())
}
/// Switch from having an unowned persistent state to having an owned one.
///
/// Requires that we hold the lock on the state files.
pub fn upgrade_to_owned_persistent_state(&self) -> Result<(), GuardMgrError> {
let mut inner = self.inner.lock().expect("Poisoned lock");
debug_assert!(inner.storage.can_store());
let new_guards = inner.storage.load()?.unwrap_or_default();
let now = self.runtime.wallclock();
inner.replace_guards_with(new_guards, now);
Ok(())
}
/// Return true if `netdir` has enough information to safely become our new netdir.
pub fn netdir_is_sufficient(&self, netdir: &NetDir) -> bool {
let mut inner = self.inner.lock().expect("Poisoned lock");
inner
.guards
.active_guards_mut()
.missing_primary_microdescriptors(netdir)
== 0
}
/// Mark every guard as potentially retriable, regardless of how recently we
/// failed to connect to it.
pub fn mark_all_guards_retriable(&self) {
let mut inner = self.inner.lock().expect("Poisoned lock");
inner.guards.active_guards_mut().mark_all_guards_retriable();
}
/// Update the state of this [`GuardMgr`] based on a new or modified
/// [`NetDir`] object.
///
/// This method can add new guards, or notice that existing guards have
/// become unusable. It needs a `NetDir` so it can identify potential
/// candidate guards.
///
/// Call this method whenever the `NetDir` changes, unless you have used
/// `install_netdir_provider`.
pub fn update_network(&self, netdir: &NetDir) {
trace!("Updating guard state from network directory");
let now = self.runtime.wallclock();
let mut inner = self.inner.lock().expect("Poisoned lock");
inner.update(now, Some(netdir));
}
/// Replace the fallback list held by this GuardMgr with `new_list`.
pub fn replace_fallback_list(&self, list: fallback::FallbackList) {
let mut fallbacks: fallback::FallbackState = list.into();
let mut inner = self.inner.lock().expect("Poisoned lock");
std::mem::swap(&mut inner.fallbacks, &mut fallbacks);
inner.fallbacks.take_status_from(fallbacks);
}
/// Replace the current [`GuardFilter`] used by this `GuardMgr`.
pub fn set_filter(&self, filter: GuardFilter, netdir: Option<&NetDir>) {
let now = self.runtime.wallclock();
let mut inner = self.inner.lock().expect("Poisoned lock");
inner.set_filter(filter, netdir, now);
}
/// Select a guard for a given [`GuardUsage`].
///
/// On success, we return a [`FirstHop`] object to identify which
/// guard we have picked, a [`GuardMonitor`] object that the
/// caller can use to report whether its attempt to use the guard
/// succeeded or failed, and a [`GuardUsable`] future that the
/// caller can use to decide whether a circuit built through the
/// guard is actually safe to use.
///
/// That last point is important: It's okay to build a circuit
/// through the guard returned by this function, but you can't
/// actually use it for traffic unless the [`GuardUsable`] future
/// yields "true".
///
/// # Limitations
///
/// This function will never return a guard that isn't listed in
/// the most recent [`NetDir`].
///
/// That's _usually_ what you'd want, but when we're trying to
/// bootstrap we might want to use _all_ guards as possible
/// directory caches. That's not implemented yet. (See ticket
/// [#220](https://gitlab.torproject.org/tpo/core/arti/-/issues/220)).
///
/// This function only looks at netdir when all of the known
/// guards are down; to force an update, use [`GuardMgr::update_network`].
pub fn select_guard(
&self,
usage: GuardUsage,
netdir: Option<&NetDir>,
) -> Result<(FirstHop, GuardMonitor, GuardUsable), PickGuardError> {
let now = self.runtime.now();
let wallclock = self.runtime.wallclock();
let mut inner = self.inner.lock().expect("Poisoned lock");
// (I am not 100% sure that we need to consider_all_retries here, but
// it should _probably_ not hurt.)
inner.guards.active_guards_mut().consider_all_retries(now);
let (origin, guard) = inner.select_guard_with_expand(&usage, netdir, now, wallclock)?;
trace!(?guard, ?usage, "Guard selected");
let (usable, usable_sender) = if origin.usable_immediately() {
(GuardUsable::new_usable_immediately(), None)
} else {
let (u, snd) = GuardUsable::new_uncertain();
(u, Some(snd))
};
let request_id = pending::RequestId::next();
let ctrl = inner.ctrl.clone();
let monitor = GuardMonitor::new(request_id, ctrl);
// Note that the network can be down even if all the primary guards
// are not yet marked as unreachable. But according to guard-spec we
// don't want to acknowledge the net as down before that point, since
// we don't mark all the primary guards as retriable unless
// we've been forced to non-primary guards.
let net_has_been_down =
if let Some(duration) = tor_proto::time_since_last_incoming_traffic() {
inner
.guards
.active_guards_mut()
.all_primary_guards_are_unreachable()
&& duration >= inner.params.internet_down_timeout
} else {
// TODO: Is this the correct behavior in this case?
false
};
let pending_request =
pending::PendingRequest::new(guard.id.clone(), usage, usable_sender, net_has_been_down);
inner.pending.insert(request_id, pending_request);
match &guard.id.0 {
FirstHopIdInner::Guard(id) => inner.guards.active_guards_mut().record_attempt(id, now),
FirstHopIdInner::Fallback(_) => {
// We don't record attempts for fallbacks; we only care when
// they have failed.
}
}
Ok((guard, monitor, usable))
}
/// Record that _after_ we built a circuit with a guard, something described
/// in `external_failure` went wrong with it.
pub fn note_external_failure(
&self,
ed_identity: &pk::ed25519::Ed25519Identity,
rsa_identity: &pk::rsa::RsaIdentity,
external_failure: ExternalActivity,
) {
let now = self.runtime.now();
let mut inner = self.inner.lock().expect("Poisoned lock");
let ids = inner.lookup_ids(ed_identity, rsa_identity);
for id in ids {
match &id.0 {
FirstHopIdInner::Guard(id) => {
inner.guards.active_guards_mut().record_failure(
id,
Some(external_failure),
now,
);
}
FirstHopIdInner::Fallback(id) => {
if external_failure == ExternalActivity::DirCache {
inner.fallbacks.note_failure(id, now);
}
}
}
}
}
/// Record that _after_ we built a circuit with a guard, some activity
/// described in `external_activity` was successful with it.
pub fn note_external_success(
&self,
ed_identity: &pk::ed25519::Ed25519Identity,
rsa_identity: &pk::rsa::RsaIdentity,
external_activity: ExternalActivity,
) {
let mut inner = self.inner.lock().expect("Poisoned lock");
inner.record_external_success(
ed_identity,
rsa_identity,
external_activity,
self.runtime.wallclock(),
);
}
/// Return a stream of events about our estimated clock skew; these events
/// are `None` when we don't have enough information to make an estimate,
/// and `Some(`[`SkewEstimate`]`)` otherwise.
///
/// Note that this stream can be lossy: if the estimate changes more than
/// one before you read from the stream, you might only get the most recent
/// update.
pub fn skew_events(&self) -> ClockSkewEvents {
let inner = self.inner.lock().expect("Poisoned lock");
inner.recv_skew.clone()
}
/// Ensure that the message queue is flushed before proceeding to
/// the next step. Used for testing.
#[cfg(test)]
async fn flush_msg_queue(&self) {
let (snd, rcv) = futures::channel::oneshot::channel();
let pingmsg = daemon::Msg::Ping(snd);
{
let inner = self.inner.lock().expect("Poisoned lock");
inner
.ctrl
.unbounded_send(pingmsg)
.expect("Guard observer task exited prematurely.");
}
let _ = rcv.await;
}
}
/// An activity that can succeed or fail, and whose success or failure can be
/// attributed to a guard.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum ExternalActivity {
/// The activity of using the guard as a directory cache.
DirCache,
}
impl GuardSets {
/// Return a reference to the currently active set of guards.
///
/// (That's easy enough for now, since there is never more than one set of
/// guards. But eventually that will change, as we add support for more
/// complex filter types, and for bridge relays. Those will use separate
/// `GuardSet` instances, and this accessor will choose the right one.)
fn active_guards(&self) -> &GuardSet {
match self.active_set {
GuardSetSelector::Default => &self.default,
GuardSetSelector::Restricted => &self.restricted,
}
}
/// Return a mutable reference to the currently active set of guards.
fn active_guards_mut(&mut self) -> &mut GuardSet {
match self.active_set {
GuardSetSelector::Default => &mut self.default,
GuardSetSelector::Restricted => &mut self.restricted,
}
}
/// Update all non-persistent state for the guards in this object with the
/// state in `other`.
fn copy_status_from(&mut self, other: GuardSets) {
self.default.copy_status_from(other.default);
}
}
impl GuardMgrInner {
/// Look up the latest [`NetDir`] (if there is one) from our
/// [`NetDirProvider`] (if we have one).
fn latest_netdir(&self) -> Option<Arc<NetDir>> {
self.netdir_provider
.as_ref()
.and_then(Weak::upgrade)
.and_then(|np| np.latest_netdir())
}
/// Run a function that takes `&mut self` and an optional NetDir.
///
/// If a NetDir is provided, use that. Otherwise, try to use the netdir
/// from our [`NetDirProvider`] (if we have one).
//
// This function exists to handle the lifetime mess where sometimes the
// resulting NetDir will borrow from `netdir`, and sometimes it will borrow
// from an Arc returned by `self.latest_netdir()`.
fn with_opt_netdir<F, T>(&mut self, netdir: Option<&NetDir>, func: F) -> T
where
F: FnOnce(&mut Self, Option<&NetDir>) -> T,
{
if let Some(nd) = netdir {
func(self, Some(nd))
} else if let Some(nd) = self.latest_netdir() {
func(self, Some(nd.as_ref()))
} else {
func(self, None)
}
}
/// Update the status of all guards in the active set, based on the passage
/// of time and (optionally) a network directory. If no directory is
/// provided, we try to find one from the installed provider.
///
/// We can expire guards based on the time alone; we can only add guards or
/// change their status with a NetDir.
fn update(&mut self, now: SystemTime, netdir: Option<&NetDir>) {
self.with_opt_netdir(netdir, |this, netdir| this.update_internal(now, netdir));
}
/// As `update`, but do not try to look up a [`NetDir`] if none is given.
fn update_internal(&mut self, now: SystemTime, netdir: Option<&NetDir>) {
// Set the parameters.
if let Some(netdir) = netdir {
match GuardParams::try_from(netdir.params()) {
Ok(params) => self.params = params,
Err(e) => warn!("Unusable guard parameters from consensus: {}", e),
}
self.select_guard_set(netdir);
}
// Change the filter, if it doesn't match what the guards have.
//
// TODO(nickm): We could use a "dirty" flag or something to decide
// whether we need to call set_filter, if this comparison starts to show
// up in profiles.
if self.guards.active_guards().filter() != &self.filter {
let restrictive = self.guards.active_set == GuardSetSelector::Restricted;
self.guards
.active_guards_mut()
.set_filter(self.filter.clone(), restrictive);
}
// Then expire guards. Do that early, in case we need more.
self.guards
.active_guards_mut()
.expire_old_guards(&self.params, now);
if let Some(netdir) = netdir {
if self
.guards
.active_guards_mut()
.missing_primary_microdescriptors(netdir)
> 0
{
// We are missing primary guard descriptors, so we shouldn't update our guard
// status.
return;
}
self.guards
.active_guards_mut()
.update_status_from_netdir(netdir);
self.guards
.active_guards_mut()
.extend_sample_as_needed(now, &self.params, netdir);
}
self.guards
.active_guards_mut()
.select_primary_guards(&self.params);
}
/// Replace the active guard state with `new_state`, preserving
/// non-persistent state for any guards that are retained.
fn replace_guards_with(&mut self, mut new_guards: GuardSets, now: SystemTime) {
std::mem::swap(&mut self.guards, &mut new_guards);
self.guards.copy_status_from(new_guards);
self.update(now, None);
}
/// Update which guard set is active based on the current filter and the
/// provided netdir.
///
/// After calling this function, the new guard set's filter may be
/// out-of-date: be sure to call `set_filter` as appropriate.
fn select_guard_set(&mut self, netdir: &NetDir) {
let frac_permitted = self.filter.frac_bw_permitted(netdir);
// In general, we'd like to use the restricted set if we're under the
// threshold, and the default set if we're over the threshold. But if
// we're sitting close to the threshold, we want to avoid flapping back
// and forth, so we only change when we're more than 5% "off" from
// whatever our current setting is.
//
// (See guard-spec section 2 for more information.)
let offset = match self.guards.active_set {
GuardSetSelector::Default => -0.05,
GuardSetSelector::Restricted => 0.05,
};
let threshold = self.params.filter_threshold + offset;
let new_choice = if frac_permitted < threshold {
GuardSetSelector::Restricted
} else {
GuardSetSelector::Default
};
if new_choice != self.guards.active_set {
info!(
"Guard selection changed; we are now using the {:?} guard set",
&new_choice
);
self.guards.active_set = new_choice;
if frac_permitted < self.params.extreme_threshold {
warn!(
"The number of guards permitted is smaller than the recommended minimum of {:.0}%.",
self.params.extreme_threshold * 100.0,
);
}
}
}
/// Mark all of our primary guards as retriable, if we haven't done
/// so since long enough before `now`.
///
/// We want to call this function whenever a guard attempt succeeds,
/// if the internet seemed to be down when the guard attempt was
/// first launched.
fn maybe_retry_primary_guards(&mut self, now: Instant) {
// We don't actually want to mark our primary guards as
// retriable more than once per internet_down_timeout: after
// the first time, we would just be noticing the same "coming
// back online" event more than once.
let interval = self.params.internet_down_timeout;
if self.last_primary_retry_time + interval <= now {
debug!("Successfully reached a guard after a while off the internet; marking all primary guards retriable.");
self.guards
.active_guards_mut()
.mark_primary_guards_retriable();
self.last_primary_retry_time = now;
}
}
/// Replace the current GuardFilter with `filter`.
fn set_filter(&mut self, filter: GuardFilter, netdir: Option<&NetDir>, now: SystemTime) {
self.with_opt_netdir(netdir, |this, netdir| {
this.filter = filter;
// This call will invoke update_chosen_guard_set() if possible, and
// then call set_filter on the GuardSet.
this.update_internal(now, netdir);
});
}
/// Called when the circuit manager reports (via [`GuardMonitor`]) that
/// a guard succeeded or failed.
///
/// Changes the guard's status as appropriate, and updates the pending
/// request as needed.
pub(crate) fn handle_msg(
&mut self,
request_id: RequestId,
status: GuardStatus,
skew: Option<ClockSkew>,
runtime: &impl tor_rtcompat::SleepProvider,
) {
if let Some(mut pending) = self.pending.remove(&request_id) {
// If there was a pending request matching this RequestId, great!
let guard_id = pending.guard_id();
trace!(?guard_id, ?status, "Received report of guard status");
// First, handle the skew report (if any)
if let Some(skew) = skew {
let now = runtime.now();
let observation = skew::SkewObservation { skew, when: now };
match &guard_id.0 {
FirstHopIdInner::Guard(id) => {
self.guards.active_guards_mut().record_skew(id, observation);
}
FirstHopIdInner::Fallback(id) => {
self.fallbacks.note_skew(id, observation);
}
}
// TODO: We call this whenever we receive an observed clock
// skew. That's not the perfect timing for two reasons. First
// off, it might be too frequent: it does an O(n) calculation,
// which isn't ideal. Second, it might be too infrequent: after
// an hour has passed, a given observation won't be up-to-date
// any more, and we might want to recalculate the skew
// accordingly.
self.update_skew(now);
}
match (status, &guard_id.0) {
(GuardStatus::Failure, FirstHopIdInner::Fallback(id)) => {
// We used a fallback, and we weren't able to build a circuit through it.
self.fallbacks.note_failure(id, runtime.now());
}
(_, FirstHopIdInner::Fallback(_)) => {
// We don't record any other kind of circuit activity if we
// took the entry from the fallback list.
}
(GuardStatus::Success, FirstHopIdInner::Guard(id)) => {
// If we had gone too long without any net activity when we
// gave out this guard, and now we're seeing a circuit
// succeed, tell the primary guards that they might be
// retriable.
if pending.net_has_been_down() {
self.maybe_retry_primary_guards(runtime.now());
}
// The guard succeeded. Tell the GuardSet.
self.guards.active_guards_mut().record_success(
id,
&self.params,
None,
runtime.wallclock(),
);
// Either tell the request whether the guard is
// usable, or schedule it as a "waiting" request.
if let Some(usable) = self.guard_usability_status(&pending, runtime.now()) {
trace!(?guard_id, usable, "Known usability status");
pending.reply(usable);
} else {
// This is the one case where we can't use the
// guard yet.
trace!(?guard_id, "Not able to answer right now");
pending.mark_waiting(runtime.now());
self.waiting.push(pending);
}
}
(GuardStatus::Failure, FirstHopIdInner::Guard(id)) => {
self.guards
.active_guards_mut()
.record_failure(id, None, runtime.now());
pending.reply(false);
}
(GuardStatus::AttemptAbandoned, FirstHopIdInner::Guard(id)) => {
self.guards.active_guards_mut().record_attempt_abandoned(id);
pending.reply(false);
}
(GuardStatus::Indeterminate, FirstHopIdInner::Guard(id)) => {
self.guards
.active_guards_mut()
.record_indeterminate_result(id);
pending.reply(false);
}
};
} else {
warn!(
"Got a status {:?} for a request {:?} that wasn't pending",
status, request_id
);
}
// We might need to update the primary guards based on changes in the
// status of guards above.
self.guards
.active_guards_mut()
.select_primary_guards(&self.params);
// Some waiting request may just have become ready (usable or
// not); we need to give them the information they're waiting
// for.
self.expire_and_answer_pending_requests(runtime.now());
}
/// Helper to implement `GuardMgr::note_external_success()`.
///
/// (This has to be a separate function so that we can borrow params while
/// we have `mut self` borrowed.)
fn record_external_success(
&mut self,
ed_identity: &pk::ed25519::Ed25519Identity,
rsa_identity: &pk::rsa::RsaIdentity,
external_activity: ExternalActivity,
now: SystemTime,
) {
for id in self.lookup_ids(ed_identity, rsa_identity) {
match &id.0 {
FirstHopIdInner::Guard(id) => {
self.guards.active_guards_mut().record_success(
id,
&self.params,
Some(external_activity),
now,
);
}
FirstHopIdInner::Fallback(id) => {
if external_activity == ExternalActivity::DirCache {
self.fallbacks.note_success(id);
}
}
}
}
}
/// Return an iterator over all of the clock skew observations we've made
/// for guards or fallbacks.
fn skew_observations(&self) -> impl Iterator<Item = &skew::SkewObservation> {
self.fallbacks
.skew_observations()
.chain(self.guards.active_guards().skew_observations())
}
/// Recalculate our estimated clock skew, and publish it to anybody who
/// cares.
fn update_skew(&mut self, now: Instant) {
let estimate = skew::SkewEstimate::estimate_skew(self.skew_observations(), now);
// TODO: we might want to do this only conditionally, when the skew
// estimate changes.
*self.send_skew.borrow_mut() = estimate;
}
/// If the circuit built because of a given [`PendingRequest`] may
/// now be used (or discarded), return `Some(true)` or
/// `Some(false)` respectively.
///
/// Return None if we can't yet give an answer about whether such
/// a circuit is usable.
fn guard_usability_status(&self, pending: &PendingRequest, now: Instant) -> Option<bool> {
match &pending.guard_id().0 {
FirstHopIdInner::Guard(id) => self.guards.active_guards().circ_usability_status(
id,
pending.usage(),
&self.params,
now,
),
// Fallback circuits are usable immediately, since we don't have to wait to
// see whether any _other_ circuit succeeds or fails.
FirstHopIdInner::Fallback(_) => Some(true),
}
}
/// For requests that have been "waiting" for an answer for too long,
/// expire them and tell the circuit manager that their circuits
/// are unusable.
fn expire_and_answer_pending_requests(&mut self, now: Instant) {
// TODO: Use Vec::drain_filter or Vec::retain_mut when/if it's stable.
#[allow(deprecated)]
use retain_mut::RetainMut;
// A bit ugly: we use a separate Vec here to avoid borrowing issues,
// and put it back when we're done.
let mut waiting = Vec::new();
std::mem::swap(&mut waiting, &mut self.waiting);
#[allow(deprecated)]
RetainMut::retain_mut(&mut waiting, |pending| {
let expired = pending
.waiting_since()
.and_then(|w| now.checked_duration_since(w))
.map(|d| d >= self.params.np_idle_timeout)
== Some(true);
if expired {
trace!(?pending, "Pending request expired");
pending.reply(false);
return false;
}
// TODO-SPEC: guard_usability_status isn't what the spec says. It
// says instead that we should look at _circuit_ status, saying:
// " Definition: In the algorithm above, C2 "blocks" C1 if:
// * C2 obeys all the restrictions that C1 had to obey, AND
// * C2 has higher priority than C1, AND
// * Either C2 is <complete>, or C2 is <waiting_for_better_guard>,
// or C2 has been <usable_if_no_better_guard> for no more than
// {NONPRIMARY_GUARD_CONNECT_TIMEOUT} seconds."
//
// See comments in sample::GuardSet::circ_usability_status.
if let Some(answer) = self.guard_usability_status(pending, now) {
trace!(?pending, answer, "Pending request now ready");
pending.reply(answer);
return false;
}
true
});
// Put the waiting list back.
std::mem::swap(&mut waiting, &mut self.waiting);
}
/// Return every currently extant FirstHopId for a guard or fallback
/// directory matching the provided keys.
///
/// # TODO
///
/// This function should probably not exist; it's only used so that dirmgr
/// can report successes or failures, since by the time it observes them it
/// doesn't know whether its circuit came from a guard or a fallback. To
/// solve that, we'll need CircMgr to record and report which one it was
/// using, which will take some more plumbing.
fn lookup_ids(
&self,
ed_identity: &pk::ed25519::Ed25519Identity,
rsa_identity: &pk::rsa::RsaIdentity,
) -> Vec<FirstHopId> {
let mut vec = Vec::with_capacity(2);
let id = ids::GuardId::new(*ed_identity, *rsa_identity);
if self.guards.active_guards().contains(&id) {
vec.push(id.into());
}
let id = ids::FallbackId::new(*ed_identity, *rsa_identity);
if self.fallbacks.contains(&id) {
vec.push(id.into());
}
vec
}
/// Run any periodic events that update guard status, and return a
/// duration after which periodic events should next be run.
pub(crate) fn run_periodic_events(&mut self, wallclock: SystemTime, now: Instant) -> Duration {
self.update(wallclock, None);
self.expire_and_answer_pending_requests(now);
Duration::from_secs(1) // TODO: Too aggressive.
}
/// Try to select a guard, expanding the sample if the first attempt fails.
fn select_guard_with_expand(
&mut self,
usage: &GuardUsage,
netdir: Option<&NetDir>,
now: Instant,
wallclock: SystemTime,
) -> Result<(sample::ListKind, FirstHop), PickGuardError> {
// Try to find a guard.
let first_error = match self.select_guard_once(usage, now) {
Ok(res1) => return Ok(res1),
Err(e) => {
trace!("Couldn't select guard on first attempt: {}", e);
e
}
};
// That didn't work. If we have a netdir, expand the sample and try again.
let res = self.with_opt_netdir(netdir, |this, dir| {
let dir = dir?;
trace!("No guards available, trying to extend the sample.");
this.update_internal(wallclock, Some(dir));
if this
.guards
.active_guards_mut()
.extend_sample_as_needed(wallclock, &this.params, dir)
{
this.guards
.active_guards_mut()
.select_primary_guards(&this.params);
match this.select_guard_once(usage, now) {
Ok(res) => return Some(res),
Err(e) => {
trace!("Couldn't select guard after expanding sample: {}", e);
}
}
}
None
});
if let Some(res) = res {
return Ok(res);
}
// Okay, that didn't work either. If we were asked for a directory
// guard, then we may be able to use a fallback.
if usage.kind == GuardUsageKind::OneHopDirectory {
return self.select_fallback(now);
}
// Couldn't extend the sample or use a fallback; return the original error.
Err(first_error)
}
/// Helper: try to pick a single guard, without retrying on failure.
fn select_guard_once(
&self,
usage: &GuardUsage,
now: Instant,
) -> Result<(sample::ListKind, FirstHop), PickGuardError> {
self.guards
.active_guards()
.pick_guard(usage, &self.params, now)
}
/// Helper: Select a fallback directory.
///
/// Called when we have no guard information to use. Return values are as
/// for [`GuardMgr::select_guard()`]
fn select_fallback(
&self,
now: Instant,
) -> Result<(sample::ListKind, FirstHop), PickGuardError> {
let filt = self.guards.active_guards().filter();
let fallback = self.fallbacks.choose(&mut rand::thread_rng(), now, filt)?;
let fallback = filt.modify_hop(fallback.clone())?;
Ok((sample::ListKind::Fallback, fallback))
}
}
/// A set of parameters, derived from the consensus document, controlling
/// the behavior of a guard manager.
#[derive(Debug, Clone)]
#[cfg_attr(test, derive(PartialEq))]
struct GuardParams {
/// How long should a sampled, un-confirmed guard be kept in the sample before it expires?
lifetime_unconfirmed: Duration,
/// How long should a confirmed guard be kept in the sample before
/// it expires?
lifetime_confirmed: Duration,
/// How long may a guard be unlisted before we remove it from the sample?
lifetime_unlisted: Duration,
/// Largest number of guards we're willing to add to the sample.
max_sample_size: usize,
/// Largest fraction of the network's guard bandwidth that we're
/// willing to add to the sample.
max_sample_bw_fraction: f64,
/// Smallest number of guards that we're willing to have in the
/// sample, after applying a [`GuardFilter`].
min_filtered_sample_size: usize,
/// How many guards are considered "Primary"?
n_primary: usize,
/// When making a regular circuit, how many primary guards should we
/// be willing to try?
data_parallelism: usize,
/// When making a one-hop directory circuit, how many primary
/// guards should we be willing to try?
dir_parallelism: usize,
/// For how long does a pending attempt to connect to a guard
/// block an attempt to use a less-favored non-primary guard?
np_connect_timeout: Duration,
/// How long do we allow a circuit to a successful but unfavored
/// non-primary guard to sit around before deciding not to use it?
np_idle_timeout: Duration,
/// After how much time without successful activity does a
/// successful circuit indicate that we should retry our primary
/// guards?
internet_down_timeout: Duration,
/// What fraction of the guards can be can be filtered out before we
/// decide that our filter is "very restrictive"?
filter_threshold: f64,
/// What fraction of the guards determine that our filter is "very
/// restrictive"?
extreme_threshold: f64,
}
impl Default for GuardParams {
fn default() -> Self {
let one_day = Duration::from_secs(86400);
GuardParams {
lifetime_unconfirmed: one_day * 120,
lifetime_confirmed: one_day * 60,
lifetime_unlisted: one_day * 20,
max_sample_size: 60,
max_sample_bw_fraction: 0.2,
min_filtered_sample_size: 20,
n_primary: 3,
data_parallelism: 1,
dir_parallelism: 3,
np_connect_timeout: Duration::from_secs(15),
np_idle_timeout: Duration::from_secs(600),
internet_down_timeout: Duration::from_secs(600),
filter_threshold: 0.2,
extreme_threshold: 0.01,
}
}
}
impl TryFrom<&NetParameters> for GuardParams {
type Error = tor_units::Error;
fn try_from(p: &NetParameters) -> Result<GuardParams, Self::Error> {
Ok(GuardParams {
lifetime_unconfirmed: p.guard_lifetime_unconfirmed.try_into()?,
lifetime_confirmed: p.guard_lifetime_confirmed.try_into()?,
lifetime_unlisted: p.guard_remove_unlisted_after.try_into()?,
max_sample_size: p.guard_max_sample_size.try_into()?,
max_sample_bw_fraction: p.guard_max_sample_threshold.as_fraction(),
min_filtered_sample_size: p.guard_filtered_min_sample_size.try_into()?,
n_primary: p.guard_n_primary.try_into()?,
data_parallelism: p.guard_use_parallelism.try_into()?,
dir_parallelism: p.guard_dir_use_parallelism.try_into()?,
np_connect_timeout: p.guard_nonprimary_connect_timeout.try_into()?,
np_idle_timeout: p.guard_nonprimary_idle_timeout.try_into()?,
internet_down_timeout: p.guard_internet_likely_down.try_into()?,
filter_threshold: p.guard_meaningful_restriction.as_fraction(),
extreme_threshold: p.guard_extreme_restriction.as_fraction(),
})
}
}
/// Representation of a guard or fallback, as returned by [`GuardMgr::select_guard()`].
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct FirstHop {
/// The guard's identities
id: FirstHopId,
/// The addresses at which the guard can be contacted.
orports: Vec<SocketAddr>,
}
impl FirstHop {
/// Return the identities of this guard.
pub fn id(&self) -> &FirstHopId {
&self.id
}
/// Look up this guard in `netdir`.
pub fn get_relay<'a>(&self, netdir: &'a NetDir) -> Option<Relay<'a>> {
self.id().get_relay(netdir)
}
}
// This is somewhat redundant with the implementation in crate::guard::Guard.
impl tor_linkspec::ChanTarget for FirstHop {
fn addrs(&self) -> &[SocketAddr] {
&self.orports[..]
}
fn ed_identity(&self) -> &pk::ed25519::Ed25519Identity {
&self.id.as_ref().ed25519
}
fn rsa_identity(&self) -> &pk::rsa::RsaIdentity {
&self.id.as_ref().rsa
}
}
/// The purpose for which we plan to use a guard.
///
/// This can affect the guard selection algorithm.
#[derive(Clone, Debug, Eq, PartialEq, Educe)]
#[educe(Default)]
#[non_exhaustive]
pub enum GuardUsageKind {
/// We want to use this guard for a data circuit.
///
/// (This encompasses everything except the `OneHopDirectory` case.)
#[educe(Default)]
Data,
/// We want to use this guard for a one-hop, non-anonymous
/// directory request.
///
/// (Our algorithm allows more parallelism for the guards that we use
/// for these circuits.)
OneHopDirectory,
}
/// A set of parameters describing how a single guard should be selected.
///
/// Used as an argument to [`GuardMgr::select_guard`].
#[derive(Clone, Debug, derive_builder::Builder)]
#[builder(build_fn(error = "tor_config::ConfigBuildError"))]
pub struct GuardUsage {
/// The purpose for which this guard will be used.
#[builder(default)]
kind: GuardUsageKind,
/// See accessor docs
#[builder(sub_builder, setter(custom))]
restrictions: GuardRestrictionList,
}
impl_standard_builder! { GuardUsage: !Deserialize }
/// List of socket restricteionesses, as configured
pub type GuardRestrictionList = Vec<GuardRestriction>;
define_list_builder_helper! {
pub struct GuardRestrictionListBuilder {
restrictions: [GuardRestriction],
}
built: GuardRestrictionList = restrictions;
default = vec![];
item_build: |restriction| Ok(restriction.clone());
}
define_list_builder_accessors! {
struct GuardUsageBuilder {
/// A list of restrictions on which guard may be used
///
/// The default is the empty list.
pub restrictions: [GuardRestriction],
}
}
impl GuardUsageBuilder {
/// Create a new empty [`GuardUsageBuilder`].
pub fn new() -> Self {
Self::default()
}
}
/// A restriction that applies to a single request for a guard.
///
/// Restrictions differ from filters (see [`GuardFilter`]) in that
/// they apply to single requests, not to our entire set of guards.
/// They're suitable for things like making sure that we don't start
/// and end a circuit at the same relay, or requiring a specific
/// subprotocol version for certain kinds of requests.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[non_exhaustive]
pub enum GuardRestriction {
/// Don't pick a guard with the provided Ed25519 identity.
AvoidId(pk::ed25519::Ed25519Identity),
/// Don't pick a guard with any of the provided Ed25519 identities.
AvoidAllIds(HashSet<pk::ed25519::Ed25519Identity>),
}
#[cfg(test)]
mod test {
#![allow(clippy::unwrap_used)]
use super::*;
use tor_persist::TestingStateMgr;
use tor_rtcompat::test_with_all_runtimes;
#[test]
fn guard_param_defaults() {
let p1 = GuardParams::default();
let p2: GuardParams = (&NetParameters::default()).try_into().unwrap();
assert_eq!(p1, p2);
}
fn init<R: Runtime>(rt: R) -> (GuardMgr<R>, TestingStateMgr, NetDir) {
use tor_netdir::{testnet, MdReceiver, PartialNetDir};
let statemgr = TestingStateMgr::new();
let have_lock = statemgr.try_lock().unwrap();
assert!(have_lock.held());
let guardmgr = GuardMgr::new(rt, statemgr.clone(), [].into()).unwrap();
let (con, mds) = testnet::construct_network().unwrap();
let param_overrides = vec![
// We make the sample size smaller than usual to compensate for the
// small testing network. (Otherwise, we'd sample the whole network,
// and not be able to observe guards in the tests.)
"guard-min-filtered-sample-size=5",
// We choose only two primary guards, to make the tests easier to write.
"guard-n-primary-guards=2",
// We define any restriction that allows 75% or fewer of relays as "meaningful",
// so that we can test the "restrictive" guard sample behavior, and to avoid
"guard-meaningful-restriction-percent=75",
];
let param_overrides: String =
itertools::Itertools::intersperse(param_overrides.into_iter(), " ").collect();
let override_p = param_overrides.parse().unwrap();
let mut netdir = PartialNetDir::new(con, Some(&override_p));
for md in mds {
netdir.add_microdesc(md);
}
let netdir = netdir.unwrap_if_sufficient().unwrap();
(guardmgr, statemgr, netdir)
}
#[test]
#[allow(clippy::clone_on_copy)]
fn simple_case() {
test_with_all_runtimes!(|rt| async move {
let (guardmgr, statemgr, netdir) = init(rt.clone());
let usage = GuardUsage::default();
guardmgr.update_network(&netdir);
let (id, mon, usable) = guardmgr.select_guard(usage, Some(&netdir)).unwrap();
// Report that the circuit succeeded.
mon.succeeded();
// May we use the circuit?
let usable = usable.await.unwrap();
assert!(usable);
// Save the state...
guardmgr.flush_msg_queue().await;
guardmgr.store_persistent_state().unwrap();
drop(guardmgr);
// Try reloading from the state...
let guardmgr2 = GuardMgr::new(rt.clone(), statemgr.clone(), [].into()).unwrap();
guardmgr2.update_network(&netdir);
// Since the guard was confirmed, we should get the same one this time!
let usage = GuardUsage::default();
let (id2, _mon, _usable) = guardmgr2.select_guard(usage, Some(&netdir)).unwrap();
assert_eq!(id2, id);
});
}
#[test]
fn simple_waiting() {
// TODO(nickm): This test fails in rare cases; I suspect a
// race condition somewhere.
//
// I've doubled up on the queue flushing in order to try to make the
// race less likely, but we should investigate.
test_with_all_runtimes!(|rt| async move {
let (guardmgr, _statemgr, netdir) = init(rt);
let u = GuardUsage::default();
guardmgr.update_network(&netdir);
// We'll have the first two guard fail, which should make us
// try a non-primary guard.
let (id1, mon, _usable) = guardmgr.select_guard(u.clone(), Some(&netdir)).unwrap();
mon.failed();
guardmgr.flush_msg_queue().await; // avoid race
guardmgr.flush_msg_queue().await; // avoid race
let (id2, mon, _usable) = guardmgr.select_guard(u.clone(), Some(&netdir)).unwrap();
mon.failed();
guardmgr.flush_msg_queue().await; // avoid race
guardmgr.flush_msg_queue().await; // avoid race
assert!(id1 != id2);
// Now we should get two sampled guards. They should be different.
let (id3, mon3, usable3) = guardmgr.select_guard(u.clone(), Some(&netdir)).unwrap();
let (id4, mon4, usable4) = guardmgr.select_guard(u.clone(), Some(&netdir)).unwrap();
assert!(id3 != id4);
let (u3, u4) = futures::join!(
async {
mon3.failed();
guardmgr.flush_msg_queue().await; // avoid race
usable3.await.unwrap()
},
async {
mon4.succeeded();
usable4.await.unwrap()
}
);
assert_eq!((u3, u4), (false, true));
});
}
#[test]
fn filtering_basics() {
test_with_all_runtimes!(|rt| async move {
use tor_linkspec::ChanTarget;
let (guardmgr, _statemgr, netdir) = init(rt);
let u = GuardUsage::default();
let filter = {
let mut f = GuardFilter::default();
// All the addresses in the test network are {0,1,2,3,4}.0.0.3:9001.
// Limit to only 2.0.0.0/8
f.push_reachable_addresses(vec!["2.0.0.0/8:9001".parse().unwrap()]);
f
};
guardmgr.set_filter(filter, Some(&netdir));
guardmgr.update_network(&netdir);
let (guard, _mon, _usable) = guardmgr.select_guard(u, Some(&netdir)).unwrap();
// Make sure that the filter worked.
let addr = guard.addrs()[0];
assert_eq!(addr, "2.0.0.3:9001".parse().unwrap());
});
}
#[test]
fn external_status() {
use tor_linkspec::ChanTarget;
test_with_all_runtimes!(|rt| async move {
let (guardmgr, _statemgr, netdir) = init(rt);
let data_usage = GuardUsage::default();
let dir_usage = GuardUsageBuilder::new()
.kind(GuardUsageKind::OneHopDirectory)
.build()
.unwrap();
guardmgr.update_network(&netdir);
{
// Override this parameter, so that we can get deterministic results below.
let mut inner = guardmgr.inner.lock().unwrap();
inner.params.dir_parallelism = 1;
}
let (guard, mon, _usable) = guardmgr
.select_guard(data_usage.clone(), Some(&netdir))
.unwrap();
mon.succeeded();
// Record that this guard gave us a bad directory object.
guardmgr.note_external_failure(
guard.ed_identity(),
guard.rsa_identity(),
ExternalActivity::DirCache,
);
// We ask for another guard, for data usage. We should get the same
// one as last time, since the director failure doesn't mean this
// guard is useless as a primary guard.
let (g2, mon, _usable) = guardmgr.select_guard(data_usage, Some(&netdir)).unwrap();
assert_eq!(g2.ed_identity(), guard.ed_identity());
mon.succeeded();
// But if we ask for a guard for directory usage, we should get a
// different one, since the last guard we gave out failed.
let (g3, mon, _usable) = guardmgr
.select_guard(dir_usage.clone(), Some(&netdir))
.unwrap();
assert_ne!(g3.ed_identity(), guard.ed_identity());
mon.succeeded();
// Now record a success for for directory usage.
guardmgr.note_external_success(
guard.ed_identity(),
guard.rsa_identity(),
ExternalActivity::DirCache,
);
// Now that the guard is working as a cache, asking for it should get us the same guard.
let (g4, _mon, _usable) = guardmgr.select_guard(dir_usage, Some(&netdir)).unwrap();
assert_eq!(g4.ed_identity(), guard.ed_identity());
});
}
}