25 lines
1.4 KiB
Markdown
25 lines
1.4 KiB
Markdown
|
## Client Blacklisting/Whitelisting Middlewares
|
||
|
|
|
||
|
|
This package provides the announce middlewares `client_whitelist` and `client_blacklist` for blacklisting or whitelisting clients for announces.
|
||
|
|
|
||
|
|
### `client_blacklist`
|
||
|
|
|
||
|
|
The `client_blacklist` middleware uses all clientIDs stored in the `ClientStore` to blacklist, i.e. block announces.
|
||
|
|
|
||
|
|
The clientID part of the peerID of an announce is matched against the `ClientStore`, if it's contained within the `ClientStore`, the announce is aborted.
|
||
|
|
|
||
|
|
### `client_whitelist`
|
||
|
|
|
||
|
|
The `client_whitelist` middleware uses all clientIDs stored in the `ClientStore` to whitelist, i.e. allow announces.
|
||
|
|
|
||
|
|
The clientID part of the peerID of an announce is matched against the `ClientStore`, if it's _not_ contained within the `ClientStore`, the announce is aborted.
|
||
|
|
|
||
|
|
### Important things to notice
|
||
|
|
|
||
|
|
Both middlewares operate on announce requests only.
|
||
|
|
|
||
|
|
Both middlewares use the same `ClientStore`.
|
||
|
|
It is therefore not advised to have both the `client_blacklist` and the `client_whitelist` middleware running.
|
||
|
|
(If you add clientID to the `ClientStore`, it will be used for blacklisting and whitelisting.
|
||
|
|
If your store contains no clientIDs, no announces will be blocked by the blacklist, but all announces will be blocked by the whitelist.
|
||
|
|
If your store contains all clientIDs, no announces will be blocked by the whitelist, but all announces will be blocked by the blacklist.)
|