ploit-malper 0.2.6

Post-exploitation analysis and vulnerability intelligence toolkit
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
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
use std::path::Path;

use rusqlite::{params, Connection, OptionalExtension, Row};
use serde_json::Value;

use crate::db::models::{Asset, ExploitExecution, Finding, Observation, ScanRun, Service};
use crate::db::{collections, Storage};
use crate::error::Result;

/// SQLite storage backend. Each collection maps to a table; JSON fields are
/// stored as TEXT columns and (de)serialized on write/read.
pub struct SqliteStorage {
    conn: Connection,
}

impl SqliteStorage {
    pub fn open(path: &str) -> Result<Self> {
        if path != ":memory:" {
            if let Some(parent) = Path::new(path).parent() {
                std::fs::create_dir_all(parent)?;
            }
        }
        let conn = Connection::open(path)?;
        let storage = Self { conn };
        storage.create_tables()?;
        Ok(storage)
    }

    fn create_tables(&self) -> Result<()> {
        self.conn.execute_batch(
            "PRAGMA foreign_keys = ON;
            CREATE TABLE IF NOT EXISTS Assets (
                stable_id   TEXT PRIMARY KEY,
                asset_type  TEXT,
                name        TEXT NOT NULL,
                ip          TEXT,
                fqdn        TEXT,
                reverse_dns TEXT,
                first_seen  TEXT,
                last_seen   TEXT,
                status      TEXT,
                metadata    TEXT
            );
            CREATE TABLE IF NOT EXISTS Services (
                stable_id    TEXT PRIMARY KEY,
                asset_id     TEXT NOT NULL,
                port         INTEGER,
                protocol     TEXT,
                service_name TEXT,
                product      TEXT,
                version      TEXT,
                version_str  TEXT,
                banner       TEXT,
                technologies TEXT,
                cpes         TEXT,
                first_seen   TEXT,
                last_seen    TEXT,
                status       TEXT,
                metadata     TEXT
            );
            CREATE TABLE IF NOT EXISTS Findings (
                stable_id       TEXT PRIMARY KEY,
                asset_id        TEXT NOT NULL,
                service_id      TEXT,
                title           TEXT NOT NULL,
                severity        TEXT,
                tool            TEXT,
                target_url      TEXT,
                detail          TEXT,
                detail_path     TEXT,
                reference       TEXT,
                cves            TEXT,
                endpoints       TEXT,
                technologies    TEXT,
                first_seen      TEXT,
                last_seen       TEXT,
                status          TEXT,
                exploitability  TEXT,
                metadata        TEXT
            );
            CREATE TABLE IF NOT EXISTS Observations (
                stable_id    TEXT PRIMARY KEY,
                run_id       TEXT NOT NULL,
                subject_type TEXT NOT NULL,
                subject_id   TEXT NOT NULL,
                kind         TEXT NOT NULL,
                before       TEXT,
                after        TEXT,
                detail       TEXT,
                observed_at  TEXT
            );
            CREATE TABLE IF NOT EXISTS ScanRuns (
                stable_id    TEXT PRIMARY KEY,
                target       TEXT NOT NULL,
                folder       TEXT,
                started_at   TEXT,
                finished_at  TEXT,
                tools        TEXT,
                artifacts    TEXT,
                content_hash TEXT,
                imported_at  TEXT,
                stats        TEXT
            );
            CREATE TABLE IF NOT EXISTS ExploitExecutions (
                execution_id    TEXT PRIMARY KEY,
                run_id          TEXT NOT NULL,
                asset_id        TEXT NOT NULL,
                vulnerability_id TEXT NOT NULL,
                module_type     TEXT,
                module          TEXT NOT NULL,
                host            TEXT,
                payload         TEXT,
                status          TEXT,
                start_time      TEXT,
                finish_time     TEXT,
                job_id          TEXT,
                session_id      TEXT,
                error           TEXT,
                loot            TEXT,
                options         TEXT,
                selected        INTEGER,
                created_at      TEXT
            );
            CREATE INDEX IF NOT EXISTS idx_services_asset ON Services(asset_id);
            CREATE INDEX IF NOT EXISTS idx_findings_asset ON Findings(asset_id);
            CREATE INDEX IF NOT EXISTS idx_obs_subject ON Observations(subject_type, subject_id);
            CREATE INDEX IF NOT EXISTS idx_exploit_run ON ExploitExecutions(run_id);",
        )?;
        Ok(())
    }
}

fn json_or_null<T: serde::Serialize>(value: &T) -> rusqlite::Result<String> {
    serde_json::to_string(value).map_err(|e| rusqlite::Error::ToSqlConversionFailure(e.into()))
}

fn parse_json(raw: Option<String>) -> Value {
    raw.and_then(|s| serde_json::from_str(&s).ok())
        .unwrap_or(Value::Null)
}

fn parse_vec(raw: Option<String>) -> Vec<String> {
    match parse_json(raw) {
        Value::Array(items) => items
            .into_iter()
            .filter_map(|v| v.as_str().map(str::to_string))
            .collect(),
        _ => Vec::new(),
    }
}

fn parse_vec_value(raw: Option<String>) -> Vec<Value> {
    match parse_json(raw) {
        Value::Array(items) => items,
        _ => Vec::new(),
    }
}

// ---------------------------------------------------------------------------
// Row mapping
// ---------------------------------------------------------------------------

fn asset_from_row(row: &Row) -> rusqlite::Result<Asset> {
    Ok(Asset {
        stable_id: row.get("stable_id")?,
        asset_type: row.get("asset_type")?,
        name: row.get("name")?,
        ip: row.get("ip")?,
        fqdn: row.get("fqdn")?,
        reverse_dns: row.get("reverse_dns")?,
        first_seen: row.get("first_seen")?,
        last_seen: row.get("last_seen")?,
        status: row.get("status")?,
        metadata: parse_json(row.get("metadata")?),
    })
}

fn service_from_row(row: &Row) -> rusqlite::Result<Service> {
    Ok(Service {
        stable_id: row.get("stable_id")?,
        asset_id: row.get("asset_id")?,
        port: row.get("port")?,
        protocol: row.get("protocol")?,
        service_name: row.get("service_name")?,
        product: row.get("product")?,
        version: row.get("version")?,
        version_str: row.get("version_str")?,
        banner: row.get("banner")?,
        technologies: parse_vec(row.get("technologies")?),
        cpes: parse_vec(row.get("cpes")?),
        first_seen: row.get("first_seen")?,
        last_seen: row.get("last_seen")?,
        status: row.get("status")?,
        metadata: parse_json(row.get("metadata")?),
    })
}

fn finding_from_row(row: &Row) -> rusqlite::Result<Finding> {
    Ok(Finding {
        stable_id: row.get("stable_id")?,
        asset_id: row.get("asset_id")?,
        service_id: row.get("service_id")?,
        title: row.get("title")?,
        severity: row.get("severity")?,
        tool: row.get("tool")?,
        target_url: row.get("target_url")?,
        detail: row.get("detail")?,
        detail_path: row.get("detail_path")?,
        reference: row.get("reference")?,
        cves: parse_vec(row.get("cves")?),
        endpoints: parse_vec(row.get("endpoints")?),
        technologies: parse_vec(row.get("technologies")?),
        first_seen: row.get("first_seen")?,
        last_seen: row.get("last_seen")?,
        status: row.get("status")?,
        exploitability: row.get("exploitability")?,
        metadata: parse_json(row.get("metadata")?),
    })
}

fn observation_from_row(row: &Row) -> rusqlite::Result<Observation> {
    Ok(Observation {
        stable_id: row.get("stable_id")?,
        run_id: row.get("run_id")?,
        subject_type: row.get("subject_type")?,
        subject_id: row.get("subject_id")?,
        kind: row.get("kind")?,
        before: parse_json(row.get("before")?),
        after: parse_json(row.get("after")?),
        detail: row.get("detail")?,
        observed_at: row.get("observed_at")?,
    })
}

fn scan_run_from_row(row: &Row) -> rusqlite::Result<ScanRun> {
    Ok(ScanRun {
        stable_id: row.get("stable_id")?,
        target: row.get("target")?,
        folder: row.get("folder")?,
        started_at: row.get("started_at")?,
        finished_at: row.get("finished_at")?,
        tools: parse_vec(row.get("tools")?),
        artifacts: parse_vec_value(row.get("artifacts")?),
        content_hash: row.get("content_hash")?,
        imported_at: row.get("imported_at")?,
        stats: parse_json(row.get("stats")?),
    })
}

fn exploit_execution_from_row(row: &Row) -> rusqlite::Result<ExploitExecution> {
    Ok(ExploitExecution {
        execution_id: row.get("execution_id")?,
        run_id: row.get("run_id")?,
        asset_id: row.get("asset_id")?,
        vulnerability_id: row.get("vulnerability_id")?,
        module_type: row.get("module_type")?,
        module: row.get("module")?,
        host: row.get("host")?,
        payload: row.get("payload")?,
        status: row.get("status")?,
        start_time: row.get("start_time")?,
        finish_time: row.get("finish_time")?,
        job_id: row.get("job_id")?,
        session_id: row.get("session_id")?,
        error: row.get("error")?,
        loot: parse_vec(row.get("loot")?),
        options: parse_options_map(row.get("options")?),
        selected: row.get("selected")?,
        created_at: row.get("created_at")?,
    })
}

fn parse_options_map(raw: Option<String>) -> std::collections::BTreeMap<String, String> {
    match parse_json(raw) {
        Value::Object(map) => map
            .into_iter()
            .filter_map(|(key, val)| val.as_str().map(|s| (key, s.to_string())))
            .collect(),
        _ => std::collections::BTreeMap::new(),
    }
}

impl Storage for SqliteStorage {
    fn kind(&self) -> &str {
        "sqlite"
    }

    fn ping(&mut self) -> Result<bool> {
        let value: String = self
            .conn
            .query_row(
                "SELECT name FROM sqlite_master WHERE type='table' AND name=?1 LIMIT 1",
                params![collections::ASSETS],
                |row| row.get(0),
            )
            .optional()?
            .unwrap_or_default();
        Ok(value == collections::ASSETS)
    }

    fn ensure_schema(&mut self) -> Result<()> {
        self.create_tables()
    }

    fn upsert_scan_run(&mut self, run: &ScanRun) -> Result<()> {
        self.conn.execute(
            "INSERT OR REPLACE INTO ScanRuns (stable_id, target, folder, started_at, finished_at, tools, artifacts, content_hash, imported_at, stats)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10)",
            params![
                run.stable_id,
                run.target,
                run.folder,
                run.started_at,
                run.finished_at,
                json_or_null(&run.tools)?,
                json_or_null(&run.artifacts)?,
                run.content_hash,
                run.imported_at,
                json_or_null(&run.stats)?
            ],
        )?;
        Ok(())
    }

    fn get_scan_run(&mut self, run_id: &str) -> Result<Option<ScanRun>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM ScanRuns WHERE stable_id = ?1",
                params![run_id],
                scan_run_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_scan_runs(&mut self) -> Result<Vec<ScanRun>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM ScanRuns ORDER BY imported_at DESC")?;
        let rows = stmt.query_map([], scan_run_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn delete_scan_run(&mut self, run_id: &str) -> Result<()> {
        self.conn.execute(
            "DELETE FROM ExploitExecutions WHERE run_id = ?1",
            params![run_id],
        )?;
        self.conn.execute(
            "DELETE FROM Observations WHERE run_id = ?1",
            params![run_id],
        )?;
        self.conn
            .execute("DELETE FROM ScanRuns WHERE stable_id = ?1", params![run_id])?;
        Ok(())
    }

    fn upsert_asset(&mut self, asset: &Asset) -> Result<()> {
        self.conn.execute(
            "INSERT OR REPLACE INTO Assets (stable_id, asset_type, name, ip, fqdn, reverse_dns, first_seen, last_seen, status, metadata)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10)",
            params![
                asset.stable_id,
                asset.asset_type,
                asset.name,
                asset.ip,
                asset.fqdn,
                asset.reverse_dns,
                asset.first_seen,
                asset.last_seen,
                asset.status,
                json_or_null(&asset.metadata)?
            ],
        )?;
        Ok(())
    }

    fn get_asset(&mut self, asset_id: &str) -> Result<Option<Asset>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM Assets WHERE stable_id = ?1",
                params![asset_id],
                asset_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_assets(&mut self) -> Result<Vec<Asset>> {
        let mut stmt = self.conn.prepare("SELECT * FROM Assets ORDER BY name")?;
        let rows = stmt.query_map([], asset_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn upsert_service(&mut self, service: &Service) -> Result<()> {
        self.conn.execute(
            "INSERT OR REPLACE INTO Services (stable_id, asset_id, port, protocol, service_name, product, version, version_str, banner, technologies, cpes, first_seen, last_seen, status, metadata)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15)",
            params![
                service.stable_id,
                service.asset_id,
                service.port,
                service.protocol,
                service.service_name,
                service.product,
                service.version,
                service.version_str,
                service.banner,
                json_or_null(&service.technologies)?,
                json_or_null(&service.cpes)?,
                service.first_seen,
                service.last_seen,
                service.status,
                json_or_null(&service.metadata)?
            ],
        )?;
        Ok(())
    }

    fn get_service(&mut self, service_id: &str) -> Result<Option<Service>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM Services WHERE stable_id = ?1",
                params![service_id],
                service_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_services_for_asset(&mut self, asset_id: &str) -> Result<Vec<Service>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM Services WHERE asset_id = ?1 ORDER BY port")?;
        let rows = stmt.query_map(params![asset_id], service_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn list_all_services(&mut self) -> Result<Vec<Service>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM Services ORDER BY asset_id, port")?;
        let rows = stmt.query_map([], service_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn upsert_finding(&mut self, finding: &Finding) -> Result<()> {
        self.conn.execute(
            "INSERT OR REPLACE INTO Findings (stable_id, asset_id, service_id, title, severity, tool, target_url, detail, detail_path, reference, cves, endpoints, technologies, first_seen, last_seen, status, exploitability, metadata)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17, ?18)",
            params![
                finding.stable_id,
                finding.asset_id,
                finding.service_id,
                finding.title,
                finding.severity,
                finding.tool,
                finding.target_url,
                finding.detail,
                finding.detail_path,
                finding.reference,
                json_or_null(&finding.cves)?,
                json_or_null(&finding.endpoints)?,
                json_or_null(&finding.technologies)?,
                finding.first_seen,
                finding.last_seen,
                finding.status,
                finding.exploitability,
                json_or_null(&finding.metadata)?
            ],
        )?;
        Ok(())
    }

    fn get_finding(&mut self, finding_id: &str) -> Result<Option<Finding>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM Findings WHERE stable_id = ?1",
                params![finding_id],
                finding_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_findings_for_asset(&mut self, asset_id: &str) -> Result<Vec<Finding>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM Findings WHERE asset_id = ?1 ORDER BY severity, title")?;
        let rows = stmt.query_map(params![asset_id], finding_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn list_all_findings(&mut self) -> Result<Vec<Finding>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM Findings ORDER BY asset_id, title")?;
        let rows = stmt.query_map([], finding_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn add_observation(&mut self, observation: &Observation) -> Result<()> {
        if self.get_observation(&observation.stable_id)?.is_some() {
            return Ok(());
        }
        self.conn.execute(
            "INSERT OR REPLACE INTO Observations (stable_id, run_id, subject_type, subject_id, kind, before, after, detail, observed_at)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9)",
            params![
                observation.stable_id,
                observation.run_id,
                observation.subject_type,
                observation.subject_id,
                observation.kind,
                json_or_null(&observation.before)?,
                json_or_null(&observation.after)?,
                observation.detail,
                observation.observed_at
            ],
        )?;
        Ok(())
    }

    fn get_observation(&mut self, obs_id: &str) -> Result<Option<Observation>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM Observations WHERE stable_id = ?1",
                params![obs_id],
                observation_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_observations_for(
        &mut self,
        subject_type: &str,
        subject_id: &str,
    ) -> Result<Vec<Observation>> {
        let mut stmt = self.conn.prepare(
            "SELECT * FROM Observations WHERE subject_type = ?1 AND subject_id = ?2 ORDER BY observed_at",
        )?;
        let rows = stmt.query_map(params![subject_type, subject_id], observation_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn list_all_observations(&mut self) -> Result<Vec<Observation>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM Observations ORDER BY observed_at")?;
        let rows = stmt.query_map([], observation_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn upsert_exploit_execution(&mut self, execution: &ExploitExecution) -> Result<()> {
        self.conn.execute(
            "INSERT OR REPLACE INTO ExploitExecutions (execution_id, run_id, asset_id, vulnerability_id, module_type, module, host, payload, status, start_time, finish_time, job_id, session_id, error, loot, options, selected, created_at)
             VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17, ?18)",
            params![
                execution.execution_id,
                execution.run_id,
                execution.asset_id,
                execution.vulnerability_id,
                execution.module_type,
                execution.module,
                execution.host,
                execution.payload,
                execution.status,
                execution.start_time,
                execution.finish_time,
                execution.job_id,
                execution.session_id,
                execution.error,
                json_or_null(&execution.loot)?,
                json_or_null(&execution.options)?,
                execution.selected,
                execution.created_at
            ],
        )?;
        Ok(())
    }

    fn get_exploit_execution(&mut self, execution_id: &str) -> Result<Option<ExploitExecution>> {
        let row = self
            .conn
            .query_row(
                "SELECT * FROM ExploitExecutions WHERE execution_id = ?1",
                params![execution_id],
                exploit_execution_from_row,
            )
            .optional()?;
        Ok(row)
    }

    fn list_exploit_executions(&mut self) -> Result<Vec<ExploitExecution>> {
        let mut stmt = self
            .conn
            .prepare("SELECT * FROM ExploitExecutions ORDER BY created_at DESC")?;
        let rows = stmt.query_map([], exploit_execution_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }

    fn list_exploit_executions_for_run(&mut self, run_id: &str) -> Result<Vec<ExploitExecution>> {
        let mut stmt = self.conn.prepare(
            "SELECT * FROM ExploitExecutions WHERE run_id = ?1 ORDER BY created_at DESC",
        )?;
        let rows = stmt.query_map(params![run_id], exploit_execution_from_row)?;
        Ok(rows.collect::<std::result::Result<Vec<_>, _>>()?)
    }
}