Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial OpenSSF baseline profile #131

Closed
wants to merge 10 commits into from

Conversation

puerco
Copy link
Contributor

@puerco puerco commented Jul 26, 2024

This commit introduces the first draft of the security baseline profile. It introduces three simple ruletypes: Check for a security policy file, check for a security insights file and check for a dependency policy in the Si file.

This commit checks in the skeleton of a profile to comply with the
OpenSSF's Security Baseline with comments to track completeness.

Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
---
version: v1
type: rule-type
name: security_insights
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a new rule and our CI will keep failing if we don't have either a test or an explicit skip placeholder. I recently added the placeholders for new rules in https://github.com/stacklok/minder-smoke-tests/commit/b69aadacb35dfd34221ae9d38cb71504cb8236a6 and https://github.com/stacklok/minder-smoke-tests/commit/4d89d22575a19575bf781ca27a9b7ab6539e38b4

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I opened this but ill write the tests as well
https://github.com/stacklok/minder-smoke-tests/pull/189

params:
branch: "main"
def:
required_approving_review_count: 2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do they really require 2?

Copy link
Contributor Author

@puerco puerco Jul 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes , there is an exception clause when projects have few maintainers ;/

# (TODO) Pinned dependencies

# Pinned dependencies
# This rule tells Minder to run Grizbee (https://github.com/stacklok/frizbee/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grizbee sounds like some energy drink with so much caffeine it's only sold on the black market :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, but you have to admit it sounded cool :)

image

@jhrozek
Copy link
Contributor

jhrozek commented Jul 26, 2024

thanks for the work @puerco ! I left some comment inline - it's mostly that we developed some conventions over the months and they are not really visible for someone who's not been following the development. But overall this looks great!

@puerco puerco force-pushed the openssf-baseline branch from 99b9638 to 6ea9e85 Compare July 26, 2024 22:25
puerco added 5 commits July 26, 2024 16:43
This commit adds a rule type to check for a security insights file
and adds it to the baseline profile.

Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
@puerco puerco force-pushed the openssf-baseline branch from 6ea9e85 to e5079f2 Compare July 26, 2024 22:46
puerco added 3 commits July 26, 2024 16:50
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
@puerco puerco force-pushed the openssf-baseline branch from e5079f2 to 240677b Compare July 26, 2024 22:50
This commit adds a check to verify that the security insights file
has a dependency policy entry.

Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
@puerco
Copy link
Contributor Author

puerco commented Jul 26, 2024

Comments are addressed here, I'm closing this PR and reopening in #136 which is not from my fork

@puerco puerco closed this Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants