Skip to content
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.

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

Add documentation on mechanisms for node monitoring and protection #1378

Closed
3 tasks done
BigLep opened this issue Sep 10, 2022 · 1 comment · Fixed by libp2p/docs#205, #1421 or #1441
Closed
3 tasks done

Add documentation on mechanisms for node monitoring and protection #1378

BigLep opened this issue Sep 10, 2022 · 1 comment · Fixed by libp2p/docs#205, #1421 or #1441
Assignees
Labels
P0 Critical: Tackled by core team ASAP

Comments

@BigLep
Copy link
Contributor

BigLep commented Sep 10, 2022

Done Criteria

  1. There is an easily discoverable way for a js-libp2p node operator to find the monitoring options available to them
  2. We have a document we can point js-libp2p operators to in defense of or response to various resource exhaustion attacks (DoS, eclipse).

Why Important

  1. These are concepts that are best thought about in advance to prevent successful attacks.
  2. If there is an attack, especially in the heat of battle, every minute reducing response/mitigation times can be significant. Having suggestions/steps prethought outside the fog of war will provide better suggestions in a quicker period of time.

Background

  1. js-libp2p has various mechanisms to protect a node against attacks. We want to make sure users are aware of the mechanisms available to them and that they're thinking about this.
  2. go-libp2p and rust-libp2p used libp2p/docs as the entry point: Guide for how to respond to resource exhaustion attacks docs#153. js-libp2p can follow the same.
  3. These need to get publicly documented in an easily discoverable place.

To-do

@BigLep BigLep added need/triage Needs initial labeling and prioritization and removed need/triage Needs initial labeling and prioritization labels Sep 10, 2022
@BigLep BigLep added this to Weekly Candidates in Maintenance Priorities - JS Sep 10, 2022
@BigLep BigLep added the P0 Critical: Tackled by core team ASAP label Sep 10, 2022
This was linked to pull requests Oct 13, 2022
@BigLep BigLep reopened this Nov 7, 2022
@p-shahi
Copy link
Member

p-shahi commented Dec 10, 2022

This item is completed. Some more docs (doc/LIMITS.md) will be updated as a part of #1508 but not a reason to keep this open

@p-shahi p-shahi closed this as completed Dec 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 Critical: Tackled by core team ASAP
Projects
No open projects
3 participants