GH-623: Direct Node to pick new public key on the command line

.gitignore

@@ -59,6 +59,7 @@ Temporary Items
 **/.idea/markdown-navigator/**
 **/.idea/aws.xml
 **/.idea/scopes/*.xml
+**/.idea/copilot*
 
 # Sensitive or high-churn files:
 **/.idea/**/dataSources/

masq_lib/src/shared_schema.rs

@@ -7,7 +7,7 @@ use crate::constants::{
     POLYGON_MAINNET_FULL_IDENTIFIER,
 };
 use crate::crash_point::CrashPoint;
-use clap::{App, Arg};
+use clap::{arg_enum, App, Arg};
 use lazy_static::lazy_static;
 
 pub const BLOCKCHAIN_SERVICE_HELP: &str =
@@ -81,6 +81,17 @@ pub const NEIGHBORS_HELP: &str = "One or more Node descriptors for running Nodes
      if you don't specify a neighbor, your Node will start without being connected to any MASQ \
      Network, although other Nodes will be able to connect to yours if they know your Node's descriptor. \
      --neighbors is meaningless in --neighborhood-mode zero-hop.";
+pub const NEW_PUBLIC_KEY_HELP: &str = "Whenever you start it, the Node will try to use the same public key \
+     it used last time. That's '--new-public-key off'. If you want it to select a new public key when it \
+     starts, then specify '--new-public-key on', and you'll get a different one this time...which it will \
+     reuse next time unless you specify '--new-public-key on' again.\n\n\
+     You should be careful about restarting your Node with the same public key too quickly. If your new \
+     Node tries to join the Network before the Network has forgotten your old Node, every Node you try \
+     to connect to will ignore you.\n\n\
+     There are some conditions under which the Node cannot use the same public key it used last time: \
+     for example, if there was no last time, or if you don't specify a `--db-password`. Normally, in \
+     these situations, the Node will select a new public key and store it for future use; but if you \
+     explicitly demand the old public key with `--new-public-key off`, the Node will refuse to start.";
 
 // generated valid encoded keys for future needs
 // UJNoZW5p/PDVqEjpr3b+8jZ/93yPG8i5dOAgE1bhK+A
@@ -226,6 +237,14 @@ lazy_static! {
        DEFAULT_GAS_PRICE);
 }
 
+arg_enum! {
+    #[derive(Debug, PartialEq, Eq, Clone, Copy)]
+    pub enum OnOff {
+        On,
+        Off,
+    }
+}
+
 // These Args are needed in more than one clap schema. To avoid code duplication, they're defined here and referred
 // to from multiple places.
 pub fn chain_arg<'a>() -> Arg<'a, 'a> {
@@ -467,13 +486,23 @@ pub fn shared_app(head: App<'static, 'static>) -> App<'static, 'static> {
             .min_values(0)
             .help(NEIGHBORS_HELP),
     )
+    .arg(
+        Arg::with_name("new-public-key")
+            .long("new-public-key")
+            .value_name("NEW-PUBLIC-KEY")
+            .takes_value(true)
+            .possible_values(&OnOff::variants())
+            .case_insensitive(true)
+            .help(NEW_PUBLIC_KEY_HELP),
+    )
     .arg(real_user_arg())
     .arg(
         Arg::with_name("scans")
             .long("scans")
             .value_name("SCANS")
             .takes_value(true)
-            .possible_values(&["on", "off"])
+            .possible_values(&OnOff::variants())
+            .case_insensitive(true)
             .help(SCANS_HELP),
     )
     .arg(common_parameter_with_separate_u64_values(

multinode_integration_tests/tests/bookkeeping_test.rs

@@ -1,4 +1,5 @@
 // Copyright (c) 2019, MASQ (https://masq.ai) and/or its affiliates. All rights reserved.
+use itertools::Itertools;
 use multinode_integration_tests_lib::masq_node::{MASQNode, NodeReference};
 use multinode_integration_tests_lib::masq_node_cluster::MASQNodeCluster;
 use multinode_integration_tests_lib::masq_real_node::{
@@ -30,54 +31,72 @@ fn provided_and_consumed_services_are_recorded_in_databases() {
 
     let mut client = originating_node.make_client(8080, STANDARD_CLIENT_TIMEOUT_MILLIS);
     client.set_timeout(Duration::from_secs(10));
-    let request = "GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n".as_bytes();
+    let request = "GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n".as_bytes();
 
     client.send_chunk(request);
     let response = String::from_utf8(client.wait_for_chunk()).unwrap();
     assert!(
-        response.contains("<h1>Example Domain</h1>"),
-        "Not from www.example.com:\n{}",
+        response.contains("<title>URL for testing.</title>"),
+        "Not from www.testingmcafeesites.com:\n{}",
         response
     );
 
+    // Waiting until everybody has finished generating payables and receivables
+    thread::sleep(Duration::from_secs(10));
+
     // get all payables from originating node
     let payables = non_pending_payables(&originating_node);
 
-    // Waiting until the serving nodes have finished accruing their receivables
-    thread::sleep(Duration::from_secs(10));
-
     // get all receivables from all other nodes
-    let receivable_balances = non_originating_nodes
+    let receivable_nodes = non_originating_nodes
         .iter()
         .flat_map(|node| {
             receivables(node)
                 .into_iter()
                 .map(move |receivable_account| {
-                    (node.earning_wallet(), receivable_account.balance_wei)
+                    (
+                        node.earning_wallet(),
+                        (node.name().to_string(), receivable_account.balance_wei),
+                    )
                 })
         })
-        .collect::<HashMap<Wallet, i128>>();
+        .collect::<HashMap<Wallet, (String, i128)>>();
 
     // check that each payable has a receivable
     assert_eq!(
         payables.len(),
-        receivable_balances.len(),
+        receivable_nodes.len(),
         "Lengths of payables and receivables should match.\nPayables: {:?}\nReceivables: {:?}",
         payables,
-        receivable_balances
+        receivable_nodes
     );
     assert!(
-        receivable_balances.len() >= 3, // minimum service list: route, route, exit.
+        receivable_nodes.len() >= 3, // minimum service list: route, route, exit.
         "not enough receivables found {:?}",
-        receivable_balances
+        receivable_nodes
     );
 
-    payables.iter().for_each(|payable| {
-        assert_eq!(
-            payable.balance_wei,
-            *receivable_balances.get(&payable.wallet).unwrap() as u128,
-        );
-    });
+    let messages = payables
+        .iter()
+        .flat_map(|payable| {
+            let payable_balance = payable.balance_wei;
+            let (non_originating_node_name, receivable_balance) =
+                receivable_nodes.get(&payable.wallet).unwrap().clone();
+            if payable_balance != receivable_balance as u128 {
+                Some(format!(
+                    "Payable for {} ({}) does not match receivable for {} ({})",
+                    originating_node.name(),
+                    payable_balance,
+                    non_originating_node_name,
+                    receivable_balance
+                ))
+            } else {
+                None
+            }
+        })
+        .collect_vec();
+
+    assert!(messages.is_empty(), "{:#?}", messages);
 }
 
 fn non_pending_payables(node: &MASQRealNode) -> Vec<PayableAccount> {

multinode_integration_tests/tests/data_routing_test.rs

@@ -58,11 +58,11 @@ fn http_end_to_end_routing_test() {
     thread::sleep(Duration::from_millis(500));
 
     let mut client = last_node.make_client(8080, 5000);
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
 
     assert_eq!(
-        index_of(&response, &b"<h1>Example Domain</h1>"[..]).is_some(),
+        index_of(&response, &b"<title>URL for testing.</title>"[..]).is_some(),
         true,
         "Actual response:\n{}",
         String::from_utf8(response).unwrap()
@@ -104,11 +104,11 @@ fn http_end_to_end_routing_test_with_consume_and_originate_only_nodes() {
     thread::sleep(Duration::from_millis(1000));
 
     let mut client = originating_node.make_client(8080, STANDARD_CLIENT_TIMEOUT_MILLIS);
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
 
     assert_eq!(
-        index_of(&response, &b"<h1>Example Domain</h1>"[..]).is_some(),
+        index_of(&response, &b"<title>URL for testing.</title>"[..]).is_some(),
         true,
         "Actual response:\n{}",
         String::from_utf8(response).unwrap()
@@ -235,11 +235,11 @@ fn http_routing_failure_produces_internal_error_response() {
 
     let mut client = originating_node.make_client(8080, STANDARD_CLIENT_TIMEOUT_MILLIS);
 
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
 
     let expected_response =
-        ServerImpersonatorHttp {}.route_query_failure_response("www.example.com");
+        ServerImpersonatorHttp {}.route_query_failure_response("www.testingmcafeesites.com");
 
     assert_eq!(
         &expected_response,
@@ -315,27 +315,56 @@ fn multiple_stream_zero_hop_test() {
     let mut one_client = zero_hop_node.make_client(8080, STANDARD_CLIENT_TIMEOUT_MILLIS);
     let mut another_client = zero_hop_node.make_client(8080, STANDARD_CLIENT_TIMEOUT_MILLIS);
 
-    one_client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
-    another_client.send_chunk(b"GET / HTTP/1.1\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7\r\nAccept-Language: cs-CZ,cs;q=0.9,en;q=0.8,sk;q=0.7\r\nCache-Control: max-age=0\r\nConnection: keep-alive\r\nHost: www.testingmcafeesites.com\r\nUpgrade-Insecure-Requests: 1\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36\r\n\r\n");
+    one_client.send_chunk(b"GET /testcat_ed.html HTTP/1.1\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7\r\nAccept-Language: cs-CZ,cs;q=0.9,en;q=0.8,sk;q=0.7\r\nCache-Control: max-age=0\r\nConnection: keep-alive\r\nHost: www.testingmcafeesites.com\r\nUpgrade-Insecure-Requests: 1\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36\r\n\r\n");
+    another_client.send_chunk(b"GET /testcat_cm.html HTTP/1.1\r\nAccept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7\r\nAccept-Language: cs-CZ,cs;q=0.9,en;q=0.8,sk;q=0.7\r\nCache-Control: max-age=0\r\nConnection: keep-alive\r\nHost: www.testingmcafeesites.com\r\nUpgrade-Insecure-Requests: 1\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36\r\n\r\n");
 
     let one_response = one_client.wait_for_chunk();
     let another_response = another_client.wait_for_chunk();
 
-    assert_eq!(
-        index_of(&one_response, &b"<h1>Example Domain</h1>"[..]).is_some(),
-        true,
-        "Actual response:\n{}",
-        String::from_utf8(one_response).unwrap()
-    );
-    assert_eq!(
-        index_of(
-            &another_response,
-            &b"This is an index url which gives an overview of the different test urls available."
-                [..],
-        )
-        .is_some(),
-        true,
-        "Actual response:\n{}",
-        String::from_utf8(another_response).unwrap()
-    );
+    {
+        assert_eq!(
+            index_of(
+                &one_response,
+                &b"Education/Reference website with a low risk reputation score"[..]
+            )
+            .is_some(),
+            true,
+            "Actual response:\n{}",
+            String::from_utf8(one_response).unwrap()
+        );
+        assert_eq!(
+            index_of(
+                &one_response,
+                &b"This page simply displays this text without any specific content on it, it is just for testing purpose."
+                    [..],
+            )
+                .is_some(),
+            true,
+            "Actual response:\n{}",
+            String::from_utf8(one_response).unwrap()
+        );
+    }
+    {
+        assert_eq!(
+            index_of(
+                &another_response,
+                &b"Public Information website with a low risk reputation score"[..]
+            )
+            .is_some(),
+            true,
+            "Actual response:\n{}",
+            String::from_utf8(another_response).unwrap()
+        );
+        assert_eq!(
+            index_of(
+                &another_response,
+                &b"This page simply displays this text without any specific content on it, it is just for testing purpose."
+                    [..],
+            )
+                .is_some(),
+            true,
+            "Actual response:\n{}",
+            String::from_utf8(another_response).unwrap()
+        );
+    }
 }

multinode_integration_tests/tests/min_hops_tests.rs

@@ -47,11 +47,11 @@ fn assert_http_end_to_end_routing(min_hops: Hops) {
 
     let last_node = nodes.last().unwrap();
     let mut client = last_node.make_client(8080, 5000);
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
 
     assert_eq!(
-        index_of(&response, &b"<h1>Example Domain</h1>"[..]).is_some(),
+        index_of(&response, &b"<title>URL for testing.</title>"[..]).is_some(),
         true,
         "Actual response:\n{}",
         String::from_utf8(response).unwrap()
@@ -84,14 +84,14 @@ fn min_hops_can_be_changed_during_runtime() {
     thread::sleep(Duration::from_millis(1000));
 
     let mut client = first_node.make_client(8080, 5000);
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
 
     // Client shutdown is necessary to re-initialize stream keys for old requests
     client.shutdown();
 
     assert_eq!(
-        index_of(&response, &b"<h1>Example Domain</h1>"[..]).is_some(),
+        index_of(&response, &b"<title>URL for testing.</title>"[..]).is_some(),
         true,
         "Actual response:\n{}",
         String::from_utf8(response).unwrap()
@@ -108,12 +108,12 @@ fn min_hops_can_be_changed_during_runtime() {
     assert!(response.payload.is_ok());
 
     let mut client = first_node.make_client(8080, 5000);
-    client.send_chunk(b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n");
+    client.send_chunk(b"GET /index.html HTTP/1.1\r\nHost: www.testingmcafeesites.com\r\n\r\n");
     let response = client.wait_for_chunk();
     assert_eq!(
         index_of(
             &response,
-            &b"<h3>Subtitle: Can't find a route to www.example.com</h3>"[..]
+            &b"<h3>Subtitle: Can't find a route to www.testingmcafeesites.com</h3>"[..]
         )
         .is_some(),
         true,

node/src/actor_system_factory.rs

@@ -1140,6 +1140,7 @@ mod tests {
             data_directory: PathBuf::new(),
             node_descriptor: NodeDescriptor::default(),
             mapping_protocol_opt: None,
+            new_public_key_opt: None,
             real_user: RealUser::null(),
             neighborhood_config: NeighborhoodConfig {
                 mode: NeighborhoodMode::Standard(
@@ -1211,6 +1212,7 @@ mod tests {
             cryptde_pair: CRYPTDE_PAIR.clone(),
             mapping_protocol_opt: Some(Igdp),
             real_user: RealUser::null(),
+            new_public_key_opt: None,
             neighborhood_config: NeighborhoodConfig {
                 mode: NeighborhoodMode::Standard(
                     NodeAddr::new(&IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), &[1234, 2345]),
@@ -1507,6 +1509,7 @@ mod tests {
             cryptde_pair: CRYPTDE_PAIR.clone(),
             mapping_protocol_opt: None,
             real_user: RealUser::null(),
+            new_public_key_opt: None,
             neighborhood_config: NeighborhoodConfig {
                 mode: NeighborhoodMode::ConsumeOnly(vec![]),
                 min_hops: MIN_HOPS_FOR_TEST,
@@ -1690,6 +1693,7 @@ mod tests {
             cryptde_pair: CRYPTDE_PAIR.clone(),
             mapping_protocol_opt: None,
             real_user: RealUser::null(),
+            new_public_key_opt: None,
             neighborhood_config: NeighborhoodConfig {
                 mode: NeighborhoodMode::Standard(
                     NodeAddr::new(&IpAddr::V4(Ipv4Addr::new(1, 2, 3, 4)), &[]),

node/src/bootstrapper.rs

@@ -361,6 +361,7 @@ pub struct BootstrapperConfig {
     pub node_descriptor: NodeDescriptor,
     pub cryptde_pair: CryptDEPair,
     pub mapping_protocol_opt: Option<AutomapProtocol>,
+    pub new_public_key_opt: Option<bool>,
     pub real_user: RealUser,
     pub payment_thresholds_opt: Option<PaymentThresholds>,
 
@@ -406,6 +407,7 @@ impl BootstrapperConfig {
                 Box::new(CryptDEReal::disabled()),
             ),
             mapping_protocol_opt: None,
+            new_public_key_opt: None,
             real_user: RealUser::new(None, None, None),
             payment_thresholds_opt: Default::default(),