Newer
Older
// Copyright 2019 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
Niklas Adolfsson
committed
use async_std::net::TcpStream;
use async_tls::client::TlsStream;
use futures::io::{BufReader, BufWriter};
use futures::prelude::*;
use soketto::connection;
use soketto::handshake::client::{Client as WsRawClient, ServerResponse};
use std::{borrow::Cow, io, net::SocketAddr, time::Duration};
use thiserror::Error;
type TlsOrPlain = crate::stream::EitherStream<TcpStream, TlsStream<TcpStream>>;
/// Sending end of WebSocket transport.
pub struct Sender {
inner: connection::Sender<BufReader<BufWriter<TlsOrPlain>>>,
}
/// Receiving end of WebSocket transport.
pub struct Receiver {
inner: connection::Receiver<BufReader<BufWriter<TlsOrPlain>>>,
}
/// Builder for a WebSocket transport [`Sender`] and ['Receiver`] pair.
#[derive(Debug)]
/// What certificate store to use
pub certificate_store: CertificateStore,
/// Remote WebSocket target.
pub target: Target,
pub timeout: Duration,
/// `Origin` header to pass during the HTTP handshake. If `None`, no
/// `Origin` header is passed.
pub origin_header: Option<Cow<'a, str>>,
/// Max payload size
David
committed
pub max_request_body_size: u32,
}
/// Stream mode, either plain TCP or TLS.
Niklas Adolfsson
committed
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Mode {
/// Plain mode (`ws://` URL).
Plain,
/// TLS mode (`wss://` URL).
Tls,
}
/// What certificate store to use
#[derive(Clone, Copy, Debug, PartialEq)]
#[non_exhaustive]
pub enum CertificateStore {
/// Use the native system certificate store
Native,
/// Use webPki's certificate store
WebPki,
}
/// Error that can happen during the WebSocket handshake.
///
/// If multiple IP addresses are attempted, only the last error is returned, similar to how
/// [`std::net::TcpStream::connect`] behaves.
pub enum WsHandshakeError {
/// Failed to load system certs
#[error("Failed to load system certs: {}", 0)]
CertificateStore(io::Error),
/// Invalid URL.
#[error("Invalid url: {}", 0)]
Url(Cow<'static, str>),
/// Error when opening the TCP socket.
#[error("Error when opening the TCP socket: {}", 0)]
Io(io::Error),
/// Error in the transport layer.
#[error("Error in the WebSocket handshake: {}", 0)]
Transport(#[source] soketto::handshake::Error),
/// Invalid DNS name error for TLS
#[error("Invalid DNS name: {}", 0)]
InvalidDnsName(#[source] webpki::InvalidDnsNameError),
#[error("Connection rejected with status code: {}", status_code)]
Rejected {
/// HTTP status code that the server returned.
status_code: u16,
},
/// Timeout while trying to connect.
#[error("Connection timeout exceeded: {}", 0)]
Timeout(Duration),
/// Failed to resolve IP addresses for this hostname.
#[error("Failed to resolve IP addresses for this hostname: {}", 0)]
ResolutionFailed(io::Error),
/// Couldn't find any IP address for this hostname.
#[error("No IP address found for this hostname: {}", 0)]
NoAddressFound(String),
/// Error that can occur when reading or sending messages on an established connection.
pub enum WsError {
#[error("WebSocket connection error: {}", 0)]
Connection(#[source] soketto::connection::Error),
/// Failed to parse the message in JSON.
#[error("Failed to parse message in JSON: {}", 0)]
ParseError(#[source] serde_json::error::Error),
}
impl Sender {
/// Sends out a request. Returns a `Future` that finishes when the request has been
pub async fn send(&mut self, body: String) -> Result<(), WsError> {
log::debug!("send: {}", body);
self.inner.send_text(body).await?;
self.inner.flush().await?;
Ok(())
}
}
impl Receiver {
/// Returns a `Future` resolving when the server sent us something back.
pub async fn next_response(&mut self) -> Result<Vec<u8>, WsError> {
let mut message = Vec::new();
self.inner.receive_data(&mut message).await?;
}
}
impl<'a> WsTransportClientBuilder<'a> {
/// Try to establish the connection.
Niklas Adolfsson
committed
pub async fn build(self) -> Result<(Sender, Receiver), WsHandshakeError> {
let connector = match self.target.mode {
Mode::Tls => {
let mut client_config = rustls::ClientConfig::default();
if let CertificateStore::Native = self.certificate_store {
client_config.root_store = rustls_native_certs::load_native_certs()
.map_err(|(_, e)| WsHandshakeError::CertificateStore(e))?;
}
Some(client_config.into())
}
Mode::Plain => None,
};
let mut err = None;
for sockaddr in &self.target.sockaddrs {
match self.try_connect(*sockaddr, &connector).await {
Niklas Adolfsson
committed
Ok(res) => return Ok(res),
Err(e) => {
log::debug!("Failed to connect to sockaddr: {:?} with err: {:?}", sockaddr, e);
err = Some(Err(e));
Niklas Adolfsson
committed
}
}
}
// NOTE(niklasad1): this is most likely unreachable because [`Url::socket_addrs`] doesn't
// return an empty `Vec` if no socket address was found for the host name.
err.unwrap_or(Err(WsHandshakeError::NoAddressFound(self.target.host)))
Niklas Adolfsson
committed
}
async fn try_connect(
&self,
sockaddr: SocketAddr,
tls_connector: &Option<async_tls::TlsConnector>,
) -> Result<(Sender, Receiver), WsHandshakeError> {
// Try establish the TCP connection.
let tcp_stream = {
Niklas Adolfsson
committed
let socket = TcpStream::connect(sockaddr);
let timeout = async_std::task::sleep(self.timeout);
futures::pin_mut!(socket, timeout);
match future::select(socket, timeout).await {
future::Either::Left((socket, _)) => {
let socket = socket?;
if let Err(err) = socket.set_nodelay(true) {
log::warn!("set nodelay failed: {:?}", err);
match tls_connector {
None => TlsOrPlain::Plain(socket),
Some(connector) => {
let dns_name: &str =
webpki::DnsNameRef::try_from_ascii_str(self.target.host.as_str())?.into();
let tls_stream = connector.connect(dns_name, socket).await?;
TlsOrPlain::Tls(tls_stream)
}
}
}
future::Either::Right((_, _)) => return Err(WsHandshakeError::Timeout(self.timeout)),
Niklas Adolfsson
committed
let mut client =
WsRawClient::new(BufReader::new(BufWriter::new(tcp_stream)), &self.target.host, &self.target.path);
if let Some(origin) = self.origin_header.as_ref() {
client.set_origin(origin);
}
// Perform the initial handshake.
match client.handshake().await? {
ServerResponse::Accepted { .. } => {}
ServerResponse::Rejected { status_code } | ServerResponse::Redirect { status_code, .. } => {
// TODO: HTTP redirects also lead here #339.
return Err(WsHandshakeError::Rejected { status_code });
}
}
// If the handshake succeeded, return.
let mut builder = client.into_builder();
David
committed
builder.set_max_message_size(self.max_request_body_size as usize);
let (sender, receiver) = builder.finish();
Ok((Sender { inner: sender }, Receiver { inner: receiver }))
}
}
impl From<io::Error> for WsHandshakeError {
fn from(err: io::Error) -> WsHandshakeError {
WsHandshakeError::Io(err)
impl From<webpki::InvalidDnsNameError> for WsHandshakeError {
fn from(err: webpki::InvalidDnsNameError) -> WsHandshakeError {
WsHandshakeError::InvalidDnsName(err)
impl From<soketto::handshake::Error> for WsHandshakeError {
fn from(err: soketto::handshake::Error) -> WsHandshakeError {
WsHandshakeError::Transport(err)
impl From<soketto::connection::Error> for WsError {
fn from(err: soketto::connection::Error) -> Self {
WsError::Connection(err)
Niklas Adolfsson
committed
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
/// Represents a verified remote WebSocket address.
#[derive(Debug, Clone)]
pub struct Target {
/// Socket addresses resolved the host name.
sockaddrs: Vec<SocketAddr>,
/// The host name (domain or IP address).
host: String,
/// WebSocket stream mode, see [`Mode`] for further documentation.
mode: Mode,
/// The HTTP host resource path.
path: String,
}
impl Target {
/// Parse an URL String to a WebSocket address.
pub fn parse(url: impl AsRef<str>) -> Result<Self, WsHandshakeError> {
let url =
url::Url::parse(url.as_ref()).map_err(|e| WsHandshakeError::Url(format!("Invalid URL: {}", e).into()))?;
let mode = match url.scheme() {
"ws" => Mode::Plain,
"wss" => Mode::Tls,
_ => return Err(WsHandshakeError::Url("URL scheme not supported, expects 'ws' or 'wss'".into())),
};
let host =
url.host_str().map(ToOwned::to_owned).ok_or_else(|| WsHandshakeError::Url("No host in URL".into()))?;
// NOTE: `Url::socket_addrs` is using the default port if it's missing (ws:// - 80, wss:// - 443)
let sockaddrs = url.socket_addrs(|| None).map_err(WsHandshakeError::ResolutionFailed)?;
Ok(Self { sockaddrs, host, mode, path: url.path().to_owned() })
}
}
Niklas Adolfsson
committed
#[cfg(test)]
mod tests {
use super::{Mode, Target, WsHandshakeError};
fn assert_ws_target(target: Target, host: &str, mode: Mode, path: &str) {
assert_eq!(&target.host, host);
assert_eq!(target.mode, mode);
assert_eq!(&target.path, path);
}
Niklas Adolfsson
committed
#[test]
fn ws_works() {
let target = Target::parse("ws://127.0.0.1:9933").unwrap();
assert_ws_target(target, "127.0.0.1", Mode::Plain, "/");
Niklas Adolfsson
committed
}
#[test]
fn wss_works() {
let target = Target::parse("wss://kusama-rpc.polkadot.io:443").unwrap();
assert_ws_target(target, "kusama-rpc.polkadot.io", Mode::Tls, "/");
Niklas Adolfsson
committed
}
#[test]
fn faulty_url_scheme() {
let err = Target::parse("http://kusama-rpc.polkadot.io:443").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
Niklas Adolfsson
committed
}
#[test]
fn faulty_port() {
let err = Target::parse("ws://127.0.0.1:-43").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
let err = Target::parse("ws://127.0.0.1:99999").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
Niklas Adolfsson
committed
}
#[test]
fn default_port_works() {
let target = Target::parse("ws://127.0.0.1").unwrap();
assert_ws_target(target, "127.0.0.1", Mode::Plain, "/");
}
#[test]
fn url_with_path_works() {
let target = Target::parse("ws://127.0.0.1/my-special-path").unwrap();
assert_ws_target(target, "127.0.0.1", Mode::Plain, "/my-special-path");