Skip to content

docs: Add changelog entry for registry-username secret#1648

Merged
asraa merged 5 commits intoslsa-framework:mainfrom
ianlewis:registry-username-changelog
Feb 16, 2023
Merged

docs: Add changelog entry for registry-username secret#1648
asraa merged 5 commits intoslsa-framework:mainfrom
ianlewis:registry-username-changelog

Conversation

@ianlewis
Copy link
Copy Markdown
Member

Signed-off-by: Ian Lewis ianlewis@google.com

Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
@asraa asraa enabled auto-merge (squash) February 15, 2023 15:01
Comment thread CHANGELOG.md
#### New Features

- A new boolean [`continue-on-error`](https://github.com/slsa-framework/slsa-github-generator/blob/main/internal/builders/container/README.md#workflow-inputs) input was added which, when set to `true`, prevents the workflow from failing when a step fails. If set to true, the result of the reusable workflow will be return in the [`outcome`](https://github.com/slsa-framework/slsa-github-generator/blob/main/internal/builders/container/README.md#workflow-outputs) output.
- A new [`repository-username`](https://github.com/slsa-framework/slsa-github-generator/blob/main/internal/builders/container/README.md#workflow-inputs) secret input was added to allow users to pass their repository username that is stored in a [Github Actions encrypted secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
Copy link
Copy Markdown
Collaborator

@laurentsimon laurentsimon Feb 15, 2023

Choose a reason for hiding this comment

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

this will make the workflow fail if the username has low entropy, because GH scanning will find it in other strings like our hashes. Can we be more prescriptive about which option to use? For example, can we say that the secret option should only be used with high-entropy secrets and give an example of cloud providers where it's suitable? I think someone had mentioned the AWS username have high entropy.

In the case where username should not be a secret but users still want to avoid commiting it to the source code of the repo, we should tell users to use https://github.blog/2023-01-10-introducing-required-workflows-and-configuration-variables-to-github-actions/

Wdut?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks. That's a good call. I'll add a note about it here and more details in the docs on workflow inputs that it links to.

I assume the entropy issue is not that GitHub checks the entropy but just that something with low entropy will match hashes etc. more often?

Copy link
Copy Markdown
Collaborator

@laurentsimon laurentsimon Feb 15, 2023

Choose a reason for hiding this comment

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

Correct, that's my understanding as well.

Signed-off-by: Ian Lewis <ianlewis@google.com>
…o registry-username-changelog

Signed-off-by: Ian Lewis <ianlewis@google.com>
@asraa asraa merged commit ac3dcf6 into slsa-framework:main Feb 16, 2023
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.

3 participants