Add some helpers for substream upgrades (#896)

* Add some helpers for substream upgrades

* Fix compilation

* Fix compilation for 32bits

* Fix some concerns

* Add read_one_then

* Fixes
This commit is contained in:
Pierre Krieger
2019-01-29 16:20:14 +01:00
committed by GitHub
parent fe4fc8c363
commit b8dfa724fd
4 changed files with 549 additions and 65 deletions

View File

@ -26,6 +26,7 @@ smallvec = "0.6"
tokio-executor = "0.1.4" tokio-executor = "0.1.4"
tokio-io = "0.1" tokio-io = "0.1"
tokio-timer = "0.2" tokio-timer = "0.2"
unsigned-varint = "0.2"
void = "1" void = "1"
[dev-dependencies] [dev-dependencies]

View File

@ -63,6 +63,7 @@ mod either;
mod error; mod error;
mod map; mod map;
mod select; mod select;
mod transfer;
use futures::future::Future; use futures::future::Future;
@ -72,7 +73,8 @@ pub use self::{
either::EitherUpgrade, either::EitherUpgrade,
error::UpgradeError, error::UpgradeError,
map::{MapInboundUpgrade, MapOutboundUpgrade, MapInboundUpgradeErr, MapOutboundUpgradeErr}, map::{MapInboundUpgrade, MapOutboundUpgrade, MapInboundUpgradeErr, MapOutboundUpgradeErr},
select::SelectUpgrade select::SelectUpgrade,
transfer::{write_one, WriteOne, read_one, ReadOne, read_one_then, ReadOneThen, ReadOneError, request_response, RequestResponse},
}; };
/// Types serving as protocol names. /// Types serving as protocol names.

View File

@ -0,0 +1,462 @@
// 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.
//! Contains some helper futures for creating upgrades.
use futures::{prelude::*, try_ready};
use std::{cmp, error, fmt, io::Cursor, mem};
use tokio_io::{io, AsyncRead, AsyncWrite};
/// Send a message to the given socket, then shuts down the writing side.
///
/// > **Note**: Prepends a variable-length prefix indicate the length of the message. This is
/// > compatible with what `read_one` expects.
#[inline]
pub fn write_one<TSocket, TData>(socket: TSocket, data: TData) -> WriteOne<TSocket, TData>
where
TSocket: AsyncWrite,
TData: AsRef<[u8]>,
{
let len_data = build_int_buffer(data.as_ref().len());
WriteOne {
inner: WriteOneInner::WriteLen(io::write_all(socket, len_data), data),
}
}
/// Builds a buffer that contains the given integer encoded as variable-length.
fn build_int_buffer(num: usize) -> io::Window<[u8; 10]> {
let mut len_data = unsigned_varint::encode::u64_buffer();
let encoded_len = unsigned_varint::encode::u64(num as u64, &mut len_data).len();
let mut len_data = io::Window::new(len_data);
len_data.set_end(encoded_len);
len_data
}
/// Future that makes `write_one` work.
pub struct WriteOne<TSocket, TData = Vec<u8>> {
inner: WriteOneInner<TSocket, TData>,
}
enum WriteOneInner<TSocket, TData> {
/// We need to write the data length to the socket.
WriteLen(io::WriteAll<TSocket, io::Window<[u8; 10]>>, TData),
/// We need to write the actual data to the socket.
Write(io::WriteAll<TSocket, TData>),
/// We need to shut down the socket.
Shutdown(io::Shutdown<TSocket>),
/// A problem happened during the processing.
Poisoned,
}
impl<TSocket, TData> Future for WriteOne<TSocket, TData>
where
TSocket: AsyncWrite,
TData: AsRef<[u8]>,
{
type Item = ();
type Error = std::io::Error;
#[inline]
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
Ok(self.inner.poll()?.map(|_socket| ()))
}
}
impl<TSocket, TData> Future for WriteOneInner<TSocket, TData>
where
TSocket: AsyncWrite,
TData: AsRef<[u8]>,
{
type Item = TSocket;
type Error = std::io::Error;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
loop {
match mem::replace(self, WriteOneInner::Poisoned) {
WriteOneInner::WriteLen(mut inner, data) => match inner.poll()? {
Async::Ready((socket, _)) => {
*self = WriteOneInner::Write(io::write_all(socket, data));
}
Async::NotReady => {
*self = WriteOneInner::WriteLen(inner, data);
}
},
WriteOneInner::Write(mut inner) => match inner.poll()? {
Async::Ready((socket, _)) => {
*self = WriteOneInner::Shutdown(tokio_io::io::shutdown(socket));
}
Async::NotReady => {
*self = WriteOneInner::Write(inner);
}
},
WriteOneInner::Shutdown(ref mut inner) => {
let socket = try_ready!(inner.poll());
return Ok(Async::Ready(socket));
}
WriteOneInner::Poisoned => panic!(),
}
}
}
}
/// Reads a message from the given socket. Only one message is processed and the socket is dropped,
/// because we assume that the socket will not send anything more.
///
/// The `max_size` parameter is the maximum size in bytes of the message that we accept. This is
/// necessary in order to avoid DoS attacks where the remote sends us a message of several
/// gigabytes.
///
/// > **Note**: Assumes that a variable-length prefix indicates the length of the message. This is
/// > compatible with what `write_one` does.
#[inline]
pub fn read_one<TSocket>(
socket: TSocket,
max_size: usize,
) -> ReadOne<TSocket>
{
ReadOne {
inner: ReadOneInner::ReadLen {
socket,
len_buf: Cursor::new([0; 10]),
max_size,
},
}
}
/// Future that makes `read_one` work.
pub struct ReadOne<TSocket> {
inner: ReadOneInner<TSocket>,
}
enum ReadOneInner<TSocket> {
// We need to read the data length from the socket.
ReadLen {
socket: TSocket,
/// A small buffer where we will right the variable-length integer representing the
/// length of the actual packet.
len_buf: Cursor<[u8; 10]>,
max_size: usize,
},
// We need to read the actual data from the socket.
ReadRest(io::ReadExact<TSocket, io::Window<Vec<u8>>>),
/// A problem happened during the processing.
Poisoned,
}
impl<TSocket> Future for ReadOne<TSocket>
where
TSocket: AsyncRead,
{
type Item = Vec<u8>;
type Error = ReadOneError;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
loop {
match mem::replace(&mut self.inner, ReadOneInner::Poisoned) {
ReadOneInner::ReadLen {
mut socket,
mut len_buf,
max_size,
} => {
match socket.read_buf(&mut len_buf)? {
Async::Ready(num_read) => {
// Reaching EOF before finishing to read the length is an error.
if num_read == 0 {
return Err(ReadOneError::Io(
std::io::ErrorKind::UnexpectedEof.into(),
));
}
let len_buf_with_data =
&len_buf.get_ref()[..len_buf.position() as usize];
if let Ok((len, data_start)) =
unsigned_varint::decode::usize(len_buf_with_data)
{
if len >= max_size {
return Err(ReadOneError::TooLarge {
requested: len,
max: max_size,
});
}
// Create `data_buf` containing the start of the data that was
// already in `len_buf`.
let n = cmp::min(data_start.len(), len);
let mut data_buf = vec![0; len];
data_buf[.. n].copy_from_slice(&data_start[.. n]);
let mut data_buf = io::Window::new(data_buf);
data_buf.set_start(data_start.len());
self.inner =
ReadOneInner::ReadRest(io::read_exact(socket, data_buf));
} else {
self.inner = ReadOneInner::ReadLen {
socket,
len_buf,
max_size,
};
}
}
Async::NotReady => {
self.inner = ReadOneInner::ReadLen {
socket,
len_buf,
max_size,
};
}
}
}
ReadOneInner::ReadRest(mut inner) => {
match inner.poll()? {
Async::Ready((_, data)) => {
return Ok(Async::Ready(data.into_inner()));
}
Async::NotReady => {
self.inner = ReadOneInner::ReadRest(inner);
}
}
}
ReadOneInner::Poisoned => panic!(),
}
}
}
}
/// Error while reading one message.
#[derive(Debug)]
pub enum ReadOneError {
/// Error on the socket.
Io(std::io::Error),
/// Requested data is over the maximum allowed size.
TooLarge {
/// Size requested by the remote.
requested: usize,
/// Maximum allowed.
max: usize,
},
}
impl From<std::io::Error> for ReadOneError {
#[inline]
fn from(err: std::io::Error) -> ReadOneError {
ReadOneError::Io(err)
}
}
impl fmt::Display for ReadOneError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
ReadOneError::Io(ref err) => write!(f, "{}", err),
ReadOneError::TooLarge { .. } => write!(f, "Received data size over maximum"),
}
}
}
impl error::Error for ReadOneError {
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
match *self {
ReadOneError::Io(ref err) => Some(err),
ReadOneError::TooLarge { .. } => None,
}
}
}
/// Similar to `read_one`, but applies a transformation on the output buffer.
#[inline]
pub fn read_one_then<TSocket, TThen, TOut, TErr>(
socket: TSocket,
max_size: usize,
then: TThen,
) -> ReadOneThen<TSocket, TThen>
where
TSocket: AsyncRead,
TThen: FnOnce(Vec<u8>) -> Result<TOut, TErr>,
TErr: From<ReadOneError>,
{
ReadOneThen {
inner: read_one(socket, max_size),
then: Some(then),
}
}
/// Future that makes `read_one_then` work.
pub struct ReadOneThen<TSocket, TThen> {
inner: ReadOne<TSocket>,
then: Option<TThen>,
}
impl<TSocket, TThen, TOut, TErr> Future for ReadOneThen<TSocket, TThen>
where
TSocket: AsyncRead,
TThen: FnOnce(Vec<u8>) -> Result<TOut, TErr>,
TErr: From<ReadOneError>,
{
type Item = TOut;
type Error = TErr;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
match self.inner.poll()? {
Async::Ready(buffer) => {
let then = self.then.take().expect("Future was polled after it was finished");
Ok(Async::Ready(then(buffer)?))
},
Async::NotReady => Ok(Async::NotReady),
}
}
}
/// Send a message to the given socket, then shuts down the writing side, then reads an answer.
///
/// This combines `write_one` followed with `read_one`.
#[inline]
pub fn request_response<TSocket, TData, TThen, TOut, TErr>(
socket: TSocket,
data: TData,
max_size: usize,
then: TThen,
) -> RequestResponse<TSocket, TThen, TData>
where
TSocket: AsyncRead + AsyncWrite,
TData: AsRef<[u8]>,
TThen: FnOnce(Vec<u8>) -> Result<TOut, TErr>,
{
RequestResponse {
inner: RequestResponseInner::Write(write_one(socket, data).inner, max_size, then),
}
}
/// Future that makes `request_response` work.
pub struct RequestResponse<TSocket, TThen, TData = Vec<u8>> {
inner: RequestResponseInner<TSocket, TData, TThen>,
}
enum RequestResponseInner<TSocket, TData, TThen> {
// We need to write data to the socket.
Write(WriteOneInner<TSocket, TData>, usize, TThen),
// We need to read the message.
Read(ReadOneThen<TSocket, TThen>),
// An error happened during the processing.
Poisoned,
}
impl<TSocket, TData, TThen, TOut, TErr> Future for RequestResponse<TSocket, TThen, TData>
where
TSocket: AsyncRead + AsyncWrite,
TData: AsRef<[u8]>,
TThen: FnOnce(Vec<u8>) -> Result<TOut, TErr>,
TErr: From<ReadOneError>,
{
type Item = TOut;
type Error = TErr;
fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
loop {
match mem::replace(&mut self.inner, RequestResponseInner::Poisoned) {
RequestResponseInner::Write(mut inner, max_size, then) => {
match inner.poll().map_err(ReadOneError::Io)? {
Async::Ready(socket) => {
self.inner =
RequestResponseInner::Read(read_one_then(socket, max_size, then));
}
Async::NotReady => {
self.inner = RequestResponseInner::Write(inner, max_size, then);
}
}
}
RequestResponseInner::Read(mut inner) => match inner.poll()? {
Async::Ready(packet) => return Ok(Async::Ready(packet)),
Async::NotReady => {
self.inner = RequestResponseInner::Read(inner);
}
},
RequestResponseInner::Poisoned => panic!(),
};
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::Cursor;
use tokio::runtime::current_thread::Runtime;
#[test]
fn write_one_works() {
let data = (0..rand::random::<usize>() % 10_000)
.map(|_| rand::random::<u8>())
.collect::<Vec<_>>();
let mut out = vec![0; 10_000];
let future = write_one(Cursor::new(&mut out[..]), data.clone());
Runtime::new().unwrap().block_on(future).unwrap();
let (out_len, out_data) = unsigned_varint::decode::usize(&out).unwrap();
assert_eq!(out_len, data.len());
assert_eq!(&out_data[..out_len], &data[..]);
}
#[test]
fn read_one_works() {
let original_data = (0..rand::random::<usize>() % 10_000)
.map(|_| rand::random::<u8>())
.collect::<Vec<_>>();
let mut len_buf = unsigned_varint::encode::usize_buffer();
let len_buf = unsigned_varint::encode::usize(original_data.len(), &mut len_buf);
let mut in_buffer = len_buf.to_vec();
in_buffer.extend_from_slice(&original_data);
let future = read_one_then(Cursor::new(in_buffer), 10_000, move |out| -> Result<_, ReadOneError> {
assert_eq!(out, original_data);
Ok(())
});
Runtime::new().unwrap().block_on(future).unwrap();
}
#[test]
fn read_one_zero_len() {
let future = read_one_then(Cursor::new(vec![0]), 10_000, move |out| -> Result<_, ReadOneError> {
assert!(out.is_empty());
Ok(())
});
Runtime::new().unwrap().block_on(future).unwrap();
}
#[test]
fn read_checks_length() {
let mut len_buf = unsigned_varint::encode::u64_buffer();
let len_buf = unsigned_varint::encode::u64(5_000, &mut len_buf);
let mut in_buffer = len_buf.to_vec();
in_buffer.extend((0..5000).map(|_| 0));
let future = read_one_then(Cursor::new(in_buffer), 100, move |_| -> Result<_, ReadOneError> {
Ok(())
});
match Runtime::new().unwrap().block_on(future) {
Err(ReadOneError::TooLarge { .. }) => (),
_ => panic!(),
}
}
}

View File

@ -20,14 +20,10 @@
use crate::rpc_proto; use crate::rpc_proto;
use crate::topic::TopicHash; use crate::topic::TopicHash;
use bytes::BytesMut; use libp2p_core::{InboundUpgrade, OutboundUpgrade, UpgradeInfo, PeerId, upgrade};
use futures::{future, stream, Future, Stream}; use protobuf::{ProtobufError, Message as ProtobufMessage};
use libp2p_core::{InboundUpgrade, OutboundUpgrade, UpgradeInfo, PeerId}; use std::{error, fmt, io, iter};
use protobuf::Message as ProtobufMessage;
use std::{io, iter};
use tokio_codec::{Decoder, FramedRead};
use tokio_io::{AsyncRead, AsyncWrite}; use tokio_io::{AsyncRead, AsyncWrite};
use unsigned_varint::codec;
/// Implementation of `ConnectionUpgrade` for the floodsub protocol. /// Implementation of `ConnectionUpgrade` for the floodsub protocol.
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
@ -56,69 +52,94 @@ where
TSocket: AsyncRead, TSocket: AsyncRead,
{ {
type Output = FloodsubRpc; type Output = FloodsubRpc;
type Error = io::Error; type Error = FloodsubDecodeError;
type Future = future::MapErr<future::AndThen<stream::StreamFuture<FramedRead<TSocket, FloodsubCodec>>, Result<FloodsubRpc, (io::Error, FramedRead<TSocket, FloodsubCodec>)>, fn((Option<FloodsubRpc>, FramedRead<TSocket, FloodsubCodec>)) -> Result<FloodsubRpc, (io::Error, FramedRead<TSocket, FloodsubCodec>)>>, fn((io::Error, FramedRead<TSocket, FloodsubCodec>)) -> io::Error>; type Future = upgrade::ReadOneThen<TSocket, fn(Vec<u8>) -> Result<FloodsubRpc, FloodsubDecodeError>>;
#[inline] #[inline]
fn upgrade_inbound(self, socket: TSocket, _: Self::Info) -> Self::Future { fn upgrade_inbound(self, socket: TSocket, _: Self::Info) -> Self::Future {
FramedRead::new(socket, FloodsubCodec { length_prefix: Default::default() }) upgrade::read_one_then(socket, 2048, |packet| {
.into_future() let mut rpc: rpc_proto::RPC = protobuf::parse_from_bytes(&packet)?;
.and_then::<fn(_) -> _, _>(|(val, socket)| {
val.ok_or_else(move || (io::ErrorKind::UnexpectedEof.into(), socket)) let mut messages = Vec::with_capacity(rpc.get_publish().len());
for mut publish in rpc.take_publish().into_iter() {
messages.push(FloodsubMessage {
source: PeerId::from_bytes(publish.take_from()).map_err(|_| {
FloodsubDecodeError::InvalidPeerId
})?,
data: publish.take_data(),
sequence_number: publish.take_seqno(),
topics: publish
.take_topicIDs()
.into_iter()
.map(TopicHash::from_raw)
.collect(),
});
}
Ok(FloodsubRpc {
messages,
subscriptions: rpc
.take_subscriptions()
.into_iter()
.map(|mut sub| FloodsubSubscription {
action: if sub.get_subscribe() {
FloodsubSubscriptionAction::Subscribe
} else {
FloodsubSubscriptionAction::Unsubscribe
},
topic: TopicHash::from_raw(sub.take_topicid()),
})
.collect(),
}) })
.map_err(|(err, _)| err) })
} }
} }
/// Implementation of `tokio_codec::Codec`. /// Reach attempt interrupt errors.
pub struct FloodsubCodec { #[derive(Debug)]
/// The codec for encoding/decoding the length prefix of messages. pub enum FloodsubDecodeError {
length_prefix: codec::UviBytes, /// Error when reading the packet from the socket.
ReadError(upgrade::ReadOneError),
/// Error when decoding the raw buffer into a protobuf.
ProtobufError(ProtobufError),
/// Error when parsing the `PeerId` in the message.
InvalidPeerId,
} }
impl Decoder for FloodsubCodec { impl From<upgrade::ReadOneError> for FloodsubDecodeError {
type Item = FloodsubRpc; #[inline]
type Error = io::Error; fn from(err: upgrade::ReadOneError) -> Self {
FloodsubDecodeError::ReadError(err)
}
}
fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> { impl From<ProtobufError> for FloodsubDecodeError {
let packet = match self.length_prefix.decode(src)? { #[inline]
Some(p) => p, fn from(err: ProtobufError) -> Self {
None => return Ok(None), FloodsubDecodeError::ProtobufError(err)
}; }
}
let mut rpc: rpc_proto::RPC = protobuf::parse_from_bytes(&packet)?; impl fmt::Display for FloodsubDecodeError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut messages = Vec::with_capacity(rpc.get_publish().len()); match *self {
for mut publish in rpc.take_publish().into_iter() { FloodsubDecodeError::ReadError(ref err) =>
messages.push(FloodsubMessage { write!(f, "Error while reading from socket: {}", err),
source: PeerId::from_bytes(publish.take_from()).map_err(|_| { FloodsubDecodeError::ProtobufError(ref err) =>
io::Error::new(io::ErrorKind::InvalidData, "Invalid peer ID in message") write!(f, "Error while decoding protobuf: {}", err),
})?, FloodsubDecodeError::InvalidPeerId =>
data: publish.take_data(), write!(f, "Error while decoding PeerId from message"),
sequence_number: publish.take_seqno(),
topics: publish
.take_topicIDs()
.into_iter()
.map(TopicHash::from_raw)
.collect(),
});
} }
}
}
Ok(Some(FloodsubRpc { impl error::Error for FloodsubDecodeError {
messages, fn source(&self) -> Option<&(dyn error::Error + 'static)> {
subscriptions: rpc match *self {
.take_subscriptions() FloodsubDecodeError::ReadError(ref err) => Some(err),
.into_iter() FloodsubDecodeError::ProtobufError(ref err) => Some(err),
.map(|mut sub| FloodsubSubscription { FloodsubDecodeError::InvalidPeerId => None,
action: if sub.get_subscribe() { }
FloodsubSubscriptionAction::Subscribe
} else {
FloodsubSubscriptionAction::Unsubscribe
},
topic: TopicHash::from_raw(sub.take_topicid()),
})
.collect(),
}))
} }
} }
@ -147,20 +168,18 @@ where
{ {
type Output = (); type Output = ();
type Error = io::Error; type Error = io::Error;
type Future = future::Map<future::AndThen<tokio_io::io::WriteAll<TSocket, Vec<u8>>, tokio_io::io::Shutdown<TSocket>, fn((TSocket, Vec<u8>)) -> tokio_io::io::Shutdown<TSocket>>, fn(TSocket) -> ()>; type Future = upgrade::WriteOne<TSocket>;
#[inline] #[inline]
fn upgrade_outbound(self, socket: TSocket, _: Self::Info) -> Self::Future { fn upgrade_outbound(self, socket: TSocket, _: Self::Info) -> Self::Future {
let bytes = self.into_length_delimited_bytes(); let bytes = self.into_bytes();
tokio_io::io::write_all(socket, bytes) upgrade::write_one(socket, bytes)
.and_then::<fn(_) -> _, _>(|(socket, _)| tokio_io::io::shutdown(socket))
.map(|_| ())
} }
} }
impl FloodsubRpc { impl FloodsubRpc {
/// Turns this `FloodsubRpc` into a message that can be sent to a substream. /// Turns this `FloodsubRpc` into a message that can be sent to a substream.
fn into_length_delimited_bytes(self) -> Vec<u8> { fn into_bytes(self) -> Vec<u8> {
let mut proto = rpc_proto::RPC::new(); let mut proto = rpc_proto::RPC::new();
for message in self.messages { for message in self.messages {
@ -186,7 +205,7 @@ impl FloodsubRpc {
} }
proto proto
.write_length_delimited_to_bytes() .write_to_bytes()
.expect("there is no situation in which the protobuf message can be invalid") .expect("there is no situation in which the protobuf message can be invalid")
} }
} }