recon-cli 0.82.0

Versatile network reconnaissance CLI: HTTP/TLS/DNS, multi-protocol probes, and a Rhai script engine
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
//! `sqlite(spec [, mode])` script binding.
//!
//! Returns a `SqliteHandle` with four methods for querying and executing
//! SQL: `query`, `query_one`, `query_value`, `exec`. `spec` is either a
//! filesystem path (contains `/`, `\`, or ends with `.db`), an alias for
//! an internal recon database (`cookiejar`, `cookiejar:NAME`), or
//! `":memory:"` for an ephemeral in-memory database.
//!
//! Default mode is `"rw"` for both paths and aliases; override with
//! `"ro"` (read-only), `"rwc"` (read-write + create on missing).
//!
//! Parameters bind positionally via `?` placeholders; each is a Rhai
//! value mapped to the closest SQLite affinity (() → NULL, bool → INT,
//! i64 → INT, f64 → REAL, String → TEXT, Blob → BLOB). Rows come back
//! as Rhai maps keyed by column name.

use crate::script::convert::err;
use rhai::{Array, Blob, Dynamic, Engine, EvalAltResult, Map};
use rusqlite::{types::ValueRef, Connection, OpenFlags, ToSql};
use std::path::{Path, PathBuf};
use std::sync::{Arc, Mutex};

#[derive(Clone)]
pub struct SqliteHandle {
    conn: Arc<Mutex<Connection>>,
    path: Arc<PathBuf>,
}

pub fn register(engine: &mut Engine) {
    engine.register_type_with_name::<SqliteHandle>("SqliteHandle");

    engine.register_fn("sqlite", |spec: &str| -> Result<SqliteHandle, Box<EvalAltResult>> {
        open_spec(spec, None)
    });
    engine.register_fn(
        "sqlite",
        |spec: &str, mode: &str| -> Result<SqliteHandle, Box<EvalAltResult>> {
            open_spec(spec, Some(mode))
        },
    );

    // query(sql) / query(sql, params)
    engine.register_fn(
        "query",
        |h: &mut SqliteHandle, sql: &str| -> Result<Array, Box<EvalAltResult>> {
            run_query(h, sql, Vec::new())
        },
    );
    engine.register_fn(
        "query",
        |h: &mut SqliteHandle, sql: &str, params: Array| -> Result<Array, Box<EvalAltResult>> {
            let bound = bind_params(params)?;
            run_query(h, sql, bound)
        },
    );

    // query_one(sql) / query_one(sql, params)
    engine.register_fn(
        "query_one",
        |h: &mut SqliteHandle, sql: &str| -> Result<Dynamic, Box<EvalAltResult>> {
            run_query_one(h, sql, Vec::new())
        },
    );
    engine.register_fn(
        "query_one",
        |h: &mut SqliteHandle, sql: &str, params: Array| -> Result<Dynamic, Box<EvalAltResult>> {
            let bound = bind_params(params)?;
            run_query_one(h, sql, bound)
        },
    );

    // query_value(sql) / query_value(sql, params)
    engine.register_fn(
        "query_value",
        |h: &mut SqliteHandle, sql: &str| -> Result<Dynamic, Box<EvalAltResult>> {
            run_query_value(h, sql, Vec::new())
        },
    );
    engine.register_fn(
        "query_value",
        |h: &mut SqliteHandle, sql: &str, params: Array| -> Result<Dynamic, Box<EvalAltResult>> {
            let bound = bind_params(params)?;
            run_query_value(h, sql, bound)
        },
    );

    // exec(sql) / exec(sql, params) → i64 rows affected
    engine.register_fn(
        "exec",
        |h: &mut SqliteHandle, sql: &str| -> Result<i64, Box<EvalAltResult>> {
            run_exec(h, sql, Vec::new())
        },
    );
    engine.register_fn(
        "exec",
        |h: &mut SqliteHandle, sql: &str, params: Array| -> Result<i64, Box<EvalAltResult>> {
            let bound = bind_params(params)?;
            run_exec(h, sql, bound)
        },
    );
}

// ── Spec resolution ───────────────────────────────────────────────────────

enum Resolved {
    Memory,
    File(PathBuf),
}

fn resolve_spec(spec: &str) -> Result<Resolved, Box<EvalAltResult>> {
    if spec == ":memory:" {
        return Ok(Resolved::Memory);
    }
    if spec.contains('/') || spec.contains('\\') || spec.ends_with(".db") {
        return Ok(Resolved::File(PathBuf::from(spec)));
    }
    // Alias form: `name` or `name:arg`
    let (name, arg) = match spec.split_once(':') {
        Some((n, a)) => (n, Some(a)),
        None => (spec, None),
    };
    match name {
        "cookiejar" => {
            let jar = arg.unwrap_or("default");
            Ok(Resolved::File(cookiejar_path(jar)))
        }
        other => Err(err(format!(
            "sqlite: unknown spec '{other}' — expected a path or known alias (cookiejar[:NAME], :memory:)"
        ))),
    }
}

fn cookiejar_path(name: &str) -> PathBuf {
    let home = std::env::var("HOME").unwrap_or_else(|_| ".".to_string());
    PathBuf::from(home).join(".recon").join("jars").join(format!("{name}.db"))
}

fn open_spec(spec: &str, mode: Option<&str>) -> Result<SqliteHandle, Box<EvalAltResult>> {
    let resolved = resolve_spec(spec)?;
    let mode_str = mode.unwrap_or("rw");
    let flags = parse_mode(mode_str)?;

    let (conn, path) = match resolved {
        Resolved::Memory => {
            let c = Connection::open_in_memory()
                .map_err(|e| err(format!("sqlite: open_in_memory: {e}")))?;
            (c, PathBuf::from(":memory:"))
        }
        Resolved::File(p) => {
            if let Some(parent) = p.parent() {
                if flags.contains(OpenFlags::SQLITE_OPEN_CREATE) && !parent.as_os_str().is_empty() {
                    let _ = std::fs::create_dir_all(parent);
                }
            }
            let c = Connection::open_with_flags(&p, flags)
                .map_err(|e| err(format!("sqlite: open '{}': {e}", p.display())))?;
            (c, p)
        }
    };

    Ok(SqliteHandle {
        conn: Arc::new(Mutex::new(conn)),
        path: Arc::new(path),
    })
}

fn parse_mode(mode: &str) -> Result<OpenFlags, Box<EvalAltResult>> {
    match mode {
        "ro" => Ok(OpenFlags::SQLITE_OPEN_READ_ONLY | OpenFlags::SQLITE_OPEN_NO_MUTEX),
        "rw" => Ok(OpenFlags::SQLITE_OPEN_READ_WRITE | OpenFlags::SQLITE_OPEN_NO_MUTEX),
        "rwc" => Ok(OpenFlags::SQLITE_OPEN_READ_WRITE
            | OpenFlags::SQLITE_OPEN_CREATE
            | OpenFlags::SQLITE_OPEN_NO_MUTEX),
        other => Err(err(format!(
            "sqlite: invalid mode '{other}' (expected \"ro\", \"rw\", or \"rwc\")"
        ))),
    }
}

// ── Parameter binding ─────────────────────────────────────────────────────

enum BoundValue {
    Null,
    Integer(i64),
    Real(f64),
    Text(String),
    Blob(Vec<u8>),
}

impl ToSql for BoundValue {
    fn to_sql(&self) -> rusqlite::Result<rusqlite::types::ToSqlOutput<'_>> {
        use rusqlite::types::{ToSqlOutput, Value, ValueRef as VR};
        Ok(match self {
            BoundValue::Null => ToSqlOutput::Owned(Value::Null),
            BoundValue::Integer(i) => ToSqlOutput::Owned(Value::Integer(*i)),
            BoundValue::Real(f) => ToSqlOutput::Owned(Value::Real(*f)),
            BoundValue::Text(s) => ToSqlOutput::Borrowed(VR::Text(s.as_bytes())),
            BoundValue::Blob(b) => ToSqlOutput::Borrowed(VR::Blob(b)),
        })
    }
}

fn bind_params(params: Array) -> Result<Vec<BoundValue>, Box<EvalAltResult>> {
    let mut out = Vec::with_capacity(params.len());
    for (i, v) in params.into_iter().enumerate() {
        out.push(dynamic_to_bound(v, i)?);
    }
    Ok(out)
}

fn dynamic_to_bound(v: Dynamic, index: usize) -> Result<BoundValue, Box<EvalAltResult>> {
    if v.is_unit() {
        return Ok(BoundValue::Null);
    }
    if let Ok(b) = v.as_bool() {
        return Ok(BoundValue::Integer(if b { 1 } else { 0 }));
    }
    if let Ok(i) = v.as_int() {
        return Ok(BoundValue::Integer(i));
    }
    if let Ok(f) = v.as_float() {
        return Ok(BoundValue::Real(f));
    }
    if v.is_string() {
        return Ok(BoundValue::Text(v.into_string().unwrap_or_default()));
    }
    if v.is_blob() {
        return Ok(BoundValue::Blob(
            v.into_blob()
                .map_err(|_| err(format!("sqlite: param {index}: blob cast failed")))?,
        ));
    }
    Err(err(format!(
        "sqlite: unsupported param type at index {index}"
    )))
}

// ── Execution helpers ─────────────────────────────────────────────────────

fn map_err_path(path: &Path, e: rusqlite::Error) -> Box<EvalAltResult> {
    err(format!("sqlite: {}{e}", path.display()))
}

fn run_query(
    h: &SqliteHandle,
    sql: &str,
    params: Vec<BoundValue>,
) -> Result<Array, Box<EvalAltResult>> {
    let conn = h.conn.lock().map_err(|_| err("sqlite: mutex poisoned"))?;
    let mut stmt = conn
        .prepare(sql)
        .map_err(|e| map_err_path(&h.path, e))?;
    let col_names: Vec<String> = stmt.column_names().iter().map(|s| s.to_string()).collect();
    let param_refs: Vec<&dyn ToSql> = params.iter().map(|p| p as &dyn ToSql).collect();
    let mut rows = stmt
        .query(rusqlite::params_from_iter(param_refs))
        .map_err(|e| map_err_path(&h.path, e))?;
    let mut out = Array::new();
    while let Some(row) = rows.next().map_err(|e| map_err_path(&h.path, e))? {
        out.push(row_to_map(row, &col_names)?.into());
    }
    Ok(out)
}

fn run_query_one(
    h: &SqliteHandle,
    sql: &str,
    params: Vec<BoundValue>,
) -> Result<Dynamic, Box<EvalAltResult>> {
    let conn = h.conn.lock().map_err(|_| err("sqlite: mutex poisoned"))?;
    let mut stmt = conn
        .prepare(sql)
        .map_err(|e| map_err_path(&h.path, e))?;
    let col_names: Vec<String> = stmt.column_names().iter().map(|s| s.to_string()).collect();
    let param_refs: Vec<&dyn ToSql> = params.iter().map(|p| p as &dyn ToSql).collect();
    let mut rows = stmt
        .query(rusqlite::params_from_iter(param_refs))
        .map_err(|e| map_err_path(&h.path, e))?;
    match rows.next().map_err(|e| map_err_path(&h.path, e))? {
        Some(row) => Ok(row_to_map(row, &col_names)?.into()),
        None => Ok(Dynamic::UNIT),
    }
}

fn run_query_value(
    h: &SqliteHandle,
    sql: &str,
    params: Vec<BoundValue>,
) -> Result<Dynamic, Box<EvalAltResult>> {
    let conn = h.conn.lock().map_err(|_| err("sqlite: mutex poisoned"))?;
    let mut stmt = conn
        .prepare(sql)
        .map_err(|e| map_err_path(&h.path, e))?;
    let param_refs: Vec<&dyn ToSql> = params.iter().map(|p| p as &dyn ToSql).collect();
    let mut rows = stmt
        .query(rusqlite::params_from_iter(param_refs))
        .map_err(|e| map_err_path(&h.path, e))?;
    match rows.next().map_err(|e| map_err_path(&h.path, e))? {
        Some(row) => value_ref_to_dynamic(
            row.get_ref(0).map_err(|e| map_err_path(&h.path, e))?,
        ),
        None => Ok(Dynamic::UNIT),
    }
}

fn run_exec(
    h: &SqliteHandle,
    sql: &str,
    params: Vec<BoundValue>,
) -> Result<i64, Box<EvalAltResult>> {
    let conn = h.conn.lock().map_err(|_| err("sqlite: mutex poisoned"))?;
    let param_refs: Vec<&dyn ToSql> = params.iter().map(|p| p as &dyn ToSql).collect();
    let n = conn
        .execute(sql, rusqlite::params_from_iter(param_refs))
        .map_err(|e| map_err_path(&h.path, e))?;
    Ok(n as i64)
}

// ── Row conversion ────────────────────────────────────────────────────────

fn row_to_map(
    row: &rusqlite::Row<'_>,
    col_names: &[String],
) -> Result<Map, Box<EvalAltResult>> {
    let mut m = Map::new();
    for (i, name) in col_names.iter().enumerate() {
        let vr = row
            .get_ref(i)
            .map_err(|e| err(format!("sqlite: read column {i}: {e}")))?;
        m.insert(name.as_str().into(), value_ref_to_dynamic(vr)?);
    }
    Ok(m)
}

fn value_ref_to_dynamic(v: ValueRef<'_>) -> Result<Dynamic, Box<EvalAltResult>> {
    Ok(match v {
        ValueRef::Null => Dynamic::UNIT,
        ValueRef::Integer(i) => Dynamic::from(i),
        ValueRef::Real(f) => Dynamic::from(f),
        ValueRef::Text(bytes) => {
            Dynamic::from(String::from_utf8_lossy(bytes).into_owned())
        }
        ValueRef::Blob(bytes) => {
            let b: Blob = bytes.to_vec();
            Dynamic::from(b)
        }
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    fn engine() -> Engine {
        let mut e = Engine::new();
        register(&mut e);
        // Helpers (for assert)
        super::super::helpers::register(&mut e);
        e
    }

    #[test]
    fn memory_db_crud_roundtrip() {
        let e = engine();
        let script = r#"
let db = sqlite(":memory:");
db.exec("CREATE TABLE t (id INTEGER, name TEXT)");
db.exec("INSERT INTO t VALUES (?, ?)", [1, "alice"]);
db.exec("INSERT INTO t VALUES (?, ?)", [2, "bob"]);
let all = db.query("SELECT * FROM t ORDER BY id");
assert(all.len() == 2, "len");
assert(all[0].name == "alice", "alice");
assert(all[1].name == "bob", "bob");
return 0;
"#;
        let code: i64 = e.eval(script).expect("eval");
        assert_eq!(code, 0);
    }

    #[test]
    fn query_one_returns_unit_for_empty() {
        let e = engine();
        let script = r#"
let db = sqlite(":memory:");
db.exec("CREATE TABLE t (id INTEGER)");
let r = db.query_one("SELECT id FROM t WHERE id = ?", [99]);
r == ()
"#;
        let eq: bool = e.eval(script).expect("eval");
        assert!(eq);
    }

    #[test]
    fn query_value_returns_scalar() {
        let e = engine();
        let script = r#"
let db = sqlite(":memory:");
db.exec("CREATE TABLE t (n INTEGER)");
db.exec("INSERT INTO t VALUES (1)");
db.exec("INSERT INTO t VALUES (2)");
db.exec("INSERT INTO t VALUES (3)");
db.query_value("SELECT COUNT(*) FROM t", [])
"#;
        let n: i64 = e.eval(script).expect("eval");
        assert_eq!(n, 3);
    }

    #[test]
    fn exec_returns_rows_affected() {
        let e = engine();
        let script = r#"
let db = sqlite(":memory:");
db.exec("CREATE TABLE t (id INTEGER)");
db.exec("INSERT INTO t VALUES (1)");
db.exec("INSERT INTO t VALUES (2)");
db.exec("DELETE FROM t WHERE id = ?", [1])
"#;
        let n: i64 = e.eval(script).expect("eval");
        assert_eq!(n, 1);
    }

    #[test]
    fn param_types_roundtrip() {
        let e = engine();
        let script = r#"
let db = sqlite(":memory:");
db.exec("CREATE TABLE t (i INTEGER, f REAL, s TEXT, n INTEGER, b BLOB)");
let blob_val = blob();
blob_val.push(0x01);
blob_val.push(0xff);
db.exec("INSERT INTO t VALUES (?, ?, ?, ?, ?)", [42, 3.14, "hi", (), blob_val]);
let row = db.query_one("SELECT * FROM t", []);
assert(row.i == 42, "i");
assert(row.s == "hi", "s");
assert(row.n == (), "null");
return 0;
"#;
        let code: i64 = e.eval(script).expect("eval");
        assert_eq!(code, 0);
    }

    #[test]
    fn unknown_alias_throws() {
        let e = engine();
        let res: Result<SqliteHandle, _> = e.eval(r#"sqlite("nosuchalias")"#);
        assert!(res.is_err());
    }

    #[test]
    fn invalid_mode_throws() {
        let e = engine();
        let res: Result<SqliteHandle, _> = e.eval(r#"sqlite(":memory:", "bogus")"#);
        assert!(res.is_err());
    }

    #[test]
    fn sql_syntax_error_throws() {
        let e = engine();
        let res: Result<Array, _> = e.eval(r#"sqlite(":memory:").query("NOT VALID SQL")"#);
        assert!(res.is_err());
    }

    #[test]
    fn file_path_open_create() {
        use tempfile::tempdir;
        let dir = tempdir().unwrap();
        let path = dir.path().join("test.db");
        let e = engine();
        let script = format!(
            r#"
let db = sqlite("{}", "rwc");
db.exec("CREATE TABLE t (n INTEGER)");
db.exec("INSERT INTO t VALUES (7)");
db.query_value("SELECT n FROM t", [])
"#,
            path.display()
        );
        let n: i64 = e.eval(&script).expect("eval");
        assert_eq!(n, 7);
    }

    #[test]
    fn file_path_rw_missing_errors() {
        use tempfile::tempdir;
        let dir = tempdir().unwrap();
        let path = dir.path().join("does_not_exist.db");
        let e = engine();
        let script = format!(r#"sqlite("{}")"#, path.display());
        let res: Result<SqliteHandle, _> = e.eval(&script);
        assert!(res.is_err(), "rw should fail on missing file");
    }

    #[test]
    fn resolve_spec_routes() {
        use super::resolve_spec;
        assert!(matches!(resolve_spec(":memory:").unwrap(), Resolved::Memory));
        assert!(matches!(
            resolve_spec("/tmp/foo.db").unwrap(),
            Resolved::File(_)
        ));
        assert!(matches!(resolve_spec("foo.db").unwrap(), Resolved::File(_)));
        assert!(matches!(resolve_spec("cookiejar").unwrap(), Resolved::File(_)));
        assert!(matches!(
            resolve_spec("cookiejar:session").unwrap(),
            Resolved::File(_)
        ));
        assert!(resolve_spec("bogusalias").is_err());
    }
}