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

Add privacy-check action #836

Conversation

ianlewis
Copy link
Member

@ianlewis ianlewis commented Sep 9, 2022

Updates #823

Adds a privacy-check action to the repo. The action checks if the repository is private and fails if it is. Users can override this by explicitly setting the override input.

Workflows will use this action to check if repos are private in a subsequent PR because the action needs to be referenced by sha.

Signed-off-by: Ian Lewis [email protected]

Copy link
Collaborator

@laurentsimon laurentsimon left a comment

Choose a reason for hiding this comment

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

LGTM. I'd like to have #823 (comment) resolved before merging.

I think we need explicit opt- in from users who have private repos, otherwise we're leaking their repo name silently.

@ianlewis
Copy link
Member Author

LGTM. I'd like to have #823 (comment) resolved before merging.

I think we need explicit opt- in from users who have private repos, otherwise we're leaking their repo name silently.

This is because the repo name appears in on the rekor transparency log? (probably another good reason why repo metadata on the cert isn't a great solution).

@ianlewis
Copy link
Member Author

From #823 (comment) by @laurentsimon

One thing to know: the certificate with your repository name is uploaded to a transparency log for audit purposes. So by using this builder, you are revealing the name of your private repository.

Is that OK with you?

Let's add a disclaimer in the README to make this more explicit.

That's a good catch. Private PKI and transparency log can be supported more properly via #34

#823 (comment) by @laurentsimon

OK. So I propose

  1. We amend the documentation
  2. We add a private-repository: true option (or a better name). At runtime we will check if the repo is private. If it is, we we only proceed if the option is set. Otherwise we will fail.

Wdut?

I'll update this PR to support private-repository on all the workflows.

@ianlewis ianlewis self-assigned this Sep 12, 2022
Ian Lewis added 2 commits September 14, 2022 01:34
Signed-off-by: Ian Lewis <[email protected]>
Signed-off-by: Ian Lewis <[email protected]>
@ianlewis ianlewis changed the title Add actions:read to Go builder job step Add privacy-check action Sep 14, 2022
@ianlewis
Copy link
Member Author

ianlewis commented Sep 14, 2022

@laurentsimon I updated this PR to just add a new privacy-check action that I will use in a later PR. Please see the updated PR description.

Permissions on workflows are not changed.

Copy link
Collaborator

@laurentsimon laurentsimon left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!
Please add a pre-submit to verify the "compilation" step gives the right dist output.

Ian Lewis added 5 commits September 14, 2022 02:58
Signed-off-by: Ian Lewis <[email protected]>
Signed-off-by: Ian Lewis <[email protected]>
Signed-off-by: Ian Lewis <[email protected]>
Signed-off-by: Ian Lewis <[email protected]>
@ianlewis ianlewis enabled auto-merge (squash) September 14, 2022 03:40
Ian Lewis added 2 commits September 14, 2022 04:09
Signed-off-by: Ian Lewis <[email protected]>
Signed-off-by: Ian Lewis <[email protected]>
@ianlewis ianlewis merged commit a3c7a56 into slsa-framework:main Sep 14, 2022
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