leaktor 0.2.0

A blazingly fast secrets scanner with validation capabilities
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

use super::{Secret, Severity};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::path::PathBuf;
use uuid::Uuid;

/// Location information for a finding
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Location {
    pub file_path: PathBuf,
    pub line_number: usize,
    pub column_start: usize,
    pub column_end: usize,
    pub commit_hash: Option<String>,
    pub commit_author: Option<String>,
    pub commit_date: Option<DateTime<Utc>>,
}

/// Context around the finding
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Context {
    pub line_before: Option<String>,
    pub line_content: String,
    pub line_after: Option<String>,
    pub is_test_file: bool,
    pub is_config_file: bool,
    pub is_documentation: bool,
    pub file_extension: Option<String>,
}

/// A complete finding with secret and location information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Finding {
    pub id: Uuid,
    pub secret: Secret,
    pub location: Location,
    pub context: Context,
    pub timestamp: DateTime<Utc>,
    pub ignored: bool,
    pub ignore_reason: Option<String>,
}

impl Finding {
    pub fn new(secret: Secret, location: Location, context: Context) -> Self {
        Self {
            id: Uuid::new_v4(),
            secret,
            location,
            context,
            timestamp: Utc::now(),
            ignored: false,
            ignore_reason: None,
        }
    }

    pub fn severity(&self) -> Severity {
        self.secret.severity
    }

    pub fn is_likely_false_positive(&self) -> bool {
        // Lower confidence or test files are more likely false positives
        self.secret.confidence < 0.7 || self.context.is_test_file || self.context.is_documentation
    }
}