Skip to content
This repository was archived by the owner on Feb 8, 2026. It is now read-only.

Fix policy decode#109

Merged
johnnyluo merged 1 commit into
mainfrom
fix/decode-policy
Jul 2, 2025
Merged

Fix policy decode#109
johnnyluo merged 1 commit into
mainfrom
fix/decode-policy

Conversation

@Ehsan-saradar

@Ehsan-saradar Ehsan-saradar commented Jul 2, 2025

Copy link
Copy Markdown
Collaborator

Follow the same patter in:
https://github.com/vultisig/verifier/blob/0d7a07d1969c01f043ed699bc2137b9696b4f72a/types/policy.go#L60

Summary by CodeRabbit

  • Bug Fixes
    • Improved policy recipe decoding to handle standard base64 encoding with padding.

@coderabbitai

coderabbitai Bot commented Jul 2, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The base64 decoding method in the ValidatePluginPolicy function within the payroll plugin was updated from using raw standard encoding to standard base64 encoding, altering how the policy recipe string is decoded. No other logic or public interfaces were changed.

Changes

File(s) Change Summary
plugin/payroll/policy.go Switched base64 decoding from RawStdEncoding to StdEncoding in policy decoding

Poem

In the world of code, where policies play,
A bunny hopped in and changed the way,
From raw to standard, base64 anew,
Decoding recipes with padding in view.
With every hop, the logic stays tight,
The payroll plugin now decodes just right!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package session: could not load export data: no export data for "github.com/vultisig/go-wrappers/go-dkls/sessions""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package session: could not load export data: no export data for "github.com/vultisig/go-wrappers/go-dkls/sessions""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0e06b and dc9c502.

📒 Files selected for processing (1)
  • plugin/payroll/policy.go (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:0-0
Timestamp: 2025-06-18T18:23:20.077Z
Learning: In the payroll plugin (plugin/payroll/transaction.go), signRequest.Transaction is stored with the "0x" prefix, making it compatible with gcommon.FromHex which requires 0x-prefixed hex strings.
Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:178-183
Timestamp: 2025-06-18T18:28:19.759Z
Learning: In the payroll plugin, the Hash field in PluginKeysignRequest is intentionally set to the unsigned transaction hex (same as Message field) because computing a hash with empty V,R,S signature fields doesn't make sense, and it's documented as "not on-chain hash without signature". This is a deliberate placeholder approach.
plugin/payroll/policy.go (2)
Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:0-0
Timestamp: 2025-06-18T18:23:20.077Z
Learning: In the payroll plugin (plugin/payroll/transaction.go), signRequest.Transaction is stored with the "0x" prefix, making it compatible with gcommon.FromHex which requires 0x-prefixed hex strings.
Learnt from: RaghavSood
PR: vultisig/plugin#36
File: api/server.go:21-33
Timestamp: 2025-05-07T08:23:45.882Z
Learning: The import path `github.com/vultisig/verifier/plugin` refers to an external dependency that provides the plugin interface, and should not be changed to `github.com/vultisig/plugin/plugin` as these are distinct packages with different purposes.
🔇 Additional comments (1)
plugin/payroll/policy.go (1)

156-156: Policy decoding method now matches standard Base64 encoding

  • common/util.go uses base64.StdEncoding.EncodeToString, so all recipes are encoded with padding
  • Existing tests (e.g. storage/postgres/time_trigger_test.go) use padded Base64 strings (…=)
  • Switching to base64.StdEncoding.DecodeString in plugin/payroll/policy.go ensures decoding aligns with encoding

No further changes required.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@Ehsan-saradar
Ehsan-saradar requested a review from RaghavSood July 2, 2025 10:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Base64 decoding mechanism for policy recipes to use the standard encoding instead of the raw, unpadded variant.

  • Switched from base64.RawStdEncoding to base64.StdEncoding for decoding policy recipes.
  • Ensures incoming recipes must be padded per standard Base64.
Comments suppressed due to low confidence (1)

plugin/payroll/policy.go:156

  • Add a comment explaining why standard Base64 (with padding) is now required, so future maintainers understand the change and its implications.
	policyBytes, err := base64.StdEncoding.DecodeString(policyDoc.Recipe)

Comment thread plugin/payroll/policy.go

@johnnyluo johnnyluo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@johnnyluo
johnnyluo merged commit 3072c44 into main Jul 2, 2025
3 checks passed
@johnnyluo
johnnyluo deleted the fix/decode-policy branch July 2, 2025 10:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants