Fix/sign cmd

[amimart]

This PR aims to fix some issues related to the credential sign command.

Details

VC file path

The provided credential file path to sign is now properly expanded.

Signature

The crypto suite used to sign the credential was systematically the Ed25519Signature2018 independently of the public key type used to sign.

We now support both EcdsaSecp256k1Signature2019 & Ed25519Signature2020 depending on the public key type.

Summary by CodeRabbit

• New Features
  • Enhanced the signing process for verifiable credentials by dynamically selecting the appropriate signature suite (ECDSA secp256k1 or Ed25519) based on the public key type.

[coderabbitai]

Walkthrough

The recent update enhances the digital signing capabilities in the project by integrating new cryptographic standards. Specifically, it broadens the scope of signature suites to include ECDSA secp256k1 and Ed25519. This is achieved by dynamically selecting the appropriate signature suite based on the public key type, ensuring that the signing process for verifiable credentials is both flexible and secure.

Changes

File(s)	Summary
client/credential/sign.go	Added support for ECDSA secp256k1 and Ed25519 signature suites in the aries-framework-go.

🐇✨
In the realm of code, where secrets hide,
A rabbit hopped, with a graceful stride.
"New keys," it said, "have found their place,
In signatures' embrace, with style and grace.
Let's hop along, on this digital quest,
With secp256k1 and Ed25519, we're truly blessed!"
🌟🐾

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.
  • 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 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 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 bab12a0 and dfa8283.

Files selected for processing (1)

• client/credential/sign.go (4 hunks)

Additional comments: 4

client/credential/sign.go (4)

• 14-15: The addition of imports for ecdsasecp256k1signature2019 and ed25519signature2020 from the aries-framework-go package aligns with the PR's objective to support dynamic signature suite selection based on the public key type. This is a crucial step in enabling the functionality described in the PR objectives.
• 25-26: The imports for ed25519 and secp256k1 from the cosmos-sdk/crypto/keys package are necessary for the implementation of dynamic signature suite selection. These imports allow the code to perform type assertions on the public keys to determine the appropriate signature suite.
• 214-214: The expandPath function has been modified to address the VC File Path Expansion issue mentioned in the PR objectives. This change ensures that file paths starting with the "~" symbol are correctly expanded to the user's home directory. This is a critical fix for the usability of the credential sign command, especially when dealing with file paths provided by the user.
• 255-280: The signVerifiableCredential function now includes logic for dynamic signature suite selection based on the public key type, which is a significant improvement as outlined in the PR objectives. This change allows for the use of either EcdsaSecp256k1Signature2019 or Ed25519Signature2020 depending on the type of the public key, enhancing the versatility and security of the credential signing process.

However, it's important to ensure that the error message in lines 278-279 is clear and helpful for debugging purposes. The current message provides the expected public key types, which is good practice. Ensuring that error messages are informative aids in troubleshooting and improves the developer experience.

Consider adding tests to verify that the dynamic selection behaves as expected with different types of public keys. This could help catch any potential issues with the type assertions or the integration with the aries-framework-go package.

[ccamel]

Thanks 👍

[bot-anik]

🎉 This PR is included in version 7.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀