2024-01-01 14:58:21 -05:00
|
|
|
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
2023-04-02 17:27:12 -04:00
|
|
|
|
2023-04-26 18:58:18 -04:00
|
|
|
use std::marker::PhantomData;
|
|
|
|
|
|
2023-04-02 17:27:12 -04:00
|
|
|
use bytes::Bytes;
|
|
|
|
|
use bytes::BytesMut;
|
|
|
|
|
use httparse::Status;
|
2023-12-27 11:59:57 -05:00
|
|
|
use hyper::header::HeaderName;
|
|
|
|
|
use hyper::header::HeaderValue;
|
|
|
|
|
use hyper::Response;
|
2023-04-02 17:27:12 -04:00
|
|
|
use memmem::Searcher;
|
|
|
|
|
use memmem::TwoWaySearcher;
|
|
|
|
|
use once_cell::sync::OnceCell;
|
|
|
|
|
|
2024-10-18 18:57:12 -04:00
|
|
|
#[derive(Debug, thiserror::Error)]
|
|
|
|
|
pub enum WebSocketUpgradeError {
|
|
|
|
|
#[error("invalid headers")]
|
|
|
|
|
InvalidHeaders,
|
|
|
|
|
#[error("{0}")]
|
|
|
|
|
HttpParse(#[from] httparse::Error),
|
|
|
|
|
#[error("{0}")]
|
|
|
|
|
Http(#[from] http::Error),
|
|
|
|
|
#[error("{0}")]
|
|
|
|
|
Utf8(#[from] std::str::Utf8Error),
|
|
|
|
|
#[error("{0}")]
|
|
|
|
|
InvalidHeaderName(#[from] http::header::InvalidHeaderName),
|
|
|
|
|
#[error("{0}")]
|
|
|
|
|
InvalidHeaderValue(#[from] http::header::InvalidHeaderValue),
|
|
|
|
|
#[error("invalid HTTP status line")]
|
|
|
|
|
InvalidHttpStatusLine,
|
|
|
|
|
#[error("attempted to write to completed upgrade buffer")]
|
|
|
|
|
UpgradeBufferAlreadyCompleted,
|
|
|
|
|
}
|
2023-04-02 17:27:12 -04:00
|
|
|
|
|
|
|
|
/// Given a buffer that ends in `\n\n` or `\r\n\r\n`, returns a parsed [`Request<Body>`].
|
2023-04-26 18:58:18 -04:00
|
|
|
fn parse_response<T: Default>(
|
2023-04-02 17:27:12 -04:00
|
|
|
header_bytes: &[u8],
|
2024-10-18 18:57:12 -04:00
|
|
|
) -> Result<(usize, Response<T>), WebSocketUpgradeError> {
|
2023-04-02 17:27:12 -04:00
|
|
|
let mut headers = [httparse::EMPTY_HEADER; 16];
|
|
|
|
|
let status = httparse::parse_headers(header_bytes, &mut headers)?;
|
|
|
|
|
match status {
|
|
|
|
|
Status::Complete((index, parsed)) => {
|
2023-04-26 18:58:18 -04:00
|
|
|
let mut resp = Response::builder().status(101).body(T::default())?;
|
2023-04-02 17:27:12 -04:00
|
|
|
for header in parsed.iter() {
|
|
|
|
|
resp.headers_mut().append(
|
|
|
|
|
HeaderName::from_bytes(header.name.as_bytes())?,
|
|
|
|
|
HeaderValue::from_str(std::str::from_utf8(header.value)?)?,
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
Ok((index, resp))
|
|
|
|
|
}
|
2024-10-18 18:57:12 -04:00
|
|
|
_ => Err(WebSocketUpgradeError::InvalidHeaders),
|
2023-04-02 17:27:12 -04:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Find a newline in a slice.
|
|
|
|
|
fn find_newline(slice: &[u8]) -> Option<usize> {
|
|
|
|
|
for (i, byte) in slice.iter().enumerate() {
|
|
|
|
|
if *byte == b'\n' {
|
|
|
|
|
return Some(i);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
None
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// WebSocket upgrade state machine states.
|
|
|
|
|
#[derive(Default)]
|
|
|
|
|
enum WebSocketUpgradeState {
|
|
|
|
|
#[default]
|
|
|
|
|
Initial,
|
|
|
|
|
StatusLine,
|
|
|
|
|
Headers,
|
|
|
|
|
Complete,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static HEADER_SEARCHER: OnceCell<TwoWaySearcher> = OnceCell::new();
|
|
|
|
|
static HEADER_SEARCHER2: OnceCell<TwoWaySearcher> = OnceCell::new();
|
|
|
|
|
|
|
|
|
|
#[derive(Default)]
|
2023-04-26 18:58:18 -04:00
|
|
|
pub struct WebSocketUpgrade<T: Default> {
|
2023-04-02 17:27:12 -04:00
|
|
|
state: WebSocketUpgradeState,
|
|
|
|
|
buf: BytesMut,
|
2023-04-26 18:58:18 -04:00
|
|
|
_t: PhantomData<T>,
|
2023-04-02 17:27:12 -04:00
|
|
|
}
|
|
|
|
|
|
2023-04-26 18:58:18 -04:00
|
|
|
impl<T: Default> WebSocketUpgrade<T> {
|
2023-04-02 17:27:12 -04:00
|
|
|
/// Ensures that the status line starts with "HTTP/1.1 101 " which matches all of the node.js
|
|
|
|
|
/// WebSocket libraries that are known. We don't care about the trailing status text.
|
2024-10-18 18:57:12 -04:00
|
|
|
fn validate_status(
|
|
|
|
|
&self,
|
|
|
|
|
status: &[u8],
|
|
|
|
|
) -> Result<(), WebSocketUpgradeError> {
|
2023-04-02 17:27:12 -04:00
|
|
|
if status.starts_with(b"HTTP/1.1 101 ") {
|
|
|
|
|
Ok(())
|
|
|
|
|
} else {
|
2024-10-18 18:57:12 -04:00
|
|
|
Err(WebSocketUpgradeError::InvalidHttpStatusLine)
|
2023-04-02 17:27:12 -04:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Writes bytes to our upgrade buffer, returning [`Ok(None)`] if we need to keep feeding it data,
|
|
|
|
|
/// [`Ok(Some(Response))`] if we got a valid upgrade header, or [`Err`] if something went badly.
|
|
|
|
|
pub fn write(
|
|
|
|
|
&mut self,
|
|
|
|
|
bytes: &[u8],
|
2024-10-18 18:57:12 -04:00
|
|
|
) -> Result<Option<(Response<T>, Bytes)>, WebSocketUpgradeError> {
|
2023-04-02 17:27:12 -04:00
|
|
|
use WebSocketUpgradeState::*;
|
|
|
|
|
|
|
|
|
|
match self.state {
|
|
|
|
|
Initial => {
|
|
|
|
|
if let Some(index) = find_newline(bytes) {
|
|
|
|
|
let (status, rest) = bytes.split_at(index + 1);
|
|
|
|
|
self.validate_status(status)?;
|
|
|
|
|
|
|
|
|
|
// Fast path for the most common node.js WebSocket libraries that use \r\n as the
|
|
|
|
|
// separator between header lines and send the whole response in one packet.
|
|
|
|
|
if rest.ends_with(b"\r\n\r\n") {
|
|
|
|
|
let (index, response) = parse_response(rest)?;
|
|
|
|
|
if index == rest.len() {
|
|
|
|
|
return Ok(Some((response, Bytes::default())));
|
|
|
|
|
} else {
|
|
|
|
|
let bytes = Bytes::copy_from_slice(&rest[index..]);
|
|
|
|
|
return Ok(Some((response, bytes)));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
self.state = Headers;
|
|
|
|
|
self.write(rest)
|
|
|
|
|
} else {
|
|
|
|
|
self.state = StatusLine;
|
|
|
|
|
self.buf.extend_from_slice(bytes);
|
|
|
|
|
Ok(None)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
StatusLine => {
|
|
|
|
|
if let Some(index) = find_newline(bytes) {
|
|
|
|
|
let (status, rest) = bytes.split_at(index + 1);
|
|
|
|
|
self.buf.extend_from_slice(status);
|
|
|
|
|
self.validate_status(&self.buf)?;
|
|
|
|
|
self.buf.clear();
|
|
|
|
|
// Recursively process this write
|
|
|
|
|
self.state = Headers;
|
|
|
|
|
self.write(rest)
|
|
|
|
|
} else {
|
|
|
|
|
self.buf.extend_from_slice(bytes);
|
|
|
|
|
Ok(None)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
Headers => {
|
|
|
|
|
self.buf.extend_from_slice(bytes);
|
|
|
|
|
let header_searcher =
|
|
|
|
|
HEADER_SEARCHER.get_or_init(|| TwoWaySearcher::new(b"\r\n\r\n"));
|
|
|
|
|
let header_searcher2 =
|
|
|
|
|
HEADER_SEARCHER2.get_or_init(|| TwoWaySearcher::new(b"\n\n"));
|
2023-07-13 17:16:24 -04:00
|
|
|
if header_searcher.search_in(&self.buf).is_some()
|
|
|
|
|
|| header_searcher2.search_in(&self.buf).is_some()
|
|
|
|
|
{
|
2023-04-02 17:27:12 -04:00
|
|
|
let (index, response) = parse_response(&self.buf)?;
|
|
|
|
|
let mut buf = std::mem::take(&mut self.buf);
|
|
|
|
|
self.state = Complete;
|
|
|
|
|
Ok(Some((response, buf.split_off(index).freeze())))
|
|
|
|
|
} else {
|
|
|
|
|
Ok(None)
|
|
|
|
|
}
|
|
|
|
|
}
|
2024-10-18 18:57:12 -04:00
|
|
|
Complete => Err(WebSocketUpgradeError::UpgradeBufferAlreadyCompleted),
|
2023-04-02 17:27:12 -04:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod tests {
|
|
|
|
|
use super::*;
|
2023-12-27 11:59:57 -05:00
|
|
|
use hyper_v014::Body;
|
2023-04-02 17:27:12 -04:00
|
|
|
|
|
|
|
|
type ExpectedResponseAndHead = Option<(Response<Body>, &'static [u8])>;
|
|
|
|
|
|
|
|
|
|
fn assert_response(
|
2024-10-18 18:57:12 -04:00
|
|
|
result: Result<Option<(Response<Body>, Bytes)>, WebSocketUpgradeError>,
|
|
|
|
|
expected: Result<ExpectedResponseAndHead, WebSocketUpgradeError>,
|
2023-04-02 17:27:12 -04:00
|
|
|
chunk_info: Option<(usize, usize)>,
|
|
|
|
|
) {
|
|
|
|
|
let formatted = format!("{result:?}");
|
|
|
|
|
match expected {
|
|
|
|
|
Ok(Some((resp1, remainder1))) => match result {
|
|
|
|
|
Ok(Some((resp2, remainder2))) => {
|
|
|
|
|
assert_eq!(format!("{resp1:?}"), format!("{resp2:?}"));
|
|
|
|
|
if let Some((byte_len, chunk_size)) = chunk_info {
|
|
|
|
|
// We need to compute how many bytes should be in the trailing data
|
|
|
|
|
|
|
|
|
|
// We know how many bytes of header data we had
|
|
|
|
|
let last_packet_header_size =
|
|
|
|
|
(byte_len - remainder1.len() + chunk_size - 1) % chunk_size + 1;
|
|
|
|
|
|
|
|
|
|
// Which means we can compute how much was in the remainder
|
|
|
|
|
let remaining =
|
|
|
|
|
(chunk_size - last_packet_header_size).min(remainder1.len());
|
|
|
|
|
|
|
|
|
|
assert_eq!(remainder1[..remaining], remainder2);
|
|
|
|
|
} else {
|
|
|
|
|
assert_eq!(remainder1, remainder2);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
_ => panic!("Expected Ok(Some(...)), was {formatted}"),
|
|
|
|
|
},
|
|
|
|
|
Ok(None) => assert!(
|
|
|
|
|
result.ok().unwrap().is_none(),
|
|
|
|
|
"Expected Ok(None), was {formatted}",
|
|
|
|
|
),
|
|
|
|
|
Err(e) => assert_eq!(
|
2024-10-18 18:57:12 -04:00
|
|
|
format!("{e:?}"),
|
|
|
|
|
format!("{:?}", result.unwrap_err()),
|
2023-04-02 17:27:12 -04:00
|
|
|
"Expected error, was {formatted}",
|
|
|
|
|
),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn validate_upgrade_all_at_once(
|
|
|
|
|
s: &str,
|
2024-10-18 18:57:12 -04:00
|
|
|
expected: Result<ExpectedResponseAndHead, WebSocketUpgradeError>,
|
2023-04-02 17:27:12 -04:00
|
|
|
) {
|
|
|
|
|
let mut upgrade = WebSocketUpgrade::default();
|
|
|
|
|
let res = upgrade.write(s.as_bytes());
|
|
|
|
|
|
|
|
|
|
assert_response(res, expected, None);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn validate_upgrade_chunks(
|
|
|
|
|
s: &str,
|
|
|
|
|
size: usize,
|
2024-10-18 18:57:12 -04:00
|
|
|
expected: Result<ExpectedResponseAndHead, WebSocketUpgradeError>,
|
2023-04-02 17:27:12 -04:00
|
|
|
) {
|
|
|
|
|
let chunk_info = Some((s.as_bytes().len(), size));
|
|
|
|
|
let mut upgrade = WebSocketUpgrade::default();
|
|
|
|
|
let mut result = Ok(None);
|
|
|
|
|
for chunk in s.as_bytes().chunks(size) {
|
|
|
|
|
result = upgrade.write(chunk);
|
|
|
|
|
if let Ok(Some(..)) = &result {
|
|
|
|
|
assert_response(result, expected, chunk_info);
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
assert_response(result, expected, chunk_info);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn validate_upgrade(
|
|
|
|
|
s: &str,
|
2024-10-18 18:57:12 -04:00
|
|
|
expected: fn() -> Result<ExpectedResponseAndHead, WebSocketUpgradeError>,
|
2023-04-02 17:27:12 -04:00
|
|
|
) {
|
|
|
|
|
validate_upgrade_all_at_once(s, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 1, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 2, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 10, expected());
|
|
|
|
|
|
|
|
|
|
// Replace \n with \r\n, but only in headers
|
|
|
|
|
let (headers, trailing) = s.split_once("\n\n").unwrap();
|
|
|
|
|
let s = headers.replace('\n', "\r\n") + "\r\n\r\n" + trailing;
|
|
|
|
|
let s = s.as_ref();
|
|
|
|
|
|
|
|
|
|
validate_upgrade_all_at_once(s, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 1, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 2, expected());
|
|
|
|
|
validate_upgrade_chunks(s, 10, expected());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade1() {
|
|
|
|
|
validate_upgrade(
|
|
|
|
|
"HTTP/1.1 101 Switching Protocols\nConnection: Upgrade\n\n",
|
|
|
|
|
|| {
|
|
|
|
|
let mut expected =
|
|
|
|
|
Response::builder().status(101).body(Body::empty()).unwrap();
|
|
|
|
|
expected.headers_mut().append(
|
|
|
|
|
HeaderName::from_static("connection"),
|
|
|
|
|
HeaderValue::from_static("Upgrade"),
|
|
|
|
|
);
|
|
|
|
|
Ok(Some((expected, b"")))
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade_trailing() {
|
|
|
|
|
validate_upgrade(
|
|
|
|
|
"HTTP/1.1 101 Switching Protocols\nConnection: Upgrade\n\ntrailing data",
|
|
|
|
|
|| {
|
|
|
|
|
let mut expected =
|
|
|
|
|
Response::builder().status(101).body(Body::empty()).unwrap();
|
|
|
|
|
expected.headers_mut().append(
|
|
|
|
|
HeaderName::from_static("connection"),
|
|
|
|
|
HeaderValue::from_static("Upgrade"),
|
|
|
|
|
);
|
|
|
|
|
Ok(Some((expected, b"trailing data")))
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade_trailing_with_newlines() {
|
|
|
|
|
validate_upgrade(
|
|
|
|
|
"HTTP/1.1 101 Switching Protocols\nConnection: Upgrade\n\ntrailing data\r\n\r\n",
|
|
|
|
|
|| {
|
|
|
|
|
let mut expected =
|
|
|
|
|
Response::builder().status(101).body(Body::empty()).unwrap();
|
|
|
|
|
expected.headers_mut().append(
|
|
|
|
|
HeaderName::from_static("connection"),
|
|
|
|
|
HeaderValue::from_static("Upgrade"),
|
|
|
|
|
);
|
|
|
|
|
Ok(Some((expected, b"trailing data\r\n\r\n")))
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade2() {
|
|
|
|
|
validate_upgrade(
|
|
|
|
|
"HTTP/1.1 101 Switching Protocols\nConnection: Upgrade\nOther: 123\n\n",
|
|
|
|
|
|| {
|
|
|
|
|
let mut expected =
|
|
|
|
|
Response::builder().status(101).body(Body::empty()).unwrap();
|
|
|
|
|
expected.headers_mut().append(
|
|
|
|
|
HeaderName::from_static("connection"),
|
|
|
|
|
HeaderValue::from_static("Upgrade"),
|
|
|
|
|
);
|
|
|
|
|
expected.headers_mut().append(
|
|
|
|
|
HeaderName::from_static("other"),
|
|
|
|
|
HeaderValue::from_static("123"),
|
|
|
|
|
);
|
|
|
|
|
Ok(Some((expected, b"")))
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade_invalid_status() {
|
|
|
|
|
validate_upgrade("HTTP/1.1 200 OK\nConnection: Upgrade\n\n", || {
|
2024-10-18 18:57:12 -04:00
|
|
|
Err(WebSocketUpgradeError::InvalidHttpStatusLine)
|
2023-04-02 17:27:12 -04:00
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn upgrade_too_many_headers() {
|
|
|
|
|
let headers = (0..20)
|
|
|
|
|
.map(|i| format!("h{i}: {i}"))
|
|
|
|
|
.collect::<Vec<_>>()
|
|
|
|
|
.join("\n");
|
|
|
|
|
validate_upgrade(
|
|
|
|
|
&format!("HTTP/1.1 101 Switching Protocols\n{headers}\n\n"),
|
2024-10-18 18:57:12 -04:00
|
|
|
|| {
|
|
|
|
|
Err(WebSocketUpgradeError::HttpParse(
|
|
|
|
|
httparse::Error::TooManyHeaders,
|
|
|
|
|
))
|
|
|
|
|
},
|
2023-04-02 17:27:12 -04:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
