mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-28 02:48:03 +00:00
Alexandru Gheorghe
2bc4ed1153
As discovered during investigation of https://github.com/paritytech/polkadot-sdk/issues/3314 and https://github.com/paritytech/polkadot-sdk/issues/3673 there are active validators which accidentally might change their network key during restart, that's not a safe operation when you are in the active set because of distributed nature of DHT, so the old records would still exist in the network until they expire 36h, so unless they have a good reason validators should avoid changing their key when they restart their nodes. There is an effort in parallel to improve this situation https://github.com/paritytech/polkadot-sdk/pull/3786, but those changes are way more intrusive and will need more rigorous testing, additionally they will reduce the time to less than 36h, but the propagation won't be instant anyway, so not changing your network during restart should be the safest way to run your node, unless you have a really good reason to change it. ## Proposal 1. Do not auto-generate the network if the network file does not exist in the provided path. Nodes where the key file does not exist will get the following error: ``` Error: 0: Starting an authorithy without network key in /home/alexggh/.local/share/polkadot/chains/ksmcc3/network/secret_ed25519. This is not a safe operation because the old identity still lives in the dht for 36 hours. Because of it your node might suffer from not being properly connected to other nodes for validation purposes. If it is the first time running your node you could use one of the following methods. 1. Pass --unsafe-force-node-key-generation and make sure you remove it for subsequent node restarts 2. Separetly generate the key with: polkadot key generate-node-key --file <YOUR_PATH_TO_NODE_KEY> ``` 2. Add an explicit parameters for nodes that do want to change their network despite the warnings or if they run the node for the first time. `--unsafe-force-node-key-generation` 3. For `polkadot key generate-node-key` add two new mutually exclusive parameters `base_path` and `default_base_path` to help with the key generation in the same path the polkadot main command would expect it. 4. Modify the installation scripts to auto-generate a key in default path if one was not present already there, this should help with making the executable work out of the box after an instalation. ## Notes Nodes that do not have already the key persisted will fail to start after this change, however I do consider that better than the current situation where they start but they silently hide that they might not be properly connected to their peers. ## TODO - [x] Make sure only nodes that are authorities on producation chains will be affected by this restrictions. - [x] Proper PRDOC, to make sure node operators are aware this is coming. --------- Signed-off-by: Alexandru Gheorghe <alexandru.gheorghe@parity.io> Co-authored-by: Dmitry Markin <dmitry@markin.tech> Co-authored-by: s0me0ne-unkn0wn <48632512+s0me0ne-unkn0wn@users.noreply.github.com> Co-authored-by: Bastian Köcher <git@kchr.de>
98 lines
2.8 KiB
Rust
98 lines
2.8 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! Implementation of the `inspect-node-key` subcommand
|
|
|
|
use crate::Error;
|
|
use clap::Parser;
|
|
use libp2p_identity::Keypair;
|
|
use std::{
|
|
fs,
|
|
io::{self, Read},
|
|
path::PathBuf,
|
|
};
|
|
|
|
/// The `inspect-node-key` command
|
|
#[derive(Debug, Parser)]
|
|
#[command(
|
|
name = "inspect-node-key",
|
|
about = "Load a node key from a file or stdin and print the corresponding peer-id."
|
|
)]
|
|
pub struct InspectNodeKeyCmd {
|
|
/// Name of file to read the secret key from.
|
|
/// If not given, the secret key is read from stdin (up to EOF).
|
|
#[arg(long)]
|
|
file: Option<PathBuf>,
|
|
|
|
/// The input is in raw binary format.
|
|
/// If not given, the input is read as an hex encoded string.
|
|
#[arg(long)]
|
|
bin: bool,
|
|
|
|
/// This argument is deprecated and has no effect for this command.
|
|
#[deprecated(note = "Network identifier is not used for node-key inspection")]
|
|
#[arg(short = 'n', long = "network", value_name = "NETWORK", ignore_case = true)]
|
|
pub network_scheme: Option<String>,
|
|
}
|
|
|
|
impl InspectNodeKeyCmd {
|
|
/// runs the command
|
|
pub fn run(&self) -> Result<(), Error> {
|
|
let mut file_data = match &self.file {
|
|
Some(file) => fs::read(&file)?,
|
|
None => {
|
|
let mut buf = Vec::with_capacity(64);
|
|
io::stdin().lock().read_to_end(&mut buf)?;
|
|
buf
|
|
},
|
|
};
|
|
|
|
if !self.bin {
|
|
// With hex input, give to the user a bit of tolerance about whitespaces
|
|
let keyhex = String::from_utf8_lossy(&file_data);
|
|
file_data = array_bytes::hex2bytes(keyhex.trim())
|
|
.map_err(|_| "failed to decode secret as hex")?;
|
|
}
|
|
|
|
let keypair =
|
|
Keypair::ed25519_from_bytes(&mut file_data).map_err(|_| "Bad node key file")?;
|
|
|
|
println!("{}", keypair.public().to_peer_id());
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use crate::commands::generate_node_key::GenerateNodeKeyCmd;
|
|
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn inspect_node_key() {
|
|
let path = tempfile::tempdir().unwrap().into_path().join("node-id").into_os_string();
|
|
let path = path.to_str().unwrap();
|
|
let cmd = GenerateNodeKeyCmd::parse_from(&["generate-node-key", "--file", path]);
|
|
|
|
assert!(cmd.run("test", &String::from("test")).is_ok());
|
|
|
|
let cmd = InspectNodeKeyCmd::parse_from(&["inspect-node-key", "--file", path]);
|
|
assert!(cmd.run().is_ok());
|
|
}
|
|
}
|