Skip to content

Conversation

erickcestari
Copy link
Contributor

I was doing differential fuzzing on lightning P2P messages and noticed that LND doesn't verify
if the length of SCID TLV is correct or not causing it to parse messages with wrong TLV encoding.

This PR strengthens TLV decoding across multiple components by enforcing strict length checks
and adding corresponding tests.

lnwire

  • ShortChannelID: decoder now validates l == 8.
  • Fee: decoder now validates l == 8.
  • Musig2Nonce: decoder now validates l == musig2.PubNonceSize.
  • Added tests for invalid lengths in SCID, Fee, and Musig2Nonce TLVs.

tlv

  • DBytes33: now enforces l == 33.
  • Added a generic test suite ensuring all fixed-size primitive decoders reject incorrect lengths.

routing/route

  • Vertex: decoder now validates l == VertexSize.
  • Added tests for valid encode/decode and invalid-length rejection.

Note: 10 commits for this might be too much for these changes. Let me know if I should squash into a multi commit.

Copy link

Summary of Changes

Hello @erickcestari, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the robustness of the system's TLV (Type-Length-Value) decoding mechanisms. By introducing strict length validation across several critical components, including ShortChannelID, Fee, Musig2Nonce, DBytes33, and Vertex, the changes prevent the parsing of malformed messages that could lead to unexpected behavior or vulnerabilities. The update also includes extensive new tests to confirm these validations are correctly applied, ensuring data integrity and protocol compliance.

Highlights

  • Strict TLV Length Validation: Implemented strict length checks for ShortChannelID, Fee, and Musig2Nonce decoders within the lnwire package, ensuring that only correctly sized TLV values are parsed.
  • tlv.DBytes33 Enforcement: The DBytes33 decoder in the tlv package now explicitly enforces a length of 33 bytes for [33]byte types.
  • routing/route.Vertex Validation: The Vertex decoder in the routing/route package now validates its TLV length against VertexSize.
  • Comprehensive Test Coverage: New tests have been added across lnwire, tlv, and routing/route packages to specifically verify that decoders correctly reject TLV values with invalid lengths, improving robustness against malformed messages.
  • Generic Primitive Decoder Testing: A generic test suite was introduced in tlv/primitive_test.go to ensure all fixed-size primitive decoders fail gracefully when presented with incorrect TLV lengths.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request strengthens TLV decoding by enforcing strict length validation across several components, which is a great improvement for the robustness and security of the P2P message parsing. The changes are logical and well-implemented. You've also added comprehensive tests to cover these new validation rules. My feedback is minor and focuses on improving the clarity and cleanliness of the new test code, such as removing a debug print statement and correcting some copy-pasted comments and variable names, to better align with the repository's style guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant