cryptomator / hub

Cryptomator Hub helps you manage vaults in large teams
GNU Affero General Public License v3.0
36 stars 8 forks source link

Refactored User Keys #282

Closed overheadhunter closed 4 weeks ago

overheadhunter commented 1 month ago

This PR has changes in three areas:

  1. It changes the data model in order to store an ECDH key (same as before) as well as an ECDSA key (new). New columns are added in our database for the ECDSA public key. No separate column is required for the private key, as it will be added in the JWE that already holds the ECDH key in its payload (existing columns user.privatekeys and device.user_privatekeys; just renamed those).
  2. With userdata.ts, it adds a new facade object to the frontend. The purpose of this object is to channel all requests to /api/me as well as access to user keys and browser keys through a single place. This not only deduplicates some code and allows us to memoize seldom changing objects, it also makes sure we have a single entry point to inspect and interact with the user's key material.
  3. Building upon (2.), if the user DTO doesn't contain any ECDSA key yet, it is created and all objects that contain the user's key material are updated (i.e. the user itself and the user's devices)

One of the sequence diagrams generated by coderabbit was actually quite good. I fetched it from its edit history:

sequenceDiagram
    participant User as User
    participant Frontend as Frontend
    participant UserData as UserData
    participant Backend as Backend

    User ->> Frontend: Create Vault
    Frontend ->> UserData: Get User Data
    UserData ->> Backend: Fetch User Information
    Backend -->> UserData: UserDto
    UserData -->> Frontend: UserDto
    Frontend ->> UserData: Get ECDH Public Key
    UserData -->> Frontend: ECDH Public Key
    Frontend ->> Backend: Create Vault with ECDH Public Key
    Backend -->> Frontend: Vault Created

    User ->> Frontend: Recover Vault
    Frontend ->> UserData: Get User Data
    UserData ->> Backend: Fetch User Information
    Backend -->> UserData: UserDto
    UserData -->> Frontend: UserDto
    Frontend ->> UserData: Decrypt User Keys with Browser
    UserData -->> Frontend: Decrypted User Keys
    Frontend ->> Backend: Recover Vault with User Keys
    Backend -->> Frontend: Vault Recovered
coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes introduce a UserData class in the frontend, centralizing user data management and key handling. This class provides methods for fetching user information, creating browser keys, and decrypting user keys. The frontend components have been refactored to utilize this new class instead of directly interacting with the backend. Additionally, the backend has been updated to use more specific cryptographic key names, enhancing clarity and security.

Changes

Files/Paths Change Summaries
frontend/src/common/userdata.ts Introduced UserData class for managing user data and keys, added several methods for key operations.
frontend/src/components/VaultDetails.vue Refactored to use UserData for fetching user data and decrypting user keys.
frontend/src/components/CreateVault.vue Updated to retrieve user's ECDH public key from UserData instead of directly from the backend.
frontend/src/components/RecoverVaultDialog.vue Changed to use UserData for accessing the ECDH public key during vault recovery.
backend/src/main/java/.../UsersResource.java Renamed cryptographic key variables and updated method calls accordingly. Added updateDevices method.

Poem

In code's vast realm, a rabbit hops with glee,
Refactoring keys with utmost clarity.
From UserData springs a new dawn,
Where vaults are safe and secrets drawn.
Backend whispers, "ECDH, ECDSA,"
While frontend dances, simplifying the way.
Together they weave a secure, bright day. 🌟


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.