Migrate vault passwords to GCM

[SailReal]

This pull request introduces a security enhancement by changing how vault passwords and cloud credentials are encrypted. Starting with this PR, new vault passwords and cloud credentials will be encrypted using AES with 256 bit key length GCM with biometric authentication.

Key Changes

• New: AES with 256 bit key length GCM (Galois/Counter Mode) is now used for encrypting vault passwords and cloud credentials.
• Old: Previously, AES with 256 bit key length CBC (Cipher Block Chaining) was used.
• New/Old: The encryption key is securely stored in the Android Keystore and the data in the internal storage, which is both accessible only to this app thanks to Android's sandbox model.
• Existing cloud credentials will be migrated silently when the updated app is firstly opened.
• Existing vault passwords will be migrated to the new format. Users can opt out of this migration, but in doing so, the vault passwords will be dropped to ensure consistency and security.

Security Considerations

• AES with 256-bit Key Length CBC Limitations:
  • While this is a robust encryption standard and was adequately secure within the confines of Android’s sandbox model, it lacks the built-in data integrity checks that GCM provides.
  • The main risk associated with CBC mode is its susceptibility to padding oracle attacks when improperly implemented. However, in our previous implementation, this risk was mitigated by the app's design, where both the encryption key and data were securely stored in the app's internal memory, isolated by Android’s sandboxing. Additionally, the export mechanism has been disabled for this app, which means attacking involves breaking the Android sandbox model first.

Conclusion

This PR enhances our application's security posture by transitioning to a more robust encryption method. The switch to AES with 256 bit key length GCM aligns with industry best practices for data encryption and integrity, providing our users with stronger protection for their sensitive information. The previous implementation, while secure within the Android ecosystem, has been improved upon to meet evolving security standards.

[coderabbitai[bot]]

Walkthrough

The recent changes significantly enhance the application's database management and cryptographic capabilities. This includes an upgrade from version 12 to 13 of the database schema, introducing robust testing to ensure data integrity during transitions. New features for managing vault passwords with varying encryption modes (CBC and GCM) improve security practices and streamline user authentication, ultimately enriching the user experience and maintaining the application's integrity.

Changes

Files	Change Summary
data/build.gradle	Updated schemaVersion from 12 to 13 to signify database changes.
data/src/androidTest/java/...	Added upgrade12To13 test method to validate the database upgrade, incorporating new encryption logic for sensitive data.
data/src/main/java/...	Enhanced DatabaseUpgrades to include new upgrade functionality. Implemented Upgrade12To13 for migrating to the new schema.
data/src/main/java/...	Introduced new class Upgrade12To13.kt for the database upgrade process, including methods for altering table structures and handling encryption modes.
data/src/main/java/...	Modified CloudEntityMapper to reflect changes in how cloud storage URIs are represented, enhancing data conversion methods.
domain/src/main/java/...	Introduced ListCBCEncryptedPasswordVaults use case for managing CBC vaults. Refactored RemoveStoredVaultPasswords to streamline password management.
presentation/src/main/...	Enhanced presenters to include new use cases for vault management and updated methods to handle password encryption modes.
presentation/src/main/res/...	Added new dialog and string resources for user interactions regarding vault migrations and biometric authentication.
util/src/main/java/...	Introduced CryptoMode enum and utility methods for cryptographic byte array handling. Refactored cryptographic classes for improved flexibility and security.
util/src/androidTest/java/...	Updated tests for CredentialCryptor and KeyStoreBuilder to utilize parameterized testing for various cryptographic modes.

🐇 Hopping through the code with glee,
New features abound, oh what a spree!
Vaults secure, with modes we can choose,
CBC or GCM, no data to lose!
Biometric bliss, passwords take flight,
In this land of encryption, all feels right! 🥕✨

---

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 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](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.