Skip to content
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

Add a peer id generator #583

Merged
merged 9 commits into from
Nov 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ members = [
"misc/multiaddr",
"misc/multihash",
"misc/multistream-select",
"misc/peer-id-generator",
"misc/rw-stream-sink",
"transports/dns",
"protocols/floodsub",
Expand Down
12 changes: 12 additions & 0 deletions misc/peer-id-generator/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[package]
name = "peer-id-generator"
version = "0.1.0"
description = "Generate peer ids that are prefixed with a specific string"
authors = ["Parity Technologies <admin@parity.io>"]
license = "MIT"

[dependencies]
libp2p-core = { path = "../../core" }
libp2p-secio = { path = "../../protocols/secio" }
num_cpus = "1.8"
rand = "0.5"
89 changes: 89 additions & 0 deletions misc/peer-id-generator/src/main.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
// Copyright 2018 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.

extern crate libp2p_core;
extern crate libp2p_secio;
extern crate num_cpus;
extern crate rand;

use libp2p_core::PeerId;
use libp2p_secio::SecioKeyPair;
use std::{env, str, thread, time::Duration};

fn main() {
// Due to the fact that a peer id uses a SHA-256 multihash, it always starts with the
// bytes 0x1220, meaning that only some characters are valid.
const ALLOWED_FIRST_BYTE: &'static [u8] = b"NPQRSTUVWXYZ";

let prefix =
match env::args().nth(1) {
Some(prefix) => prefix,
None => {
println!(
"Usage: {} <prefix>\n\n\
Generates a peer id that starts with the chosen prefix using a secp256k1 public \
key.\n\n\
Prefix must be a sequence of characters in the base58 \
alphabet, and must start with one of the following: {}",
env::current_exe().unwrap().file_name().unwrap().to_str().unwrap(),
str::from_utf8(ALLOWED_FIRST_BYTE).unwrap()
);
return;
}
};

// The base58 alphabet is not necessarily obvious.
const ALPHABET: &'static [u8] = b"123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
if prefix.as_bytes().iter().any(|c| !ALPHABET.contains(c)) {
println!("Prefix {} is not valid base58", prefix);
return;
}

// Checking conformity to ALLOWED_FIRST_BYTE.
if !prefix.is_empty() {
if !ALLOWED_FIRST_BYTE.contains(&prefix.as_bytes()[0]) {
println!("Prefix {} is not reachable", prefix);
println!(
"Only the following bytes are possible as first byte: {}",
str::from_utf8(ALLOWED_FIRST_BYTE).unwrap()
);
return;
}
}

// Find peer IDs in a multithreaded fashion.
for _ in 0..num_cpus::get() {
let prefix = prefix.clone();
thread::spawn(move || loop {
let private_key: [u8; 32] = rand::random();
let generated = SecioKeyPair::secp256k1_raw_key(private_key).unwrap();
let peer_id: PeerId = generated.to_public_key().into_peer_id();
let base58 = peer_id.to_base58();
if base58[2..].starts_with(&prefix) {
println!("Found {:?}", peer_id);
println!("=> Private key = {:?}", private_key);
}
});
}

loop {
thread::sleep(Duration::from_secs(3600));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of executing for a certain amount of time, would you not rather want to generate a specific number of keys? How about a second command line parameter to specific that number and then maybe utilise rayon with (0 .. number).into_par_iter().for_each(move |_| ...)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generating keys is super slow, so I don't think it really makes sense to stop after a certain number.
Do you think I should use rayon?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rayon works well but I was only suggesting it in the context of "I want n peer IDs". If you rather prefer time-based execution the existing approach is fine I think.

}
}