Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2020-08-12 01:46:25 +0300
committerJames M Snell <jasnell@gmail.com>2020-08-17 21:31:28 +0300
commitc855c3e8ca5142e7b7f4a4e6adbf43e0ab18439b (patch)
tree3d39e98cea119b63c3a804df26db6ed2fc1adf9b /doc/api/quic.md
parent1c14810edc68cc460d32da80fc52284c079d20ff (diff)
quic: use net.BlockList for limiting access to a QuicSocket
PR-URL: https://github.com/nodejs/node/pull/34741 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/quic.md')
-rw-r--r--doc/api/quic.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/quic.md b/doc/api/quic.md
index 84484357b72..486c8ee6d68 100644
--- a/doc/api/quic.md
+++ b/doc/api/quic.md
@@ -1445,6 +1445,24 @@ error will be thrown if `quicsock.addEndpoint()` is called either after
the `QuicSocket` has already started binding to the local ports, or after
the `QuicSocket` has been destroyed.
+#### `quicsocket.blockList`
+<!-- YAML
+added: REPLACEME
+-->
+
+* Type: {net.BlockList}
+
+A {net.BlockList} instance used to define rules for remote IPv4 or IPv6
+addresses that this `QuicSocket` is not permitted to interact with. The
+rules can be specified as either specific individual addresses, ranges
+of addresses, or CIDR subnet ranges.
+
+When listening as a server, if a packet is received from a blocked address,
+the packet will be ignored.
+
+When connecting as a client, if the remote IP address is blocked, the
+connection attempt will be rejected.
+
#### `quicsocket.bound`
<!-- YAML
added: REPLACEME