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 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
//! Code to handle incoming cells on a circuit.
//!
//! ## On message validation
//!
//! There are three steps for validating an incoming message on a stream:
//!
//! 1. Is the message contextually appropriate? (e.g., no more than one
//! `CONNECTED` message per stream.) This is handled by calling
//! [`CmdChecker::check_msg`](crate::stream::CmdChecker::check_msg).
//! 2. Does the message comply with flow-control rules? (e.g., no more data than
//! we've gotten SENDMEs for.) For open streams, the stream itself handles
//! this; for half-closed streams, the reactor handles it using the
//! `halfstream` module.
//! 3. Does the message have an acceptable command type, and is the message
//! well-formed? For open streams, the streams themselves handle this check.
//! For half-closed streams, the reactor handles it by calling
//! `consume_checked_msg()`.
pub(super) mod syncview;
use super::handshake::RelayCryptLayerProtocol;
use super::streammap::{EndSentStreamEnt, OpenStreamEnt, ShouldSendEnd, StreamEntMut};
use super::MutableState;
use crate::circuit::celltypes::{ClientCircChanMsg, CreateResponse};
use crate::circuit::handshake::{BoxedClientLayer, HandshakeRole};
use crate::circuit::unique_id::UniqId;
use crate::circuit::{
sendme, streammap, CircParameters, Create2Wrap, CreateFastWrap, CreateHandshakeWrap,
};
use crate::crypto::binding::CircuitBinding;
use crate::crypto::cell::{
ClientLayer, CryptInit, HopNum, InboundClientCrypt, InboundClientLayer, OutboundClientCrypt,
OutboundClientLayer, RelayCellBody, Tor1RelayCrypto,
};
use crate::crypto::handshake::fast::CreateFastClient;
#[cfg(feature = "ntor_v3")]
use crate::crypto::handshake::ntor_v3::{NtorV3Client, NtorV3PublicKey};
use crate::stream::{AnyCmdChecker, StreamStatus};
use crate::util::err::{ChannelClosed, ReactorError};
use crate::{Error, Result};
use std::borrow::Borrow;
use std::collections::VecDeque;
use std::marker::PhantomData;
use std::pin::Pin;
use tor_cell::chancell::msg::{AnyChanMsg, HandshakeType, Relay};
use tor_cell::relaycell::msg::{AnyRelayMsg, End, Sendme};
use tor_cell::relaycell::{
AnyRelayMsgOuter, RelayCellDecoder, RelayCellFormat, RelayCellFormatTrait, RelayCellFormatV0,
RelayCmd, StreamId, UnparsedRelayMsg,
};
#[cfg(feature = "hs-service")]
use {
crate::stream::{DataCmdChecker, IncomingStreamRequest, IncomingStreamRequestFilter},
tor_cell::relaycell::msg::Begin,
};
use futures::channel::mpsc;
use futures::Stream;
use futures::{Sink, StreamExt};
use tor_async_utils::oneshot;
use tor_error::internal;
use std::sync::{Arc, Mutex};
use std::task::{Context, Poll};
use crate::channel::Channel;
use crate::circuit::path;
#[cfg(test)]
use crate::circuit::sendme::CircTag;
use crate::circuit::sendme::StreamSendWindow;
use crate::crypto::handshake::ntor::{NtorClient, NtorPublicKey};
use crate::crypto::handshake::{ClientHandshake, KeyGenerator};
use safelog::sensitive as sv;
use tor_cell::chancell::{self, BoxedCellBody, ChanMsg};
use tor_cell::chancell::{AnyChanCell, CircId};
use tor_cell::relaycell::extend::NtorV3Extension;
use tor_linkspec::{EncodedLinkSpec, OwnedChanTarget, RelayIds};
use tor_llcrypto::pk;
use tracing::{debug, trace, warn};
/// Initial value for outbound flow-control window on streams.
pub(super) const SEND_WINDOW_INIT: u16 = 500;
/// Initial value for inbound flow-control window on streams.
pub(super) const RECV_WINDOW_INIT: u16 = 500;
/// Size of the buffer used between the reactor and a `StreamReader`.
///
/// FIXME(eta): We pick 2× the receive window, which is very conservative (we arguably shouldn't
/// get sent more than the receive window anyway!). We might do due to things that
/// don't count towards the window though.
pub(super) const STREAM_READER_BUFFER: usize = (2 * RECV_WINDOW_INIT) as usize;
/// The type of a oneshot channel used to inform reactor users of the result of an operation.
pub(super) type ReactorResultChannel<T> = oneshot::Sender<Result<T>>;
/// A handshake type, to be used when creating circuit hops.
#[derive(Clone, Debug)]
pub(super) enum CircuitHandshake {
/// Use the CREATE_FAST handshake.
CreateFast,
/// Use the ntor handshake.
Ntor {
/// The public key of the relay.
public_key: NtorPublicKey,
/// The Ed25519 identity of the relay, which is verified against the
/// identity held in the circuit's channel.
ed_identity: pk::ed25519::Ed25519Identity,
},
/// Use the ntor-v3 handshake.
#[cfg(feature = "ntor_v3")]
NtorV3 {
/// The public key of the relay.
public_key: NtorV3PublicKey,
},
}
/// A behavior to perform when closing a stream.
///
/// We don't use `Option<End>`` here, since the behavior of `SendNothing` is so surprising
/// that we shouldn't let it pass unremarked.
#[derive(Clone, Debug)]
pub(crate) enum CloseStreamBehavior {
/// Send nothing at all, so that the other side will not realize we have
/// closed the stream.
///
/// We should only do this for incoming onion service streams when we
/// want to black-hole the client's requests.
SendNothing,
/// Send an End cell, if we haven't already sent one.
SendEnd(End),
}
impl Default for CloseStreamBehavior {
fn default() -> Self {
Self::SendEnd(End::new_misc())
}
}
/// A message telling the reactor to do something.
#[derive(educe::Educe)]
#[educe(Debug)]
pub(super) enum CtrlMsg {
/// Create the first hop of this circuit.
Create {
/// A oneshot channel on which we'll receive the creation response.
recv_created: oneshot::Receiver<CreateResponse>,
/// The handshake type to use for the first hop.
handshake: CircuitHandshake,
/// Other parameters relevant for circuit creation.
params: CircParameters,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
},
/// Extend a circuit by one hop, using the ntor handshake.
ExtendNtor {
/// The peer that we're extending to.
///
/// Used to extend our record of the circuit's path.
peer_id: OwnedChanTarget,
/// The handshake type to use for this hop.
public_key: NtorPublicKey,
/// Information about how to connect to the relay we're extending to.
linkspecs: Vec<EncodedLinkSpec>,
/// Other parameters relevant for circuit extension.
params: CircParameters,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
},
/// Extend a circuit by one hop, using the ntorv3 handshake.
#[cfg(feature = "ntor_v3")]
ExtendNtorV3 {
/// The peer that we're extending to.
///
/// Used to extend our record of the circuit's path.
peer_id: OwnedChanTarget,
/// The handshake type to use for this hop.
public_key: NtorV3PublicKey,
/// Information about how to connect to the relay we're extending to.
linkspecs: Vec<EncodedLinkSpec>,
/// Other parameters relevant for circuit extension.
params: CircParameters,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
},
/// Extend the circuit by one hop, in response to an out-of-band handshake.
///
/// (This is used for onion services, where the negotiation takes place in
/// INTRODUCE and RENDEZVOUS messages.)
#[cfg(feature = "hs-common")]
ExtendVirtual {
/// Which relay cell format to use for this hop.
relay_cell_format: RelayCellFormat,
/// The cryptographic algorithms and keys to use when communicating with
/// the newly added hop.
#[educe(Debug(ignore))]
cell_crypto: (
Box<dyn OutboundClientLayer + Send>,
Box<dyn InboundClientLayer + Send>,
Option<CircuitBinding>,
),
/// A set of parameters used to configure this hop.
params: CircParameters,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
},
/// Begin a stream with the provided hop in this circuit.
///
/// Allocates a stream ID, and sends the provided message to that hop.
BeginStream {
/// The hop number to begin the stream with.
hop_num: HopNum,
/// The message to send.
message: AnyRelayMsg,
/// A channel to send messages on this stream down.
///
/// This sender shouldn't ever block, because we use congestion control and only send
/// SENDME cells once we've read enough out of the other end. If it *does* block, we
/// can assume someone is trying to send us more cells than they should, and abort
/// the stream.
sender: mpsc::Sender<UnparsedRelayMsg>,
/// A channel to receive messages to send on this stream from.
rx: mpsc::Receiver<AnyRelayMsg>,
/// Oneshot channel to notify on completion, with the allocated stream ID.
done: ReactorResultChannel<StreamId>,
/// A `CmdChecker` to keep track of which message types are acceptable.
cmd_checker: AnyCmdChecker,
},
/// Close the specified pending incoming stream, sending the provided END message.
///
/// A stream is said to be pending if the message for initiating the stream was received but
/// not has not been responded to yet.
///
/// This should be used by responders for closing pending incoming streams initiated by the
/// other party on the circuit.
#[cfg(feature = "hs-service")]
ClosePendingStream {
/// The hop number the stream is on.
hop_num: HopNum,
/// The stream ID to send the END for.
stream_id: StreamId,
/// The END message to send, if any.
message: CloseStreamBehavior,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
},
/// Begin accepting streams on this circuit.
#[cfg(feature = "hs-service")]
AwaitStreamRequest {
/// A channel for sending information about an incoming stream request.
incoming_sender: mpsc::Sender<StreamReqInfo>,
/// A `CmdChecker` to keep track of which message types are acceptable.
cmd_checker: AnyCmdChecker,
/// Oneshot channel to notify on completion.
done: ReactorResultChannel<()>,
/// The hop that is allowed to create streams.
hop_num: HopNum,
/// A filter used to check requests before passing them on.
#[educe(Debug(ignore))]
#[cfg(feature = "hs-service")]
filter: Box<dyn IncomingStreamRequestFilter>,
},
/// Send a given control message on this circuit.
#[cfg(feature = "send-control-msg")]
SendMsg {
/// The hop to receive this message.
hop_num: HopNum,
/// The message to send.
msg: AnyRelayMsg,
/// A sender that we use to tell the caller that the message was sent
/// and the handler installed.
sender: oneshot::Sender<Result<()>>,
},
/// Send a given control message on this circuit, and install a control-message handler to
/// receive responses.
#[cfg(feature = "send-control-msg")]
SendMsgAndInstallHandler {
/// The message to send, if any
msg: Option<AnyRelayMsgOuter>,
/// A message handler to install.
///
/// If this is `None`, there must already be a message handler installed
#[educe(Debug(ignore))]
handler: Option<Box<dyn MetaCellHandler + Send + 'static>>,
/// A sender that we use to tell the caller that the message was sent
/// and the handler installed.
sender: oneshot::Sender<Result<()>>,
},
/// Send a SENDME cell (used to ask for more data to be sent) on the given stream.
SendSendme {
/// The stream ID to send a SENDME for.
stream_id: StreamId,
/// The hop number the stream is on.
hop_num: HopNum,
},
/// Shut down the reactor.
Shutdown,
/// (tests only) Add a hop to the list of hops on this circuit, with dummy cryptography.
#[cfg(test)]
AddFakeHop {
relay_cell_format: RelayCellFormat,
fwd_lasthop: bool,
rev_lasthop: bool,
params: CircParameters,
done: ReactorResultChannel<()>,
},
/// (tests only) Get the send window and expected tags for a given hop.
#[cfg(test)]
QuerySendWindow {
hop: HopNum,
done: ReactorResultChannel<(u16, Vec<CircTag>)>,
},
/// (tests only) Send a raw relay cell with send_relay_cell().
#[cfg(test)]
SendRelayCell {
hop: HopNum,
early: bool,
cell: AnyRelayMsgOuter,
},
}
/// Represents the reactor's view of a single hop.
pub(super) struct CircHop {
/// Map from stream IDs to streams.
///
/// We store this with the reactor instead of the circuit, since the
/// reactor needs it for every incoming cell on a stream, whereas
/// the circuit only needs it when allocating new streams.
map: streammap::StreamMap,
/// Window used to say how many cells we can receive.
recvwindow: sendme::CircRecvWindow,
/// Window used to say how many cells we can send.
sendwindow: sendme::CircSendWindow,
/// Buffer for messages we can't send to this hop yet due to congestion control.
///
/// Contains the cell to send, and a boolean equivalent to the `early` parameter
/// in `Reactor::send_relay_cell` (as in, whether to send the cell using `RELAY_EARLY`).
///
/// This shouldn't grow unboundedly: we try and pop things off it first before
/// doing things that would result in it growing (and stop before growing it
/// if popping things off it can't be done).
///
/// NOTE: Control messages could potentially add unboundedly to this, although that's
/// not likely to happen (and isn't triggereable from the network, either).
outbound: VecDeque<(bool, AnyRelayMsgOuter)>,
/// Decodes relay cells received from this hop.
inbound: RelayCellDecoder,
}
/// An indicator on what we should do when we receive a cell for a circuit.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
enum CellStatus {
/// The circuit should stay open.
Continue,
/// Perform a clean shutdown on this circuit.
CleanShutdown,
}
impl CircHop {
/// Create a new hop.
pub(super) fn new(format: RelayCellFormat, initial_window: u16) -> Self {
CircHop {
map: streammap::StreamMap::new(),
recvwindow: sendme::CircRecvWindow::new(1000),
sendwindow: sendme::CircSendWindow::new(initial_window),
outbound: VecDeque::new(),
inbound: RelayCellDecoder::new(format),
}
}
}
/// Handle to use during an ongoing protocol exchange with a circuit's last hop
///
/// This is passed to `MsgHandler::handle_msg`.
///
/// See also [`ConversationInHandler`], which is a type used for the same purpose
/// but available to the caller of `start_conversation`
//
// This is the subset of the arguments to MetaCellHandler::handle_msg
// which are needed to be able to call send_relay_cell.
#[cfg(feature = "send-control-msg")]
pub struct ConversationInHandler<'r, 'c, 'cc> {
/// Async task waker context
pub(super) cx: &'c mut Context<'cc>,
/// Reactor
pub(super) reactor: &'r mut Reactor,
/// Hop
pub(super) hop_num: HopNum,
}
/// An object that's waiting for a meta cell (one not associated with a stream) in order to make
/// progress.
///
/// # Background
///
/// The `Reactor` can't have async functions that send and receive cells, because its job is to
/// send and receive cells: if one of its functions tried to do that, it would just hang forever.
///
/// To get around this problem, the reactor can send some cells, and then make one of these
/// `MetaCellHandler` objects, which will be run when the reply arrives.
pub(super) trait MetaCellHandler: Send {
/// The hop we're expecting the message to come from. This is compared against the hop
/// from which we actually receive messages, and an error is thrown if the two don't match.
fn expected_hop(&self) -> HopNum;
/// Called when the message we were waiting for arrives.
///
/// Gets a copy of the `Reactor` in order to do anything it likes there.
///
/// If this function returns an error, the reactor will shut down.
fn handle_msg(
&mut self,
cx: &mut Context<'_>,
msg: UnparsedRelayMsg,
reactor: &mut Reactor,
) -> Result<MetaCellDisposition>;
}
/// A possible successful outcome of giving a message to a [`MsgHandler`](super::msghandler::MsgHandler).
#[derive(Debug, Clone)]
#[cfg_attr(feature = "send-control-msg", visibility::make(pub))]
#[non_exhaustive]
pub(super) enum MetaCellDisposition {
/// The message was consumed; the handler should remain installed.
#[cfg(feature = "send-control-msg")]
Consumed,
/// The message was consumed; the handler should be uninstalled.
ConversationFinished,
/// The message was consumed; the circuit should be closed.
#[cfg(feature = "send-control-msg")]
CloseCirc,
// TODO: Eventually we might want the ability to have multiple handlers
// installed, and to let them say "not for me, maybe for somebody else?".
// But right now we don't need that.
}
/// An object that can extend a circuit by one hop, using the `MetaCellHandler` trait.
///
/// Yes, I know having trait bounds on structs is bad, but in this case it's necessary
/// since we want to be able to use `H::KeyType`.
struct CircuitExtender<H, L, FWD, REV>
where
H: ClientHandshake,
{
/// The peer that we're extending to.
///
/// Used to extend our record of the circuit's path.
peer_id: OwnedChanTarget,
/// Handshake state.
state: Option<H::StateType>,
/// Parameters used for this extension.
params: CircParameters,
/// An identifier for logging about this reactor's circuit.
unique_id: UniqId,
/// The hop we're expecting the EXTENDED2 cell to come back from.
expected_hop: HopNum,
/// The relay cell format we intend to use for this hop.
relay_cell_format: RelayCellFormat,
/// A oneshot channel that we should inform when we are done with this extend operation.
operation_finished: Option<oneshot::Sender<Result<()>>>,
/// `PhantomData` used to make the other type parameters required for a circuit extension
/// part of the `struct`, instead of having them be provided during a function call.
///
/// This is done this way so we can implement `MetaCellHandler` for this type, which
/// doesn't include any generic type parameters; we need them to be part of the type
/// so we know what they are for that `impl` block.
phantom: PhantomData<(L, FWD, REV)>,
}
impl<H, L, FWD, REV> CircuitExtender<H, L, FWD, REV>
where
H: ClientHandshake + HandshakeAuxDataHandler,
H::KeyGen: KeyGenerator,
L: CryptInit + ClientLayer<FWD, REV>,
FWD: OutboundClientLayer + 'static + Send,
REV: InboundClientLayer + 'static + Send,
{
/// Start extending a circuit, sending the necessary EXTEND cell and returning a
/// new `CircuitExtender` to be called when the reply arrives.
///
/// The `handshake_id` is the numeric identifier for what kind of
/// handshake we're doing. The `key` is the relay's onion key that
/// goes along with the handshake, and the `linkspecs` are the
/// link specifiers to include in the EXTEND cell to tell the
/// current last hop which relay to connect to.
#[allow(clippy::too_many_arguments)]
#[allow(clippy::blocks_in_conditions)]
fn begin(
cx: &mut Context<'_>,
relay_cell_format: RelayCellFormat,
peer_id: OwnedChanTarget,
handshake_id: HandshakeType,
key: &H::KeyType,
linkspecs: Vec<EncodedLinkSpec>,
params: CircParameters,
client_aux_data: &impl Borrow<H::ClientAuxData>,
reactor: &mut Reactor,
done: ReactorResultChannel<()>,
) -> Result<Self> {
match (|| {
let mut rng = rand::thread_rng();
let unique_id = reactor.unique_id;
use tor_cell::relaycell::msg::Extend2;
let (state, msg) = H::client1(&mut rng, key, client_aux_data)?;
let n_hops = reactor.crypto_out.n_layers();
let hop = ((n_hops - 1) as u8).into();
trace!(
"{}: Extending circuit to hop {} with {:?}",
unique_id,
n_hops + 1,
linkspecs
);
let extend_msg = Extend2::new(linkspecs, handshake_id, msg);
let cell = AnyRelayMsgOuter::new(None, extend_msg.into());
// Send the message to the last hop...
reactor.send_relay_cell(
cx, hop, true, // use a RELAY_EARLY cell
cell,
)?;
trace!("{}: waiting for EXTENDED2 cell", unique_id);
// ... and now we wait for a response.
Ok::<CircuitExtender<_, _, _, _>, Error>(Self {
peer_id,
state: Some(state),
params,
unique_id,
expected_hop: hop,
operation_finished: None,
phantom: Default::default(),
relay_cell_format,
})
})() {
Ok(mut result) => {
result.operation_finished = Some(done);
Ok(result)
}
Err(e) => {
// It's okay if the receiver went away.
let _ = done.send(Err(e.clone()));
Err(e)
}
}
}
/// Perform the work of extending the circuit another hop.
///
/// This is a separate function to simplify the error-handling work of handle_msg().
fn extend_circuit(
&mut self,
msg: UnparsedRelayMsg,
reactor: &mut Reactor,
) -> Result<MetaCellDisposition> {
let msg = msg
.decode::<tor_cell::relaycell::msg::Extended2>()
.map_err(|e| Error::from_bytes_err(e, "extended2 message"))?
.into_msg();
let relay_handshake = msg.into_body();
trace!(
"{}: Received EXTENDED2 cell; completing handshake.",
self.unique_id
);
// Now perform the second part of the handshake, and see if it
// succeeded.
let (server_aux_data, keygen) = H::client2(
self.state
.take()
.expect("CircuitExtender::finish() called twice"),
relay_handshake,
)?;
// Handle auxiliary data returned from the server, e.g. validating that
// requested extensions have been acknowledged.
H::handle_server_aux_data(reactor, &self.params, &server_aux_data)?;
let layer = L::construct(keygen)?;
trace!("{}: Handshake complete; circuit extended.", self.unique_id);
// If we get here, it succeeded. Add a new hop to the circuit.
let (layer_fwd, layer_back, binding) = layer.split();
reactor.add_hop(
self.relay_cell_format,
path::HopDetail::Relay(self.peer_id.clone()),
Box::new(layer_fwd),
Box::new(layer_back),
Some(binding),
&self.params,
);
Ok(MetaCellDisposition::ConversationFinished)
}
}
impl<H, L, FWD, REV> MetaCellHandler for CircuitExtender<H, L, FWD, REV>
where
H: ClientHandshake + HandshakeAuxDataHandler,
H::StateType: Send,
H::KeyGen: KeyGenerator,
L: CryptInit + ClientLayer<FWD, REV> + Send,
FWD: OutboundClientLayer + 'static + Send,
REV: InboundClientLayer + 'static + Send,
{
fn expected_hop(&self) -> HopNum {
self.expected_hop
}
fn handle_msg(
&mut self,
_cx: &mut Context<'_>,
msg: UnparsedRelayMsg,
reactor: &mut Reactor,
) -> Result<MetaCellDisposition> {
let status = self.extend_circuit(msg, reactor);
if let Some(done) = self.operation_finished.take() {
// ignore it if the receiving channel went away.
let _ = done.send(status.as_ref().map(|_| ()).map_err(Clone::clone));
status
} else {
Err(Error::from(internal!(
"Passed two messages to an CircuitExtender!"
)))
}
}
}
/// Specifies handling of auxiliary handshake data for a given `ClientHandshake`.
//
// For simplicity we implement this as a trait of the handshake object itself.
// This is currently sufficient because
//
// 1. We only need or want one handler implementation for a given handshake type.
// 2. We currently don't need to keep extra state; i.e. its method doesn't take
// &self.
//
// If we end up wanting to instantiate objects for one or both of the
// `ClientHandshake` object or the `HandshakeAuxDataHandler` object, we could
// decouple them by making this something like:
//
// ```
// trait HandshakeAuxDataHandler<H> where H: ClientHandshake
// ```
trait HandshakeAuxDataHandler: ClientHandshake {
/// Handle auxiliary handshake data returned when creating or extending a
/// circuit.
fn handle_server_aux_data(
reactor: &mut Reactor,
params: &CircParameters,
data: &<Self as ClientHandshake>::ServerAuxData,
) -> Result<()>;
}
#[cfg(feature = "ntor_v3")]
impl HandshakeAuxDataHandler for NtorV3Client {
fn handle_server_aux_data(
_reactor: &mut Reactor,
_params: &CircParameters,
data: &Vec<NtorV3Extension>,
) -> Result<()> {
// There are currently no accepted server extensions,
// particularly since we don't request any extensions yet.
if !data.is_empty() {
return Err(Error::HandshakeProto(
"Received unexpected ntorv3 extension".into(),
));
}
Ok(())
}
}
impl HandshakeAuxDataHandler for NtorClient {
fn handle_server_aux_data(
_reactor: &mut Reactor,
_params: &CircParameters,
_data: &(),
) -> Result<()> {
// This handshake doesn't have any auxiliary data; nothing to do.
Ok(())
}
}
impl HandshakeAuxDataHandler for CreateFastClient {
fn handle_server_aux_data(
_reactor: &mut Reactor,
_params: &CircParameters,
_data: &(),
) -> Result<()> {
// This handshake doesn't have any auxiliary data; nothing to do.
Ok(())
}
}
/// Object to handle incoming cells and background tasks on a circuit
///
/// This type is returned when you finish a circuit; you need to spawn a
/// new task that calls `run()` on it.
#[must_use = "If you don't call run() on a reactor, the circuit won't work."]
pub struct Reactor {
/// Receiver for control messages for this reactor, sent by `ClientCirc` objects.
control: mpsc::UnboundedReceiver<CtrlMsg>,
/// Buffer for cells we can't send out the channel yet due to it being full.
///
/// We try and dequeue off this first before doing anything else, ensuring that
/// it cannot grow unboundedly (and if we start having to enqueue things on here after
/// the channel shows backpressure, we stop pulling from receivers that could send here).
///
/// NOTE: Control messages could potentially add unboundedly to this, although that's
/// not likely to happen (and isn't triggereable from the network, either).
outbound: VecDeque<AnyChanCell>,
/// The channel this circuit is using to send cells through.
channel: Channel,
/// A oneshot sender that is used to alert other tasks when this reactor is
/// finally dropped.
///
/// It is a sender for Void because we never actually want to send anything here;
/// we only want to generate canceled events.
#[allow(dead_code)] // the only purpose of this field is to be dropped.
reactor_closed_tx: oneshot::Sender<void::Void>,
/// Input stream, on which we receive ChanMsg objects from this circuit's
/// channel.
// TODO: could use a SPSC channel here instead.
input: mpsc::Receiver<ClientCircChanMsg>,
/// The cryptographic state for this circuit for inbound cells.
/// This object is divided into multiple layers, each of which is
/// shared with one hop of the circuit.
crypto_in: InboundClientCrypt,
/// The cryptographic state for this circuit for outbound cells.
crypto_out: OutboundClientCrypt,
/// List of hops state objects used by the reactor
hops: Vec<CircHop>,
/// Mutable information about this circuit, shared with
/// [`ClientCirc`](super::ClientCirc).
mutable: Arc<Mutex<MutableState>>,
/// An identifier for logging about this reactor's circuit.
unique_id: UniqId,
/// This circuit's identifier on the upstream channel.
channel_id: CircId,
/// A handler for a meta cell, together with a result channel to notify on completion.
meta_handler: Option<Box<dyn MetaCellHandler + Send>>,
/// A handler for incoming stream requests.
#[cfg(feature = "hs-service")]
incoming_stream_req_handler: Option<IncomingStreamRequestHandler>,
}
/// Information about an incoming stream request.
#[cfg(feature = "hs-service")]
#[derive(Debug)]
pub(super) struct StreamReqInfo {
/// The [`IncomingStreamRequest`].
pub(super) req: IncomingStreamRequest,
/// The ID of the stream being requested.
pub(super) stream_id: StreamId,
/// The [`HopNum`].
//
// TODO: When we add support for exit relays, we need to turn this into an Option<HopNum>.
// (For outbound messages (towards relays), there is only one hop that can send them: the client.)
//
// TODO: For onion services, we might be able to enforce the HopNum earlier: we would never accept an
// incoming stream request from two separate hops. (There is only one that's valid.)
pub(super) hop_num: HopNum,
/// A channel for receiving messages from this stream.
pub(super) receiver: mpsc::Receiver<UnparsedRelayMsg>,
/// A channel for sending messages to be sent on this stream.
pub(super) msg_tx: mpsc::Sender<AnyRelayMsg>,
}
/// Data required for handling an incoming stream request.
#[cfg(feature = "hs-service")]
#[derive(educe::Educe)]
#[educe(Debug)]
struct IncomingStreamRequestHandler {
/// A sender for sharing information about an incoming stream request.
incoming_sender: mpsc::Sender<StreamReqInfo>,
/// A [`AnyCmdChecker`] for validating incoming stream requests.
cmd_checker: AnyCmdChecker,
/// The hop to expect incoming stream requests from.
hop_num: HopNum,
/// An [`IncomingStreamRequestFilter`] for checking whether the user wants
/// this request, or wants to reject it immediately.
#[educe(Debug(ignore))]
filter: Box<dyn IncomingStreamRequestFilter>,
}
impl Reactor {
/// Create a new circuit reactor.
///
/// The reactor will send outbound messages on `channel`, receive incoming
/// messages on `input`, and identify this circuit by the channel-local
/// [`CircId`] provided.
///
/// The internal unique identifier for this circuit will be `unique_id`.
pub(super) fn new(
channel: Channel,
channel_id: CircId,
unique_id: UniqId,
input: mpsc::Receiver<ClientCircChanMsg>,
) -> (
Self,
mpsc::UnboundedSender<CtrlMsg>,
oneshot::Receiver<void::Void>,
Arc<Mutex<MutableState>>,
) {
let crypto_out = OutboundClientCrypt::new();
let (control_tx, control_rx) = mpsc::unbounded();
let path = Arc::new(path::Path::default());
let binding = Vec::new();
let mutable = Arc::new(Mutex::new(MutableState { path, binding }));
let (reactor_closed_tx, reactor_closed_rx) = oneshot::channel();
let reactor = Reactor {
control: control_rx,
reactor_closed_tx,
outbound: Default::default(),
channel,
input,
crypto_in: InboundClientCrypt::new(),
hops: vec![],
unique_id,
channel_id,
crypto_out,
meta_handler: None,
#[cfg(feature = "hs-service")]
incoming_stream_req_handler: None,
mutable: mutable.clone(),
};
(reactor, control_tx, reactor_closed_rx, mutable)
}
/// Launch the reactor, and run until the circuit closes or we
/// encounter an error.
///
/// Once this method returns, the circuit is dead and cannot be
/// used again.
pub async fn run(mut self) -> Result<()> {
trace!("{}: Running circuit reactor", self.unique_id);
let result: Result<()> = loop {
match self.run_once().await {
Ok(()) => (),
Err(ReactorError::Shutdown) => break Ok(()),
Err(ReactorError::Err(e)) => break Err(e),
}
};
trace!("{}: Circuit reactor stopped: {:?}", self.unique_id, result);
result
}
/// Helper for run: doesn't mark the circuit closed on finish. Only
/// processes one cell or control message.
async fn run_once(&mut self) -> std::result::Result<(), ReactorError> {
if self.hops.is_empty() {
self.wait_for_create().await?;
return Ok(());
}
#[allow(clippy::cognitive_complexity)]
let fut = futures::future::poll_fn(|cx| -> Poll<std::result::Result<_, ReactorError>> {
let mut did_things = false;
// Check whether we've got a control message pending.
if let Poll::Ready(ret) = Pin::new(&mut self.control).poll_next(cx) {
match ret {
None => {
trace!("{}: reactor shutdown due to control drop", self.unique_id);
return Poll::Ready(Err(ReactorError::Shutdown));
}
Some(CtrlMsg::Shutdown) => return Poll::Ready(self.handle_shutdown()),
Some(msg) => {
self.handle_control(cx, msg)?;
did_things = true;
}
}
}
// Check whether we've got an input message pending.
if let Poll::Ready(ret) = Pin::new(&mut self.input).poll_next(cx) {
match ret {
None => {
trace!("{}: reactor shutdown due to input drop", self.unique_id);
return Poll::Ready(Err(ReactorError::Shutdown));
}
Some(cell) => {
if self.handle_cell(cx, cell)? == CellStatus::CleanShutdown {
trace!("{}: reactor shutdown due to handled cell", self.unique_id);
return Poll::Ready(Err(ReactorError::Shutdown));
}
did_things = true;
}
}
}
// Now for the tricky part. We want to grab some relay cells from all of our streams
// and forward them on to the channel, but we need to pay attention to both whether
// the channel can accept cells right now, and whether congestion control allows us
// to send them.
//
// We also have to do somewhat cursed things and call start_send inside this poll_fn,
// since we need to check whether the channel can still receive cells after each one
// that we send.
let mut streams_to_close = vec![];
let mut stream_relaycells = vec![];
// Is the channel ready to receive anything at all?
if self.channel.poll_ready(cx)? {
// (using this as a named block for early returns; not actually a loop)
#[allow(clippy::never_loop)]
'outer: loop {
// First, drain our queue of things we tried to send earlier, but couldn't.
while let Some(msg) = self.outbound.pop_front() {
trace!("{}: sending from enqueued: {:?}", self.unique_id, msg);
Pin::new(&mut self.channel).start_send(msg)?;
// `futures::Sink::start_send` dictates we need to call `poll_ready` before
// each `start_send` call.
if !self.channel.poll_ready(cx)? {
break 'outer;
}
}
// Let's look at our hops, and streams for each hop.
for i in 0..self.hops.len() {
let hop_num = HopNum::from(i as u8);
// If we can, drain our queue of things we tried to send earlier, but
// couldn't due to congestion control.
if self.hops[i].sendwindow.window() > 0 {
'hop: while let Some((early, cell)) = self.hops[i].outbound.pop_front()
{
trace!(
"{}: sending from hop-{}-enqueued: {:?}",
self.unique_id,
i,
cell
);
// We know the stream has a non-empty SENDME
// window because we accept at most one cell per
// stream below, and only when the relevant
// stream has a non-empty window and after
// clearing the backlog here.
//
// TODO prop340: We need to be careful here when
// adding fragmentation; e.g. this argument
// fails to hold if we allow later breaking a
// DATA message into multiple messages and cells
// for packing.
self.send_relay_cell(cx, hop_num, early, cell)?;
if !self.channel.poll_ready(cx)? {
break 'outer;
}
if self.hops[i].sendwindow.window() == 0 {
break 'hop;
}
}
}
let hop = &mut self.hops[i];
// Look at all of the streams on this hop.
for (id, stream) in hop.map.iter_mut() {
if let StreamEntMut::Open(OpenStreamEnt {
rx, send_window, ..
}) = stream
{
// Do the stream and hop send windows allow us to obtain and
// send something?
//
// NOTE: not everything counts toward congestion
// control. However, we can't easily remove
// this check:
// * We need to be careful not to buffer more
// than ONE message per stream for the call to
// `send_relay_cell` above, and potentially
// closing the stream below, to be correct.
// * We need to be careful about allowing
// messages that *don't* count to be sent before
// messages that *do*; e.g. we wouldn't want to
// accept and send an END message on a stream where we
// still have DATA messages queued.
if send_window.window() > 0 && hop.sendwindow.window() > 0 {
match Pin::new(rx).poll_next(cx) {
Poll::Ready(Some(m)) => {
stream_relaycells.push((
hop_num,
AnyRelayMsgOuter::new(Some(id), m),
));
}
Poll::Ready(None) => {
// Stream receiver was dropped; close the stream.
//
// We know there are no queued messages for the stream
// since we already flushed above.
//
// We can't close it here due to
// borrowck; that will happen later.
streams_to_close.push((hop_num, id));
}
Poll::Pending => {}
}
}
}
}
}
break;
}
}
// Close the streams we said we'd close.
for (hopn, id) in streams_to_close {
self.close_stream(
cx,
hopn,
id,
CloseStreamBehavior::default(),
streammap::TerminateReason::StreamTargetClosed,
)?;
did_things = true;
}
// Send messages we said we'd send.
for (hopn, rc) in stream_relaycells {
self.send_relay_cell(cx, hopn, false, rc)?;
did_things = true;
}
let _ = Pin::new(&mut self.channel)
.poll_flush(cx)
.map_err(|_| ChannelClosed)?;
if did_things {
Poll::Ready(Ok(()))
} else {
Poll::Pending
}
});
fut.await?;
Ok(())
}
/// Wait for a [`CtrlMsg::Create`] to come along to set up the circuit.
///
/// Returns an error if an unexpected `CtrlMsg` is received.
async fn wait_for_create(&mut self) -> std::result::Result<(), ReactorError> {
let Some(msg) = self.control.next().await else {
trace!("{}: reactor shutdown due to control drop", self.unique_id);
return Err(ReactorError::Shutdown);
};
match msg {
CtrlMsg::Create {
recv_created,
handshake,
params,
done,
} => {
self.handle_create(recv_created, handshake, ¶ms, done)
.await
}
CtrlMsg::Shutdown => self.handle_shutdown(),
#[cfg(test)]
CtrlMsg::AddFakeHop {
relay_cell_format: format,
fwd_lasthop,
rev_lasthop,
params,
done,
} => {
self.handle_add_fake_hop(format, fwd_lasthop, rev_lasthop, ¶ms, done);
Ok(())
}
_ => {
trace!("reactor shutdown due to unexpected cell: {:?}", msg);
Err(Error::CircProto(format!("Unexpected {msg:?} cell on client circuit")).into())
}
}
}
/// Handle a [`CtrlMsg::Create`] message.
async fn handle_create(
&mut self,
recv_created: oneshot::Receiver<CreateResponse>,
handshake: CircuitHandshake,
params: &CircParameters,
done: ReactorResultChannel<()>,
) -> std::result::Result<(), ReactorError> {
let ret = match handshake {
CircuitHandshake::CreateFast => self.create_firsthop_fast(recv_created, params).await,
CircuitHandshake::Ntor {
public_key,
ed_identity,
} => {
self.create_firsthop_ntor(recv_created, ed_identity, public_key, params)
.await
}
#[cfg(feature = "ntor_v3")]
CircuitHandshake::NtorV3 { public_key } => {
self.create_firsthop_ntor_v3(recv_created, public_key, params)
.await
}
};
let _ = done.send(ret); // don't care if sender goes away
futures::future::poll_fn(|cx| -> Poll<Result<()>> {
let _ = Pin::new(&mut self.channel)
.poll_flush(cx)
.map_err(|_| ChannelClosed)?;
Poll::Ready(Ok(()))
})
.await?;
Ok(())
}
/// Handle a [`CtrlMsg::Shutdown`] message.
fn handle_shutdown(&self) -> std::result::Result<(), ReactorError> {
trace!(
"{}: reactor shutdown due to explicit request",
self.unique_id
);
Err(ReactorError::Shutdown)
}
/// Handle a [`CtrlMsg::AddFakeHop`] message.
#[cfg(test)]
fn handle_add_fake_hop(
&mut self,
format: RelayCellFormat,
fwd_lasthop: bool,
rev_lasthop: bool,
params: &CircParameters,
done: ReactorResultChannel<()>,
) {
use crate::circuit::test::DummyCrypto;
let dummy_peer_id = OwnedChanTarget::builder()
.ed_identity([4; 32].into())
.rsa_identity([5; 20].into())
.build()
.expect("Could not construct fake hop");
let fwd = Box::new(DummyCrypto::new(fwd_lasthop));
let rev = Box::new(DummyCrypto::new(rev_lasthop));
let binding = None;
self.add_hop(
format,
path::HopDetail::Relay(dummy_peer_id),
fwd,
rev,
binding,
params,
);
let _ = done.send(Ok(()));
}
/// Helper: create the first hop of a circuit.
///
/// This is parameterized not just on the RNG, but a wrapper object to
/// build the right kind of create cell, and a handshake object to perform
/// the cryptographic handshake.
async fn create_impl<H, W, M>(
&mut self,
cell_protocol: RelayCryptLayerProtocol,
recvcreated: oneshot::Receiver<CreateResponse>,
wrap: &W,
key: &H::KeyType,
params: &CircParameters,
msg: &M,
) -> Result<()>
where
H: ClientHandshake + HandshakeAuxDataHandler,
W: CreateHandshakeWrap,
H::KeyGen: KeyGenerator,
M: Borrow<H::ClientAuxData>,
{
// We don't need to shut down the circuit on failure here, since this
// function consumes the PendingClientCirc and only returns
// a ClientCirc on success.
let (state, msg) = {
// done like this because holding the RNG across an await boundary makes the future
// non-Send
let mut rng = rand::thread_rng();
H::client1(&mut rng, key, msg)?
};
let create_cell = wrap.to_chanmsg(msg);
trace!(
"{}: Extending to hop 1 with {}",
self.unique_id,
create_cell.cmd()
);
self.send_msg(create_cell).await?;
let reply = recvcreated
.await
.map_err(|_| Error::CircProto("Circuit closed while waiting".into()))?;
let relay_handshake = wrap.decode_chanmsg(reply)?;
let (server_msg, keygen) = H::client2(state, relay_handshake)?;
H::handle_server_aux_data(self, params, &server_msg)?;
let relay_cell_format = cell_protocol.relay_cell_format();
let BoxedClientLayer { fwd, back, binding } =
cell_protocol.construct_layers(HandshakeRole::Initiator, keygen)?;
trace!("{}: Handshake complete; circuit created.", self.unique_id);
let peer_id = self.channel.target().clone();
self.add_hop(
relay_cell_format,
path::HopDetail::Relay(peer_id),
fwd,
back,
binding,
params,
);
Ok(())
}
/// Use the (questionable!) CREATE_FAST handshake to connect to the
/// first hop of this circuit.
///
/// There's no authentication in CREATE_FAST,
/// so we don't need to know whom we're connecting to: we're just
/// connecting to whichever relay the channel is for.
async fn create_firsthop_fast(
&mut self,
recvcreated: oneshot::Receiver<CreateResponse>,
params: &CircParameters,
) -> Result<()> {
// In a CREATE_FAST handshake, we can't negotiate a format other than this.
let protocol = RelayCryptLayerProtocol::Tor1(RelayCellFormat::V0);
let wrap = CreateFastWrap;
self.create_impl::<CreateFastClient, _, _>(protocol, recvcreated, &wrap, &(), params, &())
.await
}
/// Use the ntor handshake to connect to the first hop of this circuit.
///
/// Note that the provided keys must match the channel's target,
/// or the handshake will fail.
async fn create_firsthop_ntor(
&mut self,
recvcreated: oneshot::Receiver<CreateResponse>,
ed_identity: pk::ed25519::Ed25519Identity,
pubkey: NtorPublicKey,
params: &CircParameters,
) -> Result<()> {
// In an ntor handshake, we can't negotiate a format other than this.
let relay_cell_protocol = RelayCryptLayerProtocol::Tor1(RelayCellFormat::V0);
// Exit now if we have an Ed25519 or RSA identity mismatch.
let target = RelayIds::builder()
.ed_identity(ed_identity)
.rsa_identity(pubkey.id)
.build()
.expect("Unable to build RelayIds");
self.channel.check_match(&target)?;
let wrap = Create2Wrap {
handshake_type: HandshakeType::NTOR,
};
self.create_impl::<NtorClient, _, _>(
relay_cell_protocol,
recvcreated,
&wrap,
&pubkey,
params,
&(),
)
.await
}
/// Use the ntor-v3 handshake to connect to the first hop of this circuit.
///
/// Note that the provided key must match the channel's target,
/// or the handshake will fail.
#[cfg(feature = "ntor_v3")]
async fn create_firsthop_ntor_v3(
&mut self,
recvcreated: oneshot::Receiver<CreateResponse>,
pubkey: NtorV3PublicKey,
params: &CircParameters,
) -> Result<()> {
// Exit now if we have a mismatched key.
let target = RelayIds::builder()
.ed_identity(pubkey.id)
.build()
.expect("Unable to build RelayIds");
self.channel.check_match(&target)?;
// TODO: Add support for negotiating other formats.
let relay_cell_protocol = RelayCryptLayerProtocol::Tor1(RelayCellFormat::V0);
// TODO: Set client extensions. e.g. request congestion control
// if specified in `params`.
let client_extensions = [];
let wrap = Create2Wrap {
handshake_type: HandshakeType::NTOR_V3,
};
self.create_impl::<NtorV3Client, _, _>(
relay_cell_protocol,
recvcreated,
&wrap,
&pubkey,
params,
&client_extensions,
)
.await
}
/// Add a hop to the end of this circuit.
fn add_hop(
&mut self,
format: RelayCellFormat,
peer_id: path::HopDetail,
fwd: Box<dyn OutboundClientLayer + 'static + Send>,
rev: Box<dyn InboundClientLayer + 'static + Send>,
binding: Option<CircuitBinding>,
params: &CircParameters,
) {
let hop = crate::circuit::reactor::CircHop::new(format, params.initial_send_window());
self.hops.push(hop);
self.crypto_in.add_layer(rev);
self.crypto_out.add_layer(fwd);
let mut mutable = self.mutable.lock().expect("poisoned lock");
Arc::make_mut(&mut mutable.path).push_hop(peer_id);
mutable.binding.push(binding);
}
/// Handle a RELAY cell on this circuit with stream ID 0.
fn handle_meta_cell(
&mut self,
cx: &mut Context<'_>,
hopnum: HopNum,
msg: UnparsedRelayMsg,
) -> Result<CellStatus> {
// SENDME cells and TRUNCATED get handled internally by the circuit.
// TODO: This pattern (Check command, try to decode, map error) occurs
// several times, and would be good to extract simplify. Such
// simplification is obstructed by a couple of factors: First, that
// there is not currently a good way to get the RelayCmd from _type_ of
// a RelayMsg. Second, that decode() [correctly] consumes the
// UnparsedRelayMsg. I tried a macro-based approach, and didn't care
// for it. -nickm
if msg.cmd() == RelayCmd::SENDME {
let sendme = msg
.decode::<Sendme>()
.map_err(|e| Error::from_bytes_err(e, "sendme message"))?
.into_msg();
return self.handle_sendme(hopnum, sendme);
}
if msg.cmd() == RelayCmd::TRUNCATED {
let truncated = msg
.decode::<tor_cell::relaycell::msg::Truncated>()
.map_err(|e| Error::from_bytes_err(e, "truncated message"))?
.into_msg();
let reason = truncated.reason();
debug!(
"{}: Truncated from hop {}. Reason: {} [{}]",
self.unique_id,
hopnum.display(),
reason.human_str(),
reason
);
return Ok(CellStatus::CleanShutdown);
}
trace!("{}: Received meta-cell {:?}", self.unique_id, msg);
// For all other command types, we'll only get them in response
// to another command, which should have registered a responder.
//
// TODO: that means that service-introduction circuits will need
// a different implementation, but that should be okay. We'll work
// something out.
if let Some(mut handler) = self.meta_handler.take() {
if handler.expected_hop() == hopnum {
// Somebody was waiting for a message -- maybe this message
let ret = handler.handle_msg(cx, msg, self);
trace!(
"{}: meta handler completed with result: {:?}",
self.unique_id,
ret
);
match ret {
#[cfg(feature = "send-control-msg")]
Ok(MetaCellDisposition::Consumed) => {
self.meta_handler = Some(handler);
Ok(CellStatus::Continue)
}
Ok(MetaCellDisposition::ConversationFinished) => Ok(CellStatus::Continue),
#[cfg(feature = "send-control-msg")]
Ok(MetaCellDisposition::CloseCirc) => Ok(CellStatus::CleanShutdown),
Err(e) => Err(e),
}
} else {
// Somebody wanted a message from a different hop! Put this
// one back.
self.meta_handler = Some(handler);
Err(Error::CircProto(format!(
"Unexpected {} cell from hop {} on client circuit",
msg.cmd(),
hopnum.display(),
)))
}
} else {
// No need to call shutdown here, since this error will
// propagate to the reactor shut it down.
Err(Error::CircProto(format!(
"Unexpected {} cell on client circuit",
msg.cmd()
)))
}
}
/// Handle a RELAY_SENDME cell on this circuit with stream ID 0.
fn handle_sendme(&mut self, hopnum: HopNum, msg: Sendme) -> Result<CellStatus> {
// No need to call "shutdown" on errors in this function;
// it's called from the reactor task and errors will propagate there.
let hop = self
.hop_mut(hopnum)
.ok_or_else(|| Error::CircProto(format!("Couldn't find hop {}", hopnum.display())))?;
let auth: Option<[u8; 20]> = match msg.into_tag() {
Some(v) => {
if let Ok(tag) = <[u8; 20]>::try_from(v) {
Some(tag)
} else {
return Err(Error::CircProto("malformed tag on circuit sendme".into()));
}
}
None => {
// Versions of Tor <=0.3.5 would omit a SENDME tag in this case;
// but we don't support those any longer.
return Err(Error::CircProto("missing tag on circuit sendme".into()));
}
};
hop.sendwindow.put(auth)?;
Ok(CellStatus::Continue)
}
/// Send a message onto the circuit's channel (to be called with a `Context`)
///
/// If the channel is ready to accept messages, it will be sent immediately. If not, the message
/// will be enqueued for sending at a later iteration of the reactor loop.
///
/// # Note
///
/// Making use of the enqueuing capabilities of this function is discouraged! You should first
/// check whether the channel is ready to receive messages (`self.channel.poll_ready`), and
/// ideally use this to implement backpressure (such that you do not read from other sources
/// that would send here while you know you're unable to forward the messages on).
fn send_msg_direct(&mut self, cx: &mut Context<'_>, msg: AnyChanMsg) -> Result<()> {
let cell = AnyChanCell::new(Some(self.channel_id), msg);
// NOTE(eta): We need to check whether the outbound queue is empty before trying to send:
// if we just checked whether the channel was ready, it'd be possible for
// cells to be sent out of order, since it could transition from not ready to
// ready during one cycle of the reactor!
// (This manifests as a protocol violation.)
if self.outbound.is_empty() && self.channel.poll_ready(cx)? {
Pin::new(&mut self.channel).start_send(cell)?;
} else {
// This has been observed to happen in code that doesn't have bugs in it, simply due
// to the way `Channel`'s `poll_ready` implementation works (it can change due to
// the actions of another thread in between callers of this function checking it,
// and this function checking it).
//
// However, if it's happening a lot more than it used to, that probably indicates
// some caller that's not checking whether the channel is full before calling
// this function.
debug!(
"{}: having to enqueue cell due to backpressure: {:?}",
self.unique_id, cell
);
self.outbound.push_back(cell);
// Ensure we absolutely get scheduled again to clear `self.outbound`.
cx.waker().wake_by_ref();
}
Ok(())
}
/// Wrapper around `send_msg_direct` that uses `futures::future::poll_fn` to get a `Context`.
async fn send_msg(&mut self, msg: AnyChanMsg) -> Result<()> {
// HACK(eta): technically the closure passed to `poll_fn` is a `FnMut` closure, since it
// can be polled multiple times.
// We're going to return Ready immediately since we're only using `poll_fn` to
// get a `Context`, but the compiler doesn't know that, so use an `Option`
// which we can `take()` in order to move out of it.
// (if we do get polled again this'll panic, but that shouldn't happen!)
let mut msg = Some(msg);
futures::future::poll_fn(|cx| -> Poll<Result<()>> {
self.send_msg_direct(cx, msg.take().expect("poll_fn called twice?"))?;
Poll::Ready(Ok(()))
})
.await?;
Ok(())
}
/// Encode `msg`, encrypt it, and send it to the 'hop'th hop.
///
/// If there is insufficient outgoing *circuit-level* SENDME window, the
/// `msg` is enqueued in the hop's `outbound` queue instead.
///
/// If there is insufficient outgoing *stream-level* SENDME window,
/// an error is returned instead.
///
/// Does not check whether the cell is well-formed or reasonable.
fn send_relay_cell(
&mut self,
cx: &mut Context<'_>,
hop: HopNum,
early: bool,
msg: AnyRelayMsgOuter,
) -> Result<()> {
let c_t_w = sendme::cmd_counts_towards_windows(msg.cmd());
let stream_id = msg.stream_id();
// Check whether the hop send window is empty, if this cell counts towards windows.
// NOTE(eta): It is imperative this happens *before* calling encrypt() below, otherwise
// we'll have cells rejected due to a protocol violation! (Cells have to be
// sent out in the order they were passed to encrypt().)
if c_t_w {
let hop_num = Into::<usize>::into(hop);
let circhop = &mut self.hops[hop_num];
if circhop.sendwindow.window() == 0 {
// Send window is empty! Push this cell onto the hop's outbound queue, and it'll
// get sent later.
trace!(
"{}: having to use onto hop {} queue for cell: {:?}",
self.unique_id,
hop.display(),
msg
);
circhop.outbound.push_back((early, msg));
return Ok(());
}
}
let mut body: RelayCellBody = msg
.encode(&mut rand::thread_rng())
.map_err(|e| Error::from_cell_enc(e, "relay cell body"))?
.into();
let tag = self.crypto_out.encrypt(&mut body, hop)?;
// NOTE(eta): Now that we've encrypted the cell, we *must* either send it or abort
// the whole circuit (e.g. by returning an error).
let msg = chancell::msg::Relay::from(BoxedCellBody::from(body));
let msg = if early {
AnyChanMsg::RelayEarly(msg.into())
} else {
AnyChanMsg::Relay(msg)
};
// If the cell counted towards our sendme window, decrement
// that window, and maybe remember the authentication tag.
if c_t_w {
let hop_num = Into::<usize>::into(hop);
let hop = &mut self.hops[hop_num];
// checked by earlier conditional, so this shouldn't fail
hop.sendwindow.take(tag)?;
if let Some(stream_id) = stream_id {
// We need to decrement the stream-level sendme window.
// Stream data cells should only be dequeued and fed into this function if
// the window is above zero, so we don't need to worry about
// enqueuing things.
match hop.map.get_mut(stream_id) {
Some(StreamEntMut::Open(OpenStreamEnt { send_window, .. })) => {
send_window.take(&())?;
}
_ => {
warn!(
"{}: sending a relay cell for non-existent or non-open stream with ID {}!",
self.unique_id, stream_id
);
return Err(Error::CircProto(format!(
"tried to send a relay cell on non-open stream {}",
sv(stream_id),
)));
}
}
}
}
self.send_msg_direct(cx, msg)
}
/// Try to install a given meta-cell handler to receive any unusual cells on
/// this circuit, along with a result channel to notify on completion.
fn set_meta_handler(&mut self, handler: Box<dyn MetaCellHandler + Send>) -> Result<()> {
if self.meta_handler.is_none() {
self.meta_handler = Some(handler);
Ok(())
} else {
Err(Error::from(internal!(
"Tried to install a meta-cell handler before the old one was gone."
)))
}
}
/// Try to install a given cell handler on this circuit.
#[cfg(feature = "hs-service")]
fn set_incoming_stream_req_handler(
&mut self,
handler: IncomingStreamRequestHandler,
) -> Result<()> {
if self.incoming_stream_req_handler.is_none() {
self.incoming_stream_req_handler = Some(handler);
Ok(())
} else {
Err(Error::from(internal!(
"Tried to install a BEGIN cell handler before the old one was gone."
)))
}
}
/// Handle a CtrlMsg other than Create and Shutdown.
fn handle_control(&mut self, cx: &mut Context<'_>, msg: CtrlMsg) -> Result<()> {
trace!("{}: reactor received {:?}", self.unique_id, msg);
match msg {
// This is handled earlier, since it requires blocking.
CtrlMsg::Create { .. } => panic!("got a CtrlMsg::Create in handle_control"),
// This is handled earlier, since it requires generating a ReactorError.
CtrlMsg::Shutdown => panic!("got a CtrlMsg::Shutdown in handle_control"),
CtrlMsg::ExtendNtor {
peer_id,
public_key,
linkspecs,
params,
done,
} => {
// ntor handshake only supports V0.
/// Local type alias to ensure consistency below.
type Rcf = RelayCellFormatV0;
let extender = CircuitExtender::<NtorClient, Tor1RelayCrypto<Rcf>, _, _>::begin(
cx,
Rcf::FORMAT,
peer_id,
HandshakeType::NTOR,
&public_key,
linkspecs,
params,
&(),
self,
done,
)?;
self.set_meta_handler(Box::new(extender))?;
}
#[cfg(feature = "ntor_v3")]
CtrlMsg::ExtendNtorV3 {
peer_id,
public_key,
linkspecs,
params,
done,
} => {
// TODO #1067: support negotiating other formats.
/// Local type alias to ensure consistency below.
type Rcf = RelayCellFormatV0;
// TODO: Set extensions, e.g. based on `params`.
let client_extensions = [];
let extender = CircuitExtender::<NtorV3Client, Tor1RelayCrypto<Rcf>, _, _>::begin(
cx,
Rcf::FORMAT,
peer_id,
HandshakeType::NTOR_V3,
&public_key,
linkspecs,
params,
&client_extensions,
self,
done,
)?;
self.set_meta_handler(Box::new(extender))?;
}
#[cfg(feature = "hs-common")]
#[allow(unreachable_code)]
CtrlMsg::ExtendVirtual {
relay_cell_format: format,
cell_crypto,
params,
done,
} => {
let (outbound, inbound, binding) = cell_crypto;
// TODO HS: Perhaps this should describe the onion service, or
// describe why the virtual hop was added, or something?
let peer_id = path::HopDetail::Virtual;
self.add_hop(format, peer_id, outbound, inbound, binding, ¶ms);
let _ = done.send(Ok(()));
}
CtrlMsg::BeginStream {
hop_num,
message,
sender,
rx,
done,
cmd_checker,
} => {
let ret = self.begin_stream(cx, hop_num, message, sender, rx, cmd_checker);
let _ = done.send(ret); // don't care if sender goes away
}
#[cfg(feature = "hs-service")]
CtrlMsg::ClosePendingStream {
hop_num,
stream_id,
message,
done,
} => {
let ret = self.close_stream(
cx,
hop_num,
stream_id,
message,
streammap::TerminateReason::ExplicitEnd,
)?;
let _ = done.send(Ok(ret)); // don't care if sender goes away
}
#[cfg(feature = "hs-service")]
CtrlMsg::AwaitStreamRequest {
cmd_checker,
incoming_sender,
hop_num,
done,
filter,
} => {
// TODO: At some point we might want to add a CtrlMsg for
// de-registering the handler. See comments on `allow_stream_requests`.
let handler = IncomingStreamRequestHandler {
incoming_sender,
cmd_checker,
hop_num,
filter,
};
let ret = self.set_incoming_stream_req_handler(handler);
let _ = done.send(ret); // don't care if the corresponding receiver goes away.
}
CtrlMsg::SendSendme { stream_id, hop_num } => {
let sendme = Sendme::new_empty();
let cell = AnyRelayMsgOuter::new(Some(stream_id), sendme.into());
self.send_relay_cell(cx, hop_num, false, cell)?;
}
#[cfg(feature = "send-control-msg")]
CtrlMsg::SendMsg {
hop_num,
msg,
sender,
} => {
let cell = AnyRelayMsgOuter::new(None, msg);
let outcome = self.send_relay_cell(cx, hop_num, false, cell);
let _ = sender.send(outcome.clone()); // don't care if receiver goes away.
outcome?;
}
#[cfg(feature = "send-control-msg")]
CtrlMsg::SendMsgAndInstallHandler {
msg,
handler,
sender,
} => {
let outcome: Result<()> = (|| {
if let Some(msg) = msg {
let handler = handler
.as_ref()
.or(self.meta_handler.as_ref())
.ok_or_else(|| internal!("tried to use an ended Conversation"))?;
self.send_relay_cell(cx, handler.expected_hop(), false, msg)?;
}
if let Some(handler) = handler {
self.set_meta_handler(handler)?;
}
Ok(())
})();
let _ = sender.send(outcome.clone()); // don't care if receiver goes away.
outcome?;
}
#[cfg(test)]
CtrlMsg::AddFakeHop {
relay_cell_format,
fwd_lasthop,
rev_lasthop,
params,
done,
} => {
self.handle_add_fake_hop(
relay_cell_format,
fwd_lasthop,
rev_lasthop,
¶ms,
done,
);
}
#[cfg(test)]
CtrlMsg::QuerySendWindow { hop, done } => {
let _ = done.send(if let Some(hop) = self.hop_mut(hop) {
Ok(hop.sendwindow.window_and_expected_tags())
} else {
Err(Error::from(internal!(
"received QuerySendWindow for unknown hop {}",
hop.display()
)))
});
}
#[cfg(test)]
CtrlMsg::SendRelayCell { hop, early, cell } => {
self.send_relay_cell(cx, hop, early, cell)?;
}
}
Ok(())
}
/// Start a stream. Creates an entry in the stream map with the given channels, and sends the
/// `message` to the provided hop.
fn begin_stream(
&mut self,
cx: &mut Context<'_>,
hopnum: HopNum,
message: AnyRelayMsg,
sender: mpsc::Sender<UnparsedRelayMsg>,
rx: mpsc::Receiver<AnyRelayMsg>,
cmd_checker: AnyCmdChecker,
) -> Result<StreamId> {
let hop = self
.hop_mut(hopnum)
.ok_or_else(|| Error::from(internal!("No such hop {}", hopnum.display())))?;
let send_window = StreamSendWindow::new(SEND_WINDOW_INIT);
let r = hop.map.add_ent(sender, rx, send_window, cmd_checker)?;
let cell = AnyRelayMsgOuter::new(Some(r), message);
self.send_relay_cell(cx, hopnum, false, cell)?;
Ok(r)
}
/// Close the stream associated with `id` because the stream was
/// dropped.
///
/// If we have not already received an END cell on this stream, send one.
/// If no END cell is specified, an END cell with the reason byte set to
/// REASON_MISC will be sent.
fn close_stream(
&mut self,
cx: &mut Context<'_>,
hopnum: HopNum,
id: StreamId,
message: CloseStreamBehavior,
why: streammap::TerminateReason,
) -> Result<()> {
// Mark the stream as closing.
let hop = self.hop_mut(hopnum).ok_or_else(|| {
Error::from(internal!(
"Tried to close a stream on a hop {:?} that wasn't there?",
hopnum
))
})?;
let should_send_end = hop.map.terminate(id, why)?;
trace!(
"{}: Ending stream {}; should_send_end={:?}",
self.unique_id,
id,
should_send_end
);
// TODO: I am about 80% sure that we only send an END cell if
// we didn't already get an END cell. But I should double-check!
if let (ShouldSendEnd::Send, CloseStreamBehavior::SendEnd(end_message)) =
(should_send_end, message)
{
let end_cell = AnyRelayMsgOuter::new(Some(id), end_message.into());
self.send_relay_cell(cx, hopnum, false, end_cell)?;
}
Ok(())
}
/// Helper: process a cell on a channel. Most cells get ignored
/// or rejected; a few get delivered to circuits.
///
/// Return true if we should exit.
fn handle_cell(&mut self, cx: &mut Context<'_>, cell: ClientCircChanMsg) -> Result<CellStatus> {
trace!("{}: handling cell: {:?}", self.unique_id, cell);
use ClientCircChanMsg::*;
match cell {
Relay(r) => Ok(self.handle_relay_cell(cx, r)?),
Destroy(d) => {
let reason = d.reason();
debug!(
"{}: Received DESTROY cell. Reason: {} [{}]",
self.unique_id,
reason.human_str(),
reason
);
self.handle_destroy_cell()?;
Ok(CellStatus::CleanShutdown)
}
}
}
/// React to a Relay or RelayEarly cell.
fn handle_relay_cell(&mut self, cx: &mut Context<'_>, cell: Relay) -> Result<CellStatus> {
let mut body = cell.into_relay_body().into();
// Decrypt the cell. If it's recognized, then find the
// corresponding hop.
let (hopnum, tag) = self.crypto_in.decrypt(&mut body)?;
// Make a copy of the authentication tag. TODO: I'd rather not
// copy it, but I don't see a way around it right now.
let tag = {
let mut tag_copy = [0_u8; 20];
// TODO(nickm): This could crash if the tag length changes. We'll
// have to refactor it then.
tag_copy.copy_from_slice(tag);
tag_copy
};
// Decode the cell.
let decode_res = self
.hop_mut(hopnum)
.ok_or_else(|| {
Error::from(internal!(
"Trying to decode cell from nonexistent hop {:?}",
hopnum
))
})?
.inbound
.decode(body.into())
.map_err(|e| Error::from_bytes_err(e, "relay cell"))?;
let c_t_w = decode_res.cmds().any(sendme::cmd_counts_towards_windows);
// Decrement the circuit sendme windows, and see if we need to
// send a sendme cell.
let send_circ_sendme = if c_t_w {
let hop = self
.hop_mut(hopnum)
.ok_or_else(|| Error::CircProto("Sendme from nonexistent hop".into()))?;
hop.recvwindow.take()?
} else {
false
};
// If we do need to send a circuit-level SENDME cell, do so.
if send_circ_sendme {
// This always sends a V1 (tagged) sendme cell, and thereby assumes
// that SendmeEmitMinVersion is no more than 1. If the authorities
// every increase that parameter to a higher number, this will
// become incorrect. (Higher numbers are not currently defined.)
let sendme = Sendme::new_tag(tag);
let cell = AnyRelayMsgOuter::new(None, sendme.into());
self.send_relay_cell(cx, hopnum, false, cell)?;
self.hop_mut(hopnum)
.ok_or_else(|| {
Error::from(internal!(
"Trying to send SENDME to nonexistent hop {:?}",
hopnum
))
})?
.recvwindow
.put();
}
let (mut msgs, incomplete) = decode_res.into_parts();
while let Some(msg) = msgs.next() {
let msg_status = self.handle_relay_msg(cx, hopnum, c_t_w, msg)?;
match msg_status {
CellStatus::Continue => (),
CellStatus::CleanShutdown => {
for msg in msgs {
debug!(
"{id}: Ignoring relay msg received after triggering shutdown: {msg:?}",
id = self.unique_id
);
}
if let Some(incomplete) = incomplete {
debug!("{id}: Ignoring parial relay msg received after triggering shutdown: {incomplete:?}", id=self.unique_id);
}
return Ok(CellStatus::CleanShutdown);
}
}
}
Ok(CellStatus::Continue)
}
/// Handle a single incoming relay message.
fn handle_relay_msg(
&mut self,
cx: &mut Context<'_>,
hopnum: HopNum,
cell_counts_toward_windows: bool,
msg: UnparsedRelayMsg,
) -> Result<CellStatus> {
// If this msg wants/refuses to have a Stream ID, does it
// have/not have one?
let cmd = msg.cmd();
let streamid = msg.stream_id();
if !cmd.accepts_streamid_val(streamid) {
return Err(Error::CircProto(format!(
"Invalid stream ID {} for relay command {}",
sv(StreamId::get_or_zero(streamid)),
msg.cmd()
)));
}
// If this doesn't have a StreamId, it's a meta cell,
// not meant for a particular stream.
let Some(streamid) = streamid else {
return self.handle_meta_cell(cx, hopnum, msg);
};
let hop = self
.hop_mut(hopnum)
.ok_or_else(|| Error::CircProto("Cell from nonexistent hop!".into()))?;
match hop.map.get_mut(streamid) {
Some(StreamEntMut::Open(OpenStreamEnt {
sink,
send_window,
dropped,
cmd_checker,
..
})) => {
// The stream for this message exists, and is open.
if msg.cmd() == RelayCmd::SENDME {
let _sendme = msg
.decode::<Sendme>()
.map_err(|e| Error::from_bytes_err(e, "Sendme message on stream"))?
.into_msg();
// We need to handle sendmes here, not in the stream's
// recv() method, or else we'd never notice them if the
// stream isn't reading.
send_window.put(Some(()))?;
return Ok(CellStatus::Continue);
}
let message_closes_stream = cmd_checker.check_msg(&msg)? == StreamStatus::Closed;
if let Err(e) = sink.try_send(msg) {
if e.is_full() {
// If we get here, we either have a logic bug (!), or an attacker
// is sending us more cells than we asked for via congestion control.
return Err(Error::CircProto(format!(
"Stream sink would block; received too many cells on stream ID {}",
sv(streamid),
)));
}
if e.is_disconnected() && cell_counts_toward_windows {
// the other side of the stream has gone away; remember
// that we received a cell that we couldn't queue for it.
//
// Later this value will be recorded in a half-stream.
*dropped += 1;
}
}
if message_closes_stream {
hop.map.ending_msg_received(streamid)?;
}
}
#[cfg(feature = "hs-service")]
Some(StreamEntMut::EndSent(_))
if matches!(
msg.cmd(),
RelayCmd::BEGIN | RelayCmd::BEGIN_DIR | RelayCmd::RESOLVE
) =>
{
// If the other side is sending us a BEGIN but hasn't yet acknowledged our END
// message, just remove the old stream from the map and stop waiting for a
// response
hop.map.ending_msg_received(streamid)?;
return self.handle_incoming_stream_request(cx, msg, streamid, hopnum);
}
Some(StreamEntMut::EndSent(EndSentStreamEnt { half_stream, .. })) => {
// We sent an end but maybe the other side hasn't heard.
match half_stream.handle_msg(msg)? {
StreamStatus::Open => {}
StreamStatus::Closed => hop.map.ending_msg_received(streamid)?,
}
}
#[cfg(feature = "hs-service")]
None if matches!(
msg.cmd(),
RelayCmd::BEGIN | RelayCmd::BEGIN_DIR | RelayCmd::RESOLVE
) =>
{
self.handle_incoming_stream_request(cx, msg, streamid, hopnum)?;
}
_ => {
// No stream wants this message, or ever did.
return Err(Error::CircProto(
"Cell received on nonexistent stream!?".into(),
));
}
}
Ok(CellStatus::Continue)
}
/// A helper for handling incoming stream requests.
#[cfg(feature = "hs-service")]
fn handle_incoming_stream_request(
&mut self,
cx: &mut Context<'_>,
msg: UnparsedRelayMsg,
stream_id: StreamId,
hop_num: HopNum,
) -> Result<CellStatus> {
use syncview::ClientCircSyncView;
use tor_cell::relaycell::msg::EndReason;
use tor_error::into_internal;
use tor_log_ratelim::log_ratelim;
// We need to construct this early so that we don't double-borrow &mut self
let Some(handler) = self.incoming_stream_req_handler.as_mut() else {
return Err(Error::CircProto(
"Cannot handle BEGIN cells on this circuit".into(),
));
};
if hop_num != handler.hop_num {
return Err(Error::CircProto(format!(
"Expecting incoming streams from {}, but received {} cell from unexpected hop {}",
handler.hop_num.display(),
msg.cmd(),
hop_num.display()
)));
}
let message_closes_stream = handler.cmd_checker.check_msg(&msg)? == StreamStatus::Closed;
// TODO: we've already looked up the `hop` in handle_relay_cell, so we shouldn't
// have to look it up again! However, we can't pass the `&mut hop` reference from
// `handle_relay_cell` to this function, because that makes Rust angry (we'd be
// borrowing self as mutable more than once).
//
// TODO: we _could_ use self.hops.get_mut(..) instead self.hop_mut(..) inside
// handle_relay_cell to work around the problem described above
let hop = self
.hops
.get_mut(Into::<usize>::into(hop_num))
.ok_or(Error::CircuitClosed)?;
if message_closes_stream {
hop.map.ending_msg_received(stream_id)?;
return Ok(CellStatus::Continue);
}
let begin = msg
.decode::<Begin>()
.map_err(|e| Error::from_bytes_err(e, "Invalid Begin message"))?
.into_msg();
let req = IncomingStreamRequest::Begin(begin);
{
use crate::stream::IncomingStreamRequestDisposition::*;
let ctx = crate::stream::IncomingStreamRequestContext { request: &req };
let view = ClientCircSyncView::new(&self.hops);
match handler.filter.as_mut().disposition(&ctx, &view)? {
Accept => {}
CloseCircuit => return Ok(CellStatus::CleanShutdown),
RejectRequest(end) => {
let end_msg = AnyRelayMsgOuter::new(Some(stream_id), end.into());
self.send_relay_cell(cx, hop_num, false, end_msg)?;
return Ok(CellStatus::Continue);
}
}
}
// TODO: Sadly, we need to look up `&mut hop` yet again,
// since we needed to pass `&self.hops` by reference to our filter above. :(
let hop = self
.hops
.get_mut(Into::<usize>::into(hop_num))
.ok_or(Error::CircuitClosed)?;
let (sender, receiver) = mpsc::channel(STREAM_READER_BUFFER);
let (msg_tx, msg_rx) = mpsc::channel(super::CIRCUIT_BUFFER_SIZE);
let send_window = StreamSendWindow::new(SEND_WINDOW_INIT);
let cmd_checker = DataCmdChecker::new_connected();
hop.map
.add_ent_with_id(sender, msg_rx, send_window, stream_id, cmd_checker)?;
let outcome = handler
.incoming_sender
.try_send(StreamReqInfo {
req,
stream_id,
hop_num,
msg_tx,
receiver,
})
.map_err(|e| e.into_send_error());
log_ratelim!("Delivering message to incoming stream handler"; outcome);
if let Err(e) = outcome {
if e.is_full() {
// The IncomingStreamRequestHandler's stream is full; it isn't
// handling requests fast enough. So instead, we reply with an
// END cell.
let end_msg = AnyRelayMsgOuter::new(
Some(stream_id),
End::new_with_reason(EndReason::RESOURCELIMIT).into(),
);
self.send_relay_cell(cx, hop_num, false, end_msg)?;
} else if e.is_disconnected() {
// The IncomingStreamRequestHandler's stream has been dropped.
// In the Tor protocol as it stands, this always means that the
// circuit itself is out-of-use and should be closed. (See notes
// on `allow_stream_requests.`)
//
// Note that we will _not_ reach this point immediately after
// the IncomingStreamRequestHandler is dropped; we won't hit it
// until we next get an incoming request. Thus, if we do later
// want to add early detection for a dropped
// IncomingStreamRequestHandler, we need to do it elsewhere, in
// a different way.
debug!(
"{}: Incoming stream request receiver dropped",
self.unique_id
);
// This will _cause_ the circuit to get closed.
return Err(Error::CircuitClosed);
} else {
// There are no errors like this with the current design of
// futures::mpsc, but we shouldn't just ignore the possibility
// that they'll be added later.
return Err(Error::from((into_internal!(
"try_send failed unexpectedly"
))(e)));
}
}
Ok(CellStatus::Continue)
}
/// Helper: process a destroy cell.
#[allow(clippy::unnecessary_wraps)]
fn handle_destroy_cell(&mut self) -> Result<()> {
// I think there is nothing more to do here.
Ok(())
}
/// Return the hop corresponding to `hopnum`, if there is one.
fn hop_mut(&mut self, hopnum: HopNum) -> Option<&mut CircHop> {
self.hops.get_mut(Into::<usize>::into(hopnum))
}
}
#[cfg(feature = "send-control-msg")]
#[cfg_attr(docsrs, doc(cfg(feature = "send-control-msg")))]
impl ConversationInHandler<'_, '_, '_> {
/// Send a protocol message as part of an ad-hoc exchange
///
/// This is the within-[`MsgHandler`](super::MsgHandler)
/// counterpart to [`Conversation`](super::Conversation).
///
/// It differs only in that the `send_message` function here is sync,
/// and takes `&mut self`.
//
// TODO hs: it might be nice to avoid exposing tor-cell APIs in the
// tor-proto interface.
pub fn send_message(&mut self, msg: tor_cell::relaycell::msg::AnyRelayMsg) -> Result<()> {
let msg = tor_cell::relaycell::AnyRelayMsgOuter::new(None, msg);
self.reactor
.send_relay_cell(self.cx, self.hop_num, false, msg)
}
}
impl Drop for Reactor {
fn drop(&mut self) {
let _ = self.channel.close_circuit(self.channel_id);
}
}
#[cfg(test)]
mod test {}