|
|
@ -1,13 +1,11 @@ |
|
|
|
//! Client handshake machine.
|
|
|
|
//! Client handshake machine.
|
|
|
|
|
|
|
|
|
|
|
|
use std::borrow::Cow; |
|
|
|
|
|
|
|
use std::io::{Read, Write}; |
|
|
|
use std::io::{Read, Write}; |
|
|
|
use std::marker::PhantomData; |
|
|
|
use std::marker::PhantomData; |
|
|
|
|
|
|
|
|
|
|
|
use http::HeaderMap; |
|
|
|
use http::{HeaderMap, Request, Response, StatusCode}; |
|
|
|
use httparse::Status; |
|
|
|
use httparse::Status; |
|
|
|
use log::*; |
|
|
|
use log::*; |
|
|
|
use url::Url; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
use super::headers::{FromHttparse, MAX_HEADERS}; |
|
|
|
use super::headers::{FromHttparse, MAX_HEADERS}; |
|
|
|
use super::machine::{HandshakeMachine, StageResult, TryParse}; |
|
|
|
use super::machine::{HandshakeMachine, StageResult, TryParse}; |
|
|
@ -15,57 +13,6 @@ use super::{convert_key, HandshakeRole, MidHandshake, ProcessingResult}; |
|
|
|
use crate::error::{Error, Result}; |
|
|
|
use crate::error::{Error, Result}; |
|
|
|
use crate::protocol::{Role, WebSocket, WebSocketConfig}; |
|
|
|
use crate::protocol::{Role, WebSocket, WebSocketConfig}; |
|
|
|
|
|
|
|
|
|
|
|
/// Client request.
|
|
|
|
|
|
|
|
#[derive(Debug)] |
|
|
|
|
|
|
|
pub struct Request<'t> { |
|
|
|
|
|
|
|
/// `ws://` or `wss://` URL to connect to.
|
|
|
|
|
|
|
|
pub url: Url, |
|
|
|
|
|
|
|
/// Extra HTTP headers to append to the request.
|
|
|
|
|
|
|
|
pub extra_headers: Option<Vec<(Cow<'t, str>, Cow<'t, str>)>>, |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
impl<'t> Request<'t> { |
|
|
|
|
|
|
|
/// Returns the GET part of the request.
|
|
|
|
|
|
|
|
fn get_path(&self) -> String { |
|
|
|
|
|
|
|
if let Some(query) = self.url.query() { |
|
|
|
|
|
|
|
format!("{path}?{query}", path = self.url.path(), query = query) |
|
|
|
|
|
|
|
} else { |
|
|
|
|
|
|
|
self.url.path().into() |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/// Returns the host part of the request.
|
|
|
|
|
|
|
|
fn get_host(&self) -> String { |
|
|
|
|
|
|
|
let host = self.url.host_str().expect("Bug: URL without host"); |
|
|
|
|
|
|
|
if let Some(port) = self.url.port() { |
|
|
|
|
|
|
|
format!("{host}:{port}", host = host, port = port) |
|
|
|
|
|
|
|
} else { |
|
|
|
|
|
|
|
host.into() |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/// Adds a WebSocket protocol to the request.
|
|
|
|
|
|
|
|
pub fn add_protocol(&mut self, protocol: Cow<'t, str>) { |
|
|
|
|
|
|
|
self.add_header(Cow::from("Sec-WebSocket-Protocol"), protocol); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/// Adds a custom header to the request.
|
|
|
|
|
|
|
|
pub fn add_header(&mut self, name: Cow<'t, str>, value: Cow<'t, str>) { |
|
|
|
|
|
|
|
let mut headers = self.extra_headers.take().unwrap_or_else(Vec::new); |
|
|
|
|
|
|
|
headers.push((name, value)); |
|
|
|
|
|
|
|
self.extra_headers = Some(headers); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
impl From<Url> for Request<'static> { |
|
|
|
|
|
|
|
fn from(value: Url) -> Self { |
|
|
|
|
|
|
|
Request { |
|
|
|
|
|
|
|
url: value, |
|
|
|
|
|
|
|
extra_headers: None, |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/// Client handshake role.
|
|
|
|
/// Client handshake role.
|
|
|
|
#[derive(Debug)] |
|
|
|
#[derive(Debug)] |
|
|
|
pub struct ClientHandshake<S> { |
|
|
|
pub struct ClientHandshake<S> { |
|
|
@ -78,31 +25,51 @@ impl<S: Read + Write> ClientHandshake<S> { |
|
|
|
/// Initiate a client handshake.
|
|
|
|
/// Initiate a client handshake.
|
|
|
|
pub fn start( |
|
|
|
pub fn start( |
|
|
|
stream: S, |
|
|
|
stream: S, |
|
|
|
request: Request, |
|
|
|
request: Request<()>, |
|
|
|
config: Option<WebSocketConfig>, |
|
|
|
config: Option<WebSocketConfig>, |
|
|
|
) -> MidHandshake<Self> { |
|
|
|
) -> Result<MidHandshake<Self>> { |
|
|
|
|
|
|
|
if request.method() != http::Method::GET { |
|
|
|
|
|
|
|
return Err(Error::Protocol( |
|
|
|
|
|
|
|
"Invalid HTTP method, only GET supported".into(), |
|
|
|
|
|
|
|
)); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if request.version() < http::Version::HTTP_11 { |
|
|
|
|
|
|
|
return Err(Error::Protocol( |
|
|
|
|
|
|
|
"HTTP version should be 1.1 or higher".into(), |
|
|
|
|
|
|
|
)); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Check the URI scheme: only ws or wss are supported
|
|
|
|
|
|
|
|
let _ = crate::client::uri_mode(request.uri())?; |
|
|
|
|
|
|
|
|
|
|
|
let key = generate_key(); |
|
|
|
let key = generate_key(); |
|
|
|
|
|
|
|
|
|
|
|
let machine = { |
|
|
|
let machine = { |
|
|
|
let mut req = Vec::new(); |
|
|
|
let mut req = Vec::new(); |
|
|
|
|
|
|
|
let uri = request.uri(); |
|
|
|
write!( |
|
|
|
write!( |
|
|
|
req, |
|
|
|
req, |
|
|
|
"\ |
|
|
|
"\ |
|
|
|
GET {path} HTTP/1.1\r\n\ |
|
|
|
GET {path} {version:?}\r\n\ |
|
|
|
Host: {host}\r\n\ |
|
|
|
Host: {host}\r\n\ |
|
|
|
Connection: Upgrade\r\n\ |
|
|
|
Connection: Upgrade\r\n\ |
|
|
|
Upgrade: websocket\r\n\ |
|
|
|
Upgrade: websocket\r\n\ |
|
|
|
Sec-WebSocket-Version: 13\r\n\ |
|
|
|
Sec-WebSocket-Version: 13\r\n\ |
|
|
|
Sec-WebSocket-Key: {key}\r\n", |
|
|
|
Sec-WebSocket-Key: {key}\r\n", |
|
|
|
host = request.get_host(), |
|
|
|
version = request.version(), |
|
|
|
path = request.get_path(), |
|
|
|
host = uri |
|
|
|
|
|
|
|
.host() |
|
|
|
|
|
|
|
.ok_or_else(|| Error::Url("No host name in the URL".into()))?, |
|
|
|
|
|
|
|
path = uri |
|
|
|
|
|
|
|
.path_and_query() |
|
|
|
|
|
|
|
.ok_or_else(|| Error::Url("No path/query in URL".into()))? |
|
|
|
|
|
|
|
.as_str(), |
|
|
|
key = key |
|
|
|
key = key |
|
|
|
) |
|
|
|
) |
|
|
|
.unwrap(); |
|
|
|
.unwrap(); |
|
|
|
if let Some(eh) = request.extra_headers { |
|
|
|
for (k, v) in request.headers() { |
|
|
|
for (k, v) in eh { |
|
|
|
writeln!(req, "{}: {}\r", k, v.to_str()?).unwrap(); |
|
|
|
writeln!(req, "{}: {}\r", k, v).unwrap(); |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
} |
|
|
|
} |
|
|
|
writeln!(req, "\r").unwrap(); |
|
|
|
writeln!(req, "\r").unwrap(); |
|
|
|
HandshakeMachine::start_write(stream, req) |
|
|
|
HandshakeMachine::start_write(stream, req) |
|
|
@ -118,17 +85,17 @@ impl<S: Read + Write> ClientHandshake<S> { |
|
|
|
}; |
|
|
|
}; |
|
|
|
|
|
|
|
|
|
|
|
trace!("Client handshake initiated."); |
|
|
|
trace!("Client handshake initiated."); |
|
|
|
MidHandshake { |
|
|
|
Ok(MidHandshake { |
|
|
|
role: client, |
|
|
|
role: client, |
|
|
|
machine, |
|
|
|
machine, |
|
|
|
} |
|
|
|
}) |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
impl<S: Read + Write> HandshakeRole for ClientHandshake<S> { |
|
|
|
impl<S: Read + Write> HandshakeRole for ClientHandshake<S> { |
|
|
|
type IncomingData = Response; |
|
|
|
type IncomingData = Response<()>; |
|
|
|
type InternalStream = S; |
|
|
|
type InternalStream = S; |
|
|
|
type FinalResult = (WebSocket<S>, Response); |
|
|
|
type FinalResult = (WebSocket<S>, Response<()>); |
|
|
|
fn stage_finished( |
|
|
|
fn stage_finished( |
|
|
|
&mut self, |
|
|
|
&mut self, |
|
|
|
finish: StageResult<Self::IncomingData, Self::InternalStream>, |
|
|
|
finish: StageResult<Self::IncomingData, Self::InternalStream>, |
|
|
@ -160,18 +127,19 @@ struct VerifyData { |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
impl VerifyData { |
|
|
|
impl VerifyData { |
|
|
|
pub fn verify_response(&self, response: &Response) -> Result<()> { |
|
|
|
pub fn verify_response(&self, response: &Response<()>) -> Result<()> { |
|
|
|
// 1. If the status code received from the server is not 101, the
|
|
|
|
// 1. If the status code received from the server is not 101, the
|
|
|
|
// client handles the response per HTTP [RFC2616] procedures. (RFC 6455)
|
|
|
|
// client handles the response per HTTP [RFC2616] procedures. (RFC 6455)
|
|
|
|
if response.code != 101 { |
|
|
|
if response.status() != StatusCode::SWITCHING_PROTOCOLS { |
|
|
|
return Err(Error::Http(response.code)); |
|
|
|
return Err(Error::Http(response.status())); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
let headers = response.headers(); |
|
|
|
|
|
|
|
|
|
|
|
// 2. If the response lacks an |Upgrade| header field or the |Upgrade|
|
|
|
|
// 2. If the response lacks an |Upgrade| header field or the |Upgrade|
|
|
|
|
// header field contains a value that is not an ASCII case-
|
|
|
|
// header field contains a value that is not an ASCII case-
|
|
|
|
// insensitive match for the value "websocket", the client MUST
|
|
|
|
// insensitive match for the value "websocket", the client MUST
|
|
|
|
// _Fail the WebSocket Connection_. (RFC 6455)
|
|
|
|
// _Fail the WebSocket Connection_. (RFC 6455)
|
|
|
|
if !response |
|
|
|
if !headers |
|
|
|
.headers |
|
|
|
|
|
|
|
.get("Upgrade") |
|
|
|
.get("Upgrade") |
|
|
|
.and_then(|h| h.to_str().ok()) |
|
|
|
.and_then(|h| h.to_str().ok()) |
|
|
|
.map(|h| h.eq_ignore_ascii_case("websocket")) |
|
|
|
.map(|h| h.eq_ignore_ascii_case("websocket")) |
|
|
@ -185,8 +153,7 @@ impl VerifyData { |
|
|
|
// |Connection| header field doesn't contain a token that is an
|
|
|
|
// |Connection| header field doesn't contain a token that is an
|
|
|
|
// ASCII case-insensitive match for the value "Upgrade", the client
|
|
|
|
// ASCII case-insensitive match for the value "Upgrade", the client
|
|
|
|
// MUST _Fail the WebSocket Connection_. (RFC 6455)
|
|
|
|
// MUST _Fail the WebSocket Connection_. (RFC 6455)
|
|
|
|
if !response |
|
|
|
if !headers |
|
|
|
.headers |
|
|
|
|
|
|
|
.get("Connection") |
|
|
|
.get("Connection") |
|
|
|
.and_then(|h| h.to_str().ok()) |
|
|
|
.and_then(|h| h.to_str().ok()) |
|
|
|
.map(|h| h.eq_ignore_ascii_case("Upgrade")) |
|
|
|
.map(|h| h.eq_ignore_ascii_case("Upgrade")) |
|
|
@ -200,8 +167,7 @@ impl VerifyData { |
|
|
|
// the |Sec-WebSocket-Accept| contains a value other than the
|
|
|
|
// the |Sec-WebSocket-Accept| contains a value other than the
|
|
|
|
// base64-encoded SHA-1 of ... the client MUST _Fail the WebSocket
|
|
|
|
// base64-encoded SHA-1 of ... the client MUST _Fail the WebSocket
|
|
|
|
// Connection_. (RFC 6455)
|
|
|
|
// Connection_. (RFC 6455)
|
|
|
|
if !response |
|
|
|
if !headers |
|
|
|
.headers |
|
|
|
|
|
|
|
.get("Sec-WebSocket-Accept") |
|
|
|
.get("Sec-WebSocket-Accept") |
|
|
|
.map(|h| h == &self.accept_key) |
|
|
|
.map(|h| h == &self.accept_key) |
|
|
|
.unwrap_or(false) |
|
|
|
.unwrap_or(false) |
|
|
@ -228,16 +194,7 @@ impl VerifyData { |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/// Server response.
|
|
|
|
impl TryParse for Response<()> { |
|
|
|
#[derive(Debug)] |
|
|
|
|
|
|
|
pub struct Response { |
|
|
|
|
|
|
|
/// HTTP response code of the response.
|
|
|
|
|
|
|
|
pub code: u16, |
|
|
|
|
|
|
|
/// Received headers.
|
|
|
|
|
|
|
|
pub headers: HeaderMap, |
|
|
|
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
impl TryParse for Response { |
|
|
|
|
|
|
|
fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> { |
|
|
|
fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> { |
|
|
|
let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS]; |
|
|
|
let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS]; |
|
|
|
let mut req = httparse::Response::new(&mut hbuffer); |
|
|
|
let mut req = httparse::Response::new(&mut hbuffer); |
|
|
@ -248,17 +205,24 @@ impl TryParse for Response { |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
impl<'h, 'b: 'h> FromHttparse<httparse::Response<'h, 'b>> for Response { |
|
|
|
impl<'h, 'b: 'h> FromHttparse<httparse::Response<'h, 'b>> for Response<()> { |
|
|
|
fn from_httparse(raw: httparse::Response<'h, 'b>) -> Result<Self> { |
|
|
|
fn from_httparse(raw: httparse::Response<'h, 'b>) -> Result<Self> { |
|
|
|
if raw.version.expect("Bug: no HTTP version") < /*1.*/1 { |
|
|
|
if raw.version.expect("Bug: no HTTP version") < /*1.*/1 { |
|
|
|
return Err(Error::Protocol( |
|
|
|
return Err(Error::Protocol( |
|
|
|
"HTTP version should be 1.1 or higher".into(), |
|
|
|
"HTTP version should be 1.1 or higher".into(), |
|
|
|
)); |
|
|
|
)); |
|
|
|
} |
|
|
|
} |
|
|
|
Ok(Response { |
|
|
|
|
|
|
|
code: raw.code.expect("Bug: no HTTP response code"), |
|
|
|
let headers = HeaderMap::from_httparse(raw.headers)?; |
|
|
|
headers: HeaderMap::from_httparse(raw.headers)?, |
|
|
|
|
|
|
|
}) |
|
|
|
let mut response = Response::new(()); |
|
|
|
|
|
|
|
*response.status_mut() = StatusCode::from_u16(raw.code.expect("Bug: no HTTP status code"))?; |
|
|
|
|
|
|
|
*response.headers_mut() = headers; |
|
|
|
|
|
|
|
// TODO: httparse only supports HTTP 0.9/1.0/1.1 but not HTTP 2.0
|
|
|
|
|
|
|
|
// so the only valid value we could get in the response would be 1.1.
|
|
|
|
|
|
|
|
*response.version_mut() = http::Version::HTTP_11; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ok(response) |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
@ -295,7 +259,10 @@ mod tests { |
|
|
|
fn response_parsing() { |
|
|
|
fn response_parsing() { |
|
|
|
const DATA: &'static [u8] = b"HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n"; |
|
|
|
const DATA: &'static [u8] = b"HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n"; |
|
|
|
let (_, resp) = Response::try_parse(DATA).unwrap().unwrap(); |
|
|
|
let (_, resp) = Response::try_parse(DATA).unwrap().unwrap(); |
|
|
|
assert_eq!(resp.code, 200); |
|
|
|
assert_eq!(resp.status(), http::StatusCode::OK); |
|
|
|
assert_eq!(resp.headers.get("Content-Type").unwrap(), &b"text/html"[..],); |
|
|
|
assert_eq!( |
|
|
|
|
|
|
|
resp.headers().get("Content-Type").unwrap(), |
|
|
|
|
|
|
|
&b"text/html"[..], |
|
|
|
|
|
|
|
); |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|