vuke 0.3.0

Research tool for studying vulnerable Bitcoin key generation practices
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Console output handler.

use anyhow::Result;
use std::fs::File;
use std::io::{self, BufWriter, Write};
use std::path::Path;
use std::sync::Mutex;

use super::Output;
use crate::derive::DerivedKey;
use crate::matcher::MatchInfo;

/// Console output - prints to stdout/stderr.
pub struct ConsoleOutput {
    writer: Mutex<Box<dyn Write + Send>>,
    verbose: bool,
}

impl ConsoleOutput {
    /// Create console output to stdout.
    pub fn new() -> Self {
        Self {
            writer: Mutex::new(Box::new(io::stdout())),
            verbose: false,
        }
    }

    /// Create verbose console output.
    pub fn verbose() -> Self {
        Self {
            writer: Mutex::new(Box::new(io::stdout())),
            verbose: true,
        }
    }

    /// Create output to file.
    pub fn to_file(path: &Path) -> Result<Self> {
        let file = File::create(path)?;
        Ok(Self {
            writer: Mutex::new(Box::new(BufWriter::new(file))),
            verbose: false,
        })
    }

    /// Create verbose output to file.
    pub fn to_file_verbose(path: &Path) -> Result<Self> {
        let file = File::create(path)?;
        Ok(Self {
            writer: Mutex::new(Box::new(BufWriter::new(file))),
            verbose: true,
        })
    }
}

impl Default for ConsoleOutput {
    fn default() -> Self {
        Self::new()
    }
}

impl Output for ConsoleOutput {
    fn key(&self, source: &str, transform: &str, derived: &DerivedKey) -> Result<()> {
        let mut w = self.writer.lock().unwrap();

        if self.verbose {
            writeln!(w, "---")?;
            writeln!(w, "source: {}", source)?;
            writeln!(w, "transform: {}", transform)?;
            writeln!(w, "private_key: {}", derived.private_key_hex)?;
            writeln!(w, "wif_compressed: {}", derived.wif_compressed)?;
            writeln!(w, "wif_uncompressed: {}", derived.wif_uncompressed)?;
            writeln!(w, "p2pkh_compressed: {}", derived.p2pkh_compressed)?;
            writeln!(w, "p2pkh_uncompressed: {}", derived.p2pkh_uncompressed)?;
            writeln!(w, "p2wpkh: {}", derived.p2wpkh)?;
        } else {
            // Compact format: source,transform,privkey,address_compressed
            writeln!(
                w,
                "{},{},{},{}",
                source, transform, derived.private_key_hex, derived.p2pkh_compressed
            )?;
        }

        Ok(())
    }

    fn hit(&self, source: &str, transform: &str, derived: &DerivedKey, match_info: &MatchInfo) -> Result<()> {
        let mut w = self.writer.lock().unwrap();

        writeln!(w, "\n========== HIT ==========")?;
        writeln!(w, "Source: {}", source)?;
        writeln!(w, "Transform: {}", transform)?;
        writeln!(w, "Matched: {} ({})", match_info.address, match_info.address_type.as_str())?;
        writeln!(w, "---")?;
        writeln!(w, "Private Key: {}", derived.private_key_hex)?;
        writeln!(w, "WIF (compressed): {}", derived.wif_compressed)?;
        writeln!(w, "WIF (uncompressed): {}", derived.wif_uncompressed)?;
        writeln!(w, "---")?;
        writeln!(w, "P2PKH (compressed): {}", derived.p2pkh_compressed)?;
        writeln!(w, "P2PKH (uncompressed): {}", derived.p2pkh_uncompressed)?;
        writeln!(w, "P2WPKH: {}", derived.p2wpkh)?;
        writeln!(w, "=========================")?;

        Ok(())
    }

    fn flush(&self) -> Result<()> {
        let mut w = self.writer.lock().unwrap();
        w.flush()?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::NamedTempFile;

    fn make_test_key() -> DerivedKey {
        DerivedKey {
            private_key_hex: "abc123".to_string(),
            private_key_decimal: "123".to_string(),
            private_key_binary: "101".to_string(),
            bit_length: 8,
            hamming_weight: 3,
            leading_zeros: 0,
            pubkey_compressed: "02abc".to_string(),
            pubkey_uncompressed: "04abc".to_string(),
            wif_compressed: "WIF_C".to_string(),
            wif_uncompressed: "WIF_U".to_string(),
            p2pkh_compressed: "1Address".to_string(),
            p2pkh_uncompressed: "1Uncompressed".to_string(),
            p2wpkh: "bc1q...".to_string(),
        }
    }

    #[test]
    fn test_to_file_writes_compact_format() {
        let temp = NamedTempFile::new().unwrap();
        let output = ConsoleOutput::to_file(temp.path()).unwrap();

        output.key("test_source", "sha256", &make_test_key()).unwrap();
        output.flush().unwrap();

        let content = std::fs::read_to_string(temp.path()).unwrap();
        assert!(content.contains("test_source,sha256,abc123,1Address"));
    }

    #[test]
    fn test_to_file_verbose_writes_yaml_format() {
        let temp = NamedTempFile::new().unwrap();
        let output = ConsoleOutput::to_file_verbose(temp.path()).unwrap();

        output.key("test_source", "sha256", &make_test_key()).unwrap();
        output.flush().unwrap();

        let content = std::fs::read_to_string(temp.path()).unwrap();
        assert!(content.contains("source: test_source"));
        assert!(content.contains("transform: sha256"));
        assert!(content.contains("private_key: abc123"));
        assert!(content.contains("p2pkh_compressed: 1Address"));
    }
}