Skip to content

routerrpc: reject payment to invoice that don't have payment secret or blinded paths#9752

Merged
ellemouton merged 3 commits intolightningnetwork:masterfrom
erickcestari:reject-payment-without-invoice
Jun 30, 2025
Merged

routerrpc: reject payment to invoice that don't have payment secret or blinded paths#9752
ellemouton merged 3 commits intolightningnetwork:masterfrom
erickcestari:reject-payment-without-invoice

Conversation

@erickcestari
Copy link
Collaborator

@erickcestari erickcestari commented Apr 22, 2025

This PR introduces the initial phase of enforcing payment secret validation for invoices, as described in issue #9718.

Reject a payment to invoice that don't have a payment secret.

Change Description

Adds validation to extractIntentFromSendRequest to ensure that an invoice includes either a payment address (payment secret) or at least one blinded path when parsing the SendRequest details.

Related to: #9700, #9718

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 22, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch 2 times, most recently from ada4d4e to 69e180c Compare April 22, 2025 17:32
@erickcestari erickcestari marked this pull request as draft April 22, 2025 18:01
@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch 2 times, most recently from 670fca4 to b37fe55 Compare April 22, 2025 18:17
@erickcestari erickcestari changed the title cmd/payments: reject invoices without payment secret or blinded paths routerrpc: reject invoices without payment secret or blinded paths Apr 22, 2025
@erickcestari erickcestari changed the title routerrpc: reject invoices without payment secret or blinded paths routerrpc: reject payment to invoice that don't have payment secret or blinded paths Apr 22, 2025
@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from b37fe55 to bb59d52 Compare April 22, 2025 18:21
@erickcestari erickcestari marked this pull request as ready for review April 22, 2025 18:24
Copy link
Contributor

@MPins MPins left a comment

Choose a reason for hiding this comment

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

Hello @erickcestari, could you please split the commit into two? One for the code changes and another for the documentation. Thanks!

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from bb59d52 to 50cc265 Compare April 24, 2025 14:06
@saubyk saubyk moved this to Medium Priority in PR Review Priority Apr 24, 2025
@saubyk saubyk added payments Related to invoices/payments invoices labels Apr 24, 2025
@saubyk saubyk added this to the v0.20.0 milestone Apr 24, 2025
Copy link
Contributor

@MPins MPins left a comment

Choose a reason for hiding this comment

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

Hi @erickcestari , consider adding a test case to TestExtractIntentFromSendRequest in router_backend_test.go to cover this scenario.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from 50cc265 to 6e7034a Compare May 1, 2025 12:59
Copy link
Contributor

@MPins MPins left a comment

Choose a reason for hiding this comment

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

That’s all from my side.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch 2 times, most recently from 2395167 to 51b1059 Compare May 1, 2025 17:22
@MPins
Copy link
Contributor

MPins commented May 2, 2025

Hello @saubyk it would be nice to have the CI Workflow running for this PR.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from 51b1059 to ca77283 Compare May 13, 2025 11:00
@lightninglabs-deploy
Copy link
Collaborator

@erickcestari, remember to re-request review from reviewers when ready

Copy link
Contributor

@MPins MPins left a comment

Choose a reason for hiding this comment

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

I have just one final comment about the commit message. LGTM 🎉

@saubyk the CI needs approval to run.

@yyforyongyu
Copy link
Member

Approved CI.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from ca77283 to c6abfff Compare May 19, 2025 12:08
Copy link
Contributor

@Abdulkbk Abdulkbk left a comment

Choose a reason for hiding this comment

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

tACK 🎉

@Roasbeef
Copy link
Member

Roasbeef commented Jun 6, 2025

Rebase conflict is preventing CI from running for some reason...

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from 2de5604 to 36675bd Compare June 9, 2025 12:14
@erickcestari
Copy link
Collaborator Author

Rebase conflict is preventing CI from running for some reason...

Rebased

Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

looking good!

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch 3 times, most recently from c5ca026 to 3e7a64c Compare June 10, 2025 20:00
@ziggie1984
Copy link
Collaborator

Needs to update buildroute as well so that we do not allow building a route without a payment_secret:

if len(req.PaymentAddr) != 0 {
var backingPayAddr [32]byte
copy(backingPayAddr[:], req.PaymentAddr)
payAddr = fn.Some(backingPayAddr)
}

@ziggie1984
Copy link
Collaborator

ziggie1984 commented Jun 16, 2025

Missing payment_addr enforcement also for the following RPC calls:

  1. QueryRoutes

  2. SendToRoute

With the restriction on decoding we have to be careful because all our keysend payments inject an invoice with a zero payment_addr into our invoice store, so they do not have a valid payment_addr but we should still be able to decode them.

All those changes can be done in a followup PR as well imo.

@erickcestari
Copy link
Collaborator Author

Needs to update buildroute as well so that we do not allow building a route without a payment_secret:

if len(req.PaymentAddr) != 0 {
var backingPayAddr [32]byte
copy(backingPayAddr[:], req.PaymentAddr)
payAddr = fn.Some(backingPayAddr)
}

Does keysend use the BuildRoute function? If so, requiring a payment_secret would break keysend functionality.

@ziggie1984
Copy link
Collaborator

Does keysend use the BuildRoute function? If so, requiring a payment_secret would break keysend functionality.

No we do not support it:

records: nil,

@ziggie1984
Copy link
Collaborator

But probably all the adoption of RPC should be done in a follow-up. And I am not sure whether we can ever can remove the decoding. Tho I do not see a need to do so anyways. Why not keep the decoding at least available.

@erickcestari
Copy link
Collaborator Author

Yes, I agree. Since keysend relies on invoices with zero payment addresses, phase 2 might be problematic.

  1. Reject decoding invoices that don't have a payment secret.

Maybe we could focus on completing phase 1 across the other payment RPCs first? We might be able to achieve the spec goals through payment validation alone while keeping things working for keysend.

@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch 2 times, most recently from b5d3d43 to d2634a6 Compare June 18, 2025 14:46
Copy link
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

Pending comments, then gtg 🤝

@ziggie1984 ziggie1984 requested a review from ellemouton June 20, 2025 08:54
Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

looks good! one or two style nits

expiry := payReq.Expiry()
validUntil := payReq.Timestamp.Add(expiry)
if time.Now().After(validUntil) {
if clock.Now().After(validUntil) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

niiiiice!

Refactors payment request expiry validation to use an injected clock
dependency instead of calling time.Now() directly.
Ensure that a payment is only sent if the invoice includes either a
payment address (payment secret) or at least one blinded path.
@erickcestari erickcestari force-pushed the reject-payment-without-invoice branch from d2634a6 to 831fefe Compare June 20, 2025 12:23
@ziggie1984 ziggie1984 requested a review from ellemouton June 24, 2025 09:38
Copy link
Collaborator

@ziggie1984 ziggie1984 left a comment

Choose a reason for hiding this comment

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

LGTM 🫡

Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

thanks 🙏 LGTM

@ellemouton ellemouton merged commit e8213db into lightningnetwork:master Jun 30, 2025
38 checks passed
@github-project-automation github-project-automation bot moved this from Medium Priority to High Priority in PR Review Priority Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

invoices payments Related to invoices/payments

Projects

Status: High Priority

Development

Successfully merging this pull request may close these issues.

10 participants