1#![allow(clippy::doc_markdown)] use std::path::PathBuf;
7
8use clap::CommandFactory;
9use clap::Parser;
10
11pub const DEFAULT_USER_AGENT: &str = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36";
15
16pub const ACCEPTABLE_USE_HELP: &str = "Scan only hosts you are authorized to scan.";
18
19#[derive(Debug, Parser, Clone)]
21#[command(
22 name = "domain-status",
23 about = "Concurrent URL scanner; results in SQLite.",
24 after_help = ACCEPTABLE_USE_HELP,
25 version = "0.0.0", long_version = "0.0.0", subcommand_required = true,
28 arg_required_else_help = true
29)]
30pub enum CliCommand {
31 #[command(name = "scan")]
33 Scan(ScanCommand),
34
35 #[command(name = "export")]
37 Export(ExportCommand),
38
39 #[command(name = "summary")]
41 Summary(SummaryCommand),
42}
43
44#[derive(Debug, Parser, Clone)]
49#[command(after_help = concat!(
50 "Everyday flags: -h. All flags: --help. Docs: docs/CLI.md\n\n",
51 "Scan only hosts you are authorized to scan."
52))]
53pub struct ScanCommand {
54 #[arg(value_parser, help_heading = "Scan")]
56 pub file: PathBuf,
57
58 #[arg(
59 long,
60 value_parser,
61 default_value = "./domain_status.db",
62 env = "DOMAIN_STATUS_DB_PATH",
63 help_heading = "Scan"
64 )]
65 pub db_path: PathBuf,
66
67 #[arg(
68 long,
69 default_value_t = 10,
70 env = "DOMAIN_STATUS_TIMEOUT_SECONDS",
71 help_heading = "Scan"
72 )]
73 pub timeout_seconds: u64,
74
75 #[arg(
76 long,
77 default_value_t = 30,
78 env = "DOMAIN_STATUS_MAX_CONCURRENCY",
79 help_heading = "Scan"
80 )]
81 pub max_concurrency: usize,
82
83 #[arg(
89 long,
90 default_value_t = 15,
91 env = "DOMAIN_STATUS_RATE_LIMIT_RPS",
92 help_heading = "Scan"
93 )]
94 pub rate_limit_rps: u32,
95
96 #[arg(long, conflicts_with = "enable_whois", help_heading = "Enrichments")]
100 pub no_whois: bool,
101
102 #[arg(long, env = "DOMAIN_STATUS_GEOIP", help_heading = "Enrichments")]
104 pub geoip: Option<String>,
105
106 #[arg(
113 long,
114 env = "DOMAIN_STATUS_SCAN_EXTERNAL_SCRIPTS",
115 help_heading = "Enrichments"
116 )]
117 pub scan_external_scripts: bool,
118
119 #[arg(
121 long,
122 value_enum,
123 default_value_t = FailOn::Never,
124 env = "DOMAIN_STATUS_FAIL_ON",
125 help_heading = "CI / logging"
126 )]
127 pub fail_on: FailOn,
128
129 #[command(flatten, next_help_heading = "CI / logging")]
130 pub verbosity: clap_verbosity_flag::Verbosity<clap_verbosity_flag::InfoLevel>,
131
132 #[arg(
134 long,
135 value_enum,
136 default_value_t = LogLevel::Info,
137 env = "DOMAIN_STATUS_LOG_LEVEL",
138 hide_short_help = true,
139 help_heading = "CI / logging"
140 )]
141 pub log_level: LogLevel,
142
143 #[arg(
147 long,
148 value_enum,
149 default_value_t = LogFormat::Plain,
150 env = "DOMAIN_STATUS_LOG_FORMAT",
151 hide_short_help = true,
152 help_heading = "CI / logging"
153 )]
154 pub log_format: LogFormat,
155
156 #[arg(
157 long,
158 default_value = "domain_status.log",
159 env = "DOMAIN_STATUS_LOG_FILE",
160 hide_short_help = true,
161 help_heading = "CI / logging"
162 )]
163 pub log_file: PathBuf,
164
165 #[arg(
167 long,
168 env = "DOMAIN_STATUS_NO_PROGRESS",
169 hide_short_help = true,
170 help_heading = "CI / logging"
171 )]
172 pub no_progress: bool,
173
174 #[arg(
175 long,
176 default_value_t = 10,
177 value_parser = clap::value_parser!(u8).range(0..=100),
178 requires_if("pct>", "fail_on"),
179 env = "DOMAIN_STATUS_FAIL_ON_PCT_THRESHOLD",
180 hide_short_help = true,
181 help_heading = "CI / logging"
182 )]
183 pub fail_on_pct_threshold: u8,
184
185 #[arg(
186 long,
187 value_parser,
188 env = "DOMAIN_STATUS_CONFIG_FILE",
189 hide_short_help = true,
190 help_heading = "Advanced"
191 )]
192 pub config: Option<PathBuf>,
193
194 #[arg(
195 long,
196 default_value = DEFAULT_USER_AGENT,
197 env = "DOMAIN_STATUS_USER_AGENT",
198 hide_short_help = true,
199 help_heading = "Advanced"
200 )]
201 pub user_agent: String,
202
203 #[arg(
204 long,
205 env = "DOMAIN_STATUS_FINGERPRINTS",
206 hide_short_help = true,
207 help_heading = "Advanced"
208 )]
209 pub fingerprints: Option<String>,
210
211 #[arg(
214 long,
215 env = "DOMAIN_STATUS_ALLOW_DEGRADED_FINGERPRINTS",
216 hide_short_help = true,
217 help_heading = "Advanced"
218 )]
219 pub allow_degraded_fingerprints: bool,
220
221 #[arg(
222 long,
223 env = "DOMAIN_STATUS_STATUS_PORT",
224 hide_short_help = true,
225 help_heading = "Advanced"
226 )]
227 pub status_port: Option<u16>,
228
229 #[arg(
234 long,
235 value_parser,
236 env = "DOMAIN_STATUS_CACHE_DIR",
237 hide_short_help = true,
238 help_heading = "Advanced"
239 )]
240 pub cache_dir: Option<PathBuf>,
241
242 #[arg(
247 long,
248 default_value_t = 10,
249 env = "DOMAIN_STATUS_DRAIN_TIMEOUT_SECS",
250 hide_short_help = true,
251 help_heading = "Advanced"
252 )]
253 pub drain_timeout_secs: u64,
254
255 #[arg(
258 long,
259 env = "DOMAIN_STATUS_ENABLE_WHOIS",
260 default_value_t = true,
261 hide = true
262 )]
263 pub enable_whois: bool,
264}
265
266#[derive(Debug, Parser, Clone)]
268pub struct ExportCommand {
269 #[arg(
270 long,
271 value_parser,
272 default_value = "./domain_status.db",
273 env = "DOMAIN_STATUS_DB_PATH"
274 )]
275 pub db_path: PathBuf,
276
277 #[arg(long, value_enum, default_value = "csv")]
278 pub format: ExportFormat,
279
280 #[arg(long)]
281 pub output: Option<String>,
282
283 #[arg(long)]
284 pub run_id: Option<String>,
285
286 #[arg(long)]
288 pub domain: Option<String>,
289
290 #[arg(long)]
291 pub status: Option<u16>,
292
293 #[arg(long)]
294 pub since: Option<i64>,
295
296 #[arg(long, default_value_t = false)]
299 pub include_implied_tech: bool,
300}
301
302#[derive(Debug, Parser, Clone)]
304pub struct SummaryCommand {
305 #[arg(
306 long,
307 value_parser,
308 default_value = "./domain_status.db",
309 env = "DOMAIN_STATUS_DB_PATH"
310 )]
311 pub db_path: PathBuf,
312
313 #[arg(long)]
315 pub run_id: Option<String>,
316
317 #[arg(long, default_value_t = 15)]
319 pub top: usize,
320}
321
322#[derive(Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
326#[non_exhaustive]
327pub enum FailOn {
328 #[default]
330 Never,
331 #[value(name = "any-failure")]
333 AnyFailure,
334 #[value(name = "pct>")]
336 PctGreaterThan,
337}
338
339#[derive(Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
341pub enum LogLevel {
342 Error,
344 Warn,
346 #[default]
348 Info,
349 Debug,
351 Trace,
353}
354
355#[derive(Copy, Clone, Debug, Default, clap::ValueEnum, PartialEq, Eq)]
359#[non_exhaustive]
360pub enum LogFormat {
361 #[default]
363 Plain,
364 Json,
366}
367
368#[derive(Debug, Clone, Default, clap::ValueEnum, PartialEq, Eq)]
370pub enum ExportFormat {
371 #[default]
372 Csv,
373 Jsonl,
374 Parquet,
375}
376
377#[must_use]
381pub fn clap_command(version: &'static str) -> clap::Command {
382 CliCommand::command().version(version).long_version(version)
383}