appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

Published 20 hours ago • verified publisher icon appsmithorg

fix: apiKey security issue

Open rishabhrathod01 opened this issue 9 months ago • 1 comments

Description

Fixes #30009

Summary:

This PR addresses the issue of masking sensitive information in query parameters or headers based on the authentication type selected by the user. The changes ensure that sensitive data is properly masked before sending back as response.

Changes:

  • RequestCaptureFilter.java Added logic to check the authentication type and mask the appropriate query parameters or headers.

Testing:

Verified that the masking functionality works as expected for API_KEY authentication types.

Automation

/ok-to-test tags="@tag.All"

:mag: Cypress test results

[!CAUTION]
If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • [ ] Yes
  • [x] No

rishabhrathod01 avatar May 16 '24 15:05 rishabhrathod01

Failed server tests

  • com.external.plugins.RestApiPluginTest#testAPIResponseEncodedInGzipFormat
  • com.external.plugins.RestApiPluginTest#testBinaryFileUploadAPIWithMustacheBinding
  • com.external.plugins.RestApiPluginTest#testDenyInstanceMetadataAwsViaCname
  • com.external.plugins.RestApiPluginTest#testDenyInstanceMetadataAwsViaCnameIpv6
  • com.external.plugins.RestApiPluginTest#testDenyInstanceMetadataAwsWithRedirect
  • com.external.plugins.RestApiPluginTest#testEncodeParamsToggleNull
  • com.external.plugins.RestApiPluginTest#testEncodeParamsToggleOn
  • com.external.plugins.RestApiPluginTest#testExecuteApiWithPaginationForNextEncodedUrl
  • com.external.plugins.RestApiPluginTest#testExecuteApiWithPaginationForNextUrl
  • com.external.plugins.RestApiPluginTest#testExecuteApiWithPaginationForPreviousEncodedUrl
  • com.external.plugins.RestApiPluginTest#testExecuteApiWithPaginationForPreviousUrl
  • com.external.plugins.RestApiPluginTest#testExecutionSuccessWhenRedirectionEndsWithoutALocationHeader
  • com.external.plugins.RestApiPluginTest#testGetApiWithBody
  • com.external.plugins.RestApiPluginTest#testGetApiWithoutBody
  • com.external.plugins.RestApiPluginTest#testHttpGetRequestRawBody
  • com.external.plugins.RestApiPluginTest#testInvalidSignature
  • com.external.plugins.RestApiPluginTest#testMultipartFormData
  • com.external.plugins.RestApiPluginTest#testMultipartFormDataJSONWithMustacheBinding
  • com.external.plugins.RestApiPluginTest#testMultipartFormDataWithArray
  • com.external.plugins.RestApiPluginTest#testMultipartFormDataWithJSON
  • com.external.plugins.RestApiPluginTest#testNumericStringHavingLeadingZero
  • com.external.plugins.RestApiPluginTest#testOrderedJsonBodyInApiExecution
  • com.external.plugins.RestApiPluginTest#testParsingBodyWithInvalidJSONHeader
  • com.external.plugins.RestApiPluginTest#testQueryParamsInDatasource
  • com.external.plugins.RestApiPluginTest#testRedirectionSuccessWithAddingFullUrlExecution
  • com.external.plugins.RestApiPluginTest#testRedirectionSuccessWithLocationHeaderHavingPath
  • com.external.plugins.RestApiPluginTest#testRequestWithApiKeyHeader
  • com.external.plugins.RestApiPluginTest#testSmartSubstitutionEvaluatedValueContainingQuestionMark
  • com.external.plugins.RestApiPluginTest#testSmartSubstitutionJSONBody
  • com.external.plugins.RestApiPluginTest#testValidApiExecutionWithWhitespacesInUrl
  • com.external.plugins.RestApiPluginTest#testValidFormApiExecution
  • com.external.plugins.RestApiPluginTest#testValidJsonApiExecution
  • com.external.plugins.RestApiPluginTest#testValidRawApiExecution
  • com.external.plugins.RestApiPluginTest#testValidSignature
  • com.external.plugins.RestApiPluginTest#test_DifferentialParsingStrategy_fromGson
  • com.external.plugins.RestApiPluginTest#test_numberToNumberPolicy_fromGson
  • com.external.plugins.RestApiPluginTest#test_setObjectToNumberPolicy_fromGson
  • com.external.plugins.RestApiPluginTest#whenAPIReturnsNon200_doNotStringifyResponseBody
  • com.external.plugins.RestApiPluginTest#whenBindingFoundWithoutValue_doNotReplaceWithNull

github-actions[bot] avatar May 16 '24 15:05 github-actions[bot]

Failed server tests

  • com.appsmith.server.solutions.DatasourceStructureSolutionTest#verifyDatasourceStorageStructureEntriesWithTwoEnvironmentId

github-actions[bot] avatar May 22 '24 22:05 github-actions[bot]

[!WARNING]

Rate Limit Exceeded

@rishabhrathod01 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 48 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 7c0b171e160d04acd9880f4ff5e6317a7e502495 and 9a7fc9cc1942ddc61c54f6ae9451706ad527f49c.

Walkthrough

The recent changes aim to enhance security by masking API keys in logs. This involves updating methods in several classes to handle DatasourceConfiguration and mask sensitive information in query parameters and headers. Additionally, new tests were added to ensure the correct masking of API keys.

Changes

File Path Change Summary
.../RequestCaptureFilter.java Added imports, a method to mask query parameters, updated URI creation logic, and adjusted header processing.
.../RestAPIActivateUtils.java Updated triggerApiCall method to accept and utilize DatasourceConfiguration.
.../GraphQLPlugin.java Modified executeCommon method to accept and pass DatasourceConfiguration.
.../RestApiPlugin.java Updated executeCommon method to handle DatasourceConfiguration.
.../RestApiPluginTest.java Added tests for masking API keys in query parameters and headers.

Assessment against linked issues

Objective Addressed Explanation
Mask API keys in logs for datasources using API key authentication (#30009) ✅
Ensure new method createURIWithMaskedQueryParam correctly masks sensitive data in URIs (#30009) ✅
Update relevant methods to handle DatasourceConfiguration and mask sensitive headers (#30009) ✅
Add tests to verify masking functionality for API keys in query parameters and headers (#30009) ✅

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 23 '24 06:05 coderabbitai[bot]

/build-deploy-preview skip-tests=true

NilanshBansal avatar May 23 '24 06:05 NilanshBansal

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9203592447. Workflow: On demand build Docker image and deploy preview. skip-tests: true. env: ``. PR: 33528. recreate: .

github-actions[bot] avatar May 23 '24 06:05 github-actions[bot]

Deploy-Preview-URL: https://ce-33528.dp.appsmith.com

github-actions[bot] avatar May 23 '24 07:05 github-actions[bot]