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 the docs for secrets masking + set default masks for AWS #381

Merged
merged 2 commits into from
Dec 21, 2022

Conversation

arm4b
Copy link
Member

@arm4b arm4b commented Dec 21, 2022

Closes #374

Also adds AWS secret ENVs to the default config, so it's secure by default.

@arm4b arm4b added the documentation 📗 Improvements or additions to documentation label Dec 21, 2022
@arm4b arm4b added this to the v2.3.0 milestone Dec 21, 2022
Comment on lines +59 to +62
- # see: https://regex101.com/r/44Ldz7/1
# looks for `AWS_ACCESS_KEY_ID={string}`
search: (AWS_ACCESS_KEY_ID=)(\S+)
replace: \1*******
Copy link
Member Author

@arm4b arm4b Dec 21, 2022

Choose a reason for hiding this comment

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

Tested the regex rules for AWS locally.

But it's also interesting that you can have unit tests and examples for the regex rule at https://regex101.com/r/snz1j6/1

Copy link
Contributor

Choose a reason for hiding this comment

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

I would move that URL to the top of the regex comments, or to the bottom, so that every regex keeps the same style of #comment / replace

Copy link
Member Author

@arm4b arm4b Dec 21, 2022

Choose a reason for hiding this comment

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

Sorry, the PR was auto-merged.

image

Though the URL was specific to the AWS_ACCESS_KEY_ID rule block as an example, moving it more to the top of the secrets section would be less relevant.

@arm4b arm4b changed the title Add documentation for secrets masking Update documentation for secrets masking Dec 21, 2022
@arm4b arm4b enabled auto-merge December 21, 2022 15:33
Copy link
Contributor

@LeoDiazL LeoDiazL left a comment

Choose a reason for hiding this comment

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

Just to be consistent, I would use

# comment 
replace
# comment
replace

We could add a bigger headder on top of the replacements with the URL and some info if needed. Or at the bottom.

Comment on lines +59 to +62
- # see: https://regex101.com/r/44Ldz7/1
# looks for `AWS_ACCESS_KEY_ID={string}`
search: (AWS_ACCESS_KEY_ID=)(\S+)
replace: \1*******
Copy link
Contributor

Choose a reason for hiding this comment

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

I would move that URL to the top of the regex comments, or to the bottom, so that every regex keeps the same style of #comment / replace

@arm4b arm4b merged commit a813fe1 into main Dec 21, 2022
@arm4b arm4b deleted the docs/secrets-masking branch December 21, 2022 15:35
@arm4b arm4b changed the title Update documentation for secrets masking Add the docs for secrets masking + set default masks for AWS Dec 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📗 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for Secrets Masking
2 participants