subscan 1.3.0

A subdomain enumeration tool leveraging diverse techniques, designed for advanced pentesting operations
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

use std::path::PathBuf;

use clap::Args;

use crate::{
    constants::{
        ASTERISK, DEFAULT_HTTP_TIMEOUT, DEFAULT_MODULE_CONCURRENCY, DEFAULT_RESOLVER_CONCURRENCY,
        DEFAULT_RESOLVER_TIMEOUT, DEFAULT_USER_AGENT,
    },
    enums::{cache::CacheFilter, output::OutputFormat},
};

/// Scan command arguments
#[derive(Args, Clone, Debug, Default)]
pub struct ScanCommandArgs {
    /// Target domain address to be enumerated
    #[arg(short, long)]
    pub domain: String,
    /// Set User-Agent header value for HTTP requests
    #[arg(short, long, default_value = DEFAULT_USER_AGENT)]
    pub user_agent: String,
    /// HTTP timeout value as a seconds
    #[arg(short = 't', long, default_value_t = DEFAULT_HTTP_TIMEOUT.as_secs())]
    pub http_timeout: u64,
    /// Set HTTP proxy
    #[arg(short, long, default_value = None)]
    pub proxy: Option<String>,
    /// Set output format
    #[arg(value_enum, short, long, default_value_t = OutputFormat::JSON)]
    pub output: OutputFormat,
    /// If sets, output will be logged on stdout
    #[arg(long, default_value_t = false)]
    pub print: bool,
    /// Module runner concurrency level, thread counts of runner instances
    #[arg(short = 'c', long, default_value_t = DEFAULT_MODULE_CONCURRENCY)]
    pub module_concurrency: u64,
    /// IP resolver timeout value as a milliseconds
    #[arg(long, default_value_t = DEFAULT_RESOLVER_TIMEOUT.as_millis() as u64)]
    pub resolver_timeout: u64,
    /// IP resolver concurrency level, thread counts of resolver instances
    #[arg(long, default_value_t = DEFAULT_RESOLVER_CONCURRENCY)]
    pub resolver_concurrency: u64,
    /// A text file containing list of resolvers to use for enumeration.
    /// See `resolverlist.template`
    #[arg(long, default_value = None)]
    pub resolver_list: Option<PathBuf>,
    /// Disable IP address resolve process
    #[arg(long = "disable-ip-resolve", default_value_t = false)]
    pub resolver_disabled: bool,
    /// Comma separated list of modules to run
    #[arg(short, long, default_value = ASTERISK)]
    pub modules: String,
    /// Comma separated list of modules to skip
    #[arg(short, long, default_value = "")]
    pub skips: String,
}

impl ScanCommandArgs {
    /// Returns [`CacheFilter`] according to [`modules`](crate::cli::commands::scan::ScanCommandArgs::modules)
    /// and [`skips`](crate::cli::commands::scan::ScanCommandArgs::skips) values
    ///
    /// # Examples
    ///
    /// ```
    /// use subscan::cli::commands::scan::ScanCommandArgs;
    /// use subscan::enums::cache::CacheFilter;
    ///
    /// let args = ScanCommandArgs {
    ///     modules: String::from("*"),
    ///     skips: String::new(),
    ///     ..Default::default()
    /// };
    ///
    /// assert_eq!(args.filter(), CacheFilter::NoFilter);
    /// ```
    pub fn filter(&self) -> CacheFilter {
        let filter_empty = |module: &str| {
            if !module.trim().is_empty() {
                Some(module.trim().to_lowercase())
            } else {
                None
            }
        };

        let split = self.modules.trim().split(",");
        let modules = split.filter_map(filter_empty).collect();

        let split = self.skips.trim().split(",");
        let skips = split.filter_map(filter_empty).collect();

        if self.modules == ASTERISK && self.skips.is_empty() {
            CacheFilter::NoFilter
        } else if self.modules == ASTERISK && !self.skips.is_empty() {
            CacheFilter::FilterByName((vec![], skips).into())
        } else {
            CacheFilter::FilterByName((modules, skips).into())
        }
    }
}