sharkio-dev / sharkio

Sharkio is an API proxy for your development environments. It records all the requests that are sent to your API. It allows you to replay the requests easily. Generate types, documentation, test suites, And interact with your API using AI.
https://sharkio.dev/
MIT License
5 stars 1 forks source link

Staging --> Production #435

Closed ypotter closed 9 months ago

ypotter commented 9 months ago

Description

Please provide a brief description of the changes made in this pull request.

Related Issues or Pull Requests

If this pull request is related to any existing issues or pull requests, please mention them here.

Proposed Changes

List the proposed changes introduced in this pull request. This could include bug fixes, new features, improvements, refactoring, etc.

Screenshots (if applicable)

If the changes are visual in nature, please provide screenshots or GIFs that showcase the before and after effects.

How to Test

Outline the steps to test the changes made in this pull request. Provide as much detail as necessary so that reviewers can easily verify the changes.

  1. Step 1
  2. Step 2
  3. ...

Additional Notes

Include any other relevant information, context, or considerations related to this pull request.

Checklist

Please make sure you've done the following before submitting this pull request:

gitguardian[bot] commented 9 months ago

⚠️ GitGuardian has uncovered 3 secrets 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 secrets in your pull request
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [9429049](https://dashboard.gitguardian.com/incidents/9429049?occurrence=124789360) | Triggered | Generic Password | e0182e8c20fd5fcd10a0a3707d7477282cca19df | docker-compose.yml | [View secret](https://github.com/sharkio-dev/sharkio/commit/e0182e8c20fd5fcd10a0a3707d7477282cca19df#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R54) | | [9429049](https://dashboard.gitguardian.com/incidents/9429049?occurrence=124789361) | Triggered | Generic Password | e0182e8c20fd5fcd10a0a3707d7477282cca19df | docker-compose.yml | [View secret](https://github.com/sharkio-dev/sharkio/commit/e0182e8c20fd5fcd10a0a3707d7477282cca19df#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R33) | | [9429049](https://dashboard.gitguardian.com/incidents/9429049?occurrence=124789362) | Triggered | Generic Password | e0182e8c20fd5fcd10a0a3707d7477282cca19df | docker-compose.yml | [View secret](https://github.com/sharkio-dev/sharkio/commit/e0182e8c20fd5fcd10a0a3707d7477282cca19df#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R68) |
🛠 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 secrets 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 these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/generics/generic_password#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://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!