fix README.md

Cargo.lock

@@ -254,6 +254,12 @@ version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
 
+[[package]]
+name = "cfg_aliases"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724"
+
 [[package]]
 name = "chrono"
 version = "0.4.42"
@@ -364,6 +370,17 @@ dependencies = [
  "typenum",
 ]
 
+[[package]]
+name = "ctrlc"
+version = "3.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "881c5d0a13b2f1498e2306e82cbada78390e152d4b1378fb28a84f4dcd0dc4f3"
+dependencies = [
+ "dispatch",
+ "nix",
+ "windows-sys 0.61.2",
+]
+
 [[package]]
 name = "digest"
 version = "0.10.7"
@@ -396,6 +413,12 @@ dependencies = [
  "winapi",
 ]
 
+[[package]]
+name = "dispatch"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bd0c93bb4b0c6d9b77f4435b0ae98c24d17f1c45b2ff844c6151a07256ca923b"
+
 [[package]]
 name = "displaydoc"
 version = "0.2.5"
@@ -473,6 +496,7 @@ version = "0.1.0"
 dependencies = [
  "anyhow",
  "clap",
+ "ctrlc",
  "fancy-regex",
  "num-integer",
  "num_cpus",
@@ -884,6 +908,18 @@ version = "1.0.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "650eef8c711430f1a879fdd01d4745a7deea475becfb90269c06775983bbf086"
 
+[[package]]
+name = "nix"
+version = "0.30.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "74523f3a35e05aba87a1d978330aef40f67b0304ac79c1c00b294c9830543db6"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "cfg_aliases",
+ "libc",
+]
+
 [[package]]
 name = "nom"
 version = "7.1.3"

Cargo.toml

@@ -12,6 +12,7 @@ categories = ["command-line-utilities"]
 [dependencies]
 anyhow = "1.0.100"
 clap = { version = "4.5.50", features = ["derive"] }
+ctrlc = "3.5.0"
 fancy-regex = "0.16.2"
 num-integer = "0.1.46"
 num_cpus = "1.17.0"

README.md

@@ -13,8 +13,9 @@ cargo install fingerprunk
 
 ## Usage
 
-Let's say you want to find keys whose fingerprints begin with `C0FFEE` and store them `secret.asc`.
-The regex for this is `^C0FFEE`. Now, simply use the following command to start the search:
+Let's say you want to find keys whose fingerprints begin with `C0FFEE` and store them
+at `secret.asc`. The regex for this is `^C0FFEE`. Now, simply use the following command to start
+the search:
 
 ```sh
 fingerprunk -r '^C0FFEE' >> secret.asc
@@ -49,25 +50,25 @@ Also see <https://en.wikipedia.org/wiki/Hexspeak> for some further examples of "
 
 ### How long does it take?
 
-On my machine with an AMD Ryzen 7 5800X Processor, Fingerprunk is able to generate and check about
-43300 keys per second. This means that for finding a fingerprint with a string of *n* specific
+On my machine with an AMD Ryzen 7 5800X processor, Fingerprunk is able to generate and check about
+43500 keys per second. This means that for finding a fingerprint with a string of *n* specific
 hexadecimal digits at a specific place, I could expect the following runtimes until finding the
 first key:
 
-| *n* |  expected tries | expected time |
-| --: | --------------: | ------------: |
-| *n* |             16ⁿ |  43300s / 16ⁿ |
-|   2 |             256 |   0.0059 secs |
-|   3 |            4096 |   0.0946 secs |
-|   4 |           65536 |      1.5 secs |
-|   5 |         1028576 |       24 secs |
-|   6 |        16777216 |      6.5 mins |
-|   7 |       268435456 |      103 mins |
-|   8 |      4294967296 |      27 hours |
-|   9 |     68719476736 |       18 days |
-|  10 |   1099511627776 |      293 days |
-|  11 |  17592186044416 |      13 years |
-|  12 | 281474976710656 |     206 years |
+| *n* |         estimate tries | estimate time |
+| --: | ---------------------: | ------------: |
+|   1 |              16 =  16¹ |    < 0.1 secs |
+|   2 |             256 =  16² |    < 0.1 secs |
+|   3 |            4096 =  16³ |      0.1 secs |
+|   4 |           65536 =  16⁴ |      1.5 secs |
+|   5 |         1048576 =  16⁵ |       24 secs |
+|   6 |        16777216 =  16⁶ |        6 mins |
+|   7 |       268435456 =  16⁷ |       2 hours |
+|   8 |      4294967296 =  16⁸ |        1 days |
+|   9 |     68719476736 =  16⁹ |       18 days |
+|  10 |   1099511627776 = 16¹⁰ |      293 days |
+|  11 |  17592186044416 = 16¹¹ |      13 years |
+|  12 | 281474976710656 = 16¹² |     205 years |
 
-As you can see, anything above 8 or 9 fixed digits is pretty much unfeasible, at least with
-a normal personal computer.
+As you can see, anything above 10 fixed digits is pretty much unfeasible, at least with a normal
+personal computer.

src/lib.rs

@@ -2,10 +2,11 @@
 
 use std::{
     fmt::{self, Write},
-    io::{self},
+    io,
+    num::NonZeroU64,
     sync::{
-        atomic::{AtomicU64, Ordering},
-        mpsc::{self, Receiver},
+        atomic::{AtomicBool, AtomicU64, Ordering},
+        mpsc,
     },
     thread,
     time::{Duration, Instant},
@@ -14,7 +15,7 @@ use std::{
 use fancy_regex::Regex;
 use num_integer::Integer;
 use sequoia_openpgp::{
-    Cert, Packet,
+    Cert, Packet, armor,
     crypto::Password,
     packet::{
         Key,
@@ -22,21 +23,30 @@ use sequoia_openpgp::{
         prelude::SignatureBuilder,
     },
     serialize::Serialize,
-    types::{HashAlgorithm, SignatureType, SymmetricAlgorithm},
+    types::{Curve, HashAlgorithm, SignatureType, SymmetricAlgorithm},
 };
 
 type SecretKey = Key<SecretParts, PrimaryRole>;
 
+#[allow(clippy::large_enum_variant)]
+enum Message {
+    Key(SecretKey),
+    Stop,
+}
+
 #[derive(Clone, Debug)]
 pub struct Config {
     pub regex: Regex,
     pub status_enabled: bool,
+    pub stop_after: Option<NonZeroU64>,
     pub password: Option<Password>,
 }
 
 #[derive(Debug)]
 pub struct Fingerprunk {
     config: Config,
+    started_instant: Instant,
+    stop: AtomicBool,
     counter_tried: AtomicU64,
     counter_found: AtomicU64,
 }
@@ -52,53 +62,89 @@ impl Fingerprunk {
     pub fn new_from_config(config: Config) -> Self {
         Self {
             config,
+            started_instant: Instant::now(),
+            stop: AtomicBool::new(false),
             counter_tried: AtomicU64::new(0),
             counter_found: AtomicU64::new(0),
         }
     }
 
-    pub fn run(self) {
-        let (tx, rx) = mpsc::channel();
+    pub fn run(mut self) -> anyhow::Result<()> {
+        self.started_instant = Instant::now();
+
+        let (sender, receiver) = mpsc::channel();
+
+        {
+            let sender = sender.clone();
+            ctrlc::set_handler(move || {
+                let _ = sender.send(Message::Stop);
+            })?;
+        }
 
         thread::scope(|scope| {
-            const THREAD_SPAWN_EXPECT_MSG: &str = "should be able to spawn thread";
-
             let ref_self = &self;
 
-            if self.config.status_enabled {
-                thread::Builder::new()
-                    .name("status_displayer".to_string())
-                    .spawn_scoped(scope, move || ref_self.status_displayer_thread())
-                    .expect(THREAD_SPAWN_EXPECT_MSG);
-            }
+            let status_displayer = if self.config.status_enabled {
+                Some(
+                    thread::Builder::new()
+                        .name("status_displayer".to_string())
+                        .spawn_scoped(scope, move || ref_self.status_displayer_thread())?,
+                )
+            } else {
+                None
+            };
 
             for num in 0..num_cpus::get() {
-                let tx = tx.clone();
+                let sender = sender.clone();
 
                 thread::Builder::new()
                     .name(format!("worker-{num:03}"))
-                    .spawn_scoped(scope, move || ref_self.worker_thread(tx))
-                    .expect(THREAD_SPAWN_EXPECT_MSG);
+                    .spawn_scoped(scope, move || ref_self.worker_thread(sender))?;
             }
 
-            thread::Builder::new()
-                .name("finalizer".to_string())
-                .spawn_scoped(scope, move || ref_self.finalizer_thread(rx))
-                .expect(THREAD_SPAWN_EXPECT_MSG);
-        });
+            let mut stdout = io::stdout().lock();
+
+            // Receive and process messages from the workers and the ctrl-c handler
+            for message in receiver {
+                match message {
+                    Message::Key(key) => {
+                        let cert = self.key_to_cert(&key)?;
+                        self.serialize_cert(cert, &mut stdout)?;
+
+                        // Increase "found" counter and stop if enough matches have been found
+                        let prev = self.counter_found.fetch_add(1, Ordering::Relaxed);
+                        if self.config.stop_after.is_some_and(|s| prev + 1 == s.get()) {
+                            break;
+                        }
+                    }
+                    Message::Stop => break,
+                }
+            }
+
+            // Ask all other threads to stop
+            self.stop.store(true, Ordering::Relaxed);
+
+            // Unpark the status displayer thread, if existant
+            if let Some(status_displayer) = status_displayer {
+                status_displayer.thread().unpark();
+            }
+
+            Ok(())
+        })
     }
 
-    fn worker_thread(&self, matches_tx: mpsc::Sender<SecretKey>) {
+    fn worker_thread(&self, sender: mpsc::Sender<Message>) {
         let mut fingerprint_hex = String::with_capacity(20 * 2);
 
-        loop {
-            let key = Key4::generate_ed25519().expect("should be able to generate key");
+        while !self.stop.load(Ordering::Relaxed) {
+            let key =
+                Key4::generate_ecc(true, Curve::Ed25519).expect("should be able to generate key");
             fingerprint_hex.clear();
             write!(fingerprint_hex, "{:X}", key.fingerprint())
                 .expect("should write into string without error");
             if self.check_fingerprint(&fingerprint_hex) {
-                matches_tx
-                    .send(Key::V4(key))
+                sender
+                    .send(Message::Key(Key::V4(key)))
                     .expect("should be able to send key");
             }
             self.counter_tried.fetch_add(1, Ordering::Relaxed);
@@ -113,22 +159,6 @@ impl Fingerprunk {
             .expect("should check regex without error")
     }
 
-    fn finalizer_thread(&self, matches_rx: Receiver<SecretKey>) {
-        let mut stdout = io::stdout().lock();
-
-        for key in matches_rx {
-            let result = self
-                .key_to_cert(&key)
-                .and_then(|cert| cert.as_tsk().armored().serialize(&mut stdout));
-
-            if let Err(err) = result {
-                eprintln!("Error: {err}");
-            } else {
-                self.counter_found.fetch_add(1, Ordering::Relaxed);
-            }
-        }
-    }
-
     fn key_to_cert(&self, key: &SecretKey) -> anyhow::Result<Cert> {
         let sig = SignatureBuilder::new(SignatureType::DirectKey)
             .set_hash_algo(HashAlgorithm::SHA512)
@@ -157,7 +187,45 @@ impl Fingerprunk {
         Cert::try_from(vec![secret_key_packet, Packet::from(sig)])
     }
 
+    fn serialize_cert(&self, cert: Cert, to: impl io::Write) -> anyhow::Result<()> {
+        let mut comments = cert.armor_headers();
+        comments.push(format!(
+            "Generated with Fingerprunk. Regex: {}",
+            self.config.regex
+        ));
+
+        let headers: Vec<_> = comments
+            .into_iter()
+            .map(|s| ("Comment".to_string(), s))
+            .collect();
+
+        let mut writer = armor::Writer::with_headers(to, armor::Kind::SecretKey, headers)?;
+
+        // Set the profile to RFC4880 because we generate v4 keys.
+        writer.set_profile(sequoia_openpgp::Profile::RFC4880)?;
+
+        cert.serialize(&mut writer)?;
+        writer.finalize()?;
+
+        Ok(())
+    }
+
     fn status_displayer_thread(&self) {
+        const UPDATE_INTERVAL: Duration = Duration::from_millis(250);
+
+        eprint!("\n\n\n\n\n");
+
+        while !self.stop.load(Ordering::Relaxed) {
+            self.print_status();
+            // We are parking the thread instead of sleeping so we can unpark it when we want to
+            // stop the program.
+            thread::park_timeout(UPDATE_INTERVAL);
+        }
+
+        self.print_status();
+    }
+
+    fn print_status(&self) {
         struct DurationDhms(Duration);
 
         impl fmt::Display for DurationDhms {
@@ -171,28 +239,20 @@ impl Fingerprunk {
             }
         }
 
-        const UPDATE_INTERVAL: Duration = Duration::from_millis(250);
         const FORMAT_WIDTH: usize = 12;
 
-        let start = Instant::now();
-
-        eprint!("\n\n\n\n\n");
-
-        loop {
-            let duration = DurationDhms(start.elapsed());
-            let keys = self.counter_tried.load(Ordering::Relaxed);
-            let keys_per_sec = keys as f64 / duration.0.as_secs_f64();
-            let found = self.counter_found.load(Ordering::Relaxed);
-            eprint!(
-                "\x1b[F\x1b[F\x1b[F\x1b[F\x1b[F\
+        let duration = DurationDhms(self.started_instant.elapsed());
+        let keys = self.counter_tried.load(Ordering::Relaxed);
+        let keys_per_sec = keys as f64 / duration.0.as_secs_f64();
+        let found = self.counter_found.load(Ordering::Relaxed);
+        eprint!(
+            "\x1b[F\x1b[F\x1b[F\x1b[F\x1b[F\
                 Time:  {duration}\n\
                 Tried: {keys: >w$} keys\n\
                 Rate:  {keys_per_sec: >w$.0} keys/s\n\
                 ---\n\
                 Found: {found: >w$} keys\n",
-                w = FORMAT_WIDTH
-            );
-            thread::sleep(UPDATE_INTERVAL);
-        }
+            w = FORMAT_WIDTH
+        );
     }
 }

src/main.rs

@@ -1,4 +1,7 @@
-use std::io::{self, IsTerminal};
+use std::{
+    io::{self, IsTerminal},
+    num::NonZeroU64,
+};
 
 use anyhow::{Context as AnyhowContext, anyhow};
 use clap::{ArgAction, Parser, ValueEnum};
@@ -26,6 +29,10 @@ struct Args {
     #[arg(long, value_enum, default_value_t)]
     status: StatusEnabled,
 
+    /// Stop once the specified number of matching keys has been found.
+    #[arg(long)]
+    stop_after: Option<NonZeroU64>,
+
     /// Prompt for a password and use it to encrypt found keys.
     ///
     /// By default, found keys are printed to stdout unencrypted. Use this if you actually plan to
@@ -78,10 +85,11 @@ fn main() -> anyhow::Result<()> {
     let config = fingerprunk::Config {
         regex: args.regex,
         status_enabled: args.status.evaluate(),
+        stop_after: args.stop_after,
         password,
     };
 
-    Fingerprunk::new_from_config(config).run();
+    Fingerprunk::new_from_config(config).run()?;
 
     Ok(())
 }