Skip to content

macaroons: ip range constraint#9546

Merged
guggero merged 4 commits into
lightningnetwork:masterfrom
hieblmi:macaroon-ip-cidr-constraint
Mar 14, 2025
Merged

macaroons: ip range constraint#9546
guggero merged 4 commits into
lightningnetwork:masterfrom
hieblmi:macaroon-ip-cidr-constraint

Conversation

@hieblmi
Copy link
Copy Markdown
Collaborator

@hieblmi hieblmi commented Feb 24, 2025

Upon user request this PR aims to add an ip_range flag to lncli constrainmacaroon subcommand.

The user intention is to constrain access to a resource to a certain IP range. Currently, only specific IPs can be tied to access resources via a macaroon.

@hieblmi hieblmi marked this pull request as draft February 24, 2025 12:12
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 24, 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.
    • 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 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 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 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 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.

@hieblmi hieblmi force-pushed the macaroon-ip-cidr-constraint branch from 0b78ea0 to b6ecf4d Compare March 7, 2025 09:03
@hieblmi hieblmi marked this pull request as ready for review March 7, 2025 09:03
@hieblmi hieblmi self-assigned this Mar 7, 2025
@hieblmi hieblmi requested a review from guggero March 7, 2025 09:15
@hieblmi hieblmi force-pushed the macaroon-ip-cidr-constraint branch from b6ecf4d to ae12030 Compare March 7, 2025 09:57
Copy link
Copy Markdown
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Very nice feature! LGTM 🎉

Comment thread macaroons/constraints.go
Comment thread macaroons/constraints.go Outdated
Comment thread macaroons/constraints.go Outdated
Comment thread macaroons/constraints.go Outdated
Comment thread itest/lnd_macaroons_test.go Outdated
@hieblmi hieblmi force-pushed the macaroon-ip-cidr-constraint branch 2 times, most recently from 263d9db to f36dc2d Compare March 11, 2025 15:47
@hieblmi
Copy link
Copy Markdown
Collaborator Author

hieblmi commented Mar 11, 2025

Thanks for the review @guggero, I've addressed all your comments.

Comment thread macaroons/constraints.go Outdated
Comment thread macaroons/constraints.go
Comment thread cmd/commands/cmd_macaroon.go Outdated
@yyforyongyu yyforyongyu self-requested a review March 11, 2025 16:59
@hieblmi hieblmi force-pushed the macaroon-ip-cidr-constraint branch from f36dc2d to dca2eb2 Compare March 12, 2025 14:24
Copy link
Copy Markdown
Member

@yyforyongyu yyforyongyu 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, just need to fix the linter.

Comment thread macaroons/constraints.go Outdated
// check.
pr, ok := peer.FromContext(ctx)
if !ok {
return fmt.Errorf("unable to get peer info from " +
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: use errors.New to avoid some bot-created PRs in the future to change it again 😂

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

fixed

Comment thread macaroons/constraints.go Outdated

if !ipNet.Contains(net.ParseIP(peerAddr)) {
msg := "macaroon locked to different IP range"
return fmt.Errorf(msg)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: same here re errors.New

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

fixed

@hieblmi hieblmi force-pushed the macaroon-ip-cidr-constraint branch from dca2eb2 to bef0268 Compare March 13, 2025 14:57
@hieblmi hieblmi requested a review from yyforyongyu March 13, 2025 14:58
Copy link
Copy Markdown
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

LGTM👍 Confirmed the CI failure is a flake fixed in #9600

@saubyk saubyk added this to the v0.19.0 milestone Mar 14, 2025
@saubyk saubyk added this to lnd v0.19 Mar 14, 2025
@saubyk saubyk moved this to In Progress in lnd v0.19 Mar 14, 2025
@guggero guggero merged commit 053d63e into lightningnetwork:master Mar 14, 2025
@github-project-automation github-project-automation Bot moved this from In Progress to Done in lnd v0.19 Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants