-
Notifications
You must be signed in to change notification settings - Fork 984
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implement /plaintext/2.0.0 #1236
Merged
Merged
Changes from all commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
e686c2f
WIP
ackintosh 6ba9ca7
plaintext/2.0.0
ackintosh cfe8cb5
Refactor protobuf related issues to compatible with the spec
ackintosh f8ff1a6
Rename: new PlainTextConfig -> PlainText2Config
ackintosh 8f0a332
Keep plaintext/1.0.0 as PlainText1Config
ackintosh bc0e506
Config contains pubkey
ackintosh 0df77db
Rename: proposition -> exchange
ackintosh 63380bf
Add PeerId to Exchange
ackintosh f67d038
Check the validity of the remote's `Exchange`
ackintosh 8ca690b
Tweak
ackintosh 279b053
Merge remote-tracking branch 'upstream/master' into plaintext
ackintosh 8155338
Delete unused import
ackintosh 037da03
Add debug log
ackintosh 9b4c606
Delete unused field: public_key_encoded
ackintosh b8ae8c4
Delete unused field: local
ackintosh be57a76
Delete unused field: exchange_bytes
ackintosh f0e5a18
The inner instance should not be public
ackintosh 7b35c0d
identity::Publickey::Rsa is not available on wasm
ackintosh abe8499
Delete PeerId from Config as it should be generated from the pubkey
ackintosh 3c2f796
Merge remote-tracking branch 'upstream/master' into plaintext
ackintosh 154a23c
Catch up for #1240
ackintosh c7e7bcc
Tweak
ackintosh 0eeaabf
Update protocols/plaintext/src/error.rs
ackintosh 91a5b9f
Update protocols/plaintext/src/handshake.rs
ackintosh 624741f
Update protocols/plaintext/src/error.rs
ackintosh ea14d39
Update protocols/plaintext/src/error.rs
ackintosh e4b56fd
Update protocols/plaintext/src/error.rs
ackintosh 15f5320
Rename: pubkey -> local_public_key
ackintosh 76a1842
Delete unused error
ackintosh 5282e84
Rename: PeerIdValidationFailed -> InvalidPeerId
ackintosh af56ce4
Fix: HandShake -> Handshake
ackintosh 354a2e3
Use bytes insteadof Publickey to avoid code duplication
ackintosh 1850fca
Replace with ProtobufError
ackintosh dbdf4e8
Merge HandshakeContext<()> into HandshakeContext<Local>
ackintosh 131740a
Improve the peer ID validation to simplify the handshake
ackintosh c9157f7
Propagate Remote to allow extracting the PeerId from the Remote
ackintosh 58a9c45
Merge branch 'master' into plaintext
ackintosh 0ba3d48
Merge branch 'master' into plaintext
tomaka 452e4f3
Merge branch 'master' into plaintext
ackintosh 1ad1b6b
Collapse the same kind of errors into the variant
ackintosh 97fb0ca
Merge branch 'plaintext' of ssh://github.com/ackintosh/rust-libp2p in…
ackintosh 228744a
Merge branch 'master' into plaintext
tomaka File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#!/bin/sh | ||
|
||
docker run --rm -v "`pwd`/../../":/usr/code:z -w /usr/code rust /bin/bash -c " \ | ||
apt-get update; \ | ||
apt-get install -y protobuf-compiler; \ | ||
cargo install --version 2.3.0 protobuf-codegen; \ | ||
protoc --rust_out=./protocols/plaintext/src/pb ./protocols/plaintext/structs.proto;" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
// 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. | ||
|
||
use std::error; | ||
use std::fmt; | ||
use std::io::Error as IoError; | ||
use protobuf::error::ProtobufError; | ||
|
||
#[derive(Debug)] | ||
pub enum PlainTextError { | ||
/// I/O error. | ||
IoError(IoError), | ||
|
||
/// Failed to parse the handshake protobuf message. | ||
InvalidPayload(Option<ProtobufError>), | ||
|
||
/// The peer id of the exchange isn't consistent with the remote public key. | ||
InvalidPeerId, | ||
} | ||
|
||
impl error::Error for PlainTextError { | ||
fn cause(&self) -> Option<&dyn error::Error> { | ||
match *self { | ||
PlainTextError::IoError(ref err) => Some(err), | ||
PlainTextError::InvalidPayload(Some(ref err)) => Some(err), | ||
_ => None, | ||
} | ||
} | ||
} | ||
|
||
impl fmt::Display for PlainTextError { | ||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> { | ||
match self { | ||
PlainTextError::IoError(e) => | ||
write!(f, "I/O error: {}", e), | ||
PlainTextError::InvalidPayload(protobuf_error) => { | ||
match protobuf_error { | ||
Some(e) => write!(f, "Protobuf error: {}", e), | ||
None => f.write_str("Failed to parse one of the handshake protobuf messages") | ||
} | ||
}, | ||
PlainTextError::InvalidPeerId => | ||
f.write_str("The peer id of the exchange isn't consistent with the remote public key"), | ||
} | ||
} | ||
} | ||
|
||
impl From<IoError> for PlainTextError { | ||
fn from(err: IoError) -> PlainTextError { | ||
PlainTextError::IoError(err) | ||
} | ||
} | ||
|
||
impl From<ProtobufError> for PlainTextError { | ||
fn from(err: ProtobufError) -> PlainTextError { | ||
PlainTextError::InvalidPayload(Some(err)) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,153 @@ | ||
// 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. | ||
|
||
use bytes::BytesMut; | ||
use std::io::{Error as IoError, ErrorKind as IoErrorKind}; | ||
use futures::Future; | ||
use futures::future; | ||
use futures::sink::Sink; | ||
use futures::stream::Stream; | ||
use libp2p_core::{PublicKey, PeerId}; | ||
use log::{debug, trace}; | ||
use crate::pb::structs::Exchange; | ||
use tokio_io::{AsyncRead, AsyncWrite}; | ||
use tokio_io::codec::length_delimited; | ||
use tokio_io::codec::length_delimited::Framed; | ||
use protobuf::Message; | ||
use crate::error::PlainTextError; | ||
use crate::PlainText2Config; | ||
|
||
struct HandshakeContext<T> { | ||
config: PlainText2Config, | ||
state: T | ||
} | ||
|
||
// HandshakeContext<()> --with_local-> HandshakeContext<Local> | ||
struct Local { | ||
// Our local exchange's raw bytes: | ||
exchange_bytes: Vec<u8>, | ||
} | ||
|
||
// HandshakeContext<Local> --with_remote-> HandshakeContext<Remote> | ||
pub struct Remote { | ||
// The remote's peer ID: | ||
pub peer_id: PeerId, | ||
// The remote's public key: | ||
pub public_key: PublicKey, | ||
} | ||
|
||
impl HandshakeContext<Local> { | ||
fn new(config: PlainText2Config) -> Result<Self, PlainTextError> { | ||
let mut exchange = Exchange::new(); | ||
exchange.set_id(config.local_public_key.clone().into_peer_id().into_bytes()); | ||
exchange.set_pubkey(config.local_public_key.clone().into_protobuf_encoding()); | ||
let exchange_bytes = exchange.write_to_bytes()?; | ||
|
||
Ok(Self { | ||
config, | ||
state: Local { | ||
exchange_bytes | ||
} | ||
}) | ||
} | ||
|
||
fn with_remote(self, exchange_bytes: BytesMut) -> Result<HandshakeContext<Remote>, PlainTextError> { | ||
let mut prop = match protobuf::parse_from_bytes::<Exchange>(&exchange_bytes) { | ||
Ok(prop) => prop, | ||
Err(e) => { | ||
debug!("failed to parse remote's exchange protobuf message"); | ||
return Err(PlainTextError::InvalidPayload(Some(e))); | ||
}, | ||
}; | ||
|
||
let pb_pubkey = prop.take_pubkey(); | ||
let public_key = match PublicKey::from_protobuf_encoding(pb_pubkey.as_slice()) { | ||
Ok(p) => p, | ||
Err(_) => { | ||
debug!("failed to parse remote's exchange's pubkey protobuf"); | ||
return Err(PlainTextError::InvalidPayload(None)); | ||
}, | ||
}; | ||
let peer_id = match PeerId::from_bytes(prop.take_id()) { | ||
Ok(p) => p, | ||
Err(_) => { | ||
debug!("failed to parse remote's exchange's id protobuf"); | ||
return Err(PlainTextError::InvalidPayload(None)); | ||
}, | ||
}; | ||
|
||
romanb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// Check the validity of the remote's `Exchange`. | ||
if peer_id != public_key.clone().into_peer_id() { | ||
debug!("The remote's `PeerId` of the exchange isn't consist with the remote public key"); | ||
return Err(PlainTextError::InvalidPeerId) | ||
} | ||
|
||
Ok(HandshakeContext { | ||
config: self.config, | ||
state: Remote { | ||
peer_id, | ||
public_key, | ||
} | ||
}) | ||
} | ||
} | ||
|
||
pub fn handshake<S>(socket: S, config: PlainText2Config) | ||
-> impl Future<Item = (Framed<S, BytesMut>, Remote), Error = PlainTextError> | ||
where | ||
S: AsyncRead + AsyncWrite + Send, | ||
{ | ||
let socket = length_delimited::Builder::new() | ||
.big_endian() | ||
.length_field_length(4) | ||
.new_framed(socket); | ||
|
||
future::ok::<_, PlainTextError>(()) | ||
.and_then(|_| { | ||
trace!("starting handshake"); | ||
Ok(HandshakeContext::new(config)?) | ||
}) | ||
// Send our local `Exchange`. | ||
.and_then(|context| { | ||
trace!("sending exchange to remote"); | ||
socket.send(BytesMut::from(context.state.exchange_bytes.clone())) | ||
.from_err() | ||
.map(|s| (s, context)) | ||
}) | ||
// Receive the remote's `Exchange`. | ||
.and_then(move |(socket, context)| { | ||
trace!("receiving the remote's exchange"); | ||
socket.into_future() | ||
.map_err(|(e, _)| e.into()) | ||
.and_then(move |(prop_raw, socket)| { | ||
let context = match prop_raw { | ||
Some(p) => context.with_remote(p)?, | ||
None => { | ||
debug!("unexpected eof while waiting for remote's exchange"); | ||
let err = IoError::new(IoErrorKind::BrokenPipe, "unexpected eof"); | ||
return Err(err.into()); | ||
} | ||
}; | ||
|
||
trace!("received exchange from remote; pubkey = {:?}", context.state.public_key); | ||
Ok((socket, context.state)) | ||
}) | ||
}) | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option is to collapse
HandshakeParsingFailure
andProtobufError
into the variantJust a thought, because it seems weird to me to have two different error variants for basically the same kind of error (that all or part of the received message payload is invalid / cannot be parsed).