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
//! Functionality for incoming streams, opened from the other side of a circuit.
use bitvec::prelude::*;
use super::{AnyCmdChecker, DataStream, StreamReader, StreamStatus};
use crate::circuit::reactor::CloseStreamBehavior;
use crate::circuit::{ClientCircSyncView, StreamTarget};
use crate::{Error, Result};
use tor_async_utils::oneshot;
use tor_cell::relaycell::{msg, RelayCmd, UnparsedRelayMsg};
use tor_cell::restricted_msg;
use tor_error::internal;
/// A pending request from the other end of the circuit for us to open a new
/// stream.
///
/// Exits, directory caches, and onion services expect to receive these; others
/// do not.
///
/// On receiving one of these objects, the party handling it should accept it or
/// reject it. If it is dropped without being explicitly handled, a reject
/// message will be sent anyway.
#[derive(Debug)]
pub struct IncomingStream {
/// The message that the client sent us to begin the stream.
request: IncomingStreamRequest,
/// The information that we'll use to wire up the stream, if it is accepted.
stream: StreamTarget,
/// The underlying `StreamReader`.
reader: StreamReader,
}
impl IncomingStream {
/// Create a new `IncomingStream`.
pub(crate) fn new(
request: IncomingStreamRequest,
stream: StreamTarget,
reader: StreamReader,
) -> Self {
Self {
request,
stream,
reader,
}
}
/// Return the underlying message that was used to try to begin this stream.
pub fn request(&self) -> &IncomingStreamRequest {
&self.request
}
/// Accept this stream as a new [`DataStream`], and send the client a
/// message letting them know the stream was accepted.
pub async fn accept_data(self, message: msg::Connected) -> Result<DataStream> {
let Self {
request,
mut stream,
reader,
} = self;
match request {
IncomingStreamRequest::Begin(_) | IncomingStreamRequest::BeginDir(_) => {
stream.send(message.into()).await?;
Ok(DataStream::new_connected(reader, stream))
}
IncomingStreamRequest::Resolve(_) => {
Err(internal!("Cannot accept data on a RESOLVE stream").into())
}
}
}
/// Reject this request and send an error message to the client.
pub async fn reject(mut self, message: msg::End) -> Result<()> {
let rx = self.reject_inner(CloseStreamBehavior::SendEnd(message))?;
rx.await.map_err(|_| Error::CircuitClosed)?.map(|_| ())
}
/// Reject this request and possibly send an error message to the client.
///
/// Returns a [`oneshot::Receiver`] that can be used to await the reactor's response.
fn reject_inner(
&mut self,
message: CloseStreamBehavior,
) -> Result<oneshot::Receiver<Result<()>>> {
self.stream.close_pending(message)
}
/// Ignore this request without replying to the client.
///
/// (If you drop an [`IncomingStream`] without calling `accept_data`,
/// `reject`, or this method, the drop handler will cause it to be
/// rejected.)
pub async fn discard(mut self) -> Result<()> {
let rx = self.reject_inner(CloseStreamBehavior::SendNothing)?;
rx.await.map_err(|_| Error::CircuitClosed)?.map(|_| ())
}
}
// NOTE: We do not need to `impl Drop for IncomingStream { .. }`: when its
// StreamTarget is dropped, this will drop its internal mpsc::Sender, and the
// circuit reactor will see a close on its mpsc::Receiver, and the circuit
// reactor will itself send an End.
restricted_msg! {
/// The allowed incoming messages on an `IncomingStream`.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum IncomingStreamRequest: RelayMsg {
/// A BEGIN message.
Begin,
/// A BEGIN_DIR message.
BeginDir,
/// A RESOLVE message.
Resolve,
}
}
/// Bit-vector used to represent a list of permitted commands.
///
/// This is cheaper and faster than using a vec, and avoids side-channel
/// attacks.
type RelayCmdSet = bitvec::BitArr!(for 256);
/// A `CmdChecker` that enforces correctness for incoming commands on unrecognized streams that
/// have a non-zero stream ID.
#[derive(Debug)]
pub(crate) struct IncomingCmdChecker {
/// The "begin" commands that can be received on this type of circuit:
///
/// * onion service circuits only accept `BEGIN`
/// * all relay circuits accept `BEGIN_DIR`
/// * exit relays additionally accept `BEGIN` or `RESOLVE` on relay circuits
/// * once CONNECT_UDP is implemented, relays and later onion services may accept CONNECT_UDP
/// as well
allow_commands: RelayCmdSet,
}
impl IncomingCmdChecker {
/// Create a new boxed `IncomingCmdChecker`.
pub(crate) fn new_any(allow_commands: &[RelayCmd]) -> AnyCmdChecker {
let mut array = BitArray::ZERO;
for c in allow_commands {
array.set(u8::from(*c) as usize, true);
}
Box::new(Self {
allow_commands: array,
})
}
}
impl super::CmdChecker for IncomingCmdChecker {
fn check_msg(&mut self, msg: &UnparsedRelayMsg) -> Result<StreamStatus> {
if self.allow_commands[u8::from(msg.cmd()) as usize] {
Ok(StreamStatus::Open)
} else {
Err(Error::StreamProto(format!(
"Unexpected {} on incoming stream",
msg.cmd()
)))
}
}
fn consume_checked_msg(&mut self, msg: UnparsedRelayMsg) -> Result<()> {
let _ = msg
.decode::<IncomingStreamRequest>()
.map_err(|err| Error::from_bytes_err(err, "invalid message on incoming stream"))?;
Ok(())
}
}
/// A callback that can check whether a given stream request is acceptable
/// immediately on its receipt.
///
/// This should only be used for checks that need to be done immediately, with a
/// view of the state of the circuit. Any other checks should, if possible, be
/// done on the [`IncomingStream`] objects as they are received.
pub trait IncomingStreamRequestFilter: Send + 'static {
/// Check an incoming stream request, and decide what to do with it.
///
/// Implementations of this function should
fn disposition(
&mut self,
ctx: &IncomingStreamRequestContext<'_>,
circ: &ClientCircSyncView<'_>,
) -> Result<IncomingStreamRequestDisposition>;
}
/// What action to take with an incoming stream request.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum IncomingStreamRequestDisposition {
/// Accept the request (for now) and pass it to the mpsc::Receiver
/// that is yielding them as [`IncomingStream``
Accept,
/// Rejected the request, and close the circuit on which it was received.
CloseCircuit,
/// Reject the request and send an END message.
RejectRequest(msg::End),
}
/// Information about a stream request, as passed to an [`IncomingStreamRequestFilter`].
pub struct IncomingStreamRequestContext<'a> {
/// The request message itself
pub(crate) request: &'a IncomingStreamRequest,
}
impl<'a> IncomingStreamRequestContext<'a> {
/// Return a reference to the message used to request this stream.
pub fn request(&self) -> &'a IncomingStreamRequest {
self.request
}
}
#[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 tor_cell::relaycell::{
msg::{Begin, BeginDir, Data, Resolve},
AnyRelayMsgOuter, RelayCellFormat,
};
use super::*;
#[test]
fn incoming_cmd_checker() {
// Convert an AnyRelayMsg to an UnparsedRelayCell.
let u = |msg| {
let body = AnyRelayMsgOuter::new(None, msg)
.encode(&mut rand::thread_rng())
.unwrap();
UnparsedRelayMsg::from_singleton_body(RelayCellFormat::V0, body).unwrap()
};
let begin = u(Begin::new("allium.example.com", 443, 0).unwrap().into());
let begin_dir = u(BeginDir::default().into());
let resolve = u(Resolve::new("allium.example.com").into());
let data = u(Data::new(&[1, 2, 3]).unwrap().into());
{
let mut cc_none = IncomingCmdChecker::new_any(&[]);
for m in [&begin, &begin_dir, &resolve, &data] {
assert!(cc_none.check_msg(m).is_err());
}
}
{
let mut cc_begin = IncomingCmdChecker::new_any(&[RelayCmd::BEGIN]);
assert_eq!(cc_begin.check_msg(&begin).unwrap(), StreamStatus::Open);
for m in [&begin_dir, &resolve, &data] {
assert!(cc_begin.check_msg(m).is_err());
}
}
{
let mut cc_any = IncomingCmdChecker::new_any(&[
RelayCmd::BEGIN,
RelayCmd::BEGIN_DIR,
RelayCmd::RESOLVE,
]);
for m in [&begin, &begin_dir, &resolve] {
assert_eq!(cc_any.check_msg(m).unwrap(), StreamStatus::Open);
}
assert!(cc_any.check_msg(&data).is_err());
}
}
}