🔐 Allow choose proof purpose when signing VC

[bdeneux]

Implements #724

Summary by CodeRabbit

• New Features
  • Introduced a new command-line flag, flagPurpose, allowing users to specify the purpose of signed verifiable credentials for enhanced clarity and security.
  • Updated the credential signing process to include the purpose in the signed credential's metadata.

[coderabbitai]

Walkthrough

The recent updates enhance the command-line interface for signing verifiable credentials by introducing a new flag, --purpose. This allows users to specify the purpose of the credential being signed, improving clarity and security. The changes modify the signing function to accept this additional parameter, ensuring that the purpose is included in the signed credential's metadata.

Changes

Files	Change Summary
client/credential/sign.go	Added --purpose flag for specifying the purpose of signed credentials; updated signing function to accept purpose as a parameter.

Possibly related issues

• 🔐 Add ability to choose proofPurpose on sign VC #724: This issue seeks to implement the same feature of choosing proofPurpose when signing a VC, aligning directly with the changes made in this PR.

🐰 In the meadow where dreams take flight,
A purpose flag shines oh so bright.
With every credential signed with care,
Clarity blooms, and confusion we spare.
Hopping along with joy we cheer,
For secure credentials are finally here! 🌟

---

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff           @@
##             main     #727   +/-   ##
=======================================
  Coverage   54.49%   54.49%           
=======================================
  Files          73       73           
  Lines        2905     2905           
=======================================
  Hits         1583     1583           
  Misses       1228     1228           
  Partials       94       94           

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6832b9a and 6294c8d.

Files ignored due to path filters (1)

• docs/command/axoned_credential_sign.md is excluded by !docs/command/**/*.md

Files selected for processing (1)

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

Additional comments not posted (4)

client/credential/sign.go (4)

39-39: LGTM! The flagPurpose declaration is appropriate.

The flagPurpose is well-defined with a clear description and a suitable default value.

---

69-71: LGTM! The flagPurpose integration in SignCmd is correct.

The flagPurpose is correctly added to the command flags with a clear description and default value.

---

128-133: LGTM! The handling of flagPurpose in runSignCmd is correct.

The flagPurpose is retrieved and passed to the signVerifiableCredential function appropriately.

---

Line range hint 258-287: LGTM! The integration of purpose in signVerifiableCredential is correct.

The purpose parameter is correctly integrated into the function and used in the linked data proof context, enhancing security.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6294c8d and 643dab4.

Files selected for processing (1)

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

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

• client/credential/sign.go

[amimart]

Looks good thanks :)

[ccamel]

👍