PLSysSec / PLSysSec/cargo-scan

publishing and sharing audit files

Open
#62 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement roadmap-unplanned
Dominant language
Rust
Stars
47
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Locally, all audit files are stored/overwritten to the same file location.
We may need a way to sign, publish, and version-number audits and associated metadata to share with other users and organizations.

This is related to #60.

This also relates to the problem we discussed today about tracking which portions of the code the user has audited or not -- since this information could be tracked in the audit files. An alternative would be to change our safety annotation model -- see audit_file.rs:

#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
pub enum SafetyAnnotation {
    Skipped,
    Safe,
    Unsafe,
    CallerChecked,
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading audit_file.rs and the discussion in issues #60 and #62. Clarify the requirements for signing, publishing, versioning, sharing audits and metadata, and tracking audited code portions. Done should be a decided design with specified file behavior and scope before implementation begins.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.