Skip to main content

SqlmapOptionsBuilder

sqlmap_rs::types

Struct SqlmapOptionsBuilder 

Source 
pub struct SqlmapOptionsBuilder { /* private fields */ }
Expand description

Builder for constructing SqlmapOptions with a fluent API.

Every field has a corresponding setter method. Call .build() to finalize.

Implementations§

Source§

impl SqlmapOptionsBuilder

Source

pub fn url(self, value: impl Into<String>) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 37)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn test_parameter(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn dbms(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn tech(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn level(self, value: i32) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 38)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn risk(self, value: i32) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 39)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn string(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn not_string(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn regexp(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn code(self, value: i32) -> Self

Sets the $name option.

Source

pub fn text_only(self, value: bool) -> Self

Sets the $name option.

Source

pub fn titles(self, value: bool) -> Self

Sets the $name option.

Source

pub fn cookie(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn headers(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn method(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn data(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn random_agent(self, value: bool) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 42)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn proxy(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn prefix(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn suffix(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn tamper(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn skip(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn skip_static(self, value: bool) -> Self

Sets the $name option.

Source

pub fn threads(self, value: i32) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 41)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn verbose(self, value: i32) -> Self

Sets the $name option.

Source

pub fn batch(self, value: bool) -> Self

Sets the $name option.

Examples found in repository?
examples/full_scan.rs (line 40)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}
Source

pub fn retries(self, value: i32) -> Self

Sets the $name option.

Source

pub fn get_dbs(self, value: bool) -> Self

Sets the $name option.

Source

pub fn get_tables(self, value: bool) -> Self

Sets the $name option.

Source

pub fn get_columns(self, value: bool) -> Self

Sets the $name option.

Source

pub fn get_users(self, value: bool) -> Self

Sets the $name option.

Source

pub fn get_passwords(self, value: bool) -> Self

Sets the $name option.

Source

pub fn get_privileges(self, value: bool) -> Self

Sets the $name option.

Source

pub fn is_dba(self, value: bool) -> Self

Sets the $name option.

Source

pub fn current_user(self, value: bool) -> Self

Sets the $name option.

Source

pub fn current_db(self, value: bool) -> Self

Sets the $name option.

Source

pub fn dump_all(self, value: bool) -> Self

Sets the $name option.

Source

pub fn dump_table(self, value: bool) -> Self

Sets the $name option.

Source

pub fn search(self, value: bool) -> Self

Sets the $name option.

Source

pub fn os_shell(self, value: bool) -> Self

Sets the $name option.

Source

pub fn sql_shell(self, value: bool) -> Self

Sets the $name option.

Source

pub fn file_read(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn file_write(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn file_dest(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn tor(self, value: bool) -> Self

Sets the $name option.

Source

pub fn tor_port(self, value: i32) -> Self

Sets the $name option.

Source

pub fn tor_type(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn crawl_depth(self, value: i32) -> Self

Sets the $name option.

Source

pub fn scope(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn forms(self, value: bool) -> Self

Sets the $name option.

Source

pub fn second_url(self, value: impl Into<String>) -> Self

Sets the $name option.

Source

pub fn build(self) -> SqlmapOptions

Finalize and return the configured SqlmapOptions.

Examples found in repository?
examples/full_scan.rs (line 43)
13async fn main() -> Result<(), Box<dyn std::error::Error>> {
14    // ── 1. Check availability ────────────────────────────
15    if !SqlmapEngine::is_available() {
16        eprintln!("ERROR: sqlmapapi not found in PATH");
17        eprintln!("Quick fix:");
18        eprintln!("  conda env create -f environment.yml");
19        eprintln!("  conda activate sqlmap-env");
20        eprintln!("  # OR: ./setup.sh");
21        std::process::exit(1);
22    }
23
24    // ── 2. Boot the daemon ───────────────────────────────
25    println!("Booting sqlmapapi daemon on port 8775...");
26    let engine = SqlmapEngine::new(8775, true, None).await?;
27    println!("Daemon ready at {}", engine.api_url());
28
29    // ── 3. Configure scan with builder ───────────────────
30    let target = std::env::args()
31        .nth(1)
32        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());
33
34    println!("Target: {target}");
35
36    let opts = SqlmapOptions::builder()
37        .url(&target)
38        .level(3)
39        .risk(2)
40        .batch(true)
41        .threads(4)
42        .random_agent(true)
43        .build();
44
45    // ── 4. Create and run task ───────────────────────────
46    let task = engine.create_task(&opts).await?;
47    println!("Task created: {}", task.task_id());
48
49    task.start().await?;
50    println!("Scan started, polling for completion...");
51
52    // ── 5. Monitor execution ─────────────────────────────
53    task.wait_for_completion(300).await?;
54    println!("Scan complete!");
55
56    // ── 6. Fetch and display logs ────────────────────────
57    match task.fetch_log().await {
58        Ok(log_resp) => {
59            if let Some(logs) = &log_resp.log {
60                println!("\n=== Scan Log ({} entries) ===", logs.len());
61                for entry in logs.iter().rev().take(10) {
62                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
63                }
64                if logs.len() > 10 {
65                    println!("  ... and {} more entries", logs.len() - 10);
66                }
67            }
68        }
69        Err(err) => eprintln!("Could not fetch log: {err}"),
70    }
71
72    // ── 7. Fetch results ─────────────────────────────────
73    let data = task.fetch_data().await?;
74    let findings = data.findings();
75
76    println!("\n=== Results ===");
77    println!("  Findings: {}", findings.len());
78
79    if findings.is_empty() {
80        println!("  No SQL injection vulnerabilities detected.");
81    } else {
82        // ── 8. Multi-format output ───────────────────────
83        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));
84
85        println!("=== JSON ===");
86        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));
87
88        println!("=== CSV ===");
89        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));
90
91        println!("=== Markdown ===");
92        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
93    }
94
95    // ── 9. Inspect configured options ────────────────────
96    match task.list_options().await {
97        Ok(options) => {
98            println!("\n=== Active Options ===");
99            println!("{}", serde_json::to_string_pretty(&options)?);
100        }
101        Err(err) => eprintln!("Could not fetch options: {err}"),
102    }
103
104    // Task is auto-deleted from daemon on drop.
105    // Engine daemon is auto-killed on drop.
106    println!("\nDone. Task and daemon will be cleaned up automatically.");
107
108    Ok(())
109}

Trait Implementations§

Source§

impl Clone for SqlmapOptionsBuilder

Source§

fn clone(&self) -> SqlmapOptionsBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SqlmapOptionsBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SqlmapOptionsBuilder

Source§

fn default() -> SqlmapOptionsBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more