Validate P2P bytes before serializing multiaddrs - #460
Open
Officeyutong wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enforces Protocol::P2P byte invariants at serialization time so that Multiaddr construction APIs (from, push, FromIterator) can’t produce internally invalid multiaddrs that may later panic during iteration/display.
Changes:
- Add
Protocol::P2Pvalidation (check_p2p) insideProtocol::write_to_bytesbefore encoding into a multiaddr. - Add regression tests asserting invalid
Protocol::P2Pbytes are rejected (panic) viaMultiaddr::from,push, andcollect. - Add a positive regression test confirming valid P2P construction paths continue to work.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| multiaddr/src/protocol.rs | Validates Protocol::P2P bytes before encoding, preventing invalid Multiaddr byte representations from being created via serialization. |
| multiaddr/tests/lib.rs | Adds regression coverage for invalid/valid P2P behavior across key construction APIs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Protocol::P2Pbytes before writing them into aMultiaddrMultiaddr::from,push, andFromIteratorRationale
Protocol::P2Pis publicly constructible from raw bytes. Parsers already validate P2P bytes, but construction paths serialized them directly, allowing invalid internalMultiaddrvalues that could later panic during iteration or display.This keeps the existing API shape while enforcing the same P2P invariant at serialization time.
Tests
cargo fmt --checkcargo test -p tentacle-multiaddr -- --nocapture