clevertap-android-sdk icon indicating copy to clipboard operation
clevertap-android-sdk copied to clipboard

Encryption over transit.

Open CTLalit opened this issue 10 months ago • 3 comments

https://wizrocket.atlassian.net/browse/SDK-4341

Summary by CodeRabbit

  • New Features
    • Enhanced encryption capabilities with improved public key management and secure response handling.
  • Refactor
    • Streamlined cryptographic and network communication flows for better security and performance.
  • Tests
    • Expanded test coverage to verify encryption configurations and secure data handling.

These updates further strengthen data security, ensure reliable encrypted communications, and provide a smoother, more robust configuration experience for end-users.

CTLalit avatar Feb 05 '25 13:02 CTLalit

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)
  • ^(task|feat|feature|fix)/

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

This pull request introduces extensive enhancements to encryption and network functionality in the CleverTap SDK. New classes for key management (e.g. CTKeyGenerator) and encryption (e.g. NetworkEncryptionManager, RSAEncryption) have been added, while existing factories and configuration classes are updated with public encryption key properties and methods. Cryptographic modules are refactored to decouple context from key generation. The network layer is restructured with a new Kotlin-based NetworkManager and improved response handling. Corresponding test cases and sample manifest configurations have been added or updated to validate and support the new encryption features.

Changes

File(s) Summary of Changes
clevertap-core/.../CleverTapFactory.kt, CleverTapInstanceConfig.java, ManifestInfo.java, Constants.java Updated factories and configurations to integrate encryption: added public encryption key fields, methods, constants, and modified instantiation logic for encryption managers.
clevertap-core/.../cryption/AESGCMCrypt.kt, CTKeyGenerator.kt, CryptExtensions.kt, CryptFactory.kt, CryptRepository.kt Refactored cryptography modules: AESGCMCrypt now uses CTKeyGenerator; introduced CTKeyGenerator for key management, Base64 utility extensions, updated CryptFactory to remove context dependency and added RSA encryption support; added methods for local key storage and update.
clevertap-core/.../network/NetworkEncryptionManager.kt, NetworkManager.java, NetworkManager.kt, RSAEncryption.kt, CtApi.kt, EncryptedSendQueueRequestBody.kt, EncryptionResult.kt, Response.kt, UrlConnectionHttpClient.kt, CleverTapResponseDecorator.java Redesigned network layer: removed old Java NetworkManager and introduced a new Kotlin NetworkManager with enhanced queue management and header handling; added NetworkEncryptionManager for response encryption; integrated RSAEncryption; updated CtApi to use string-based request bodies and conditionally include an encryption header; streamlined HTTP response handling.
clevertap-core/.../test/... (CleverTapFixtures.kt, CleverTapInstanceConfigTest.kt, NetworkManagerTest.kt, CtApiTest.kt, MockHttpClient.kt) Extended test coverage: added encryption constants; created tests validating encryption configuration and header attachment; updated test mocks to align with new response handling logic.
sample/src/main/AndroidManifest.xml Modified manifest: removed ad services configuration and added new meta-data for the public encryption key.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant CtApi
    participant NetworkEncryptionManager
    participant AESGCMCrypt
    participant CTKeyGenerator

    Client->>CtApi: sendQueue(isEncrypted=true, body)
    CtApi->>CtApi: Add encryption header if enabled
    CtApi->>NetworkEncryptionManager: encryptResponse(response)
    NetworkEncryptionManager->>CTKeyGenerator: Retrieve/generate session key
    NetworkEncryptionManager->>AESGCMCrypt: performCryptOperation(response, sessionKey)
    AESGCMCrypt-->>NetworkEncryptionManager: Return EncryptionResult
    NetworkEncryptionManager-->>CtApi: Encrypted response payload

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 Feb 05 '25 13:02 coderabbitai[bot]

@coderabbitai review

darshanclevertap avatar Feb 05 '25 13:02 darshanclevertap

:white_check_mark: Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot] avatar Feb 05 '25 13:02 coderabbitai[bot]