keyhunter 0.2.0

Check for leaked API keys and secrets on public websites
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

/// Copyright © 2024 Don Isaac
///
/// This file is part of KeyHunter.
///
/// KeyHunter is free software: you can redistribute it and/or modify it
/// under the terms of the GNU General Public License as published by the Free
/// Software Foundation, either version 3 of the License, or (at your option)
/// any later version.
///
/// KeyHunter is distributed in the hope that it will be useful, but WITHOUT
/// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
/// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
/// more details.
///
/// You should have received a copy of the GNU General Public License along with
/// KeyHunter. If not, see <https://www.gnu.org/licenses/>.
use log::trace;
use std::{
    sync::{mpsc, Arc},
    thread::{self, JoinHandle},
};

use keyhunter::{
    ApiKeyCollector, ApiKeyMessage, ApiKeyReceiver, Config, ScriptMessage, WebsiteWalkBuilder,
};
use miette::{Context as _, Error, IntoDiagnostic as _, Result};

#[derive(Debug)]
pub struct Runner {
    config: Arc<Config>,
    max_walks: usize,
    headers: Vec<(String, String)>,
    random_ua: bool,
}

impl Runner {
    pub fn new(
        config: Arc<Config>,
        max_walks: usize,
        headers: Vec<(String, String)>,
        random_ua: bool,
    ) -> Self {
        Self {
            config,
            max_walks,
            headers,
            random_ua,
        }
    }

    pub fn run<U: IntoIterator<Item = String> + Send + 'static>(
        &self,
        urls: U,
    ) -> (ApiKeyReceiver, JoinHandle<Vec<Error>>) {
        let (key_sender, key_receiver) = mpsc::channel::<ApiKeyMessage>();
        let config = Arc::clone(&self.config);
        let random_ua = self.random_ua;
        let walk_builder = WebsiteWalkBuilder::default()
            .with_max_walks(self.max_walks)
            .with_random_ua(self.random_ua)
            .with_headers(self.headers.clone())
            .with_shared_cache(true)
            .with_cookie_jar(true);

        trace!("Starting runner thread");
        // let mut errors: Arc<RwLock<Vec<Error>>> = Default::default();

        let handle = thread::spawn(move || {
            let mut errors: Vec<Error> = Default::default();
            urls.into_iter().for_each(|url| {
                let url = if !url.contains("://") {
                    String::from("https://") + &url
                } else {
                    url
                };
                // info!("Scraping keys for site '{url}'...");

                let (tx_scripts, rx_scripts) = mpsc::channel::<ScriptMessage>();
                let walker = walk_builder.build(tx_scripts.clone());
                let collector =
                    ApiKeyCollector::new(config.clone(), rx_scripts, key_sender.clone())
                        .with_random_ua(random_ua);

                // Visit pages in the target site, sending found script urls over the
                // script channel
                let moved_url = url.clone();
                let walk_handle = thread::spawn(move || {
                    let result = walker.walk(&moved_url);
                    if let Err(ref err) = result {
                        // println!("failed to create walker: {}", err);
                        println!("{:?}", err);
                        tx_scripts
                            .send(ScriptMessage::Done)
                            .into_diagnostic()
                            .context("Failed to send stop signal over script channel")
                            .unwrap();
                    }

                    result
                });

                trace!("Starting API key collector thread");
                let collector_handle = thread::spawn(move || collector.collect());
                if let Err(error) = Self::join(&url, collector_handle, walk_handle) {
                    errors.push(error)
                }
            });

            debug!("Sending stop signal to API key collector");
            key_sender
                .send(ApiKeyMessage::Stop)
                .into_diagnostic()
                .context("Failed to close API key channel")
                .unwrap();

            debug!("Scraping completed");
            errors
        });

        (key_receiver, handle)
    }

    fn join<S: AsRef<str>>(
        url: S,
        collector_handle: JoinHandle<()>,
        walk_handle: JoinHandle<Result<()>>,
    ) -> Result<()> {
        let _url = url.as_ref();

        debug!("Waiting for collector thread to finish...");
        collector_handle
            .join()
            .expect("ApiKeyCollector thread should have joined successfully");

        debug!("Waiting for walker thread to finish...");
        walk_handle
            .join()
            .expect("WebsiteWalker thread should have joined successfully")
    }
}