Skip to content

Commit

Permalink
Threat shield doc (#475)
Browse files Browse the repository at this point in the history
* Add nethserver-blacklist chapter

Co-authored-by: Andrea Leardini <andre8244@gmail.com>
Co-authored-by: Filippo Carletti <filippo.carletti@gmail.com>
  • Loading branch information
3 people committed Mar 6, 2020
1 parent 4e89646 commit e3d88e0
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 1 deletion.
9 changes: 8 additions & 1 deletion administrator-manual/en/.tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -422,8 +422,15 @@ source_file = _build/locale/launcher.pot
source_lang = en
type = PO


[docs-v7.blacklist]
file_filter = locale/<lang>/LC_MESSAGES/blacklist.po
source_file = _build/locale/blacklist.pot
source_lang = en
type = PO

[docs-v7.mssql]
file_filter = locale/<lang>/LC_MESSAGES/mssql.po
source_file = _build/locale/mssql.pot
source_lang = en
type = PO
type = PO
47 changes: 47 additions & 0 deletions administrator-manual/en/blacklist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
=============
Threat shield
=============

.. note::

The configuration page of this module is available only in the new Server Manager.


The threat shield blocks connections to and from malicious hosts, preventing attacks, service abuse, malware, and other cybercrime activities.
The package can be installed both on firewalls and on machines without a red interface, like mail servers
or PBXs.

Configuration
=============

First, access the threat shield web interface to set the download URL for the blacklists.

After setting the URL, the administrator can choose what :index:`blacklist` categories should be enabled.
Each category can have a :guilabel:`Confidence` score between 0 and 10.
Categories with a higher confidence are less prone to false positives.

Enabled categories will be automatically updated at regular intervals.

The download URL must contain a valid GIT repository.
Administrators can choose a public repository, like `Firehol ipsets one <https://github.com/firehol/blocklist-ipsets>`_,
or subscribe to a commercial service. If the machine has a Community or an Enterprise subscription, the access to the URL
will be authenticated using system id and secret.

Experienced administrators can also `setup their own blacklist server <https://docs.nethserver.org/projects/nethserver-devel/en/latest/nethserver-blacklist.html#setup-a-blacklist-server>`_.

Whitelist
---------

In case of a false positive, a host or a CIDR can be added to the local :guilabel:`Whitelist`.
If the firewall module is installed, the whitelist will also accept host and CIDR firewall objects.

Hosts should be added to the whitelist only for a limited period of time.
As a best pratice, when a false positive is found, please report it to the blacklist maintainer.

Incident response
=================

The :guilabel:`Analysis` page displays most recent attacks which can be filtered by source, destination, protocol and port.
Using the :guilabel:`Check IP address` section, administrators can also check if a given IP has been blacklisted by an enabled category.

For advanced log analysis with regular expressions support, use the :guilabel:`Logs` page.
1 change: 1 addition & 0 deletions administrator-manual/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Administrator Manual
fail2ban
rspamd
antivirus
blacklist

.. toctree::
:hidden:
Expand Down

0 comments on commit e3d88e0

Please sign in to comment.