killer 2.0.0

A Rust security platform: static analysis, the .klr test language, a parallel test framework, project intelligence, code review, and a CI gate.
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

//! The rule registry.
//!
//! Rules are grouped into submodules by category. [`default_rules`] assembles
//! the active rule set, respecting the enable/disable switches in the config.
//! Adding a new rule is a matter of implementing [`crate::analyzer::Rule`] and
//! registering it here.

pub mod dependencies;
pub mod quality;
pub mod security;

use crate::analyzer::Rule;
use crate::config::Config;

/// Build the list of enabled rules from configuration.
pub fn default_rules(config: &Config) -> Vec<Box<dyn Rule>> {
    let mut rules: Vec<Box<dyn Rule>> = Vec::new();
    let r = &config.rules;

    if r.secret_detection {
        rules.push(Box::new(security::HardcodedSecretRule::new()));
    }
    if r.dangerous_commands {
        rules.push(Box::new(security::DangerousCommandRule::new()));
    }
    if r.weak_crypto {
        rules.push(Box::new(security::WeakCryptoRule::new()));
    }
    if r.large_files {
        rules.push(Box::new(quality::LargeFileRule::new(
            config.scan.large_file_threshold,
        )));
    }
    if r.todo_tracker {
        rules.push(Box::new(quality::TodoTrackerRule::new()));
    }
    if r.duplicate_code {
        rules.push(Box::new(quality::DuplicateCodeRule::new()));
    }

    rules
}

/// Every rule id known to Killer, for documentation and `killer version`.
pub fn all_rule_ids() -> Vec<&'static str> {
    vec![
        "hardcoded-secret",
        "dangerous-command",
        "weak-crypto",
        "large-file",
        "todo-tracker",
        "duplicate-code",
    ]
}