search

OpenQDev / OpenQ-Fullstack

Bash scripts for booting the full backend across local and test environments
10 stars 8 forks source link

Suggestion: Simplified boot / from forks #30

Closed mktcode closed 1 year ago

mktcode commented 1 year ago

Requires now to set an env var for the PAT:

export PAT=...

The .env files are then generated for you (where there's a .env.sample).

I think generally we can ask for required env vars first and then populate the files automatically, right?

We cannot include the OAuth Client Secret in the OpenQ-Github-OAuth-Server .env.sample because when the Git Guardian bot detects the secret, it revokes it.

~Not true for OAuth app secrets (to my own surprise): https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-user-alerts~

I confused GitHub's internal scanning with this GitGuardian bot. It in deed removes the secret but maybe it can still be obfuscated with base64 or something. Alternatively devs need to be instructed to create their own OAuth app.

I also added functionality to boot from forks:

export OPENQ_FORKS=username/OpenQ-Frontend,username/OpenQ-Contracts
gitguardian[bot] commented 1 year ago

⚠️ 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 | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [-](https://dashboard.gitguardian.com/incidents/secrets) | Generic High Entropy Secret | d74f1b240dd1c711ef1026a392dd660804b7c05d | boot.sh | [View secret](https://github.com/OpenQDev/OpenQ-Fullstack/commit/d74f1b240dd1c711ef1026a392dd660804b7c05d#diff-dd8a848a3d0ef50d50b80f0325d26051R55) |
🛠 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](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate this secret](https://docs.gitguardian.com/secrets-detection/detectors/generics/generic_high_entropy_secret#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 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 - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 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!