weggli-ruleset

Crates.ioweggli-ruleset
lib.rsweggli-ruleset
version0.1.7
sourcesrc
created_at2024-10-29 02:41:10.651334
updated_at2024-11-01 04:58:02.873384
descriptionRuleset managment/matching/reporting for weggli patterns
homepage
repositoryhttps://github.com/xorpse/weggli-ruleset.git
max_upload_size
id1426400
size27,910
Sam L. Thomas (xorpse)

documentation

README

weggli-ruleset

This is a utility crate to help manage weggli patterns. To do so, it provides a yaml-based rule format that allows different (related) patterns to be grouped along with metadata useful for categorising and triaging matches. For example, we can encode the patterns from here, as follows:

id: call-to-unbounded-copy-functions
description: call to unbounded copy functions
severity: medium
tags:
- CWE-120
- CWE-242
- CWE-676
check-patterns:
- name: gets
  regex: func=^gets$
  pattern: |
    { $func(); }
- name: st(r|p)(cpy|cat)
  regex: func=st(r|p)(cpy|cat)$
  pattern: |
    { $func(); }
- name: wc(r|p)(cpy|cat)
  regex: func=wc(r|p)(cpy|cat)$
  pattern: |
    { $func(); }
- name: sprintf
  regex: func=sprintf$
  pattern: |
    { $func(); }
- name: scanf
  regex: func=scanf$
  pattern: |
    { $func(); }

Usage

use std::fs;
use weggli_ruleset::RuleMatcher;

let mut matcher = RuleMatcher::from_directory("rules")?;
let source = fs::read_to_string("tests/test.c")?;

let matches = matcher.matches(source)?;
Commit count: 14

cargo fmt