use-security-finding 0.0.1

Security finding and remediation metadata primitives for RustUse
Documentation
  • Coverage
  • 43.21%
    35 out of 81 items documented1 out of 40 items with examples
  • Size
  • Source code size: 12.97 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.42 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 2s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Documentation
  • RustUse/use-security
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • CloudBranch

use-security-finding

Security finding, scanner result, and remediation metadata primitives for RustUse.

Experimental

use-security-finding is experimental while the use-security workspace remains below 0.3.0. Expect small API adjustments during the first release wave.

Example

use use_security_finding::{FindingKind, FindingSeverity, SecurityFinding, SecurityFindingId};

let finding = SecurityFinding::new(
    SecurityFindingId::new("F-1")?,
    FindingKind::Vulnerability,
    FindingSeverity::High,
);

assert_eq!(finding.kind(), FindingKind::Vulnerability);
# Ok::<(), use_security_finding::SecurityFindingError>(())

Scope

  • Finding IDs, source labels, kinds, statuses, confidence, severity, locations, evidence, references, and remediation statuses.
  • Metadata models that can represent output from many kinds of tools without depending on a specific scanner.

Non-goals

  • Running scanners.
  • Parsing scanner-specific report formats.
  • Contacting advisory databases or package registries.

License

Licensed under either of the following, at your option:

  • Apache License, Version 2.0
  • MIT license