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 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068
//! Parsing implementation for networkstatus documents.
//!
//! In Tor, a networkstatus documents describes a complete view of the
//! relays in the network: how many there are, how to contact them,
//! and so forth.
//!
//! A networkstatus document can either be a "votes" -- an authority's
//! view of the network, used as input to the voting process -- or a
//! "consensus" -- a combined view of the network based on multiple
//! authorities' votes, and signed by multiple authorities.
//!
//! A consensus document can itself come in two different flavors: a
//! "ns"-flavored consensus has references to router descriptors, and
//! a "microdesc"-flavored consensus has references to
//! microdescriptors.
//!
//! To keep an up-to-date view of the network, clients download
//! microdescriptor-flavored consensuses periodically, and then
//! download whatever microdescriptors the consensus lists that the
//! client doesn't already have.
//!
//! For full information about the network status format, see
//! [dir-spec.txt](https://spec.torproject.org/dir-spec).
//!
//! # Limitations
//!
//! NOTE: The consensus format has changes time, using a
//! "consensus-method" mechanism. This module is does not yet handle all
//! all historical consensus-methods.
//!
//! NOTE: This module _does_ parse some fields that are not in current
//! use, like relay nicknames, and the "published" times on
//! microdescriptors. We should probably decide whether we actually
//! want to do this.
//!
//! TODO: This module doesn't implement vote parsing at all yet.
//!
//! TODO: This module doesn't implement ns-flavored consensuses.
//!
//! TODO: More testing is needed!
//!
//! TODO: There should be accessor functions for most of the fields here.
//! As with the other tor-netdoc types, I'm deferring those till I know what
//! they should be.
mod rs;
#[cfg(feature = "build_docs")]
mod build;
use crate::doc::authcert::{AuthCert, AuthCertKeyIds};
use crate::parse::keyword::Keyword;
use crate::parse::parser::{Section, SectionRules, SectionRulesBuilder};
use crate::parse::tokenize::{Item, ItemResult, NetDocReader};
use crate::types::misc::*;
use crate::util::private::Sealed;
use crate::util::PeekableIterator;
use crate::{Error, NetdocErrorKind as EK, Pos, Result};
use std::collections::{HashMap, HashSet};
use std::{net, result, time};
use tor_error::internal;
use tor_protover::Protocols;
use bitflags::bitflags;
use digest::Digest;
use once_cell::sync::Lazy;
use tor_checkable::{timed::TimerangeBound, ExternallySigned};
use tor_llcrypto as ll;
use tor_llcrypto::pk::rsa::RsaIdentity;
use serde::{Deserialize, Deserializer};
#[cfg(feature = "build_docs")]
pub use build::ConsensusBuilder;
#[cfg(feature = "build_docs")]
pub use rs::build::RouterStatusBuilder;
pub use rs::MdConsensusRouterStatus;
#[cfg(feature = "ns_consensus")]
pub use rs::NsConsensusRouterStatus;
/// The lifetime of a networkstatus document.
///
/// In a consensus, this type describes when the consensus may safely
/// be used. In a vote, this type describes the proposed lifetime for a
/// consensus.
#[derive(Clone, Debug)]
pub struct Lifetime {
/// Time at which the document becomes valid
valid_after: time::SystemTime,
/// Time after which there is expected to be a better version
/// of this consensus
fresh_until: time::SystemTime,
/// Time after which this consensus is expired.
///
/// (In practice, Tor clients will keep using documents for a while
/// after this expiration time, if no better one can be found.)
valid_until: time::SystemTime,
}
impl Lifetime {
/// Construct a new Lifetime.
pub fn new(
valid_after: time::SystemTime,
fresh_until: time::SystemTime,
valid_until: time::SystemTime,
) -> Result<Self> {
if valid_after < fresh_until && fresh_until < valid_until {
Ok(Lifetime {
valid_after,
fresh_until,
valid_until,
})
} else {
Err(EK::InvalidLifetime.err())
}
}
/// Return time when this consensus first becomes valid.
///
/// (You might see a consensus a little while before this time,
/// since voting tries to finish up before the.)
pub fn valid_after(&self) -> time::SystemTime {
self.valid_after
}
/// Return time when this consensus is no longer fresh.
///
/// You can use the consensus after this time, but there is (or is
/// supposed to be) a better one by this point.
pub fn fresh_until(&self) -> time::SystemTime {
self.fresh_until
}
/// Return the time when this consensus is no longer valid.
///
/// You should try to get a better consensus after this time,
/// though it's okay to keep using this one if no more recent one
/// can be found.
pub fn valid_until(&self) -> time::SystemTime {
self.valid_until
}
/// Return true if this consensus is officially valid at the provided time.
pub fn valid_at(&self, when: time::SystemTime) -> bool {
self.valid_after <= when && when <= self.valid_until
}
/// Return the voting period implied by this lifetime.
///
/// (The "voting period" is the amount of time in between when a consensus first
/// becomes valid, and when the next consensus is expected to become valid)
pub fn voting_period(&self) -> time::Duration {
let valid_after = self.valid_after();
let fresh_until = self.fresh_until();
fresh_until
.duration_since(valid_after)
.expect("Mis-formed lifetime")
}
}
/// A set of named network parameters.
///
/// These are used to describe current settings for the Tor network,
/// current weighting parameters for path selection, and so on. They're
/// encoded with a space-separated K=V format.
///
/// A `NetParams<i32>` is part of the validated directory manager configuration,
/// where it is built (in the builder-pattern sense) from a transparent HashMap.
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub struct NetParams<T> {
/// Map from keys to values.
params: HashMap<String, T>,
}
impl<T> NetParams<T> {
/// Create a new empty list of NetParams.
#[allow(unused)]
pub fn new() -> Self {
NetParams {
params: HashMap::new(),
}
}
/// Retrieve a given network parameter, if it is present.
pub fn get<A: AsRef<str>>(&self, v: A) -> Option<&T> {
self.params.get(v.as_ref())
}
/// Return an iterator over all key value pairs in an arbitrary order.
pub fn iter(&self) -> impl Iterator<Item = (&String, &T)> {
self.params.iter()
}
/// Set or replace the value of a network parameter.
pub fn set(&mut self, k: String, v: T) {
self.params.insert(k, v);
}
}
impl<K: Into<String>, T> FromIterator<(K, T)> for NetParams<T> {
fn from_iter<I: IntoIterator<Item = (K, T)>>(i: I) -> Self {
NetParams {
params: i.into_iter().map(|(k, v)| (k.into(), v)).collect(),
}
}
}
impl<'de, T> Deserialize<'de> for NetParams<T>
where
T: Deserialize<'de>,
{
fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let params = HashMap::deserialize(deserializer)?;
Ok(NetParams { params })
}
}
/// A list of subprotocol versions that implementors should/must provide.
///
/// Each consensus has two of these: one for relays, and one for clients.
#[allow(dead_code)]
#[derive(Debug, Clone, Default)]
pub struct ProtoStatus {
/// Set of protocols that are recommended; if we're missing a protocol
/// in this list we should warn the user.
recommended: Protocols,
/// Set of protocols that are required; if we're missing a protocol
/// in this list we should refuse to start.
required: Protocols,
}
/// A recognized 'flavor' of consensus document.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
#[non_exhaustive]
pub enum ConsensusFlavor {
/// A "microdesc"-flavored consensus. This is the one that
/// clients and relays use today.
Microdesc,
/// A "networkstatus"-flavored consensus. It's used for
/// historical and network-health purposes. Instead of listing
/// microdescriptor digests, it lists digests of full relay
/// descriptors.
Ns,
}
impl ConsensusFlavor {
/// Return the name of this consensus flavor.
pub fn name(&self) -> &'static str {
match self {
ConsensusFlavor::Ns => "ns",
ConsensusFlavor::Microdesc => "microdesc",
}
}
/// Try to find the flavor whose name is `name`.
///
/// For historical reasons, an unnamed flavor indicates an "Ns"
/// document.
pub fn from_opt_name(name: Option<&str>) -> Result<Self> {
match name {
Some("microdesc") => Ok(ConsensusFlavor::Microdesc),
Some("ns") | None => Ok(ConsensusFlavor::Ns),
Some(other) => {
Err(EK::BadDocumentType.with_msg(format!("unrecognized flavor {:?}", other)))
}
}
}
}
/// The signature of a single directory authority on a networkstatus document.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
pub struct Signature {
/// The name of the digest algorithm used to make the signature.
///
/// Currently sha1 and sh256 are recognized. Here we only support
/// sha256.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
digestname: String,
/// Fingerprints of the keys for the authority that made
/// this signature.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
key_ids: AuthCertKeyIds,
/// The signature itself.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
signature: Vec<u8>,
}
/// A collection of signatures that can be checked on a networkstatus document
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
pub struct SignatureGroup {
/// The sha256 of the document itself
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
sha256: Option<[u8; 32]>,
/// The sha1 of the document itself
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
sha1: Option<[u8; 20]>,
/// The signatures listed on the document.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
signatures: Vec<Signature>,
}
/// A shared random value produced by the directory authorities.
#[derive(
Debug, Clone, Copy, Eq, PartialEq, derive_more::From, derive_more::Into, derive_more::AsRef,
)]
// (This doesn't need to use CtByteArray; we don't really need to compare these.)
pub struct SharedRandVal([u8; 32]);
/// A shared-random value produced by the directory authorities,
/// along with meta-information about that value.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
pub struct SharedRandStatus {
/// How many authorities revealed shares that contributed to this value.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
n_reveals: u8,
/// The current random value.
///
/// The properties of the secure shared-random system guarantee
/// that this value isn't predictable before it first becomes
/// live, and that a hostile party could not have forced it to
/// have any more than a small number of possible random values.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
value: SharedRandVal,
/// The time when this SharedRandVal becomes (or became) the latest.
///
/// (This is added per proposal 342, assuming that gets accepted.)
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
timestamp: Option<time::SystemTime>,
}
/// Parts of the networkstatus header that are present in every networkstatus.
///
/// NOTE: this type is separate from the header parts that are only in
/// votes or only in consensuses, even though we don't implement votes yet.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
struct CommonHeader {
/// What kind of consensus document is this? Absent in votes and
/// in ns-flavored consensuses.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
flavor: ConsensusFlavor,
/// Over what time is this consensus valid? (For votes, this is
/// the time over which the voted-upon consensus should be valid.)
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
lifetime: Lifetime,
/// List of recommended Tor client versions.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
client_versions: Vec<String>,
/// List of recommended Tor relay versions.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
relay_versions: Vec<String>,
/// Lists of recommended and required subprotocol versions for clients
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
client_protos: ProtoStatus,
/// Lists of recommended and required subprotocol versions for relays
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
relay_protos: ProtoStatus,
/// Declared parameters for tunable settings about how to the
/// network should operator. Some of these adjust timeouts and
/// whatnot; some features things on and off.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
params: NetParams<i32>,
/// How long in seconds should voters wait for votes and
/// signatures (respectively) to propagate?
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
voting_delay: Option<(u32, u32)>,
}
/// The header of a consensus networkstatus.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
struct ConsensusHeader {
/// Header fields common to votes and consensuses
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
hdr: CommonHeader,
/// What "method" was used to produce this consensus? (A
/// consensus method is a version number used by authorities to
/// upgrade the consensus algorithm.)
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
consensus_method: u32,
/// Global shared-random value for the previous shared-random period.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
shared_rand_prev: Option<SharedRandStatus>,
/// Global shared-random value for the current shared-random period.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
shared_rand_cur: Option<SharedRandStatus>,
}
/// Description of an authority's identity and address.
///
/// (Corresponds to a dir-source line.)
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
struct DirSource {
/// human-readable nickname for this authority.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
nickname: String,
/// Fingerprint for the _authority_ identity key of this
/// authority.
///
/// This is the same key as the one that signs the authority's
/// certificates.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
identity: RsaIdentity,
/// IP address for the authority
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
ip: net::IpAddr,
/// HTTP directory port for this authority
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
dir_port: u16,
/// OR port for this authority.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
or_port: u16,
}
bitflags! {
/// A set of recognized directory flags on a single relay.
///
/// These flags come from a consensus directory document, and are
/// used to describe what the authorities believe about the relay.
/// If the document contained any flags that we _didn't_ recognize,
/// they are not listed in this type.
///
/// The bit values used to represent the flags have no meaning;
/// they may change between releases of this crate. Relying on their
/// values may void your semver guarantees.
#[derive(Clone, Copy, Debug)]
pub struct RelayFlags: u16 {
/// Is this a directory authority?
const AUTHORITY = (1<<0);
/// Is this relay marked as a bad exit?
///
/// Bad exits can be used as intermediate relays, but not to
/// deliver traffic.
const BAD_EXIT = (1<<1);
/// Is this relay marked as an exit for weighting purposes?
const EXIT = (1<<2);
/// Is this relay considered "fast" above a certain threshold?
const FAST = (1<<3);
/// Is this relay suitable for use as a guard relay?
///
/// Clients choose their their initial relays from among the set
/// of Guard relays.
const GUARD = (1<<4);
/// Does this relay participate on the onion service directory
/// ring?
const HSDIR = (1<<5);
/// Set if this relay is considered "middle only", not suitable to run
/// as an exit or guard relay.
///
/// Note that this flag is only used by authorities as part of
/// the voting process; clients do not and should not act
/// based on whether it is set.
const MIDDLE_ONLY = (1<<6);
/// If set, there is no consensus for the ed25519 key for this relay.
const NO_ED_CONSENSUS = (1<<7);
/// Is this relay considered "stable" enough for long-lived circuits?
const STABLE = (1<<8);
/// Set if the authorities are requesting a fresh descriptor for
/// this relay.
const STALE_DESC = (1<<9);
/// Set if this relay is currently running.
///
/// This flag can appear in votes, but in consensuses, every relay
/// is assumed to be running.
const RUNNING = (1<<10);
/// Set if this relay is considered "valid" -- allowed to be on
/// the network.
///
/// This flag can appear in votes, but in consensuses, every relay
/// is assumed to be valid.
const VALID = (1<<11);
/// Set if this relay supports a currently recognized version of the
/// directory protocol.
const V2DIR = (1<<12);
}
}
/// Recognized weight fields on a single relay in a consensus
#[non_exhaustive]
#[derive(Debug, Clone, Copy)]
pub enum RelayWeight {
/// An unmeasured weight for a relay.
Unmeasured(u32),
/// An measured weight for a relay.
Measured(u32),
}
impl RelayWeight {
/// Return true if this weight is the result of a successful measurement
pub fn is_measured(&self) -> bool {
matches!(self, RelayWeight::Measured(_))
}
/// Return true if this weight is nonzero
pub fn is_nonzero(&self) -> bool {
!matches!(self, RelayWeight::Unmeasured(0) | RelayWeight::Measured(0))
}
}
/// All information about a single authority, as represented in a consensus
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
struct ConsensusVoterInfo {
/// Contents of the dirsource line about an authority
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
dir_source: DirSource,
/// Human-readable contact information about the authority
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
contact: String,
/// Digest of the vote that the authority cast to contribute to
/// this consensus.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
vote_digest: Vec<u8>,
}
/// The signed footer of a consensus netstatus.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
visibility::make(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
struct Footer {
/// Weights to be applied to certain classes of relays when choosing
/// for different roles.
///
/// For example, we want to avoid choosing exits for non-exit
/// roles when overall the proportion of exits is small.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
weights: NetParams<i32>,
}
/// Trait to parse a single relay as listed in a consensus document.
///
/// TODO(nickm): I'd rather not have this trait be public, but I haven't yet
/// figured out how to make it private.
pub trait ParseRouterStatus: Sized + Sealed {
/// Parse this object from a `Section` object containing its
/// elements.
fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<Self>;
/// Return the networkstatus consensus flavor in which this
/// routerstatus appears.
fn flavor() -> ConsensusFlavor;
}
/// Represents a single relay as listed in a consensus document.
///
/// Not implementable outside of the `tor-netdoc` crate.
pub trait RouterStatus: Sealed {
/// A digest of the document that's identified by this RouterStatus.
type DocumentDigest: Clone;
/// Return RSA identity for the relay described by this RouterStatus
fn rsa_identity(&self) -> &RsaIdentity;
/// Return the digest of the document identified by this
/// routerstatus.
fn doc_digest(&self) -> &Self::DocumentDigest;
}
/// A single microdescriptor consensus netstatus
///
/// TODO: This should possibly turn into a parameterized type, to represent
/// votes and ns consensuses.
#[allow(dead_code)]
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
pub struct Consensus<RS> {
/// Part of the header shared by all consensus types.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
header: ConsensusHeader,
/// List of voters whose votes contributed to this consensus.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
voters: Vec<ConsensusVoterInfo>,
/// A list of routerstatus entries for the relays on the network,
/// with one entry per relay.
///
/// These are currently ordered by the router's RSA identity, but this is not
/// to be relied on, since we may want to even abolish RSA at some point!
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
relays: Vec<RS>,
/// Footer for the consensus object.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
footer: Footer,
}
/// A consensus document that lists relays along with their
/// microdescriptor documents.
pub type MdConsensus = Consensus<MdConsensusRouterStatus>;
/// An MdConsensus that has been parsed and checked for timeliness,
/// but not for signatures.
pub type UnvalidatedMdConsensus = UnvalidatedConsensus<MdConsensusRouterStatus>;
/// An MdConsensus that has been parsed but not checked for signatures
/// and timeliness.
pub type UncheckedMdConsensus = UncheckedConsensus<MdConsensusRouterStatus>;
#[cfg(feature = "ns_consensus")]
/// A consensus document that lists relays along with their
/// router descriptor documents.
pub type NsConsensus = Consensus<NsConsensusRouterStatus>;
#[cfg(feature = "ns_consensus")]
/// An NsConsensus that has been parsed and checked for timeliness,
/// but not for signatures.
pub type UnvalidatedNsConsensus = UnvalidatedConsensus<NsConsensusRouterStatus>;
#[cfg(feature = "ns_consensus")]
/// An NsConsensus that has been parsed but not checked for signatures
/// and timeliness.
pub type UncheckedNsConsensus = UncheckedConsensus<NsConsensusRouterStatus>;
impl<RS> Consensus<RS> {
/// Return the Lifetime for this consensus.
pub fn lifetime(&self) -> &Lifetime {
&self.header.hdr.lifetime
}
/// Return a slice of all the routerstatus entries in this consensus.
pub fn relays(&self) -> &[RS] {
&self.relays[..]
}
/// Return a mapping from keywords to integers representing how
/// to weight different kinds of relays in different path positions.
pub fn bandwidth_weights(&self) -> &NetParams<i32> {
&self.footer.weights
}
/// Return the map of network parameters that this consensus advertises.
pub fn params(&self) -> &NetParams<i32> {
&self.header.hdr.params
}
/// Return the latest shared random value, if the consensus
/// contains one.
pub fn shared_rand_cur(&self) -> Option<&SharedRandStatus> {
self.header.shared_rand_cur.as_ref()
}
/// Return the previous shared random value, if the consensus
/// contains one.
pub fn shared_rand_prev(&self) -> Option<&SharedRandStatus> {
self.header.shared_rand_prev.as_ref()
}
/// Return a [`ProtoStatus`] that lists the network's current requirements and
/// recommendations for the list of protocols that every relay must implement.
pub fn relay_protocol_status(&self) -> &ProtoStatus {
&self.header.hdr.relay_protos
}
/// Return a [`ProtoStatus`] that lists the network's current requirements and
/// recommendations for the list of protocols that every client must implement.
pub fn client_protocol_status(&self) -> &ProtoStatus {
&self.header.hdr.client_protos
}
}
decl_keyword! {
/// Keywords that can be used in votes and consensuses.
// TODO: This is public because otherwise we can't use it in the
// ParseRouterStatus crate. But I'd rather find a way to make it
// private.
#[non_exhaustive]
#[allow(missing_docs)]
pub NetstatusKwd {
// Header
"network-status-version" => NETWORK_STATUS_VERSION,
"vote-status" => VOTE_STATUS,
"consensus-methods" => CONSENSUS_METHODS,
"consensus-method" => CONSENSUS_METHOD,
"published" => PUBLISHED,
"valid-after" => VALID_AFTER,
"fresh-until" => FRESH_UNTIL,
"valid-until" => VALID_UNTIL,
"voting-delay" => VOTING_DELAY,
"client-versions" => CLIENT_VERSIONS,
"server-versions" => SERVER_VERSIONS,
"known-flags" => KNOWN_FLAGS,
"flag-thresholds" => FLAG_THRESHOLDS,
"recommended-client-protocols" => RECOMMENDED_CLIENT_PROTOCOLS,
"required-client-protocols" => REQUIRED_CLIENT_PROTOCOLS,
"recommended-relay-protocols" => RECOMMENDED_RELAY_PROTOCOLS,
"required-relay-protocols" => REQUIRED_RELAY_PROTOCOLS,
"params" => PARAMS,
"bandwidth-file-headers" => BANDWIDTH_FILE_HEADERS,
"bandwidth-file-digest" => BANDWIDTH_FILE_DIGEST,
// "package" is now ignored.
// header in consensus, voter section in vote?
"shared-rand-previous-value" => SHARED_RAND_PREVIOUS_VALUE,
"shared-rand-current-value" => SHARED_RAND_CURRENT_VALUE,
// Voter section (both)
"dir-source" => DIR_SOURCE,
"contact" => CONTACT,
// voter section (vote, but not consensus)
"legacy-dir-key" => LEGACY_DIR_KEY,
"shared-rand-participate" => SHARED_RAND_PARTICIPATE,
"shared-rand-commit" => SHARED_RAND_COMMIT,
// voter section (consensus, but not vote)
"vote-digest" => VOTE_DIGEST,
// voter cert beginning (but only the beginning)
"dir-key-certificate-version" => DIR_KEY_CERTIFICATE_VERSION,
// routerstatus
"r" => RS_R,
"a" => RS_A,
"s" => RS_S,
"v" => RS_V,
"pr" => RS_PR,
"w" => RS_W,
"p" => RS_P,
"m" => RS_M,
"id" => RS_ID,
// footer
"directory-footer" => DIRECTORY_FOOTER,
"bandwidth-weights" => BANDWIDTH_WEIGHTS,
"directory-signature" => DIRECTORY_SIGNATURE,
}
}
/// Shared parts of rules for all kinds of netstatus headers
static NS_HEADER_RULES_COMMON_: Lazy<SectionRulesBuilder<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = SectionRules::builder();
rules.add(NETWORK_STATUS_VERSION.rule().required().args(1..=2));
rules.add(VOTE_STATUS.rule().required().args(1..));
rules.add(VALID_AFTER.rule().required());
rules.add(FRESH_UNTIL.rule().required());
rules.add(VALID_UNTIL.rule().required());
rules.add(VOTING_DELAY.rule().args(2..));
rules.add(CLIENT_VERSIONS.rule());
rules.add(SERVER_VERSIONS.rule());
rules.add(KNOWN_FLAGS.rule().required());
rules.add(RECOMMENDED_CLIENT_PROTOCOLS.rule().args(1..));
rules.add(RECOMMENDED_RELAY_PROTOCOLS.rule().args(1..));
rules.add(REQUIRED_CLIENT_PROTOCOLS.rule().args(1..));
rules.add(REQUIRED_RELAY_PROTOCOLS.rule().args(1..));
rules.add(PARAMS.rule());
rules
});
/// Rules for parsing the header of a consensus.
static NS_HEADER_RULES_CONSENSUS: Lazy<SectionRules<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = NS_HEADER_RULES_COMMON_.clone();
rules.add(CONSENSUS_METHOD.rule().args(1..=1));
rules.add(SHARED_RAND_PREVIOUS_VALUE.rule().args(2..));
rules.add(SHARED_RAND_CURRENT_VALUE.rule().args(2..));
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules.build()
});
/*
/// Rules for parsing the header of a vote.
static NS_HEADER_RULES_VOTE: SectionRules<NetstatusKwd> = {
use NetstatusKwd::*;
let mut rules = NS_HEADER_RULES_COMMON_.clone();
rules.add(CONSENSUS_METHODS.rule().args(1..));
rules.add(FLAG_THRESHOLDS.rule());
rules.add(BANDWIDTH_FILE_HEADERS.rule());
rules.add(BANDWIDTH_FILE_DIGEST.rule().args(1..));
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules
};
/// Rules for parsing a single voter's information in a vote.
static NS_VOTERINFO_RULES_VOTE: SectionRules<NetstatusKwd> = {
use NetstatusKwd::*;
let mut rules = SectionRules::new();
rules.add(DIR_SOURCE.rule().required().args(6..));
rules.add(CONTACT.rule().required());
rules.add(LEGACY_DIR_KEY.rule().args(1..));
rules.add(SHARED_RAND_PARTICIPATE.rule().no_args());
rules.add(SHARED_RAND_COMMIT.rule().may_repeat().args(4..));
rules.add(SHARED_RAND_PREVIOUS_VALUE.rule().args(2..));
rules.add(SHARED_RAND_CURRENT_VALUE.rule().args(2..));
// then comes an entire cert: When we implement vote parsing,
// we should use the authcert code for handling that.
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules
};
*/
/// Rules for parsing a single voter's information in a consensus
static NS_VOTERINFO_RULES_CONSENSUS: Lazy<SectionRules<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = SectionRules::builder();
rules.add(DIR_SOURCE.rule().required().args(6..));
rules.add(CONTACT.rule().required());
rules.add(VOTE_DIGEST.rule().required());
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules.build()
});
/// Shared rules for parsing a single routerstatus
static NS_ROUTERSTATUS_RULES_COMMON_: Lazy<SectionRulesBuilder<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = SectionRules::builder();
rules.add(RS_A.rule().may_repeat().args(1..));
rules.add(RS_S.rule().required());
rules.add(RS_V.rule());
rules.add(RS_PR.rule().required());
rules.add(RS_W.rule());
rules.add(RS_P.rule().args(2..));
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules
});
/// Rules for parsing a single routerstatus in an NS consensus
static NS_ROUTERSTATUS_RULES_NSCON: Lazy<SectionRules<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = NS_ROUTERSTATUS_RULES_COMMON_.clone();
rules.add(RS_R.rule().required().args(8..));
rules.build()
});
/*
/// Rules for parsing a single routerstatus in a vote
static NS_ROUTERSTATUS_RULES_VOTE: SectionRules<NetstatusKwd> = {
use NetstatusKwd::*;
let mut rules = NS_ROUTERSTATUS_RULES_COMMON_.clone();
rules.add(RS_R.rule().required().args(8..));
rules.add(RS_M.rule().may_repeat().args(2..));
rules.add(RS_ID.rule().may_repeat().args(2..)); // may-repeat?
rules
};
*/
/// Rules for parsing a single routerstatus in a microdesc consensus
static NS_ROUTERSTATUS_RULES_MDCON: Lazy<SectionRules<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = NS_ROUTERSTATUS_RULES_COMMON_.clone();
rules.add(RS_R.rule().required().args(6..));
rules.add(RS_M.rule().required().args(1..));
rules.build()
});
/// Rules for parsing consensus fields from a footer.
static NS_FOOTER_RULES: Lazy<SectionRules<NetstatusKwd>> = Lazy::new(|| {
use NetstatusKwd::*;
let mut rules = SectionRules::builder();
rules.add(DIRECTORY_FOOTER.rule().required().no_args());
// consensus only
rules.add(BANDWIDTH_WEIGHTS.rule());
rules.add(UNRECOGNIZED.rule().may_repeat().obj_optional());
rules.build()
});
impl ProtoStatus {
/// Construct a ProtoStatus from two chosen keywords in a section.
fn from_section(
sec: &Section<'_, NetstatusKwd>,
recommend_token: NetstatusKwd,
required_token: NetstatusKwd,
) -> Result<ProtoStatus> {
/// Helper: extract a Protocols entry from an item's arguments.
fn parse(t: Option<&Item<'_, NetstatusKwd>>) -> Result<Protocols> {
if let Some(item) = t {
item.args_as_str()
.parse::<Protocols>()
.map_err(|e| EK::BadArgument.at_pos(item.pos()).with_source(e))
} else {
Ok(Protocols::new())
}
}
let recommended = parse(sec.get(recommend_token))?;
let required = parse(sec.get(required_token))?;
Ok(ProtoStatus {
recommended,
required,
})
}
/// Return the protocols that are listed as "required" in this `ProtoStatus`.
///
/// Implementations may assume that relays on the network implement all the
/// protocols in the relays' required-protocols list. Implementations should
/// refuse to start if they do not implement all the protocols on their own
/// (client or relay) required-protocols list.
pub fn required_protocols(&self) -> &Protocols {
&self.required
}
/// Return the protocols that are listed as "recommended" in this `ProtoStatus`.
///
/// Implementations should warn if they do not implement all the protocols
/// on their own (client or relay) recommended-protocols list.
pub fn recommended_protocols(&self) -> &Protocols {
&self.recommended
}
}
impl<T> std::str::FromStr for NetParams<T>
where
T: std::str::FromStr,
T::Err: std::error::Error,
{
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
/// Helper: parse a single K=V pair.
fn parse_pair<U>(p: &str) -> Result<(String, U)>
where
U: std::str::FromStr,
U::Err: std::error::Error,
{
let parts: Vec<_> = p.splitn(2, '=').collect();
if parts.len() != 2 {
return Err(EK::BadArgument
.at_pos(Pos::at(p))
.with_msg("Missing = in key=value list"));
}
let num = parts[1].parse::<U>().map_err(|e| {
EK::BadArgument
.at_pos(Pos::at(parts[1]))
.with_msg(e.to_string())
})?;
Ok((parts[0].to_string(), num))
}
let params = s
.split(' ')
.filter(|p| !p.is_empty())
.map(parse_pair)
.collect::<Result<HashMap<_, _>>>()?;
Ok(NetParams { params })
}
}
impl CommonHeader {
/// Extract the CommonHeader members from a single header section.
fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<CommonHeader> {
use NetstatusKwd::*;
{
// this unwrap is safe because if there is not at least one
// token in the section, the section is unparsable.
#[allow(clippy::unwrap_used)]
let first = sec.first_item().unwrap();
if first.kwd() != NETWORK_STATUS_VERSION {
return Err(EK::UnexpectedToken
.with_msg(first.kwd().to_str())
.at_pos(first.pos()));
}
}
let ver_item = sec.required(NETWORK_STATUS_VERSION)?;
let version: u32 = ver_item.parse_arg(0)?;
if version != 3 {
return Err(EK::BadDocumentVersion.with_msg(version.to_string()));
}
let flavor = ConsensusFlavor::from_opt_name(ver_item.arg(1))?;
let valid_after = sec
.required(VALID_AFTER)?
.args_as_str()
.parse::<Iso8601TimeSp>()?
.into();
let fresh_until = sec
.required(FRESH_UNTIL)?
.args_as_str()
.parse::<Iso8601TimeSp>()?
.into();
let valid_until = sec
.required(VALID_UNTIL)?
.args_as_str()
.parse::<Iso8601TimeSp>()?
.into();
let lifetime = Lifetime::new(valid_after, fresh_until, valid_until)?;
let client_versions = sec
.maybe(CLIENT_VERSIONS)
.args_as_str()
.unwrap_or("")
.split(',')
.map(str::to_string)
.collect();
let relay_versions = sec
.maybe(SERVER_VERSIONS)
.args_as_str()
.unwrap_or("")
.split(',')
.map(str::to_string)
.collect();
let client_protos = ProtoStatus::from_section(
sec,
RECOMMENDED_CLIENT_PROTOCOLS,
REQUIRED_CLIENT_PROTOCOLS,
)?;
let relay_protos =
ProtoStatus::from_section(sec, RECOMMENDED_RELAY_PROTOCOLS, REQUIRED_RELAY_PROTOCOLS)?;
let params = sec.maybe(PARAMS).args_as_str().unwrap_or("").parse()?;
let voting_delay = if let Some(tok) = sec.get(VOTING_DELAY) {
let n1 = tok.parse_arg(0)?;
let n2 = tok.parse_arg(1)?;
Some((n1, n2))
} else {
None
};
Ok(CommonHeader {
flavor,
lifetime,
client_versions,
relay_versions,
client_protos,
relay_protos,
params,
voting_delay,
})
}
}
impl SharedRandStatus {
/// Parse a current or previous shared rand value from a given
/// SharedRandPreviousValue or SharedRandCurrentValue.
fn from_item(item: &Item<'_, NetstatusKwd>) -> Result<Self> {
match item.kwd() {
NetstatusKwd::SHARED_RAND_PREVIOUS_VALUE | NetstatusKwd::SHARED_RAND_CURRENT_VALUE => {}
_ => {
return Err(Error::from(internal!(
"wrong keyword {:?} on shared-random value",
item.kwd()
))
.at_pos(item.pos()))
}
}
let n_reveals: u8 = item.parse_arg(0)?;
let val: B64 = item.parse_arg(1)?;
let value = SharedRandVal(val.into_array()?);
// Added in proposal 342
let timestamp = item
.parse_optional_arg::<Iso8601TimeNoSp>(2)?
.map(Into::into);
Ok(SharedRandStatus {
n_reveals,
value,
timestamp,
})
}
/// Return the actual shared random value.
pub fn value(&self) -> &SharedRandVal {
&self.value
}
/// Return the timestamp (if any) associated with this `SharedRandValue`.
pub fn timestamp(&self) -> Option<std::time::SystemTime> {
self.timestamp
}
}
impl ConsensusHeader {
/// Parse the ConsensusHeader members from a provided section.
fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<ConsensusHeader> {
use NetstatusKwd::*;
let status: &str = sec.required(VOTE_STATUS)?.arg(0).unwrap_or("");
if status != "consensus" {
return Err(EK::BadDocumentType.err());
}
// We're ignoring KNOWN_FLAGS in the consensus.
let hdr = CommonHeader::from_section(sec)?;
let consensus_method: u32 = sec.required(CONSENSUS_METHOD)?.parse_arg(0)?;
let shared_rand_prev = sec
.get(SHARED_RAND_PREVIOUS_VALUE)
.map(SharedRandStatus::from_item)
.transpose()?;
let shared_rand_cur = sec
.get(SHARED_RAND_CURRENT_VALUE)
.map(SharedRandStatus::from_item)
.transpose()?;
Ok(ConsensusHeader {
hdr,
consensus_method,
shared_rand_prev,
shared_rand_cur,
})
}
}
impl DirSource {
/// Parse a "dir-source" item
fn from_item(item: &Item<'_, NetstatusKwd>) -> Result<Self> {
if item.kwd() != NetstatusKwd::DIR_SOURCE {
return Err(
Error::from(internal!("Bad keyword {:?} on dir-source", item.kwd()))
.at_pos(item.pos()),
);
}
let nickname = item.required_arg(0)?.to_string();
let identity = item.parse_arg::<Fingerprint>(1)?.into();
let ip = item.parse_arg(3)?;
let dir_port = item.parse_arg(4)?;
let or_port = item.parse_arg(5)?;
Ok(DirSource {
nickname,
identity,
ip,
dir_port,
or_port,
})
}
}
impl ConsensusVoterInfo {
/// Parse a single ConsensusVoterInfo from a voter info section.
fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<ConsensusVoterInfo> {
use NetstatusKwd::*;
// this unwrap should be safe because if there is not at least one
// token in the section, the section is unparsable.
#[allow(clippy::unwrap_used)]
let first = sec.first_item().unwrap();
if first.kwd() != DIR_SOURCE {
return Err(Error::from(internal!(
"Wrong keyword {:?} at start of voter info",
first.kwd()
))
.at_pos(first.pos()));
}
let dir_source = DirSource::from_item(sec.required(DIR_SOURCE)?)?;
let contact = sec.required(CONTACT)?.args_as_str().to_string();
let vote_digest = sec.required(VOTE_DIGEST)?.parse_arg::<B16>(0)?.into();
Ok(ConsensusVoterInfo {
dir_source,
contact,
vote_digest,
})
}
}
impl std::str::FromStr for RelayFlags {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(match s {
"Authority" => RelayFlags::AUTHORITY,
"BadExit" => RelayFlags::BAD_EXIT,
"Exit" => RelayFlags::EXIT,
"Fast" => RelayFlags::FAST,
"Guard" => RelayFlags::GUARD,
"HSDir" => RelayFlags::HSDIR,
"MiddleOnly" => RelayFlags::MIDDLE_ONLY,
"NoEdConsensus" => RelayFlags::NO_ED_CONSENSUS,
"Stable" => RelayFlags::STABLE,
"StaleDesc" => RelayFlags::STALE_DESC,
"Running" => RelayFlags::RUNNING,
"Valid" => RelayFlags::VALID,
"V2Dir" => RelayFlags::V2DIR,
_ => RelayFlags::empty(),
})
}
}
impl RelayFlags {
/// Parse a relay-flags entry from an "s" line.
fn from_item(item: &Item<'_, NetstatusKwd>) -> Result<RelayFlags> {
if item.kwd() != NetstatusKwd::RS_S {
return Err(
Error::from(internal!("Wrong keyword {:?} for S line", item.kwd()))
.at_pos(item.pos()),
);
}
// These flags are implicit.
let mut flags: RelayFlags = RelayFlags::RUNNING | RelayFlags::VALID;
let mut prev: Option<&str> = None;
for s in item.args() {
if let Some(p) = prev {
if p >= s {
// Arguments out of order.
return Err(EK::BadArgument
.at_pos(item.pos())
.with_msg("Flags out of order"));
}
}
match s.parse() {
Ok(fl) => {
flags |= fl;
prev = Some(s);
}
Err(_e) => {
return Err(EK::BadArgument
.at_pos(item.pos())
.with_msg("failed to parse flag"))
}
};
}
Ok(flags)
}
}
impl Default for RelayWeight {
fn default() -> RelayWeight {
RelayWeight::Unmeasured(0)
}
}
impl RelayWeight {
/// Parse a routerweight from a "w" line.
fn from_item(item: &Item<'_, NetstatusKwd>) -> Result<RelayWeight> {
if item.kwd() != NetstatusKwd::RS_W {
return Err(
Error::from(internal!("Wrong keyword {:?} on W line", item.kwd()))
.at_pos(item.pos()),
);
}
let params: NetParams<u32> = item.args_as_str().parse()?;
let bw = params.params.get("Bandwidth");
let unmeas = params.params.get("Unmeasured");
let bw = match bw {
None => return Ok(RelayWeight::Unmeasured(0)),
Some(b) => *b,
};
match unmeas {
None | Some(0) => Ok(RelayWeight::Measured(bw)),
Some(1) => Ok(RelayWeight::Unmeasured(bw)),
_ => Err(EK::BadArgument
.at_pos(item.pos())
.with_msg("unmeasured value")),
}
}
}
impl Footer {
/// Parse a directory footer from a footer section.
fn from_section(sec: &Section<'_, NetstatusKwd>) -> Result<Footer> {
use NetstatusKwd::*;
sec.required(DIRECTORY_FOOTER)?;
let weights = sec
.maybe(BANDWIDTH_WEIGHTS)
.args_as_str()
.unwrap_or("")
.parse()?;
Ok(Footer { weights })
}
}
/// Result of checking a single authority signature.
enum SigCheckResult {
/// The signature checks out. Great!
Valid,
/// The signature is invalid; no additional information could make it
/// valid.
Invalid,
/// We can't check the signature because we don't have a
/// certificate with the right signing key.
MissingCert,
}
impl Signature {
/// Parse a Signature from a directory-signature section
fn from_item(item: &Item<'_, NetstatusKwd>) -> Result<Signature> {
if item.kwd() != NetstatusKwd::DIRECTORY_SIGNATURE {
return Err(Error::from(internal!(
"Wrong keyword {:?} for directory signature",
item.kwd()
))
.at_pos(item.pos()));
}
let (alg, id_fp, sk_fp) = if item.n_args() > 2 {
(
item.required_arg(0)?,
item.required_arg(1)?,
item.required_arg(2)?,
)
} else {
("sha1", item.required_arg(0)?, item.required_arg(1)?)
};
let digestname = alg.to_string();
let id_fingerprint = id_fp.parse::<Fingerprint>()?.into();
let sk_fingerprint = sk_fp.parse::<Fingerprint>()?.into();
let key_ids = AuthCertKeyIds {
id_fingerprint,
sk_fingerprint,
};
let signature = item.obj("SIGNATURE")?;
Ok(Signature {
digestname,
key_ids,
signature,
})
}
/// Return true if this signature has the identity key and signing key
/// that match a given cert.
fn matches_cert(&self, cert: &AuthCert) -> bool {
cert.key_ids() == &self.key_ids
}
/// If possible, find the right certificate for checking this signature
/// from among a slice of certificates.
fn find_cert<'a>(&self, certs: &'a [AuthCert]) -> Option<&'a AuthCert> {
certs.iter().find(|&c| self.matches_cert(c))
}
/// Try to check whether this signature is a valid signature of a
/// provided digest, given a slice of certificates that might contain
/// its signing key.
fn check_signature(&self, signed_digest: &[u8], certs: &[AuthCert]) -> SigCheckResult {
match self.find_cert(certs) {
None => SigCheckResult::MissingCert,
Some(cert) => {
let key = cert.signing_key();
match key.verify(signed_digest, &self.signature[..]) {
Ok(()) => SigCheckResult::Valid,
Err(_) => SigCheckResult::Invalid,
}
}
}
}
}
/// A Consensus object that has been parsed, but not checked for
/// signatures and timeliness.
pub type UncheckedConsensus<RS> = TimerangeBound<UnvalidatedConsensus<RS>>;
impl<RS: RouterStatus + ParseRouterStatus> Consensus<RS> {
/// Return a new ConsensusBuilder for building test consensus objects.
///
/// This function is only available when the `build_docs` feature has
/// been enabled.
#[cfg(feature = "build_docs")]
pub fn builder() -> ConsensusBuilder<RS> {
ConsensusBuilder::new(RS::flavor())
}
/// Try to parse a single networkstatus document from a string.
pub fn parse(s: &str) -> Result<(&str, &str, UncheckedConsensus<RS>)> {
let mut reader = NetDocReader::new(s);
Self::parse_from_reader(&mut reader).map_err(|e| e.within(s))
}
/// Extract a voter-info section from the reader; return
/// Ok(None) when we are out of voter-info sections.
fn take_voterinfo(
r: &mut NetDocReader<'_, NetstatusKwd>,
) -> Result<Option<ConsensusVoterInfo>> {
use NetstatusKwd::*;
match r.peek() {
None => return Ok(None),
Some(e) if e.is_ok_with_kwd_in(&[RS_R, DIRECTORY_FOOTER]) => return Ok(None),
_ => (),
};
let mut first_dir_source = true;
// TODO: Extract this pattern into a "pause at second"???
// Pause at the first 'r', or the second 'dir-source'.
let mut p = r.pause_at(|i| match i {
Err(_) => false,
Ok(item) => {
item.kwd() == RS_R
|| if item.kwd() == DIR_SOURCE {
let was_first = first_dir_source;
first_dir_source = false;
!was_first
} else {
false
}
}
});
let voter_sec = NS_VOTERINFO_RULES_CONSENSUS.parse(&mut p)?;
let voter = ConsensusVoterInfo::from_section(&voter_sec)?;
Ok(Some(voter))
}
/// Extract the footer (but not signatures) from the reader.
fn take_footer(r: &mut NetDocReader<'_, NetstatusKwd>) -> Result<Footer> {
use NetstatusKwd::*;
let mut p = r.pause_at(|i| i.is_ok_with_kwd_in(&[DIRECTORY_SIGNATURE]));
let footer_sec = NS_FOOTER_RULES.parse(&mut p)?;
let footer = Footer::from_section(&footer_sec)?;
Ok(footer)
}
/// Extract a routerstatus from the reader. Return Ok(None) if we're
/// out of routerstatus entries.
fn take_routerstatus(r: &mut NetDocReader<'_, NetstatusKwd>) -> Result<Option<(Pos, RS)>> {
use NetstatusKwd::*;
match r.peek() {
None => return Ok(None),
Some(e) if e.is_ok_with_kwd_in(&[DIRECTORY_FOOTER]) => return Ok(None),
_ => (),
};
let pos = r.pos();
let mut first_r = true;
let mut p = r.pause_at(|i| match i {
Err(_) => false,
Ok(item) => {
item.kwd() == DIRECTORY_FOOTER
|| if item.kwd() == RS_R {
let was_first = first_r;
first_r = false;
!was_first
} else {
false
}
}
});
let rules = match RS::flavor() {
ConsensusFlavor::Microdesc => &NS_ROUTERSTATUS_RULES_MDCON,
ConsensusFlavor::Ns => &NS_ROUTERSTATUS_RULES_NSCON,
};
let rs_sec = rules.parse(&mut p)?;
let rs = RS::from_section(&rs_sec)?;
Ok(Some((pos, rs)))
}
/// Extract an entire UncheckedConsensus from a reader.
///
/// Returns the signed portion of the string, the remainder of the
/// string, and an UncheckedConsensus.
fn parse_from_reader<'a>(
r: &mut NetDocReader<'a, NetstatusKwd>,
) -> Result<(&'a str, &'a str, UncheckedConsensus<RS>)> {
use NetstatusKwd::*;
let (header, start_pos) = {
let mut h = r.pause_at(|i| i.is_ok_with_kwd_in(&[DIR_SOURCE]));
let header_sec = NS_HEADER_RULES_CONSENSUS.parse(&mut h)?;
// Unwrapping should be safe because above `.parse` would have
// returned an Error
#[allow(clippy::unwrap_used)]
let pos = header_sec.first_item().unwrap().offset_in(r.str()).unwrap();
(ConsensusHeader::from_section(&header_sec)?, pos)
};
if RS::flavor() != header.hdr.flavor {
return Err(EK::BadDocumentType.with_msg(format!(
"Expected {:?}, got {:?}",
RS::flavor(),
header.hdr.flavor
)));
}
let mut voters = Vec::new();
while let Some(voter) = Self::take_voterinfo(r)? {
voters.push(voter);
}
let mut relays: Vec<RS> = Vec::new();
while let Some((pos, routerstatus)) = Self::take_routerstatus(r)? {
if let Some(prev) = relays.last() {
if prev.rsa_identity() >= routerstatus.rsa_identity() {
return Err(EK::WrongSortOrder.at_pos(pos));
}
}
relays.push(routerstatus);
}
relays.shrink_to_fit();
let footer = Self::take_footer(r)?;
let consensus = Consensus {
header,
voters,
relays,
footer,
};
// Find the signatures.
let mut first_sig: Option<Item<'_, NetstatusKwd>> = None;
let mut signatures = Vec::new();
for item in &mut *r {
let item = item?;
if item.kwd() != DIRECTORY_SIGNATURE {
return Err(EK::UnexpectedToken
.with_msg(item.kwd().to_str())
.at_pos(item.pos()));
}
let sig = Signature::from_item(&item)?;
if first_sig.is_none() {
first_sig = Some(item);
}
signatures.push(sig);
}
let end_pos = match first_sig {
None => return Err(EK::MissingToken.with_msg("directory-signature")),
// Unwrap should be safe because `first_sig` was parsed from `r`
#[allow(clippy::unwrap_used)]
Some(sig) => sig.offset_in(r.str()).unwrap() + "directory-signature ".len(),
};
// Find the appropriate digest.
let signed_str = &r.str()[start_pos..end_pos];
let remainder = &r.str()[end_pos..];
let (sha256, sha1) = match RS::flavor() {
ConsensusFlavor::Ns => (
None,
Some(ll::d::Sha1::digest(signed_str.as_bytes()).into()),
),
ConsensusFlavor::Microdesc => (
Some(ll::d::Sha256::digest(signed_str.as_bytes()).into()),
None,
),
};
let siggroup = SignatureGroup {
sha256,
sha1,
signatures,
};
let unval = UnvalidatedConsensus {
consensus,
siggroup,
n_authorities: None,
};
let lifetime = unval.consensus.header.hdr.lifetime.clone();
let delay = unval.consensus.header.hdr.voting_delay.unwrap_or((0, 0));
let dist_interval = time::Duration::from_secs(delay.1.into());
let starting_time = lifetime.valid_after - dist_interval;
let timebound = TimerangeBound::new(unval, starting_time..lifetime.valid_until);
Ok((signed_str, remainder, timebound))
}
}
/// A Microdesc consensus whose signatures have not yet been checked.
///
/// To validate this object, call set_n_authorities() on it, then call
/// check_signature() on that result with the set of certs that you
/// have. Make sure only to provide authority certificates representing
/// real authorities!
#[cfg_attr(
feature = "dangerous-expose-struct-fields",
visible::StructFields(pub),
non_exhaustive
)]
#[derive(Debug, Clone)]
pub struct UnvalidatedConsensus<RS> {
/// The consensus object. We don't want to expose this until it's
/// validated.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
consensus: Consensus<RS>,
/// The signatures that need to be validated before we can call
/// this consensus valid.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
siggroup: SignatureGroup,
/// The total number of authorities that we believe in. We need
/// this information in order to validate the signatures, since it
/// determines how many signatures we need to find valid in `siggroup`.
#[cfg_attr(docsrs, doc(cfg(feature = "dangerous-expose-struct-fields")))]
n_authorities: Option<u16>,
}
impl<RS> UnvalidatedConsensus<RS> {
/// Tell the unvalidated consensus how many authorities we believe in.
///
/// Without knowing this number, we can't validate the signature.
#[must_use]
pub fn set_n_authorities(self, n_authorities: u16) -> Self {
UnvalidatedConsensus {
n_authorities: Some(n_authorities),
..self
}
}
/// Return an iterator of all the certificate IDs that we might use
/// to validate this consensus.
pub fn signing_cert_ids(&self) -> impl Iterator<Item = AuthCertKeyIds> {
match self.key_is_correct(&[]) {
Ok(()) => Vec::new(),
Err(missing) => missing,
}
.into_iter()
}
/// Return the lifetime of this unvalidated consensus
pub fn peek_lifetime(&self) -> &Lifetime {
self.consensus.lifetime()
}
/// Return true if a client who believes in exactly the provided
/// set of authority IDs might might consider this consensus to be
/// well-signed.
///
/// (This is the case if the consensus claims to be signed by more than
/// half of the authorities in the list.)
pub fn authorities_are_correct(&self, authorities: &[&RsaIdentity]) -> bool {
self.siggroup.could_validate(authorities)
}
/// Return the number of relays in this unvalidated consensus.
///
/// This function is unstable. It is only enabled if the crate was
/// built with the `experimental-api` feature.
#[cfg(feature = "experimental-api")]
pub fn n_relays(&self) -> usize {
self.consensus.relays.len()
}
/// Modify the list of relays in this unvalidated consensus.
///
/// A use case for this is long-lasting custom directories. To ensure Arti can still quickly
/// build circuits when the directory gets old, a tiny churn file can be regularly obtained,
/// listing no longer available Tor nodes, which can then be removed from the consensus.
///
/// This function is unstable. It is only enabled if the crate was
/// built with the `experimental-api` feature.
#[cfg(feature = "experimental-api")]
pub fn modify_relays<F>(&mut self, func: F)
where
F: FnOnce(&mut Vec<RS>),
{
func(&mut self.consensus.relays);
}
}
impl<RS> ExternallySigned<Consensus<RS>> for UnvalidatedConsensus<RS> {
type Key = [AuthCert];
type KeyHint = Vec<AuthCertKeyIds>;
type Error = Error;
fn key_is_correct(&self, k: &Self::Key) -> result::Result<(), Self::KeyHint> {
let (n_ok, missing) = self.siggroup.list_missing(k);
match self.n_authorities {
Some(n) if n_ok > (n / 2) as usize => Ok(()),
_ => Err(missing.iter().map(|cert| cert.key_ids).collect()),
}
}
fn is_well_signed(&self, k: &Self::Key) -> result::Result<(), Self::Error> {
match self.n_authorities {
None => Err(Error::from(internal!(
"Didn't set authorities on consensus"
))),
Some(authority) => {
if self.siggroup.validate(authority, k) {
Ok(())
} else {
Err(EK::BadSignature.err())
}
}
}
}
fn dangerously_assume_wellsigned(self) -> Consensus<RS> {
self.consensus
}
}
impl SignatureGroup {
// TODO: these functions are pretty similar and could probably stand to be
// refactored a lot.
/// Helper: Return a pair of the number of possible authorities'
/// signatures in this object for which we _could_ find certs, and
/// a list of the signatures we couldn't find certificates for.
fn list_missing(&self, certs: &[AuthCert]) -> (usize, Vec<&Signature>) {
let mut ok: HashSet<RsaIdentity> = HashSet::new();
let mut missing = Vec::new();
for sig in &self.signatures {
let id_fingerprint = &sig.key_ids.id_fingerprint;
if ok.contains(id_fingerprint) {
continue;
}
if sig.find_cert(certs).is_some() {
ok.insert(*id_fingerprint);
continue;
}
missing.push(sig);
}
(ok.len(), missing)
}
/// Given a list of authority identity key fingerprints, return true if
/// this signature group is _potentially_ well-signed according to those
/// authorities.
fn could_validate(&self, authorities: &[&RsaIdentity]) -> bool {
let mut signed_by: HashSet<RsaIdentity> = HashSet::new();
for sig in &self.signatures {
let id_fp = &sig.key_ids.id_fingerprint;
if signed_by.contains(id_fp) {
// Already found this in the list.
continue;
}
if authorities.contains(&id_fp) {
signed_by.insert(*id_fp);
}
}
signed_by.len() > (authorities.len() / 2)
}
/// Return true if the signature group defines a valid signature.
///
/// A signature is valid if it signed by more than half of the
/// authorities. This API requires that `n_authorities` is the number of
/// authorities we believe in, and that every cert in `certs` belongs
/// to a real authority.
fn validate(&self, n_authorities: u16, certs: &[AuthCert]) -> bool {
// A set of the authorities (by identity) who have have signed
// this document. We use a set here in case `certs` has more
// than one certificate for a single authority.
let mut ok: HashSet<RsaIdentity> = HashSet::new();
for sig in &self.signatures {
let id_fingerprint = &sig.key_ids.id_fingerprint;
if ok.contains(id_fingerprint) {
// We already checked at least one signature using this
// authority's identity fingerprint.
continue;
}
let d: Option<&[u8]> = match sig.digestname.as_ref() {
"sha256" => self.sha256.as_ref().map(|a| &a[..]),
"sha1" => self.sha1.as_ref().map(|a| &a[..]),
_ => None, // We don't know how to find this digest.
};
if d.is_none() {
// We don't support this kind of digest for this kind
// of document.
continue;
}
// Unwrap should be safe because of above `d.is_none()` check
#[allow(clippy::unwrap_used)]
match sig.check_signature(d.as_ref().unwrap(), certs) {
SigCheckResult::Valid => {
ok.insert(*id_fingerprint);
}
_ => continue,
}
}
ok.len() > (n_authorities / 2) as usize
}
}
#[cfg(test)]
mod test {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_duration_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use super::*;
use hex_literal::hex;
const CERTS: &str = include_str!("../../testdata/authcerts2.txt");
const CONSENSUS: &str = include_str!("../../testdata/mdconsensus1.txt");
#[cfg(feature = "ns_consensus")]
const NS_CERTS: &str = include_str!("../../testdata/authcerts3.txt");
#[cfg(feature = "ns_consensus")]
const NS_CONSENSUS: &str = include_str!("../../testdata/nsconsensus1.txt");
fn read_bad(fname: &str) -> String {
use std::fs;
use std::path::PathBuf;
let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("testdata");
path.push("bad-mdconsensus");
path.push(fname);
fs::read_to_string(path).unwrap()
}
#[test]
fn parse_and_validate_md() -> Result<()> {
use std::net::SocketAddr;
use tor_checkable::{SelfSigned, Timebound};
let mut certs = Vec::new();
for cert in AuthCert::parse_multiple(CERTS) {
let cert = cert?.check_signature()?.dangerously_assume_timely();
certs.push(cert);
}
let auth_ids: Vec<_> = certs.iter().map(|c| &c.key_ids().id_fingerprint).collect();
assert_eq!(certs.len(), 3);
let (_, _, consensus) = MdConsensus::parse(CONSENSUS)?;
let consensus = consensus.dangerously_assume_timely().set_n_authorities(3);
// The set of authorities we know _could_ validate this cert.
assert!(consensus.authorities_are_correct(&auth_ids));
// A subset would also work.
assert!(consensus.authorities_are_correct(&auth_ids[0..1]));
{
// If we only believe in an authority that isn't listed,
// that won't work.
let bad_auth_id = (*b"xxxxxxxxxxxxxxxxxxxx").into();
assert!(!consensus.authorities_are_correct(&[&bad_auth_id]));
}
let missing = consensus.key_is_correct(&[]).err().unwrap();
assert_eq!(3, missing.len());
assert!(consensus.key_is_correct(&certs).is_ok());
let missing = consensus.key_is_correct(&certs[0..1]).err().unwrap();
assert_eq!(2, missing.len());
// here is a trick that had better not work.
let same_three_times = vec![certs[0].clone(), certs[0].clone(), certs[0].clone()];
let missing = consensus.key_is_correct(&same_three_times).err().unwrap();
assert_eq!(2, missing.len());
assert!(consensus.is_well_signed(&same_three_times).is_err());
assert!(consensus.key_is_correct(&certs).is_ok());
let consensus = consensus.check_signature(&certs)?;
assert_eq!(6, consensus.relays().len());
let r0 = &consensus.relays()[0];
assert_eq!(
r0.md_digest(),
&hex!("73dabe0a0468f4f7a67810a18d11e36731bb1d2ec3634db459100609f3b3f535")
);
assert_eq!(
r0.rsa_identity().as_bytes(),
&hex!("0a3057af2910415794d8ea430309d9ac5f5d524b")
);
assert!(!r0.weight().is_measured());
assert!(!r0.weight().is_nonzero());
let pv = &r0.protovers();
assert!(pv.supports_subver("HSDir", 2));
assert!(!pv.supports_subver("HSDir", 3));
let ip4 = "127.0.0.1:5002".parse::<SocketAddr>().unwrap();
let ip6 = "[::1]:5002".parse::<SocketAddr>().unwrap();
assert!(r0.orport_addrs().any(|a| a == &ip4));
assert!(r0.orport_addrs().any(|a| a == &ip6));
Ok(())
}
#[test]
#[cfg(feature = "ns_consensus")]
fn parse_and_validate_ns() -> Result<()> {
use tor_checkable::{SelfSigned, Timebound};
let mut certs = Vec::new();
for cert in AuthCert::parse_multiple(NS_CERTS) {
let cert = cert?.check_signature()?.dangerously_assume_timely();
certs.push(cert);
}
let auth_ids: Vec<_> = certs.iter().map(|c| &c.key_ids().id_fingerprint).collect();
assert_eq!(certs.len(), 3);
let (_, _, consensus) = NsConsensus::parse(NS_CONSENSUS)?;
let consensus = consensus.dangerously_assume_timely().set_n_authorities(3);
// The set of authorities we know _could_ validate this cert.
assert!(consensus.authorities_are_correct(&auth_ids));
// A subset would also work.
assert!(consensus.authorities_are_correct(&auth_ids[0..1]));
assert!(consensus.key_is_correct(&certs).is_ok());
let _consensus = consensus.check_signature(&certs)?;
Ok(())
}
#[test]
fn test_bad() {
use crate::Pos;
fn check(fname: &str, e: &Error) {
let content = read_bad(fname);
let res = MdConsensus::parse(&content);
assert!(res.is_err());
assert_eq!(&res.err().unwrap(), e);
}
check(
"bad-flags",
&EK::BadArgument
.at_pos(Pos::from_line(27, 1))
.with_msg("Flags out of order"),
);
check(
"bad-md-digest",
&EK::BadArgument
.at_pos(Pos::from_line(40, 3))
.with_msg("Invalid base64"),
);
check(
"bad-weight",
&EK::BadArgument
.at_pos(Pos::from_line(67, 141))
.with_msg("invalid digit found in string"),
);
check(
"bad-weights",
&EK::BadArgument
.at_pos(Pos::from_line(51, 13))
.with_msg("invalid digit found in string"),
);
check(
"wrong-order",
&EK::WrongSortOrder.at_pos(Pos::from_line(52, 1)),
);
check(
"wrong-start",
&EK::UnexpectedToken
.with_msg("vote-status")
.at_pos(Pos::from_line(1, 1)),
);
check("wrong-version", &EK::BadDocumentVersion.with_msg("10"));
}
fn gettok(s: &str) -> Result<Item<'_, NetstatusKwd>> {
let mut reader = NetDocReader::new(s);
let tok = reader.next().unwrap();
assert!(reader.next().is_none());
tok
}
#[test]
fn test_weight() {
let w = gettok("w Unmeasured=1 Bandwidth=6\n").unwrap();
let w = RelayWeight::from_item(&w).unwrap();
assert!(!w.is_measured());
assert!(w.is_nonzero());
let w = gettok("w Bandwidth=10\n").unwrap();
let w = RelayWeight::from_item(&w).unwrap();
assert!(w.is_measured());
assert!(w.is_nonzero());
let w = RelayWeight::default();
assert!(!w.is_measured());
assert!(!w.is_nonzero());
let w = gettok("w Mustelid=66 Cheato=7 Unmeasured=1\n").unwrap();
let w = RelayWeight::from_item(&w).unwrap();
assert!(!w.is_measured());
assert!(!w.is_nonzero());
let w = gettok("r foo\n").unwrap();
let w = RelayWeight::from_item(&w);
assert!(w.is_err());
let w = gettok("r Bandwidth=6 Unmeasured=Frog\n").unwrap();
let w = RelayWeight::from_item(&w);
assert!(w.is_err());
let w = gettok("r Bandwidth=6 Unmeasured=3\n").unwrap();
let w = RelayWeight::from_item(&w);
assert!(w.is_err());
}
#[test]
fn test_netparam() {
let p = "Hello=600 Goodbye=5 Fred=7"
.parse::<NetParams<u32>>()
.unwrap();
assert_eq!(p.get("Hello"), Some(&600_u32));
let p = "Hello=Goodbye=5 Fred=7".parse::<NetParams<u32>>();
assert!(p.is_err());
let p = "Hello=Goodbye Fred=7".parse::<NetParams<u32>>();
assert!(p.is_err());
}
#[test]
fn test_sharedrand() {
let sr =
gettok("shared-rand-previous-value 9 5LodY4yWxFhTKtxpV9wAgNA9N8flhUCH0NqQv1/05y4\n")
.unwrap();
let sr = SharedRandStatus::from_item(&sr).unwrap();
assert_eq!(sr.n_reveals, 9);
assert_eq!(
sr.value.0,
hex!("e4ba1d638c96c458532adc6957dc0080d03d37c7e5854087d0da90bf5ff4e72e")
);
assert!(sr.timestamp.is_none());
let sr2 = gettok(
"shared-rand-current-value 9 \
5LodY4yWxFhTKtxpV9wAgNA9N8flhUCH0NqQv1/05y4 2022-01-20T12:34:56\n",
)
.unwrap();
let sr2 = SharedRandStatus::from_item(&sr2).unwrap();
assert_eq!(sr2.n_reveals, sr.n_reveals);
assert_eq!(sr2.value.0, sr.value.0);
assert_eq!(
sr2.timestamp.unwrap(),
humantime::parse_rfc3339("2022-01-20T12:34:56Z").unwrap()
);
let sr = gettok("foo bar\n").unwrap();
let sr = SharedRandStatus::from_item(&sr);
assert!(sr.is_err());
}
}