Add create vault template command

[SailReal]

Fixes #11

Summary by CodeRabbit

• New Features
  • Introduced a command-line tool for creating vault templates, including generating configurations and keys.
  • Added functionality for managing vault configurations with JWT authentication and encryption.
• Refactor
  • Streamlined vault creation process by refactoring method calls and removing unused imports.
• Bug Fixes
  • Fixed issues related to vault creation and configuration.

[coderabbitai]

Walkthrough

The recent updates to the Cryptomator Hub CLI introduce a new command-line tool for creating and managing vault templates, alongside modifications to vault creation and configuration management. This includes the addition of a VaultTemplate subcommand, enhancements in vault configuration handling with JWT and SIV_GCM cipher, and refactoring to streamline the process. The changes aim to facilitate the creation and later downloading of vault templates, addressing specific user needs for flexibility in managing vault templates.

Changes

File Path	Change Summary
.../hubcli/Vault.java	Added VaultTemplate subcommand
.../hubcli/VaultConfig.java	New file for vault configuration management
.../hubcli/VaultCreate.java	Refactored, removing specific methods and imports, using VaultConfig methods
.../hubcli/VaultTemplate.java	New class for creating and managing vault templates
.../hubcli/VaultCreateTemplate.java	New class for creating vault templates of existing vaults

Assessment against linked issues

Objective	Addressed	Explanation
#11: Add function to download the vault template later	✅

Poem

In the vaults where secrets lie,
A rabbit hopped, beneath the sky.
🐇✨ Crafting templates, oh so grand,
With digital keys, at your command.

Through lines of code, a path we weave,
For treasures locked, and dreams to achieve.
"Fear not," it whispers, "for I've found,
A way to keep your secrets sound."

🔐🐰

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
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c711512 and 1e2c99e.

Files selected for processing (4)

• src/main/java/org/cryptomator/hubcli/Vault.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultConfig.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultCreate.java (4 hunks)
• src/main/java/org/cryptomator/hubcli/VaultTemplate.java (1 hunks)

Additional comments: 6

src/main/java/org/cryptomator/hubcli/Vault.java (1)

• 11-11: The addition of VaultTemplate as a subcommand in the Vault class is correctly implemented and follows the pattern of other subcommands. This change effectively integrates the new feature into the CLI tool.

src/main/java/org/cryptomator/hubcli/VaultCreate.java (1)

• 52-56: Refactoring the creation of vault configurations and local vaults to use static methods in VaultConfig is a good practice for code modularity and reusability. Ensure that all necessary parameters are correctly passed and handled in the VaultConfig methods.

src/main/java/org/cryptomator/hubcli/VaultTemplate.java (2)

• 22-22: The @Command annotation correctly defines the VaultTemplate class as a CLI command with an appropriate description. This aligns with the objective of adding a command to create vault templates.
• 40-66: The implementation of the call method in VaultTemplate correctly follows the required steps to create a vault template, including cryptographic operations and interaction with the backend. Ensure that all cryptographic operations are securely implemented and that error handling is comprehensive for all external calls.

src/main/java/org/cryptomator/hubcli/VaultConfig.java (2)

• 32-66: The createVaultConfig method correctly implements the logic for creating a vault configuration using JWT and cryptographic operations. Ensure that the JWT signing process is secure and that the kid and custom parameters are correctly set.
• 68-85: The createLocalVault method correctly implements the logic for creating a local vault, including file operations and cryptographic operations for directory encryption. Ensure that file operations are securely handled and that the cryptographic operations are correctly implemented.

[SailReal]

CI fails due to Error: nimbus-jose-jwt-9.37.jar: CVE-2023-52428(7.5), soon will bump the dependencies during release.

[infeo]

I don't like, how we deal with our keys. We only hand over a key.copy() into the methods (requires a try-catch-around the method!) and even doing so, sometimes we even make a keyCopy.copy().

But to move fast, i suggest let this technical debt stay. Apart from that, only minor things.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1e2c99e and cea4aeb.

Files selected for processing (2)

• src/main/java/org/cryptomator/hubcli/Vault.java (1 hunks)
• src/main/java/org/cryptomator/hubcli/VaultCreateTemplate.java (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/main/java/org/cryptomator/hubcli/Vault.java

Additional comments: 2

src/main/java/org/cryptomator/hubcli/VaultCreateTemplate.java (2)

• 22-22: Ensure the command description accurately reflects the functionality provided by this class.
• 27-38: Verify the necessity of making vaultId and path mandatory options. Consider if there are scenarios where these could be optional or have default values.