Merge remote-tracking branch 'origin/master' into v0.2

Author: gavofyork

Cargo.lock

@@ -12,7 +12,7 @@ env_logger = "0.4"
 error-chain = "0.12"
 log = "0.3"
 atty = "0.2"
-regex = "0.2"
+regex = "1"
 time = "0.1"
 slog = "^2"
 ansi_term = "0.10"

polkadot/cli/Cargo.toml

@@ -86,6 +86,7 @@ use codec::{Decode, Encode};
 use client::BlockOrigin;
 use runtime_primitives::generic::SignedBlock;
 use names::{Generator, Name};
+use regex::Regex;
 
 use futures::Future;
 use tokio::runtime::Runtime;
@@ -155,6 +156,29 @@ pub trait Worker {
 	fn work<C: ServiceComponents>(self, service: &Service<C>) -> Self::Work;
 }
 
+/// Check whether a node name is considered as valid
+fn is_node_name_valid(_name: &str) -> Result<(), &str> {
+	const MAX_NODE_NAME_LENGTH: usize = 32;
+	let name = _name.to_string();
+	if name.chars().count() >= MAX_NODE_NAME_LENGTH {
+		return Err("Node name too long");
+}
+
+	let invalid_chars = r"[\\.@]";
+	let re = Regex::new(invalid_chars).unwrap();
+	if re.is_match(&name) {
+		return Err("Node name should not contain invalid chars such as '.' and '@'");
+	}
+
+	let invalid_patterns = r"(https?:\\/+)?(www)+";
+	let re = Regex::new(invalid_patterns).unwrap();
+	if re.is_match(&name) {
+		return Err("Node name should not contain urls");
+	}
+
+	Ok(())
+}
+
 /// Parse command line arguments and start the node.
 ///
 /// IANA unassigned port ranges that we could use:
@@ -206,7 +230,11 @@ pub fn run<I, T, W>(args: I, worker: W) -> error::Result<()> where
 		None => Generator::with_naming(Name::Numbered).next().unwrap(),
 		Some(name) => name.into(),
 	};
-	info!("Node name: {}", config.name);
+	match is_node_name_valid(&config.name) {
+		Ok(_) => info!("Node name: {}", config.name),
+		Err(msg) => return Err(error::ErrorKind::Input(
+			format!("Invalid node name '{}'. Reason: {}. If unsure, use none.", config.name, msg)).into())
+	}
 
 	let base_path = base_path(&matches);
 
@@ -613,7 +641,27 @@ fn init_logger(pattern: &str) {
 
 fn kill_color(s: &str) -> String {
 	lazy_static! {
-		static ref RE: regex::Regex = regex::Regex::new("\x1b\\[[^m]+m").expect("Error initializing color regex");
+		static ref RE: Regex = Regex::new("\x1b\\[[^m]+m").expect("Error initializing color regex");
 	}
 	RE.replace_all(s, "").to_string()
 }
+
+#[cfg(test)]
+mod tests {
+	use super::*;
+
+    #[test]
+    fn tests_node_name_good() {
+        assert!(is_node_name_valid("short name").is_ok());
+    }
+
+    #[test]
+	fn tests_node_name_bad() {
+        assert!(is_node_name_valid("long names are not very cool for the ui").is_err());
+        assert!(is_node_name_valid("Dots.not.Ok").is_err());
+        assert!(is_node_name_valid("http://visit.me").is_err());
+        assert!(is_node_name_valid("https://visit.me").is_err());
+        assert!(is_node_name_valid("www.visit.me").is_err());
+        assert!(is_node_name_valid("email@domain").is_err());
+    }
+}

polkadot/cli/src/lib.rs

@@ -49,7 +49,7 @@ use parking_lot::Mutex;
 use polkadot_consensus::{Statement, SignedStatement, GenericStatement};
 use polkadot_primitives::{AccountId, Block, SessionKey, Hash, Header};
 use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt, Collation};
-use substrate_network::{PeerId, RequestId, Context};
+use substrate_network::{PeerId, RequestId, Context, Severity};
 use substrate_network::consensus_gossip::ConsensusGossip;
 use substrate_network::{message, generic_message};
 use substrate_network::specialization::Specialization;
@@ -403,7 +403,7 @@ impl PolkadotProtocol {
 			};
 
 			if !info.claimed_validator {
-				ctx.disable_peer(peer_id, "Session key broadcasted without setting authority role");
+				ctx.report_peer(peer_id, Severity::Bad("Session key broadcasted without setting authority role"));
 				return;
 			}
 
@@ -438,7 +438,7 @@ impl PolkadotProtocol {
 				self.pending.push(req);
 				self.dispatch_pending_requests(ctx);
 			}
-			None => ctx.disable_peer(peer_id, "Unexpected block data response"),
+			None => ctx.report_peer(peer_id, Severity::Bad("Unexpected block data response")),
 		}
 	}
 
@@ -453,9 +453,9 @@ impl PolkadotProtocol {
 		};
 
 		match info.validator_key {
-			None => ctx.disable_peer(
+			None => ctx.report_peer(
 				peer_id,
-				"Sent collator role without registering first as validator",
+				Severity::Bad("Sent collator role without registering first as validator"),
 			),
 			Some(key) => for (relay_parent, collation) in self.local_collations.note_validator_role(key, role) {
 				send_polkadot_message(
@@ -483,7 +483,7 @@ impl Specialization<Block> for PolkadotProtocol {
 
 		if let Some((ref acc_id, ref para_id)) = local_status.collating_for {
 			if self.collator_peer_id(acc_id.clone()).is_some() {
-				ctx.disconnect_peer(peer_id);
+				ctx.report_peer(peer_id, Severity::Useless("Unknown Polkadot-specific reason"));
 				return
 			}
 
@@ -571,7 +571,7 @@ impl Specialization<Block> for PolkadotProtocol {
 					Some(msg) => self.on_polkadot_message(ctx, peer_id, raw, msg),
 					None => {
 						trace!(target: "p_net", "Bad message from {}", peer_id);
-						ctx.disable_peer(peer_id, "Invalid polkadot protocol message format");
+						ctx.report_peer(peer_id, Severity::Bad("Invalid polkadot protocol message format"));
 					}
 				}
 			}
@@ -616,15 +616,15 @@ impl PolkadotProtocol {
 		let collated_acc = collation.receipt.collator;
 
 		match self.peers.get(&from) {
-			None => ctx.disconnect_peer(from),
+			None => ctx.report_peer(from, Severity::Useless("Unknown Polkadot specific reason")),
 			Some(peer_info) => match peer_info.collating_for {
-				None => ctx.disable_peer(from, "Sent collation without registering collator intent"),
+				None => ctx.report_peer(from, Severity::Bad("Sent collation without registering collator intent")),
 				Some((ref acc_id, ref para_id)) => {
 					let structurally_valid = para_id == &collation_para && acc_id == &collated_acc;
 					if structurally_valid && collation.receipt.check_signature().is_ok() {
 						self.collators.on_collation(acc_id.clone(), relay_parent, collation)
 					} else {
-						ctx.disable_peer(from, "Sent malformed collation")
+						ctx.report_peer(from, Severity::Bad("Sent malformed collation"))
 					};
 				}
 			},
@@ -654,7 +654,7 @@ impl PolkadotProtocol {
 	// disconnect a collator by account-id.
 	fn disconnect_bad_collator(&self, ctx: &mut Context<Block>, account_id: AccountId) {
 		if let Some(peer_id) = self.collator_peer_id(account_id) {
-			ctx.disable_peer(peer_id, "Consensus layer determined the given collator misbehaved")
+			ctx.report_peer(peer_id, Severity::Bad("Consensus layer determined the given collator misbehaved"))
 		}
 	}
 }

polkadot/network/src/lib.rs

@@ -24,7 +24,7 @@ use polkadot_primitives::{Block, Hash, SessionKey};
 use polkadot_primitives::parachain::{CandidateReceipt, HeadData, BlockData};
 use substrate_primitives::H512;
 use codec::Encode;
-use substrate_network::{PeerId, PeerInfo, ClientHandle, Context, Roles, message::Message as SubstrateMessage, specialization::Specialization, generic_message::Message as GenericMessage};
+use substrate_network::{Severity, PeerId, PeerInfo, ClientHandle, Context, Roles, message::Message as SubstrateMessage, specialization::Specialization, generic_message::Message as GenericMessage};
 
 use std::sync::Arc;
 use futures::Future;
@@ -41,12 +41,11 @@ impl Context<Block> for TestContext {
 		unimplemented!()
 	}
 
-	fn disable_peer(&mut self, peer: PeerId, _reason: &str) {
-		self.disabled.push(peer);
-	}
-
-	fn disconnect_peer(&mut self, peer: PeerId) {
-		self.disconnected.push(peer);
+	fn report_peer(&mut self, peer: PeerId, reason: Severity) {
+		match reason {
+			Severity::Bad(_) => self.disabled.push(peer),
+			_ => self.disconnected.push(peer),
+		}
 	}
 
 	fn peer_info(&self, _peer: PeerId) -> Option<PeerInfo<Block>> {

polkadot/network/src/tests.rs

@@ -1,18 +1,18 @@
 // Copyright 2015-2018 Parity Technologies (UK) Ltd.
-// This file is part of Parity.
+// This file is part of Substrate.
 
-// Parity is free software: you can redistribute it and/or modify
+// Substrate is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
 // (at your option) any later version.
 
-// Parity is distributed in the hope that it will be useful,
+// Substrate is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 // GNU General Public License for more details.
 
 // You should have received a copy of the GNU General Public License
-// along with Parity.  If not, see <http://www.gnu.org/licenses/>.
+// along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
 //! Connection filter trait.