opengovsg / sgid-client

The official TypeScript/JavaScript SDK for sgID
MIT License
11 stars 6 forks source link

(WIP) test: OIDC conformance tests #59

Closed raynerljm closed 1 year ago

raynerljm commented 1 year ago

Problem

What problem are you trying to solve? What issue does this close?

Closes [insert issue #]

Solution

How did you solve the problem?

Features:

Improvements:

Bug Fixes:

Before & After Screenshots

BEFORE: [insert screenshot here]

AFTER: [insert screenshot here]

Tests

What tests should be run to confirm functionality?

Deploy Notes

Notes regarding deployment of the contained body of work. These should note any new dependencies, new scripts, etc.

New environment variables:

New scripts:

New dependencies:

New dev dependencies:

gitguardian[bot] commented 1 year ago

⚠️ GitGuardian has uncovered 4 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 | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [6805328](https://dashboard.gitguardian.com/incidents/6805328?occurrence=96175374) | RSA Private Key | 316342196ddb203ce532a3a92cd6eb5216d1ef01 | test/conformance/demo-rp/mocks/ConformanceSgidClient.ts | [View secret](https://github.com/opengovsg/sgid-client/commit/316342196ddb203ce532a3a92cd6eb5216d1ef01#diff-769cd8ae4abfbd994cd4a53c699b35399ed176987184a43ed80bb6b0542a58f8R21) | | [6805328](https://dashboard.gitguardian.com/incidents/6805328?occurrence=96175373) | RSA Private Key | 316342196ddb203ce532a3a92cd6eb5216d1ef01 | test/conformance/demo-rp/src/lib/sgidClient.ts | [View secret](https://github.com/opengovsg/sgid-client/commit/316342196ddb203ce532a3a92cd6eb5216d1ef01#diff-e0654a19490c1da7cfd964fde3fee6c7ad09623c739cf2a3ad3b1fa13227194bR21) | | [6805328](https://dashboard.gitguardian.com/incidents/6805328?occurrence=96182517) | RSA Private Key | 49516ea096825ecf6e615b94d875e3a4c3ce75c7 | test/conformance/demo-rp/mocks/ConformanceSgidClient.ts | [View secret](https://github.com/opengovsg/sgid-client/commit/49516ea096825ecf6e615b94d875e3a4c3ce75c7#diff-769cd8ae4abfbd994cd4a53c699b35399ed176987184a43ed80bb6b0542a58f8L21) | | [6805328](https://dashboard.gitguardian.com/incidents/6805328?occurrence=97512215) | RSA Private Key | 776e6205f44fd715ddfac648e2d2109b8839237d | test/conformance/demo-rp/src/lib/sgidClient.ts | [View secret](https://github.com/opengovsg/sgid-client/commit/776e6205f44fd715ddfac648e2d2109b8839237d#diff-e0654a19490c1da7cfd964fde3fee6c7ad09623c739cf2a3ad3b1fa13227194bL22) |
🛠 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/detectors/specifics/private_key_rsa#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!