Skip to content

Document that LSPS5 services should double-check the destination #4557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tnull merged 1 commit into from
Apr 13, 2026
Merged

Document that LSPS5 services should double-check the destination #4557

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lightning-liquidity/src/lsps5/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ pub enum LSPS5ServiceEvent {
///
/// This is the [`webhook URL`] provided by the client during registration.
///
/// Obviously as the URL provided here is untrusted you should check whether it would
/// access any internal or private resources and decline to send the request if it is.
///
Comment on lines +59 to +61
Copy link
Copy Markdown
Collaborator

@ldk-claude-review-bot ldk-claude-review-bot Apr 13, 2026

Choose a reason for hiding this comment

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

nit: Two small suggestions:

  1. The trailing "if it is" reads awkwardly — consider "if so" or rewording:
Suggested change
/// Obviously as the URL provided here is untrusted you should check whether it would
/// access any internal or private resources and decline to send the request if it is.
///
/// Obviously as the URL provided here is untrusted you should check whether it would
/// access any internal or private resources (SSRF) and decline to send the request if so.
///
  1. This warning is only on the url field doc, which is easy to miss. Consider also adding a brief SSRF note to the variant-level doc block above (around line 35), since that's the first thing developers will read when handling SendWebhookNotification.

/// [`webhook URL`]: super::msgs::LSPS5WebhookUrl
url: LSPS5WebhookUrl,
/// Notification method with its parameters.
Expand Down
Loading