pub struct SqlmapTask<'a> { /* private fields */ }Expand description
An RAII-tracked scan execution task.
Ensures that the daemon reclaims task memory on drop by sending a delete request. Provides the full scan lifecycle: start → poll → fetch.
Implementations§
Source§impl<'a> SqlmapTask<'a>
impl<'a> SqlmapTask<'a>
Sourcepub fn task_id(&self) -> &str
pub fn task_id(&self) -> &str
Returns the unique task ID assigned by the daemon.
Examples found in repository?
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}Sourcepub async fn start(&self) -> Result<(), SqlmapError>
pub async fn start(&self) -> Result<(), SqlmapError>
Starts the SQL injection scan on this task.
The URL and options must have been configured via SqlmapEngine::create_task.
Examples found in repository?
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}Sourcepub async fn wait_for_completion(
&self,
timeout_secs: u64,
) -> Result<(), SqlmapError>
pub async fn wait_for_completion( &self, timeout_secs: u64, ) -> Result<(), SqlmapError>
Polls the task status until completion or timeout.
Uses the engine’s configured poll interval (default: 1 second).
Examples found in repository?
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}Sourcepub async fn fetch_data(&self) -> Result<DataResponse, SqlmapError>
pub async fn fetch_data(&self) -> Result<DataResponse, SqlmapError>
Fetches the compiled data results from the engine.
Examples found in repository?
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}Sourcepub async fn fetch_log(&self) -> Result<LogResponse, SqlmapError>
pub async fn fetch_log(&self) -> Result<LogResponse, SqlmapError>
Fetches execution log entries for this task.
Useful for monitoring what sqlmap is doing during a scan.
Examples found in repository?
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}Sourcepub async fn stop(&self) -> Result<(), SqlmapError>
pub async fn stop(&self) -> Result<(), SqlmapError>
Gracefully stops a running scan.
The task can potentially be restarted after stopping.
Sourcepub async fn kill(&self) -> Result<(), SqlmapError>
pub async fn kill(&self) -> Result<(), SqlmapError>
Forcefully kills a running scan.
The task is terminated immediately. Data collected up to this point
may still be retrievable via fetch_data.
Sourcepub async fn list_options(&self) -> Result<Value, SqlmapError>
pub async fn list_options(&self) -> Result<Value, SqlmapError>
Retrieves the current option values configured for this task.
Examples found in repository?
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}