apihunter 0.1.2

Async API security scanner with passive and active checks for CORS, CSP, GraphQL, JWT, OpenAPI, and API posture.
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
164

use std::collections::HashSet;

use futures::stream::{self, StreamExt};
use rand::seq::SliceRandom;
use tracing::{debug, warn};

use crate::{error::CapturedError, http_client::HttpClient};

/// Built-in wordlist of high-value API / admin paths.
/// Extend this list or load an external wordlist via `Config::wordlist`.
static COMMON_PATHS: &[&str] = &[
    "/api",
    "/api/v1",
    "/api/v2",
    "/api/v3",
    "/graphql",
    "/graphiql",
    "/playground",
    "/swagger",
    "/swagger.json",
    "/swagger.yaml",
    "/swagger-ui",
    "/swagger-ui.html",
    "/openapi",
    "/openapi.json",
    "/openapi.yaml",
    "/api-docs",
    "/api-docs.json",
    "/docs",
    "/redoc",
    "/admin",
    "/admin/api",
    "/internal",
    "/internal/api",
    "/private",
    "/debug",
    "/actuator",
    "/actuator/health",
    "/actuator/env",
    "/actuator/mappings",
    "/actuator/beans",
    "/actuator/metrics",
    "/metrics",
    "/health",
    "/healthz",
    "/readyz",
    "/livez",
    "/status",
    "/.well-known/openid-configuration",
    "/.well-known/oauth-authorization-server",
    "/oauth/token",
    "/oauth/authorize",
    "/auth/token",
    "/auth/login",
    "/auth/refresh",
    "/login",
    "/logout",
    "/register",
    "/users",
    "/user",
    "/account",
    "/accounts",
    "/profile",
    "/me",
    "/config",
    "/configuration",
    "/settings",
    "/env",
    "/environment",
    "/version",
    "/info",
    "/ping",
    "/trace",
    "/log",
    "/logs",
    "/debug/vars",
    "/server-status",
    "/server-info",
    "/phpinfo.php",
    "/.env",
    "/.git/config",
    "/wp-json/wp/v2",
    "/wp-json",
    "/jsonapi",
    "/rest/v1",
    "/rest/v2",
    "/api/swagger.json",
    "/api/openapi.json",
    "/api/graphql",
];

pub struct CommonPathDiscovery<'a> {
    client: &'a HttpClient,
    base_url: &'a str,
    concurrency: usize,
    /// Optional external wordlist to merge with the built-in list
    extra: Vec<String>,
}

impl<'a> CommonPathDiscovery<'a> {
    pub fn new(
        client: &'a HttpClient,
        base_url: &'a str,
        concurrency: usize,
        extra: Vec<String>,
    ) -> Self {
        Self {
            client,
            base_url,
            concurrency,
            extra,
        }
    }

    /// Returns only paths that responded with < 404 (i.e. exist or auth-gated)
    pub async fn run(&self) -> (HashSet<String>, Vec<CapturedError>) {
        let base = self.base_url.trim_end_matches('/');

        // Merge built-in + external wordlist, deduplicate, and shuffle to
        // avoid deterministic probing fingerprints.
        let mut all_paths: Vec<String> = COMMON_PATHS.iter().map(|p| (*p).to_string()).collect();
        all_paths.extend(self.extra.iter().cloned());
        all_paths.sort_unstable();
        all_paths.dedup();
        if all_paths.len() > 1 {
            let mut rng = rand::thread_rng();
            all_paths.shuffle(&mut rng);
        }

        let results = stream::iter(all_paths)
            .map(|path| {
                let url = format!("{base}{path}");
                async move {
                    let result = self.client.head(&url).await;
                    (path, url, result)
                }
            })
            .buffer_unordered(self.concurrency)
            .collect::<Vec<_>>()
            .await;

        let mut found = HashSet::new();
        let mut errors = Vec::new();

        for (path, url, result) in results {
            match result {
                Ok(resp) => {
                    // Treat anything except 404/410 as "exists"
                    if resp.status != 404 && resp.status != 410 {
                        debug!("[common_paths] {} => {}", url, resp.status);
                        found.insert(path);
                    }
                }
                Err(e) => {
                    warn!("[common_paths] probe error: {}", e);
                    errors.push(e);
                }
            }
        }

        debug!("[common_paths] {} live paths found", found.len());
        (found, errors)
    }
}