feat: introduce `libp2p-allow-block-list` connection management module #3590

thomaseizinger · 2023-03-11T15:49:07Z

Description

Currently, banning peers is a first-class feature of Swarm. With the new connection management capabilities of NetworkBehaviour, we can now implement allow and block lists as a separate module.

We introduce a new crate libp2p-allow-block-list and deprecate Swarm::ban_peer_id in favor of that.

Related #2824.

Notes & open questions

Change checklist

I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
A changelog entry has been made in the appropriate crates

mergify · 2023-03-12T14:50:17Z

This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏

mxinden

Very neat implementation! Minor comments.

libp2p/Cargo.toml

misc/allow-block-list/src/lib.rs

thomaseizinger · 2023-03-15T11:06:11Z

#3547 was such a good idea. The amount of times this job has failed on me is insane 😂

thomaseizinger · 2023-03-18T10:53:04Z

Depends-On: #3615.

No sure why this isn't working (mergify tried to merge anyway) but this PR is already using the "new" changelog convention so I'd like to get that approved and merged first.

thomaseizinger · 2023-03-21T14:16:05Z

I am removing the dependency on #3615. Based on #3386 (comment), I am assuming that @mxinden is in favor of the new changelog syntax so I am using this here and we can iterate on the exact wording in #3615 after that.

thomaseizinger · 2023-03-21T14:16:25Z

@Mergifyio refresh

mergify · 2023-03-21T14:16:32Z

refresh

✅ Pull request refreshed

mergify · 2023-03-21T15:11:04Z

This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏

…824-blocklist

mergify · 2023-03-21T17:54:44Z

This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏

mxinden · 2023-03-21T18:12:33Z

👍 for going ahead with the new changelog format.

mergify · 2023-03-21T19:33:08Z

This pull request has merge conflicts. Could you please resolve them @thomaseizinger? 🙏

thomaseizinger · 2023-03-21T20:42:45Z

I've resolved 3 merge conflicts on this branch in last hours that are only related to CHANGELOG.md. Even though the semver aspect of https://github.com/thomaseizinger/semverlog isn't as compelling anymore with our strategy of holding back breaking changes, not having to merge changelog files would be nice.

bajtos · 2023-04-13T10:22:54Z

@thomaseizinger @mxinden After upgrading Zinnia from libp2p 0.51.1 to 0.51.3, I am getting a compiler warning about using a deprecated type SwarmEvent::BannedPeer, which is expected.

However, when I remove this deprecated arm from the match statement, I get a compiler error:

non-exhaustive patterns: `SwarmEvent::BannedPeer { .. }` not covered

I fixed the problem by adding #[allow(deprecated)] to the BannedPeer arm, but it feels like it's defeating the point of deprecating this enum variant.

This is not a big deal, as I am not using peer banning. I just wanted to share my experience as a libp2p consumer in case it's useful.

thomaseizinger · 2023-04-13T10:51:25Z

Thank you!

Yes, that is an unfortunate issue with deprecating enum variants. You can use a _ match arm to silence the deprecation and not receive a compile error once we remove it!

divagant-martian

A couple of questions since we do use this feature

divagant-martian · 2023-04-13T18:22:33Z

misc/allow-block-list/src/lib.rs

+    ///
+    /// All active connections to this peer will be closed immediately.
+    pub fn disallow_peer(&mut self, peer: PeerId) {
+        self.state.peers.insert(peer);


ok commenting on the original PR: It looks to me like this should be a remove?

divagant-martian · 2023-04-13T18:22:45Z

misc/allow-block-list/src/lib.rs

+
+    /// Unblock connections to a given peer.
+    pub fn unblock_peer(&mut self, peer: PeerId) {
+        self.state.peers.insert(peer);


thomaseizinger · 2023-04-13T21:33:22Z

A couple of questions since we do use this feature

Correct on both occasions, sorry for the oversight and thanks for the in-depth review!

thomaseizinger · 2023-04-13T21:42:19Z

Submitted a bugfix here: #3789

thomaseizinger added 2 commits March 11, 2023 16:41

Add allow-block list

03fbd26

Deprecate Swarm::ban_peer_id

f835520

thomaseizinger requested review from jxs and mxinden March 11, 2023 15:49

thomaseizinger added 4 commits March 11, 2023 16:49

Fill in PR number into changelog

58c1644

Remove unnecessary dev dependencies

b6c4909

Add since to deprecation attributes

33627ef

Update cargo lock

1874666

thomaseizinger added 2 commits March 12, 2023 21:38

Merge branch 'master' into 2824-blocklist

c660a8c

Fix deprecation warnings

51e4885

mxinden approved these changes Mar 14, 2023

View reviewed changes

libp2p/Cargo.toml Show resolved Hide resolved

misc/allow-block-list/src/lib.rs Show resolved Hide resolved

thomaseizinger added 2 commits March 15, 2023 11:28

Bump version of libp2p and add changelog entry

22d37f9

Update docs and bump manifest version

ed73185

thomaseizinger requested a review from mxinden March 15, 2023 11:05

thomaseizinger added 2 commits March 15, 2023 13:44

Revert type aliases

f3f1938

Improve docs

53db464

mxinden approved these changes Mar 15, 2023

View reviewed changes

Fix doc tests

422259e

thomaseizinger mentioned this pull request Mar 18, 2023

upgrade to Libp2p 0.52 sigp/lighthouse#4087

Closed

thomaseizinger added the send-it label Mar 18, 2023

Merge branch 'master' into 2824-blocklist

6c96821

thomaseizinger removed the send-it label Mar 18, 2023

thomaseizinger added the send-it label Mar 21, 2023

thomaseizinger added 2 commits March 21, 2023 18:33

Merge branch 'master' into 2824-blocklist

4260be0

Merge branch '2824-blocklist' of github.com:libp2p/rust-libp2p into 2…

87445cd

…824-blocklist

Merge branch 'master' into 2824-blocklist

db0cc38

Merge branch 'master' into 2824-blocklist

4bfede9

mergify bot merged commit f641870 into master Mar 21, 2023

mergify bot deleted the 2824-blocklist branch March 21, 2023 20:58

thomaseizinger mentioned this pull request Mar 22, 2023

*: Automate various parts of the release process #2902

Closed

divagant-martian reviewed Apr 13, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: introduce `libp2p-allow-block-list` connection management module #3590

feat: introduce `libp2p-allow-block-list` connection management module #3590

thomaseizinger commented Mar 11, 2023 •

edited

Loading

mergify bot commented Mar 12, 2023

mxinden left a comment

thomaseizinger commented Mar 15, 2023

thomaseizinger commented Mar 18, 2023 •

edited

Loading

thomaseizinger commented Mar 21, 2023

thomaseizinger commented Mar 21, 2023

mergify bot commented Mar 21, 2023

mergify bot commented Mar 21, 2023

mergify bot commented Mar 21, 2023

mxinden commented Mar 21, 2023

mergify bot commented Mar 21, 2023

thomaseizinger commented Mar 21, 2023 •

edited

Loading

bajtos commented Apr 13, 2023

thomaseizinger commented Apr 13, 2023

divagant-martian left a comment

divagant-martian Apr 13, 2023

divagant-martian Apr 13, 2023

thomaseizinger commented Apr 13, 2023

thomaseizinger commented Apr 13, 2023

feat: introduce libp2p-allow-block-list connection management module #3590

feat: introduce libp2p-allow-block-list connection management module #3590

Conversation

thomaseizinger commented Mar 11, 2023 • edited Loading

Description

Notes & open questions

Change checklist

mergify bot commented Mar 12, 2023

mxinden left a comment

Choose a reason for hiding this comment

thomaseizinger commented Mar 15, 2023

thomaseizinger commented Mar 18, 2023 • edited Loading

thomaseizinger commented Mar 21, 2023

thomaseizinger commented Mar 21, 2023

mergify bot commented Mar 21, 2023

✅ Pull request refreshed

mergify bot commented Mar 21, 2023

mergify bot commented Mar 21, 2023

mxinden commented Mar 21, 2023

mergify bot commented Mar 21, 2023

thomaseizinger commented Mar 21, 2023 • edited Loading

bajtos commented Apr 13, 2023

thomaseizinger commented Apr 13, 2023

divagant-martian left a comment

Choose a reason for hiding this comment

divagant-martian Apr 13, 2023

Choose a reason for hiding this comment

divagant-martian Apr 13, 2023

Choose a reason for hiding this comment

thomaseizinger commented Apr 13, 2023

thomaseizinger commented Apr 13, 2023

feat: introduce `libp2p-allow-block-list` connection management module #3590

feat: introduce `libp2p-allow-block-list` connection management module #3590

thomaseizinger commented Mar 11, 2023 •

edited

Loading

thomaseizinger commented Mar 18, 2023 •

edited

Loading

thomaseizinger commented Mar 21, 2023 •

edited

Loading