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

feat(build): delete test keys from repo #332

Conversation

paullatzelsperger
Copy link
Contributor

@paullatzelsperger paullatzelsperger commented May 10, 2023

WHAT

This PR adds scripts and tools to generate certificates and keys, so that we do not have them checked in the code base.

WHY

security guidelines prohibit checking in even test keys

FURTHER NOTES

  • scripts should be used as much as possible to increase portability and user-friendlyness
  • unless stated otherwise, a POSIX-compliant shell (e.g. bash) is assumed
  • the following tools are presumed to be present:
    • openssl to generate certs/keys
    • yq to manipulate YAML files
    • base64 to encode/decode base64 strings

Closes #278

@paullatzelsperger paullatzelsperger changed the title Feature/278 delete test keys from repo feat(build): delete test keys from repo May 10, 2023
@paullatzelsperger paullatzelsperger force-pushed the feature/278_delete_test_keys_from_repo branch 3 times, most recently from edb70bf to e7e3fc9 Compare May 11, 2023 05:31
@gitguardian
Copy link

gitguardian bot commented May 11, 2023

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id Secret Commit Filename
- Generic Private Key 6ca8440 .github/workflows/deploy-test-secrets View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@paullatzelsperger paullatzelsperger force-pushed the feature/278_delete_test_keys_from_repo branch 3 times, most recently from 2993798 to 51c3afb Compare May 11, 2023 06:51
@paullatzelsperger paullatzelsperger force-pushed the feature/278_delete_test_keys_from_repo branch from 51c3afb to 6ca8440 Compare May 11, 2023 06:53
@sonarcloud
Copy link

sonarcloud bot commented May 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@paullatzelsperger
Copy link
Contributor Author

paullatzelsperger commented May 11, 2023

I don't know why Gitguardian still complains, I did actually delete the hard-coded secret. Maybe it needs to run again after the merge

@paullatzelsperger paullatzelsperger marked this pull request as ready for review May 14, 2023 12:40
@paullatzelsperger paullatzelsperger deleted the feature/278_delete_test_keys_from_repo branch May 14, 2023 12:41
@paullatzelsperger paullatzelsperger restored the feature/278_delete_test_keys_from_repo branch May 14, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

delete keys from repository
1 participant