Newer
Older
// Copyright 2019-2021 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.
use std::io;
use std::net::{SocketAddr, ToSocketAddrs};
use std::time::Duration;
use jsonrpsee_core::client::{CertificateStore, TransportReceiverT, TransportSenderT};
use jsonrpsee_core::TEN_MB_SIZE_BYTES;
use jsonrpsee_core::{async_trait, Cow};
use soketto::handshake::client::{Client as WsHandshakeClient, ServerResponse};
use stream::EitherStream;
use tokio::net::TcpStream;
pub use http::{uri::InvalidUri, Uri};
pub use soketto::handshake::client::Header;
inner: connection::Sender<BufReader<BufWriter<EitherStream>>>,
}
/// Receiving end of WebSocket transport.
inner: connection::Receiver<BufReader<BufWriter<EitherStream>>>,
/// Builder for a WebSocket transport [`Sender`] and ['Receiver`] pair.
#[derive(Debug)]
/// What certificate store to use
pub certificate_store: CertificateStore,
pub connection_timeout: Duration,
/// Custom headers to pass during the HTTP handshake. If `None`, no
/// custom header is passed.
pub headers: Vec<Header<'a>>,
/// Max payload size
David
committed
pub max_request_body_size: u32,
/// Max number of redirections.
pub max_redirections: usize,
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
impl<'a> Default for WsTransportClientBuilder<'a> {
fn default() -> Self {
Self {
certificate_store: CertificateStore::Native,
max_request_body_size: TEN_MB_SIZE_BYTES,
connection_timeout: Duration::from_secs(10),
headers: Vec::new(),
max_redirections: 5,
}
}
}
impl<'a> WsTransportClientBuilder<'a> {
/// Set whether to use system certificates (default is native).
pub fn certificate_store(mut self, certificate_store: CertificateStore) -> Self {
self.certificate_store = certificate_store;
self
}
/// Set max request body size (default is 10 MB).
pub fn max_request_body_size(mut self, size: u32) -> Self {
self.max_request_body_size = size;
self
}
/// Set connection timeout for the handshake (default is 10 seconds).
pub fn connection_timeout(mut self, timeout: Duration) -> Self {
self.connection_timeout = timeout;
self
}
/// Set a custom header passed to the server during the handshake (default is none).
///
/// The caller is responsible for checking that the headers do not conflict or are duplicated.
pub fn add_header(mut self, name: &'a str, value: &'a str) -> Self {
self.headers.push(Header { name, value: value.as_bytes() });
self
}
/// Set the max number of redirections to perform until a connection is regarded as failed.
/// (default is 5).
pub fn max_redirections(mut self, redirect: usize) -> Self {
self.max_redirections = redirect;
self
}
}
Niklas Adolfsson
committed
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Mode {
/// Plain mode (`ws://` URL).
Plain,
/// TLS mode (`wss://` URL).
Tls,
}
/// 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.
Url(Cow<'static, str>),
#[error("Error when opening the TCP socket: {0}")]
/// Error in the transport layer.
#[error("Error in the WebSocket handshake: {0}")]
Transport(#[source] soketto::handshake::Error),
InvalidDnsName(#[source] tokio_rustls::webpki::InvalidDnsNameError),
/// Server rejected the handshake.
#[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),
#[async_trait]
impl TransportSenderT for Sender {
type Error = WsError;
/// Sends out a request. Returns a `Future` that finishes when the request has been
async fn send(&mut self, body: String) -> Result<(), WsError> {
tracing::debug!("send: {}", body);
self.inner.send_text(body).await?;
self.inner.flush().await?;
Ok(())
}
Niklas Adolfsson
committed
/// Send a close message and close the connection.
async fn close(&mut self) -> Result<(), WsError> {
Niklas Adolfsson
committed
self.inner.close().await.map_err(Into::into)
}
#[async_trait]
impl TransportReceiverT for Receiver {
type Error = WsError;
/// Returns a `Future` resolving when the server sent us something back.
async fn receive(&mut self) -> Result<String, WsError> {
let mut message = Vec::new();
self.inner.receive_data(&mut message).await?;
let s = String::from_utf8(message).expect("Found invalid UTF-8");
Ok(s)
}
}
impl<'a> WsTransportClientBuilder<'a> {
/// Try to establish the connection.
pub async fn build(self, uri: Uri) -> Result<(Sender, Receiver), WsHandshakeError> {
let target: Target = uri.try_into()?;
self.try_connect(target).await
Niklas Adolfsson
committed
}
async fn try_connect(self, mut target: Target) -> Result<(Sender, Receiver), WsHandshakeError> {
// Only build TLS connector if `wss` in URL.
#[cfg(feature = "tls")]
let mut connector = match target._mode {
Mode::Tls => Some(build_tls_config(&self.certificate_store)?),
Mode::Plain => None,
};
tracing::debug!("Connecting to target: {:?}", target);
// The sockaddrs might get reused if the server replies with a relative URI.
let sockaddrs = std::mem::take(&mut target.sockaddrs);
for sockaddr in &sockaddrs {
let tcp_stream = match connect(*sockaddr, self.connection_timeout, &target.host, connector.as_ref()).await {
tracing::debug!("Failed to connect to sockaddr: {:?}", sockaddr);
err = Some(Err(e));
continue;
}
};
let tcp_stream = match connect(*sockaddr, self.connection_timeout).await {
Ok(stream) => stream,
Err(e) => {
tracing::debug!("Failed to connect to sockaddr: {:?}", sockaddr);
err = Some(Err(e));
continue;
}
};
let mut client = WsHandshakeClient::new(
BufReader::new(BufWriter::new(tcp_stream)),
&target.host_header,
&target.path_and_query,
);
client.set_headers(&self.headers);
// Perform the initial handshake.
match client.handshake().await {
Ok(ServerResponse::Accepted { .. }) => {
tracing::info!("Connection established to target: {:?}", target);
let mut builder = client.into_builder();
builder.set_max_message_size(self.max_request_body_size as usize);
let (sender, receiver) = builder.finish();
return Ok((Sender { inner: sender }, Receiver { inner: receiver }));
}
Ok(ServerResponse::Rejected { status_code }) => {
tracing::debug!("Connection rejected: {:?}", status_code);
err = Some(Err(WsHandshakeError::Rejected { status_code }));
}
Ok(ServerResponse::Redirect { status_code, location }) => {
tracing::debug!("Redirection: status_code: {}, location: {}", status_code, location);
match location.parse::<Uri>() {
// redirection with absolute path => need to lookup.
Ok(uri) => {
// Absolute URI.
if uri.scheme().is_some() {
target = uri.try_into().map_err(|e| {
tracing::error!("Redirection failed: {:?}", e);
e
})?;
// Only build TLS connector if `wss` in redirection URL.
#[cfg(feature = "tls")]
Mode::Tls if connector.is_none() => {
connector = Some(build_tls_config(&self.certificate_store)?);
}
Mode::Tls => (),
// Drop connector if it was configured previously.
Mode::Plain => {
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
}
};
}
// Relative URI.
else {
// Replace the entire path_and_query if `location` starts with `/` or `//`.
if location.starts_with('/') {
target.path_and_query = location;
} else {
match target.path_and_query.rfind('/') {
Some(offset) => {
target.path_and_query.replace_range(offset + 1.., &location)
}
None => {
err = Some(Err(WsHandshakeError::Url(
format!(
"path_and_query: {}; this is a bug it must contain `/` please open issue",
location
)
.into(),
)));
continue;
}
};
}
target.sockaddrs = sockaddrs;
}
}
Err(e) => {
err = Some(Err(WsHandshakeError::Url(e.to_string().into())));
}
};
}
Err(e) => {
err = Some(Err(e.into()));
}
};
err.unwrap_or(Err(WsHandshakeError::NoAddressFound(target.host)))
}
}
async fn connect(
sockaddr: SocketAddr,
timeout_dur: Duration,
host: &str,
tls_connector: Option<&tokio_rustls::TlsConnector>,
) -> Result<EitherStream, WsHandshakeError> {
let socket = TcpStream::connect(sockaddr);
let timeout = tokio::time::sleep(timeout_dur);
tokio::select! {
socket = socket => {
let socket = socket?;
if let Err(err) = socket.set_nodelay(true) {
tracing::warn!("set nodelay failed: {:?}", err);
None => Ok(EitherStream::Plain(socket)),
let server_name: tokio_rustls::rustls::ServerName = host.try_into().map_err(|e| WsHandshakeError::Url(format!("Invalid host: {} {:?}", host, e).into()))?;
let tls_stream = connector.connect(server_name, socket).await?;
}
}
}
_ = timeout => Err(WsHandshakeError::Timeout(timeout_dur))
#[cfg(not(feature = "tls"))]
async fn connect(sockaddr: SocketAddr, timeout_dur: Duration) -> Result<EitherStream, WsHandshakeError> {
let socket = TcpStream::connect(sockaddr);
let timeout = tokio::time::sleep(timeout_dur);
tokio::select! {
socket = socket => {
let socket = socket?;
if let Err(err) = socket.set_nodelay(true) {
tracing::warn!("set nodelay failed: {:?}", err);
}
Ok(EitherStream::Plain(socket))
}
_ = timeout => Err(WsHandshakeError::Timeout(timeout_dur))
}
}
impl From<io::Error> for WsHandshakeError {
fn from(err: io::Error) -> WsHandshakeError {
WsHandshakeError::Io(err)
#[cfg(feature = "tls")]
impl From<tokio_rustls::webpki::InvalidDnsNameError> for WsHandshakeError {
fn from(err: tokio_rustls::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
/// 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,
/// The Host request header specifies the host and port number of the server to which the request is being sent.
host_header: String,
/// WebSocket stream mode, see [`Mode`] for further documentation.
/// The path and query parts from an URL.
path_and_query: String,
impl TryFrom<Uri> for Target {
type Error = WsHandshakeError;
fn try_from(uri: Uri) -> Result<Self, Self::Error> {
let _mode = match uri.scheme_str() {
invalid_scheme => {
let scheme = invalid_scheme.unwrap_or("no scheme");
let err = format!("`{}` not supported, expects 'ws' or 'wss'", scheme);
let err = format!("`{}` not supported, expects 'ws' ('wss' requires the tls feature)", scheme);
return Err(WsHandshakeError::Url(err.into()));
}
let host = uri.host().map(ToOwned::to_owned).ok_or_else(|| WsHandshakeError::Url("No host in URL".into()))?;
let port = uri
.port_u16()
.ok_or_else(|| WsHandshakeError::Url("No port number in URL (default port is not supported)".into()))?;
let host_header = format!("{}:{}", host, port);
let parts = uri.into_parts();
let path_and_query = parts.path_and_query.ok_or_else(|| WsHandshakeError::Url("No path in URL".into()))?;
let sockaddrs = host_header.to_socket_addrs().map_err(WsHandshakeError::ResolutionFailed)?;
Ok(Self {
sockaddrs: sockaddrs.collect(),
host,
host_header,
_mode,
path_and_query: path_and_query.to_string(),
})
}
// NOTE: this is slow and should be used sparingly.
#[cfg(feature = "tls")]
fn build_tls_config(cert_store: &CertificateStore) -> Result<tokio_rustls::TlsConnector, WsHandshakeError> {
use tokio_rustls::rustls;
let mut roots = rustls::RootCertStore::empty();
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
match cert_store {
CertificateStore::Native => {
let mut first_error = None;
let certs = rustls_native_certs::load_native_certs().map_err(WsHandshakeError::CertificateStore)?;
for cert in certs {
let cert = rustls::Certificate(cert.0);
if let Err(err) = roots.add(&cert) {
first_error = first_error.or_else(|| Some(io::Error::new(io::ErrorKind::InvalidData, err)));
}
}
if roots.is_empty() {
let err = first_error
.unwrap_or_else(|| io::Error::new(io::ErrorKind::NotFound, "No valid certificate found"));
return Err(WsHandshakeError::CertificateStore(err));
}
}
CertificateStore::WebPki => {
roots.add_server_trust_anchors(webpki_roots::TLS_SERVER_ROOTS.0.iter().map(|ta| {
rustls::OwnedTrustAnchor::from_subject_spki_name_constraints(ta.subject, ta.spki, ta.name_constraints)
}));
}
_ => {
let err = io::Error::new(io::ErrorKind::NotFound, "Invalid certificate store");
return Err(WsHandshakeError::CertificateStore(err));
}
};
let config =
rustls::ClientConfig::builder().with_safe_defaults().with_root_certificates(roots).with_no_client_auth();
Ok(std::sync::Arc::new(config).into())
}
Niklas Adolfsson
committed
#[cfg(test)]
mod tests {
use super::{Mode, Target, Uri, WsHandshakeError};
use http::uri::InvalidUri;
fn assert_ws_target(target: Target, host: &str, host_header: &str, mode: Mode, path_and_query: &str) {
assert_eq!(&target.host, host);
assert_eq!(&target.host_header, host_header);
assert_eq!(target._mode, mode);
assert_eq!(&target.path_and_query, path_and_query);
Niklas Adolfsson
committed
fn parse_target(uri: &str) -> Result<Target, WsHandshakeError> {
uri.parse::<Uri>().map_err(|e: InvalidUri| WsHandshakeError::Url(e.to_string().into()))?.try_into()
}
Niklas Adolfsson
committed
#[test]
fn ws_works() {
let target = parse_target("ws://127.0.0.1:9933").unwrap();
assert_ws_target(target, "127.0.0.1", "127.0.0.1:9933", Mode::Plain, "/");
Niklas Adolfsson
committed
}
Niklas Adolfsson
committed
#[test]
fn wss_works() {
let target = parse_target("wss://kusama-rpc.polkadot.io:443").unwrap();
assert_ws_target(target, "kusama-rpc.polkadot.io", "kusama-rpc.polkadot.io:443", Mode::Tls, "/");
Niklas Adolfsson
committed
}
#[cfg(not(feature = "tls"))]
#[test]
fn wss_fails_with_tls_feature() {
let err = parse_target("wss://kusama-rpc.polkadot.io:443").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
}
Niklas Adolfsson
committed
#[test]
fn faulty_url_scheme() {
let err = parse_target("http://kusama-rpc.polkadot.io:443").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
Niklas Adolfsson
committed
}
#[test]
fn faulty_port() {
let err = parse_target("ws://127.0.0.1:-43").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
let err = parse_target("ws://127.0.0.1:99999").unwrap_err();
assert!(matches!(err, WsHandshakeError::Url(_)));
Niklas Adolfsson
committed
}
#[test]
fn url_with_path_works() {
let target = parse_target("ws://127.0.0.1:443/my-special-path").unwrap();
assert_ws_target(target, "127.0.0.1", "127.0.0.1:443", Mode::Plain, "/my-special-path");
Niklas Adolfsson
committed
}
#[test]
fn url_with_query_works() {
let target = parse_target("ws://127.0.0.1:443/my?name1=value1&name2=value2").unwrap();
assert_ws_target(target, "127.0.0.1", "127.0.0.1:443", Mode::Plain, "/my?name1=value1&name2=value2");
}
#[test]
fn url_with_fragment_is_ignored() {
let target = parse_target("ws://127.0.0.1:443/my.htm#ignore").unwrap();
assert_ws_target(target, "127.0.0.1", "127.0.0.1:443", Mode::Plain, "/my.htm");