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

use std::collections::BTreeSet;

use async_trait::async_trait;

use crate::{
    enums::content::Content,
    interfaces::extractor::SubdomainExtractorInterface,
    types::{
        core::{Result, Subdomain},
        func::InnerExtractFunc,
    },
};

/// JSON content parser wrapper struct
///
/// This object compatible with [`SubdomainExtractorInterface`] and it uses `extract` method
/// to extract subdomain addresses from JSON content. JSON parsing function must be given
/// for this extractor. Please follow up examples to learn usage techniques
pub struct JSONExtractor {
    inner: InnerExtractFunc,
}

impl JSONExtractor {
    /// Creates a new [`JSONExtractor`] instance
    ///
    /// # Examples
    ///
    /// ```
    /// use subscan::extractors::json::JSONExtractor;
    /// use subscan::interfaces::extractor::SubdomainExtractorInterface;
    /// use subscan::enums::content::Content;
    /// use std::collections::BTreeSet;
    /// use serde_json::{Value, json};
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let inner = |content: Value, _domain: &str| {
    ///         let bar = content["foo"].as_str().unwrap().to_string();
    ///
    ///         Ok([bar].into())
    ///     };
    ///
    ///     let json = Content::from(json!({"foo": "bar"}));
    ///     let extractor = JSONExtractor::new(Box::new(inner));
    ///     let expected = BTreeSet::from(["bar".to_string()]);
    ///     let result = extractor.extract(json, "foo.com").await.unwrap();
    ///
    ///     assert_eq!(result, expected);
    /// }
    /// ```
    pub fn new(inner: InnerExtractFunc) -> Self {
        Self { inner }
    }
}

#[async_trait]
impl SubdomainExtractorInterface for JSONExtractor {
    /// Main extraction method to extract subdomains from
    /// given JSON content
    ///
    /// # Examples
    ///
    /// ```
    /// use subscan::extractors::json::JSONExtractor;
    /// use subscan::interfaces::extractor::SubdomainExtractorInterface;
    /// use subscan::types::core::Subdomain;
    /// use subscan::enums::content::Content;
    /// use std::collections::BTreeSet;
    /// use serde_json::{Value, json};
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let content = Content::from(json!({"foo": "bar"}));
    ///
    ///     let inner = |item: Value, _domain: &str| {
    ///         Ok(
    ///             [
    ///                 Subdomain::from(item["foo"].as_str().unwrap())
    ///             ].into()
    ///         )
    ///     };
    ///     let extractor = JSONExtractor::new(Box::new(inner));
    ///
    ///     let result = extractor.extract(content, "foo.com").await.unwrap();
    ///
    ///     assert_eq!(result, [Subdomain::from("bar")].into());
    /// }
    /// ```
    async fn extract(&self, content: Content, domain: &str) -> Result<BTreeSet<Subdomain>> {
        (self.inner)(content.as_json(), domain)
    }
}