Skip to content

Commit

Permalink
docs(security): add prose explaining OpenSSF CII Best Practices badge…
Browse files Browse the repository at this point in the history
… results
  • Loading branch information
ljharb committed Oct 21, 2023
1 parent fc6bf5c commit 8bc5aa8
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,25 @@ work as a member of the Fastify Core team.
* [__KaKa Ng__](https://github.com/climba03003)
* [__James Sumners__](https://github.com/jsumners),
<https://twitter.com/jsumners79>, <https://www.npmjs.com/~jsumners>

## OpenSSF CII Best Practices

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/7585/badge)](https://bestpractices.coreinfrastructure.org/projects/7585)

There are three “tiers”: passing, silver, and gold.

### Passing
We meet 100% of the “passing” criteria.

### Silver
We meet 87% of the “silver” criteria. The gaps are as follows:
- we do not have a DCO or a CLA process for contributions
- we do not currently document “what the user can and cannot expect in terms of security” for our project

Check failure on line 146 in SECURITY.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 107]
- we do not currently document ”the architecture (aka high-level design)” for our project

Check failure on line 147 in SECURITY.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 91]

### Gold
We meet 70% of the “gold” criteria. The gaps are as follows:
- we do not yet have the “silver” badge; see all the gaps above.
- We do not include a copyright or license statement in each source file. Efforts are underway to change this archaic practice into a suggestion instead of a hard requirement.

Check failure on line 152 in SECURITY.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 177]
- There are a few unanswered questions around cryptography that are waiting for clarification.

Check failure on line 153 in SECURITY.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 96]

0 comments on commit 8bc5aa8

Please sign in to comment.