chore: release version 0.4.0

- set meaningful value names for options
- add backticks around CLI options in user-facing messages

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fingerprunk"
-version = "0.1.0"
+version = "0.4.0"
 authors = ["Niklas Elsbrock <mail@nelsbrock.de>"]
 edition = "2024"
 description = "CLI tool for brute-forcing OpenPGP keys with cool fingerprints"
@@ -10,11 +10,10 @@ keywords = ["fingerprint", "openpgp", "bruteforce"]
 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"
+anyhow = "1.0.102"
+clap = { version = "4.6.1", features = ["derive"] }
+ctrlc = "3.5.2"
+fancy-regex = "0.18.0"
 num-integer = "0.1.46"
-num_cpus = "1.17.0"
-rpassword = "7.4.0"
-sequoia-openpgp = "2.0.0"
+rpassword = "7.5.2"
+sequoia-openpgp = "2.3.0"

README.md

@@ -18,11 +18,11 @@ at `secret.asc`. The regex for this is `^C0FFEE`. Now, simply use the following
 the search:
 
 ```sh
-fingerprunk -r '^C0FFEE' >> secret.asc
+fingerprunk -r '^C0FFEE' -u "Your Name <your.email@example.org>" >> secret.asc
 ```
 
 Fingerprunk will now generate many keys and write out all keys with matching fingerprints to
-standard output (here: `secret.asc`).
+standard output (here: `secret.asc`), adding the provided user ID.
 
 If you want Fingerprunk to output password-encrypted keys use the `-p` flag and you will be prompted
 for a password.

src/lib.rs

@@ -3,13 +3,13 @@
 use std::{
     fmt::{self, Write},
     io,
-    num::NonZeroU64,
+    num::NonZero,
     sync::{
         atomic::{AtomicBool, AtomicU64, Ordering},
         mpsc,
     },
     thread,
-    time::{Duration, Instant},
+    time::{Duration, Instant, SystemTime},
 };
 
 use fancy_regex::Regex;
@@ -18,7 +18,7 @@ use sequoia_openpgp::{
     Cert, Packet, armor,
     crypto::Password,
     packet::{
-        Key,
+        Key, UserID,
         key::{Key4, PrimaryRole, SecretParts},
         prelude::SignatureBuilder,
     },
@@ -38,8 +38,10 @@ enum Message {
 pub struct Config {
     pub regex: Regex,
     pub status_enabled: bool,
-    pub stop_after: Option<NonZeroU64>,
+    pub count: Option<NonZero<u64>>,
     pub password: Option<Password>,
+    pub userids: Vec<UserID>,
+    pub workers: NonZero<usize>,
 }
 
 #[derive(Debug)]
@@ -72,7 +74,7 @@ impl Fingerprunk {
     pub fn run(mut self) -> anyhow::Result<()> {
         self.started_instant = Instant::now();
 
-        let (sender, receiver) = mpsc::channel();
+        let (sender, receiver) = mpsc::sync_channel(16);
 
         {
             let sender = sender.clone();
@@ -82,24 +84,20 @@ impl Fingerprunk {
         }
 
         thread::scope(|scope| {
-            let ref_self = &self;
-
             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())?,
+                        .spawn_scoped(scope, || self.status_displayer_thread())?,
                 )
             } else {
                 None
             };
 
-            for num in 0..num_cpus::get() {
-                let sender = sender.clone();
-
+            for num in 0..self.config.workers.get() {
                 thread::Builder::new()
                     .name(format!("worker-{num:03}"))
-                    .spawn_scoped(scope, move || ref_self.worker_thread(sender))?;
+                    .spawn_scoped(scope, || self.worker_thread(&sender))?;
             }
 
             let mut stdout = io::stdout().lock();
@@ -108,12 +106,12 @@ impl Fingerprunk {
             for message in receiver {
                 match message {
                     Message::Key(key) => {
-                        let cert = self.key_to_cert(&key)?;
-                        self.serialize_cert(cert, &mut stdout)?;
+                        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()) {
+                        if self.config.count.is_some_and(|s| prev + 1 == s.get()) {
                             break;
                         }
                     }
@@ -133,7 +131,7 @@ impl Fingerprunk {
         })
     }
 
-    fn worker_thread(&self, sender: mpsc::Sender<Message>) {
+    fn worker_thread(&self, sender: &mpsc::SyncSender<Message>) {
         let mut fingerprint_hex = String::with_capacity(20 * 2);
 
         while !self.stop.load(Ordering::Relaxed) {
@@ -143,9 +141,9 @@ impl Fingerprunk {
             write!(fingerprint_hex, "{:X}", key.fingerprint())
                 .expect("should write into string without error");
             if self.check_fingerprint(&fingerprint_hex) {
-                sender
-                    .send(Message::Key(Key::V4(key)))
-                    .expect("should be able to send key");
+                // The channel might already be closed here if we're stopping.
+                // That is fine, so we just ignore the error.
+                let _ = sender.send(Message::Key(Key::V4(key)));
             }
             self.counter_tried.fetch_add(1, Ordering::Relaxed);
         }
@@ -159,35 +157,50 @@ impl Fingerprunk {
             .expect("should check regex without error")
     }
 
-    fn key_to_cert(&self, key: &SecretKey) -> anyhow::Result<Cert> {
-        let sig = SignatureBuilder::new(SignatureType::DirectKey)
-            .set_hash_algo(HashAlgorithm::SHA512)
-            .set_preferred_hash_algorithms(vec![HashAlgorithm::SHA512, HashAlgorithm::SHA256])?
-            .set_preferred_symmetric_algorithms(vec![
-                SymmetricAlgorithm::AES256,
-                SymmetricAlgorithm::AES128,
-            ])?;
+    fn key_to_cert(&self, mut key: SecretKey) -> anyhow::Result<Cert> {
+        let creation_time = SystemTime::now();
 
         let mut signer = key
             .clone()
             .into_keypair()
             .expect("key should have a secret");
-        let sig = sig.sign_direct_key(&mut signer, key.parts_as_public())?;
 
-        let secret_key_packet = Packet::SecretKey({
-            let mut key = key.clone();
+        // Sign keypair
+        let key_sig = create_sig_builder(SignatureType::DirectKey, creation_time)?
+            .sign_direct_key(&mut signer, key.parts_as_public())?;
+
+        // Create certificate
+        let mut cert = Cert::try_from(Packet::SecretKey({
             if let Some(ref password) = self.config.password {
                 let (k, mut secret) = key.take_secret();
                 secret.encrypt_in_place(&k, password)?;
                 key = k.add_secret(secret).0;
             }
             key
-        });
+        }))?;
 
-        Cert::try_from(vec![secret_key_packet, Packet::from(sig)])
+        let mut packets = vec![Packet::from(key_sig)];
+
+        // Sign user IDs
+        let mut next_is_primary = true;
+        for user_id in self.config.userids.iter().cloned() {
+            let mut sig_builder =
+                create_sig_builder(SignatureType::PositiveCertification, creation_time)?;
+            if next_is_primary {
+                sig_builder = sig_builder.set_primary_userid(true)?;
+                next_is_primary = false;
+            }
+            let sig = user_id.bind(&mut signer, &cert, sig_builder)?;
+
+            packets.push(user_id.into());
+            packets.push(sig.into());
+        }
+
+        cert = cert.insert_packets(packets)?.0;
+        Ok(cert)
     }
 
-    fn serialize_cert(&self, cert: Cert, to: impl io::Write) -> anyhow::Result<()> {
+    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: {}",
@@ -256,3 +269,17 @@ impl Fingerprunk {
         );
     }
 }
+
+fn create_sig_builder(
+    typ: SignatureType,
+    creation_time: SystemTime,
+) -> Result<SignatureBuilder, anyhow::Error> {
+    SignatureBuilder::new(typ)
+        .set_signature_creation_time(creation_time)?
+        .set_hash_algo(HashAlgorithm::SHA512)
+        .set_preferred_hash_algorithms(vec![HashAlgorithm::SHA512, HashAlgorithm::SHA256])?
+        .set_preferred_symmetric_algorithms(vec![
+            SymmetricAlgorithm::AES256,
+            SymmetricAlgorithm::AES128,
+        ])
+}

src/main.rs

@@ -1,12 +1,13 @@
 use std::{
     io::{self, IsTerminal},
-    num::NonZeroU64,
+    num::NonZero,
 };
 
-use anyhow::{Context as AnyhowContext, anyhow};
+use anyhow::{Context, anyhow};
 use clap::{ArgAction, Parser, ValueEnum};
 use fancy_regex::Regex;
 use fingerprunk::Fingerprunk;
+use sequoia_openpgp::packet::UserID;
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
@@ -30,15 +31,32 @@ struct Args {
     status: StatusEnabled,
 
     /// Stop once the specified number of matching keys has been found.
-    #[arg(long)]
-    stop_after: Option<NonZeroU64>,
+    #[arg(short = 'n', long, value_name = "NUM")]
+    count: Option<NonZero<u64>>,
 
-    /// Prompt for a password and use it to encrypt found keys.
+    /// Prompt for a password and use it to encrypt matching keys.
     ///
     /// By default, found keys are printed to stdout unencrypted. Use this if you actually plan to
     /// use generated keys.
     #[arg(short, long, action = ArgAction::SetTrue)]
     password: bool,
+
+    /// Add the given user ID to matching keys.
+    #[arg(short, long = "userid")]
+    userid: Vec<UserID>,
+
+    /// Explicitly do not add user IDs to matching keys.
+    ///
+    /// Disables the warning about importing keys without user IDs into GnuPG.
+    #[arg(long, conflicts_with = "userid", action = ArgAction::SetTrue)]
+    no_userid: bool,
+
+    /// Use the specified amount of worker threads.
+    ///
+    /// If not specified, the amount of worker threads will be set to the amount of the machine's
+    /// available parallelism.
+    #[arg(long, value_name = "NUM")]
+    workers: Option<NonZero<usize>>,
 }
 
 #[derive(ValueEnum, Clone, Copy, Debug, Default)]
@@ -62,16 +80,33 @@ impl StatusEnabled {
 fn main() -> anyhow::Result<()> {
     let args = Args::parse();
 
+    let workers = match args.workers {
+        Some(workers) => workers,
+        None => std::thread::available_parallelism().context(
+            "unable to determine available parallelism, \
+            use `--workers <NUM>` to specify amount of worker threads",
+        )?,
+    };
+
+    if !args.no_userid && args.userid.is_empty() {
+        eprintln!(
+            "WARNING: No user ID was provided.\n\
+            You may experience problems importing generated keys into GnuPG.\n\
+            Use `--userid <USERID>` to add a user ID.\n"
+        );
+    }
+
     let password = if args.password {
         let password = rpassword::prompt_password(
             "Enter password for encrypting found keys (leave empty for no encryption): ",
         )
-        .with_context(|| "Failed to prompt password")?;
+        .context("Failed to prompt password")?;
+
         if password.is_empty() {
             None
         } else {
             let password_retype = rpassword::prompt_password("Retype password: ")
-                .with_context(|| "Failed to prompt password retype")?;
+                .context("Failed to prompt password retype")?;
             if password_retype == password {
                 Some(password.into())
             } else {
@@ -85,11 +120,11 @@ fn main() -> anyhow::Result<()> {
     let config = fingerprunk::Config {
         regex: args.regex,
         status_enabled: args.status.evaluate(),
-        stop_after: args.stop_after,
+        count: args.count,
         password,
+        userids: args.userid,
+        workers,
     };
 
-    Fingerprunk::new_from_config(config).run()?;
-
-    Ok(())
+    Fingerprunk::new_from_config(config).run()
 }