ballerine-io / ballerine

Open-source infrastructure and data orchestration platform for risk decisioning
https://www.ballerine.com
Other
2.02k stars 176 forks source link

fix: base64 for hashing key #2429

Closed liorzam closed 1 month ago

liorzam commented 2 months ago

New generation salt for each customer automaticlly in based64

image

for backwards compatibility old hash key still can be used, in case non of them will present an error will raise

image

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: d5c0dc02dfb32561430b1c53fedbf53f6da21af5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates span several files, focusing on enhancing environment variable management, refining hashing mechanisms, and updating various configurations for the workflows-service. Major changes include the introduction of HASHING_KEY_SECRET_BASE64, removal of redundant environment variables, and improvements in bcrypt salt generation. Additionally, the package.json scripts and several test files have been adjusted to accommodate these updates. The overall aim is to streamline configuration, enhance security, and improve code maintainability.

Changes

Files Change Summary
deploy/docker-compose-build-https.yml, deploy/docker-compose-build.yml Added HASHING_KEY_SECRET_BASE64 environment variable.
package.json Updated scripts by removing ENV_FILE_NAME and adjusting VITE_POLLING_INTERVAL and VITE_EXAMPLE_TYPE.
scripts/generate-salt.sh, scripts/init.js Added functions for bcrypt salt generation and integrated new script execution.
services/workflows-service/.env.example, .../docker-compose.yml Replaced HASHING_KEY_SECRET with HASHING_KEY_SECRET_BASE64.
services/workflows-service/package.json Added docker:db:down script to stop the Docker database service before resetting and seeding the database.
services/workflows-service/scripts/generate-salt.ts New file for generating and encoding bcrypt salt using Base64.
services/workflows-service/src/alert/alert.service.intg.test.ts Updated generateAlertDefinitions function call structure.
services/workflows-service/src/app.module.ts Added serverEnvSchema and validation function for environment variables.
services/workflows-service/src/common/filters/HttpExceptions.filter.ts Minor change to handle a specific Prisma error case.
services/workflows-service/src/customer/api-key/api-key.service.intg.test.ts, utils.ts Updated hashing mechanism and added SALT import.
services/workflows-service/src/data-analytics/data-analytics.service.ts Added conditional check for excludedCounterparty in the join clause.
services/workflows-service/src/env.ts Restructured environment variable declarations and introduced serverEnvSchema.
services/workflows-service/src/transaction/transaction.service.ts Minor addition of a blank line.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant App
    participant Docker
    participant GenerateSaltScript
    participant EnvFile

    User->>App: Run setup script
    App->>Docker: Stop DB service (docker:db:down)
    App->>GenerateSaltScript: Execute generate-salt.sh
    GenerateSaltScript->>EnvFile: Update .env with new salt
    App->>Docker: Start DB service (docker:db)
    App->>EnvFile: Load environment variables
    App->>User: Complete setup

Poem

In the world of code so bright,
We added keys and scripts by night.
With secrets hashed in Base64,
Our services are secure, once more.
Docker dances, salts align,
Our workflow's now a work of art, so fine.
🎉✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.