vsec 0.0.1

Detect secrets and in Rust codebases
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

// src/output/mod.rs

pub mod formatter;
pub mod json;
pub mod markdown;
pub mod sarif;
pub mod text;

pub use formatter::{format_findings, OutputFormat};
pub use json::JsonFormatter;
pub use markdown::MarkdownFormatter;
pub use sarif::SarifFormatter;
pub use text::TextFormatter;

use crate::config::Config;
use crate::models::Finding;

/// Format findings using the specified format
pub fn format(findings: &[Finding], format: OutputFormat, config: &Config) -> String {
    match format {
        OutputFormat::Text => TextFormatter::new(config).format(findings),
        OutputFormat::Json => JsonFormatter::new().format(findings),
        OutputFormat::Sarif => SarifFormatter::new().format(findings),
        OutputFormat::Markdown => MarkdownFormatter::new(config).format(findings),
        OutputFormat::Github => format_github_annotations(findings),
    }
}

/// Format findings as GitHub Actions annotations
fn format_github_annotations(findings: &[Finding]) -> String {
    findings
        .iter()
        .map(|f| {
            let level = match f.score.severity {
                crate::models::Severity::Critical | crate::models::Severity::High => "error",
                crate::models::Severity::Medium => "warning",
                _ => "notice",
            };
            format!(
                "::{} file={},line={},col={}::{}",
                level,
                f.location.file.display(),
                f.location.line,
                f.location.column,
                f.explanation.replace('\n', "%0A")
            )
        })
        .collect::<Vec<_>>()
        .join("\n")
}