Skip to content

Commit

Permalink
more implementation details
Browse files Browse the repository at this point in the history
  • Loading branch information
balteravishay committed Jan 22, 2025
1 parent b238090 commit a159254
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/probes.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ The probe returns 1 true outcome if the project has no workflows "write" permiss

**Motivation**: Memory safety in software should be considered a continuum, rather than being binary. This probe does not consider a specific ecosystem more or less memory safe than another, but rather tries to surface non memory safe code or practices in the project, in the context of the ecosystems it is using.

**Implementation**: The probe is ecosystem-specific and tries to flag non memory safe code blocks in the project by looking at the code and practices used in the project. It may look for specific memory safety practices, such as the use tools or non memory-safe patterns and code.
**Implementation**: The probe is ecosystem-specific and tries to flag non memory safe code blocks in the project by looking at the code and practices used in the project. It may look for specific memory safety practices, such as the use tools or non memory-safe patterns and code. The probe supports multiple checks for each ecosystem, and the outcome is based on the results of these checks.

**Outcomes**: For supported ecosystem, the probe returns OutcomeTrue per safe method or tool.
For supported ecosystem, the probe returns OutcomeFalse per unsafe code or method.
Expand Down
1 change: 1 addition & 0 deletions probes/memorysafe/def.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ motivation: >
implementation: >
The probe is ecosystem-specific and tries to flag non memory safe code blocks in the project by looking at the code and practices used in the project.
It may look for specific memory safety practices, such as the use tools or non memory-safe patterns and code.
The probe supports multiple checks for each ecosystem, and the outcome is based on the results of these checks.
outcome:
- For supported ecosystem, the probe returns OutcomeTrue per safe method or tool.
- For supported ecosystem, the probe returns OutcomeFalse per unsafe code or method.
Expand Down

0 comments on commit a159254

Please sign in to comment.