1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 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 299 300 301 302 303 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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 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 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
// Copyright 2017 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.
//! Protocol negotiation strategies for the peer acting as the dialer.
use crate::{
codec::unsigned_varint::UnsignedVarint,
error::{self, Error, ParseError},
multistream_select::{
protocol::{
encode_multistream_message, HeaderLine, Message, MessageIO, Protocol, ProtocolError,
},
Negotiated, NegotiationError, Version,
},
types::protocol::ProtocolName,
};
use bytes::BytesMut;
use futures::prelude::*;
use rustls::internal::msgs::hsjoiner::HandshakeJoiner;
use std::{
convert::TryFrom as _,
iter, mem,
pin::Pin,
task::{Context, Poll},
};
const LOG_TARGET: &str = "litep2p::multistream-select";
/// Returns a `Future` that negotiates a protocol on the given I/O stream
/// for a peer acting as the _dialer_ (or _initiator_).
///
/// This function is given an I/O stream and a list of protocols and returns a
/// computation that performs the protocol negotiation with the remote. The
/// returned `Future` resolves with the name of the negotiated protocol and
/// a [`Negotiated`] I/O stream.
///
/// Within the scope of this library, a dialer always commits to a specific
/// multistream-select [`Version`], whereas a listener always supports
/// all versions supported by this library. Frictionless multistream-select
/// protocol upgrades may thus proceed by deployments with updated listeners,
/// eventually followed by deployments of dialers choosing the newer protocol.
pub fn dialer_select_proto<R, I>(
inner: R,
protocols: I,
version: Version,
) -> DialerSelectFuture<R, I::IntoIter>
where
R: AsyncRead + AsyncWrite,
I: IntoIterator,
I::Item: AsRef<[u8]>,
{
let protocols = protocols.into_iter().peekable();
DialerSelectFuture {
version,
protocols,
state: State::SendHeader {
io: MessageIO::new(inner),
},
}
}
/// A `Future` returned by [`dialer_select_proto`] which negotiates
/// a protocol iteratively by considering one protocol after the other.
#[pin_project::pin_project]
pub struct DialerSelectFuture<R, I: Iterator> {
// TODO: It would be nice if eventually N = I::Item = Protocol.
protocols: iter::Peekable<I>,
state: State<R, I::Item>,
version: Version,
}
enum State<R, N> {
SendHeader {
io: MessageIO<R>,
},
SendProtocol {
io: MessageIO<R>,
protocol: N,
header_received: bool,
},
FlushProtocol {
io: MessageIO<R>,
protocol: N,
header_received: bool,
},
AwaitProtocol {
io: MessageIO<R>,
protocol: N,
header_received: bool,
},
Done,
}
impl<R, I> Future for DialerSelectFuture<R, I>
where
// The Unpin bound here is required because we produce
// a `Negotiated<R>` as the output. It also makes
// the implementation considerably easier to write.
R: AsyncRead + AsyncWrite + Unpin,
I: Iterator,
I::Item: AsRef<[u8]>,
{
type Output = Result<(I::Item, Negotiated<R>), NegotiationError>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
loop {
match mem::replace(this.state, State::Done) {
State::SendHeader { mut io } => {
match Pin::new(&mut io).poll_ready(cx)? {
Poll::Ready(()) => {}
Poll::Pending => {
*this.state = State::SendHeader { io };
return Poll::Pending;
}
}
let h = HeaderLine::from(*this.version);
if let Err(err) = Pin::new(&mut io).start_send(Message::Header(h)) {
return Poll::Ready(Err(From::from(err)));
}
let protocol = this.protocols.next().ok_or(NegotiationError::Failed)?;
// The dialer always sends the header and the first protocol
// proposal in one go for efficiency.
*this.state = State::SendProtocol {
io,
protocol,
header_received: false,
};
}
State::SendProtocol {
mut io,
protocol,
header_received,
} => {
match Pin::new(&mut io).poll_ready(cx)? {
Poll::Ready(()) => {}
Poll::Pending => {
*this.state = State::SendProtocol {
io,
protocol,
header_received,
};
return Poll::Pending;
}
}
let p = Protocol::try_from(protocol.as_ref())?;
if let Err(err) = Pin::new(&mut io).start_send(Message::Protocol(p.clone())) {
return Poll::Ready(Err(From::from(err)));
}
tracing::debug!(target: LOG_TARGET, "Dialer: Proposed protocol: {}", p);
if this.protocols.peek().is_some() {
*this.state = State::FlushProtocol {
io,
protocol,
header_received,
}
} else {
match this.version {
Version::V1 =>
*this.state = State::FlushProtocol {
io,
protocol,
header_received,
},
// This is the only effect that `V1Lazy` has compared to `V1`:
// Optimistically settling on the only protocol that
// the dialer supports for this negotiation. Notably,
// the dialer expects a regular `V1` response.
Version::V1Lazy => {
tracing::debug!(
target: LOG_TARGET,
"Dialer: Expecting proposed protocol: {}",
p
);
let hl = HeaderLine::from(Version::V1Lazy);
let io = Negotiated::expecting(io.into_reader(), p, Some(hl));
return Poll::Ready(Ok((protocol, io)));
}
}
}
}
State::FlushProtocol {
mut io,
protocol,
header_received,
} => match Pin::new(&mut io).poll_flush(cx)? {
Poll::Ready(()) =>
*this.state = State::AwaitProtocol {
io,
protocol,
header_received,
},
Poll::Pending => {
*this.state = State::FlushProtocol {
io,
protocol,
header_received,
};
return Poll::Pending;
}
},
State::AwaitProtocol {
mut io,
protocol,
header_received,
} => {
let msg = match Pin::new(&mut io).poll_next(cx)? {
Poll::Ready(Some(msg)) => msg,
Poll::Pending => {
*this.state = State::AwaitProtocol {
io,
protocol,
header_received,
};
return Poll::Pending;
}
// Treat EOF error as [`NegotiationError::Failed`], not as
// [`NegotiationError::ProtocolError`], allowing dropping or closing an I/O
// stream as a permissible way to "gracefully" fail a negotiation.
Poll::Ready(None) => return Poll::Ready(Err(NegotiationError::Failed)),
};
match msg {
Message::Header(v)
if v == HeaderLine::from(*this.version) && !header_received =>
{
*this.state = State::AwaitProtocol {
io,
protocol,
header_received: true,
};
}
Message::Protocol(ref p) if p.as_ref() == protocol.as_ref() => {
tracing::debug!(
target: LOG_TARGET,
"Dialer: Received confirmation for protocol: {}",
p
);
let io = Negotiated::completed(io.into_inner());
return Poll::Ready(Ok((protocol, io)));
}
Message::NotAvailable => {
tracing::debug!(
target: LOG_TARGET,
"Dialer: Received rejection of protocol: {}",
String::from_utf8_lossy(protocol.as_ref())
);
let protocol = this.protocols.next().ok_or(NegotiationError::Failed)?;
*this.state = State::SendProtocol {
io,
protocol,
header_received,
}
}
_ => return Poll::Ready(Err(ProtocolError::InvalidMessage.into())),
}
}
State::Done => panic!("State::poll called after completion"),
}
}
}
}
/// `multistream-select` handshake result for dialer.
#[derive(Debug, PartialEq, Eq)]
pub enum HandshakeResult {
/// Handshake is not complete, data missing.
NotReady,
/// Handshake has succeeded.
///
/// The returned tuple contains the negotiated protocol and response
/// that must be sent to remote peer.
Succeeded(ProtocolName),
}
/// Handshake state.
#[derive(Debug)]
enum HandshakeState {
/// Wainting to receive any response from remote peer.
WaitingResponse,
/// Waiting to receive the actual application protocol from remote peer.
WaitingProtocol,
}
/// `multistream-select` dialer handshake state.
#[derive(Debug)]
pub struct DialerState {
/// Proposed main protocol.
protocol: ProtocolName,
/// Fallback names of the main protocol.
fallback_names: Vec<ProtocolName>,
/// Dialer handshake state.
state: HandshakeState,
}
impl DialerState {
/// Propose protocol to remote peer.
///
/// Return [`DialerState`] which is used to drive forward the negotiation and an encoded
/// `multistream-select` message that contains the protocol proposal for the substream.
pub fn propose(
protocol: ProtocolName,
fallback_names: Vec<ProtocolName>,
) -> crate::Result<(Self, Vec<u8>)> {
let message = encode_multistream_message(
std::iter::once(protocol.clone())
.chain(fallback_names.clone())
.filter_map(|protocol| Protocol::try_from(protocol.as_ref()).ok())
.map(Message::Protocol),
)?
.freeze()
.to_vec();
Ok((
Self {
protocol,
fallback_names,
state: HandshakeState::WaitingResponse,
},
message,
))
}
/// Register response to [`DialerState`].
pub fn register_response(
&mut self,
payload: Vec<u8>,
) -> Result<HandshakeResult, crate::error::NegotiationError> {
let Message::Protocols(protocols) =
Message::decode(payload.into()).map_err(|_| ParseError::InvalidData)?
else {
return Err(crate::error::NegotiationError::MultistreamSelectError(
NegotiationError::Failed,
));
};
let mut protocol_iter = protocols.into_iter();
loop {
match (&self.state, protocol_iter.next()) {
(HandshakeState::WaitingResponse, None) =>
return Err(crate::error::NegotiationError::StateMismatch),
(HandshakeState::WaitingResponse, Some(protocol)) => {
let header = Protocol::try_from(&b"/multistream/1.0.0"[..])
.expect("valid multitstream-select header");
if protocol == header {
self.state = HandshakeState::WaitingProtocol;
} else {
return Err(crate::error::NegotiationError::MultistreamSelectError(
NegotiationError::Failed,
));
}
}
(HandshakeState::WaitingProtocol, Some(protocol)) => {
if self.protocol.as_bytes() == protocol.as_ref() {
return Ok(HandshakeResult::Succeeded(self.protocol.clone()));
}
for fallback in &self.fallback_names {
if fallback.as_bytes() == protocol.as_ref() {
return Ok(HandshakeResult::Succeeded(fallback.clone()));
}
}
return Err(crate::error::NegotiationError::MultistreamSelectError(
NegotiationError::Failed,
));
}
(HandshakeState::WaitingProtocol, None) => {
return Ok(HandshakeResult::NotReady);
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::multistream_select::listener_select_proto;
use std::time::Duration;
use tokio::net::{TcpListener, TcpStream};
#[tokio::test]
async fn select_proto_basic() {
async fn run(version: Version) {
let (client_connection, server_connection) = futures_ringbuf::Endpoint::pair(100, 100);
let server: tokio::task::JoinHandle<Result<(), ()>> = tokio::spawn(async move {
let protos = vec!["/proto1", "/proto2"];
let (proto, mut io) =
listener_select_proto(server_connection, protos).await.unwrap();
assert_eq!(proto, "/proto2");
let mut out = vec![0; 32];
let n = io.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, b"ping");
io.write_all(b"pong").await.unwrap();
io.flush().await.unwrap();
Ok(())
});
let client: tokio::task::JoinHandle<Result<(), ()>> = tokio::spawn(async move {
let protos = vec!["/proto3", "/proto2"];
let (proto, mut io) =
dialer_select_proto(client_connection, protos, version).await.unwrap();
assert_eq!(proto, "/proto2");
io.write_all(b"ping").await.unwrap();
io.flush().await.unwrap();
let mut out = vec![0; 32];
let n = io.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, b"pong");
Ok(())
});
server.await.unwrap();
client.await.unwrap();
}
run(Version::V1).await;
run(Version::V1Lazy).await;
}
/// Tests the expected behaviour of failed negotiations.
#[tokio::test]
async fn negotiation_failed() {
async fn run(
version: Version,
dial_protos: Vec<&'static str>,
dial_payload: Vec<u8>,
listen_protos: Vec<&'static str>,
) {
let (client_connection, server_connection) = futures_ringbuf::Endpoint::pair(100, 100);
let server: tokio::task::JoinHandle<Result<(), ()>> = tokio::spawn(async move {
let io = match tokio::time::timeout(
Duration::from_secs(2),
listener_select_proto(server_connection, listen_protos),
)
.await
.unwrap()
{
Ok((_, io)) => io,
Err(NegotiationError::Failed) => return Ok(()),
Err(NegotiationError::ProtocolError(e)) => {
panic!("Unexpected protocol error {e}")
}
};
match io.complete().await {
Err(NegotiationError::Failed) => {}
_ => panic!(),
}
Ok(())
});
let client: tokio::task::JoinHandle<Result<(), ()>> = tokio::spawn(async move {
let mut io = match tokio::time::timeout(
Duration::from_secs(2),
dialer_select_proto(client_connection, dial_protos, version),
)
.await
.unwrap()
{
Err(NegotiationError::Failed) => return Ok(()),
Ok((_, io)) => io,
Err(_) => panic!(),
};
// The dialer may write a payload that is even sent before it
// got confirmation of the last proposed protocol, when `V1Lazy`
// is used.
io.write_all(&dial_payload).await.unwrap();
match io.complete().await {
Err(NegotiationError::Failed) => {}
_ => panic!(),
}
Ok(())
});
server.await.unwrap();
client.await.unwrap();
}
// Incompatible protocols.
run(Version::V1, vec!["/proto1"], vec![1], vec!["/proto2"]).await;
run(Version::V1Lazy, vec!["/proto1"], vec![1], vec!["/proto2"]).await;
}
#[tokio::test]
async fn v1_lazy_do_not_wait_for_negotiation_on_poll_close() {
let (client_connection, _server_connection) =
futures_ringbuf::Endpoint::pair(1024 * 1024, 1);
let client = tokio::spawn(async move {
// Single protocol to allow for lazy (or optimistic) protocol negotiation.
let protos = vec!["/proto1"];
let (proto, mut io) =
dialer_select_proto(client_connection, protos, Version::V1Lazy).await.unwrap();
assert_eq!(proto, "/proto1");
// In Libp2p the lazy negotation of protocols can be closed at any time,
// even if the negotiation is not yet done.
// However, for the Litep2p the negotation must conclude before closing the
// lazy negotation of protocol. We'll wait for the close until the
// server has produced a message, in this test that means forever.
io.close().await.unwrap();
});
// TODO: Once https://github.com/paritytech/litep2p/pull/62 is merged, this
// should be changed to `is_ok`.
assert!(tokio::time::timeout(Duration::from_secs(10), client).await.is_err());
}
#[tokio::test]
async fn low_level_negotiate() {
async fn run(version: Version) {
let (client_connection, mut server_connection) =
futures_ringbuf::Endpoint::pair(100, 100);
let server = tokio::spawn(async move {
let protos = vec!["/proto2"];
let multistream = b"/multistream/1.0.0\n";
let len = multistream.len();
let proto = b"/proto2\n";
let proto_len = proto.len();
// Check that our implementation writes optimally
// the multistream ++ protocol in a single message.
let mut expected_message = Vec::new();
expected_message.push(len as u8);
expected_message.extend_from_slice(multistream);
expected_message.push(proto_len as u8);
expected_message.extend_from_slice(proto);
if version == Version::V1Lazy {
expected_message.extend_from_slice(b"ping");
}
let mut out = vec![0; 64];
let n = server_connection.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, expected_message);
// We must send the back the multistream packet.
let mut send_message = Vec::new();
send_message.push(len as u8);
send_message.extend_from_slice(multistream);
server_connection.write_all(&mut send_message).await.unwrap();
let mut send_message = Vec::new();
send_message.push(proto_len as u8);
send_message.extend_from_slice(proto);
server_connection.write_all(&mut send_message).await.unwrap();
// Handle handshake.
match version {
Version::V1 => {
let mut out = vec![0; 64];
let n = server_connection.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, b"ping");
server_connection.write_all(b"pong").await.unwrap();
}
Version::V1Lazy => {
// Ping (handshake) payload expected in the initial message.
server_connection.write_all(b"pong").await.unwrap();
}
}
});
let client = tokio::spawn(async move {
let protos = vec!["/proto2"];
let (proto, mut io) =
dialer_select_proto(client_connection, protos, version).await.unwrap();
assert_eq!(proto, "/proto2");
io.write_all(b"ping").await.unwrap();
io.flush().await.unwrap();
let mut out = vec![0; 32];
let n = io.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, b"pong");
});
server.await.unwrap();
client.await.unwrap();
}
run(Version::V1).await;
run(Version::V1Lazy).await;
}
#[tokio::test]
async fn v1_low_level_negotiate_multiple_headers() {
let (client_connection, mut server_connection) = futures_ringbuf::Endpoint::pair(100, 100);
let server = tokio::spawn(async move {
let protos = vec!["/proto2"];
let multistream = b"/multistream/1.0.0\n";
let len = multistream.len();
let proto = b"/proto2\n";
let proto_len = proto.len();
// Check that our implementation writes optimally
// the multistream ++ protocol in a single message.
let mut expected_message = Vec::new();
expected_message.push(len as u8);
expected_message.extend_from_slice(multistream);
expected_message.push(proto_len as u8);
expected_message.extend_from_slice(proto);
let mut out = vec![0; 64];
let n = server_connection.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, expected_message);
// We must send the back the multistream packet.
let mut send_message = Vec::new();
send_message.push(len as u8);
send_message.extend_from_slice(multistream);
server_connection.write_all(&mut send_message).await.unwrap();
// We must send the back the multistream packet again.
let mut send_message = Vec::new();
send_message.push(len as u8);
send_message.extend_from_slice(multistream);
server_connection.write_all(&mut send_message).await.unwrap();
});
let client = tokio::spawn(async move {
let protos = vec!["/proto2"];
// Negotiation fails because the protocol receives the `/multistream/1.0.0` header
// multiple times.
let result =
dialer_select_proto(client_connection, protos, Version::V1).await.unwrap_err();
match result {
NegotiationError::ProtocolError(ProtocolError::InvalidMessage) => {}
_ => panic!("unexpected error: {:?}", result),
};
});
server.await.unwrap();
client.await.unwrap();
}
#[tokio::test]
async fn v1_lazy_low_level_negotiate_multiple_headers() {
let (client_connection, mut server_connection) = futures_ringbuf::Endpoint::pair(100, 100);
let server = tokio::spawn(async move {
let protos = vec!["/proto2"];
let multistream = b"/multistream/1.0.0\n";
let len = multistream.len();
let proto = b"/proto2\n";
let proto_len = proto.len();
// Check that our implementation writes optimally
// the multistream ++ protocol in a single message.
let mut expected_message = Vec::new();
expected_message.push(len as u8);
expected_message.extend_from_slice(multistream);
expected_message.push(proto_len as u8);
expected_message.extend_from_slice(proto);
let mut out = vec![0; 64];
let n = server_connection.read(&mut out).await.unwrap();
out.truncate(n);
assert_eq!(out, expected_message);
// We must send the back the multistream packet.
let mut send_message = Vec::new();
send_message.push(len as u8);
send_message.extend_from_slice(multistream);
server_connection.write_all(&mut send_message).await.unwrap();
// We must send the back the multistream packet again.
let mut send_message = Vec::new();
send_message.push(len as u8);
send_message.extend_from_slice(multistream);
server_connection.write_all(&mut send_message).await.unwrap();
});
let client = tokio::spawn(async move {
let protos = vec!["/proto2"];
// Negotiation fails because the protocol receives the `/multistream/1.0.0` header
// multiple times.
let (proto, to_negociate) =
dialer_select_proto(client_connection, protos, Version::V1Lazy).await.unwrap();
assert_eq!(proto, "/proto2");
let result = to_negociate.complete().await.unwrap_err();
match result {
NegotiationError::ProtocolError(ProtocolError::InvalidMessage) => {}
_ => panic!("unexpected error: {:?}", result),
};
});
server.await.unwrap();
client.await.unwrap();
}
#[test]
fn propose() {
let (mut dialer_state, message) =
DialerState::propose(ProtocolName::from("/13371338/proto/1"), vec![]).unwrap();
let message = bytes::BytesMut::from(&message[..]).freeze();
let Message::Protocols(protocols) = Message::decode(message).unwrap() else {
panic!("invalid message type");
};
assert_eq!(protocols.len(), 2);
assert_eq!(
protocols[0],
Protocol::try_from(&b"/multistream/1.0.0"[..])
.expect("valid multitstream-select header")
);
assert_eq!(
protocols[1],
Protocol::try_from(&b"/13371338/proto/1"[..])
.expect("valid multitstream-select header")
);
}
#[test]
fn propose_with_fallback() {
let (mut dialer_state, message) = DialerState::propose(
ProtocolName::from("/13371338/proto/1"),
vec![ProtocolName::from("/sup/proto/1")],
)
.unwrap();
let message = bytes::BytesMut::from(&message[..]).freeze();
let Message::Protocols(protocols) = Message::decode(message).unwrap() else {
panic!("invalid message type");
};
assert_eq!(protocols.len(), 3);
assert_eq!(
protocols[0],
Protocol::try_from(&b"/multistream/1.0.0"[..])
.expect("valid multitstream-select header")
);
assert_eq!(
protocols[1],
Protocol::try_from(&b"/13371338/proto/1"[..])
.expect("valid multitstream-select header")
);
assert_eq!(
protocols[2],
Protocol::try_from(&b"/sup/proto/1"[..]).expect("valid multitstream-select header")
);
}
#[test]
fn register_response_invalid_message() {
// send only header line
let mut bytes = BytesMut::with_capacity(32);
let message = Message::Header(HeaderLine::V1);
let _ = message.encode(&mut bytes).map_err(|_| Error::InvalidData).unwrap();
let (mut dialer_state, _message) =
DialerState::propose(ProtocolName::from("/13371338/proto/1"), vec![]).unwrap();
match dialer_state.register_response(bytes.freeze().to_vec()) {
Err(error::NegotiationError::MultistreamSelectError(NegotiationError::Failed)) => {}
event => panic!("invalid event: {event:?}"),
}
}
#[test]
fn header_line_missing() {
// header line missing
let mut bytes = BytesMut::with_capacity(256);
let message = Message::Protocols(vec![
Protocol::try_from(&b"/13371338/proto/1"[..]).unwrap(),
Protocol::try_from(&b"/sup/proto/1"[..]).unwrap(),
]);
let _ = message.encode(&mut bytes).map_err(|_| Error::InvalidData).unwrap();
let (mut dialer_state, _message) =
DialerState::propose(ProtocolName::from("/13371338/proto/1"), vec![]).unwrap();
match dialer_state.register_response(bytes.freeze().to_vec()) {
Err(error::NegotiationError::MultistreamSelectError(NegotiationError::Failed)) => {}
event => panic!("invalid event: {event:?}"),
}
}
#[test]
fn negotiate_main_protocol() {
let message = encode_multistream_message(
vec![Message::Protocol(
Protocol::try_from(&b"/13371338/proto/1"[..]).unwrap(),
)]
.into_iter(),
)
.unwrap()
.freeze();
let (mut dialer_state, _message) = DialerState::propose(
ProtocolName::from("/13371338/proto/1"),
vec![ProtocolName::from("/sup/proto/1")],
)
.unwrap();
match dialer_state.register_response(message.to_vec()) {
Ok(HandshakeResult::Succeeded(negotiated)) =>
assert_eq!(negotiated, ProtocolName::from("/13371338/proto/1")),
_ => panic!("invalid event"),
}
}
#[test]
fn negotiate_fallback_protocol() {
let message = encode_multistream_message(
vec![Message::Protocol(
Protocol::try_from(&b"/sup/proto/1"[..]).unwrap(),
)]
.into_iter(),
)
.unwrap()
.freeze();
let (mut dialer_state, _message) = DialerState::propose(
ProtocolName::from("/13371338/proto/1"),
vec![ProtocolName::from("/sup/proto/1")],
)
.unwrap();
match dialer_state.register_response(message.to_vec()) {
Ok(HandshakeResult::Succeeded(negotiated)) =>
assert_eq!(negotiated, ProtocolName::from("/sup/proto/1")),
_ => panic!("invalid event"),
}
}
}