Struct SqlmapEngine 

pub struct SqlmapEngine { /* private fields */ }

Manages the sqlmapapi lifecycle and provides access to its REST API.

When the engine is dropped, the daemon subprocess (if locally spawned) is killed automatically via RAII.

Implementations

impl SqlmapEngine

pub async fn new( port: u16, spawn_local: bool, binary_path: Option<&str>, ) -> Result<Self, SqlmapError>

Launches a local sqlmapapi daemon or connects to an existing remote one.

Arguments

• port — TCP port for the daemon. If 0 is passed with spawn_local, the OS assigns an ephemeral port (not yet supported by sqlmapapi).
• spawn_local — If true, spawns a local sqlmapapi subprocess.
• binary_path — Override the sqlmapapi binary location.

Errors

Returns SqlmapError::ProcessError if the daemon fails to spawn, or SqlmapError::ApiError if it doesn’t become responsive within 5 seconds.

Examples found in repository

examples/full_scan.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // ── 1. Check availability ────────────────────────────
    if !SqlmapEngine::is_available() {
        eprintln!("ERROR: sqlmapapi not found in PATH");
        eprintln!("Quick fix:");
        eprintln!("  conda env create -f environment.yml");
        eprintln!("  conda activate sqlmap-env");
        eprintln!("  # OR: ./setup.sh");
        std::process::exit(1);
    }

    // ── 2. Boot the daemon ───────────────────────────────
    println!("Booting sqlmapapi daemon on port 8775...");
    let engine = SqlmapEngine::new(8775, true, None).await?;
    println!("Daemon ready at {}", engine.api_url());

    // ── 3. Configure scan with builder ───────────────────
    let target = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());

    println!("Target: {target}");

    let opts = SqlmapOptions::builder()
        .url(&target)
        .level(3)
        .risk(2)
        .batch(true)
        .threads(4)
        .random_agent(true)
        .build();

    // ── 4. Create and run task ───────────────────────────
    let task = engine.create_task(&opts).await?;
    println!("Task created: {}", task.task_id());

    task.start().await?;
    println!("Scan started, polling for completion...");

    // ── 5. Monitor execution ─────────────────────────────
    task.wait_for_completion(300).await?;
    println!("Scan complete!");

    // ── 6. Fetch and display logs ────────────────────────
    match task.fetch_log().await {
        Ok(log_resp) => {
            if let Some(logs) = &log_resp.log {
                println!("\n=== Scan Log ({} entries) ===", logs.len());
                for entry in logs.iter().rev().take(10) {
                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
                }
                if logs.len() > 10 {
                    println!("  ... and {} more entries", logs.len() - 10);
                }
            }
        }
        Err(err) => eprintln!("Could not fetch log: {err}"),
    }

    // ── 7. Fetch results ─────────────────────────────────
    let data = task.fetch_data().await?;
    let findings = data.findings();

    println!("\n=== Results ===");
    println!("  Findings: {}", findings.len());

    if findings.is_empty() {
        println!("  No SQL injection vulnerabilities detected.");
    } else {
        // ── 8. Multi-format output ───────────────────────
        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));

        println!("=== JSON ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));

        println!("=== CSV ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));

        println!("=== Markdown ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
    }

    // ── 9. Inspect configured options ────────────────────
    match task.list_options().await {
        Ok(options) => {
            println!("\n=== Active Options ===");
            println!("{}", serde_json::to_string_pretty(&options)?);
        }
        Err(err) => eprintln!("Could not fetch options: {err}"),
    }

    // Task is auto-deleted from daemon on drop.
    // Engine daemon is auto-killed on drop.
    println!("\nDone. Task and daemon will be cleaned up automatically.");

    Ok(())
}

pub async fn with_config( port: u16, spawn_local: bool, binary_path: Option<&str>, request_timeout: Duration, poll_interval: Duration, ) -> Result<Self, SqlmapError>

Launches a daemon with custom HTTP timeout and polling interval.

Arguments

• request_timeout — HTTP request timeout for API calls.
• poll_interval — Interval between status polls in wait_for_completion.

pub async fn create_task( &self, options: &SqlmapOptions, ) -> Result<SqlmapTask<'_>, SqlmapError>

Creates and configures a new scanning task, returning an RAII wrapper.

The task is automatically deleted from the daemon when dropped.

Examples found in repository

examples/full_scan.rs (line 46)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // ── 1. Check availability ────────────────────────────
    if !SqlmapEngine::is_available() {
        eprintln!("ERROR: sqlmapapi not found in PATH");
        eprintln!("Quick fix:");
        eprintln!("  conda env create -f environment.yml");
        eprintln!("  conda activate sqlmap-env");
        eprintln!("  # OR: ./setup.sh");
        std::process::exit(1);
    }

    // ── 2. Boot the daemon ───────────────────────────────
    println!("Booting sqlmapapi daemon on port 8775...");
    let engine = SqlmapEngine::new(8775, true, None).await?;
    println!("Daemon ready at {}", engine.api_url());

    // ── 3. Configure scan with builder ───────────────────
    let target = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());

    println!("Target: {target}");

    let opts = SqlmapOptions::builder()
        .url(&target)
        .level(3)
        .risk(2)
        .batch(true)
        .threads(4)
        .random_agent(true)
        .build();

    // ── 4. Create and run task ───────────────────────────
    let task = engine.create_task(&opts).await?;
    println!("Task created: {}", task.task_id());

    task.start().await?;
    println!("Scan started, polling for completion...");

    // ── 5. Monitor execution ─────────────────────────────
    task.wait_for_completion(300).await?;
    println!("Scan complete!");

    // ── 6. Fetch and display logs ────────────────────────
    match task.fetch_log().await {
        Ok(log_resp) => {
            if let Some(logs) = &log_resp.log {
                println!("\n=== Scan Log ({} entries) ===", logs.len());
                for entry in logs.iter().rev().take(10) {
                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
                }
                if logs.len() > 10 {
                    println!("  ... and {} more entries", logs.len() - 10);
                }
            }
        }
        Err(err) => eprintln!("Could not fetch log: {err}"),
    }

    // ── 7. Fetch results ─────────────────────────────────
    let data = task.fetch_data().await?;
    let findings = data.findings();

    println!("\n=== Results ===");
    println!("  Findings: {}", findings.len());

    if findings.is_empty() {
        println!("  No SQL injection vulnerabilities detected.");
    } else {
        // ── 8. Multi-format output ───────────────────────
        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));

        println!("=== JSON ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));

        println!("=== CSV ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));

        println!("=== Markdown ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
    }

    // ── 9. Inspect configured options ────────────────────
    match task.list_options().await {
        Ok(options) => {
            println!("\n=== Active Options ===");
            println!("{}", serde_json::to_string_pretty(&options)?);
        }
        Err(err) => eprintln!("Could not fetch options: {err}"),
    }

    // Task is auto-deleted from daemon on drop.
    // Engine daemon is auto-killed on drop.
    println!("\nDone. Task and daemon will be cleaned up automatically.");

    Ok(())
}

pub fn is_available() -> bool

Check if sqlmapapi is available on this system.

Tests that the sqlmapapi binary exists and is executable. Does NOT fall back to python3 -c "import sqlmap" since that doesn’t guarantee the REST API server is available.

Examples found in repository

examples/full_scan.rs (line 15)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // ── 1. Check availability ────────────────────────────
    if !SqlmapEngine::is_available() {
        eprintln!("ERROR: sqlmapapi not found in PATH");
        eprintln!("Quick fix:");
        eprintln!("  conda env create -f environment.yml");
        eprintln!("  conda activate sqlmap-env");
        eprintln!("  # OR: ./setup.sh");
        std::process::exit(1);
    }

    // ── 2. Boot the daemon ───────────────────────────────
    println!("Booting sqlmapapi daemon on port 8775...");
    let engine = SqlmapEngine::new(8775, true, None).await?;
    println!("Daemon ready at {}", engine.api_url());

    // ── 3. Configure scan with builder ───────────────────
    let target = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());

    println!("Target: {target}");

    let opts = SqlmapOptions::builder()
        .url(&target)
        .level(3)
        .risk(2)
        .batch(true)
        .threads(4)
        .random_agent(true)
        .build();

    // ── 4. Create and run task ───────────────────────────
    let task = engine.create_task(&opts).await?;
    println!("Task created: {}", task.task_id());

    task.start().await?;
    println!("Scan started, polling for completion...");

    // ── 5. Monitor execution ─────────────────────────────
    task.wait_for_completion(300).await?;
    println!("Scan complete!");

    // ── 6. Fetch and display logs ────────────────────────
    match task.fetch_log().await {
        Ok(log_resp) => {
            if let Some(logs) = &log_resp.log {
                println!("\n=== Scan Log ({} entries) ===", logs.len());
                for entry in logs.iter().rev().take(10) {
                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
                }
                if logs.len() > 10 {
                    println!("  ... and {} more entries", logs.len() - 10);
                }
            }
        }
        Err(err) => eprintln!("Could not fetch log: {err}"),
    }

    // ── 7. Fetch results ─────────────────────────────────
    let data = task.fetch_data().await?;
    let findings = data.findings();

    println!("\n=== Results ===");
    println!("  Findings: {}", findings.len());

    if findings.is_empty() {
        println!("  No SQL injection vulnerabilities detected.");
    } else {
        // ── 8. Multi-format output ───────────────────────
        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));

        println!("=== JSON ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));

        println!("=== CSV ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));

        println!("=== Markdown ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
    }

    // ── 9. Inspect configured options ────────────────────
    match task.list_options().await {
        Ok(options) => {
            println!("\n=== Active Options ===");
            println!("{}", serde_json::to_string_pretty(&options)?);
        }
        Err(err) => eprintln!("Could not fetch options: {err}"),
    }

    // Task is auto-deleted from daemon on drop.
    // Engine daemon is auto-killed on drop.
    println!("\nDone. Task and daemon will be cleaned up automatically.");

    Ok(())
}

pub fn is_available_at(binary_path: &str) -> bool

Check if sqlmapapi is available, trying the provided binary path first.

pub fn api_url(&self) -> &str

Returns the base API URL for this engine.

Examples found in repository

examples/full_scan.rs (line 27)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // ── 1. Check availability ────────────────────────────
    if !SqlmapEngine::is_available() {
        eprintln!("ERROR: sqlmapapi not found in PATH");
        eprintln!("Quick fix:");
        eprintln!("  conda env create -f environment.yml");
        eprintln!("  conda activate sqlmap-env");
        eprintln!("  # OR: ./setup.sh");
        std::process::exit(1);
    }

    // ── 2. Boot the daemon ───────────────────────────────
    println!("Booting sqlmapapi daemon on port 8775...");
    let engine = SqlmapEngine::new(8775, true, None).await?;
    println!("Daemon ready at {}", engine.api_url());

    // ── 3. Configure scan with builder ───────────────────
    let target = std::env::args()
        .nth(1)
        .unwrap_or_else(|| "http://testphp.vulnweb.com/listproducts.php?cat=1".to_string());

    println!("Target: {target}");

    let opts = SqlmapOptions::builder()
        .url(&target)
        .level(3)
        .risk(2)
        .batch(true)
        .threads(4)
        .random_agent(true)
        .build();

    // ── 4. Create and run task ───────────────────────────
    let task = engine.create_task(&opts).await?;
    println!("Task created: {}", task.task_id());

    task.start().await?;
    println!("Scan started, polling for completion...");

    // ── 5. Monitor execution ─────────────────────────────
    task.wait_for_completion(300).await?;
    println!("Scan complete!");

    // ── 6. Fetch and display logs ────────────────────────
    match task.fetch_log().await {
        Ok(log_resp) => {
            if let Some(logs) = &log_resp.log {
                println!("\n=== Scan Log ({} entries) ===", logs.len());
                for entry in logs.iter().rev().take(10) {
                    println!("  [{}] {}: {}", entry.time, entry.level, entry.message);
                }
                if logs.len() > 10 {
                    println!("  ... and {} more entries", logs.len() - 10);
                }
            }
        }
        Err(err) => eprintln!("Could not fetch log: {err}"),
    }

    // ── 7. Fetch results ─────────────────────────────────
    let data = task.fetch_data().await?;
    let findings = data.findings();

    println!("\n=== Results ===");
    println!("  Findings: {}", findings.len());

    if findings.is_empty() {
        println!("  No SQL injection vulnerabilities detected.");
    } else {
        // ── 8. Multi-format output ───────────────────────
        println!("\n{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Plain));

        println!("=== JSON ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::JsonPretty));

        println!("=== CSV ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Csv));

        println!("=== Markdown ===");
        println!("{}", sqlmap_rs::types::format_findings(&findings, OutputFormat::Markdown));
    }

    // ── 9. Inspect configured options ────────────────────
    match task.list_options().await {
        Ok(options) => {
            println!("\n=== Active Options ===");
            println!("{}", serde_json::to_string_pretty(&options)?);
        }
        Err(err) => eprintln!("Could not fetch options: {err}"),
    }

    // Task is auto-deleted from daemon on drop.
    // Engine daemon is auto-killed on drop.
    println!("\nDone. Task and daemon will be cleaned up automatically.");

    Ok(())
}

Trait Implementations

impl Drop for SqlmapEngine

fn drop(&mut self)

Executes the destructor for this type.