Version 4.12.1

CERT-Polska · Jan 3, 2025 · 35db2e3 · 35db2e3
1 parent bdeb557
commit 35db2e3
Show file tree

Hide file tree

Showing 9 changed files with 175 additions and 154 deletions.
diff --git a/.n6-version b/.n6-version
@@ -1 +1 @@
-4.12.0
+4.12.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/N6Lib/requirements b/N6Lib/requirements
@@ -30,6 +30,7 @@ pyotp==2.3.0
 PyStemmer==2.0.1
 pystempel==1.2.0
 pytest==7.1.2
+redis==2.10.6
 ruamel.yaml<0.17.22
 unittest_expander==0.4.4
 typing_extensions
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Contact us via e-mail: [n6@cert.pl](mailto:n6@cert.pl).
 
 ## Copyright and License
 
-Copyright (c) 2013-2024
+Copyright (c) 2013-2025
 [Naukowa i Akademicka Sieć Komputerowa (Research and Academic Computer Network)](https://en.nask.pl/).
 All rights reserved.
 

diff --git a/docker/base/deb12/Dockerfile b/docker/base/deb12/Dockerfile
@@ -88,12 +88,12 @@ RUN \
 
 # install libssl1.1.1 and libssl1.1.1-dev
 RUN \
-    wget --no-check-certificate http://ftp.pl.debian.org/debian/pool/main/o/openssl/libssl1.1_1.1.1w-0+deb11u1_amd64.deb; \
-    wget --no-check-certificate http://ftp.pl.debian.org/debian/pool/main/o/openssl/libssl-dev_1.1.1w-0+deb11u1_amd64.deb
+    wget --no-check-certificate http://security.debian.org/debian-security/pool/updates/main/o/openssl/libssl1.1_1.1.1w-0+deb11u2_amd64.deb; \
+    wget --no-check-certificate http://security.debian.org/debian-security/pool/updates/main/o/openssl/libssl-dev_1.1.1w-0+deb11u2_amd64.deb
 
 RUN \
-    dpkg -i libssl1.1_1.1.1w-0+deb11u1_amd64.deb; \
-    dpkg -i libssl-dev_1.1.1w-0+deb11u1_amd64.deb
+    dpkg -i libssl1.1_1.1.1w-0+deb11u2_amd64.deb; \
+    dpkg -i libssl-dev_1.1.1w-0+deb11u2_amd64.deb
 
 RUN \
     # sudo apt-get install libssl-dev && \

diff --git a/docs/src/install_and_conf/docker.md b/docs/src/install_and_conf/docker.md
@@ -13,9 +13,9 @@ latest version of *n6* -- using the _Docker_ and _docker compose_ tools.
 The goal of this guide is to give you an example of how you can run *n6*
 in the easiest possible way, so that you can learn -- by monitoring and
 experimenting -- how the *n6* system works and how you can interact with
-it. Keep in mind that this guide was designed for linux-based systems.
-Even with usage of _Docker_ and _docker compose_ -- we cannot guarantee --
-that it will work on other systems such as Windows or Mac OS.
+it. Keep in mind that this guide was designed for Linux-based systems.
+Even with usage of _Docker_ and _docker compose_, we cannot guarantee
+that it will work on other systems (such as Windows or Mac OS).
 
 
 !!! warning "Disclaimer: what these materials _are_ and what they are _not_"
@@ -66,6 +66,7 @@ docker compose build
 The result of the process are ready-to-use docker images.
 
 !!! tip
+
     Sometimes docker images might not be built correctly due to external factors.
     In case of any errors, try building them once more.
 
@@ -220,7 +221,7 @@ To see the results, restart (or reload) the `apache2` service:
 docker compose exec web apache2ctl restart
 ```
 
-!!! warning "As mentioned in disclaimer"
+!!! warning "As mentioned in the disclaimer"
     This is not a production setup, so it may produce error:
 
     ```
@@ -264,9 +265,9 @@ Then follow the directions in _Multi-Factor Authentication Setup_.
 - URL: [https://localhost/](https://localhost/)
 
 - Credentials to log in:
-  - username: `login@example.com`,
-  - organization: `example.com`,
-  - password: `entered when calling the n6populate_auth_db script`.
+    - username: `login@example.com`,
+    - organization: `example.com`,
+    - password: `entered when calling the n6populate_auth_db script`.
 
 **Mailhog Web GUI:**
 
@@ -278,17 +279,15 @@ Then follow the directions in _Multi-Factor Authentication Setup_.
 **MongoDB Compass / Studio 3T Free - client GUI for MongoDB:**
 
 - Connection:
-
-  - name: any, e.g.: `n6-open`
-  - hostname: `localhost`
-  - port: `27017`
+    - name: any, e.g.: `n6-open`
+    - hostname: `localhost`
+    - port: `27017`
 
 - Authentication:
-
-  - database name: `n6` or `admin`
-  - username: `admin`
-  - password: `password`
-  - auth mechanism: `MONGODB-CR` or `Default` in MongoDB Compass
+    - database name: `n6` or `admin`
+    - username: `admin`
+    - password: `password`
+    - auth mechanism: `MONGODB-CR` or `Default` in MongoDB Compass
 
 ## Working with Docker environment
 
@@ -334,8 +333,9 @@ Some files and directories are worth mentioning -- namely:
   Every collector, parser or other *n6* component will write its logs
   here.
 
-  **The `logs` directory will be lost on every container stop. You can
-  use the Docker's _volumes_ feature to make the directory persistent.**
+!!! note
+    The `logs` directory will be lost on every container stop. You can
+    use the Docker's _volumes_ feature to make the directory persistent.
 
 - the **`supervisord`** directory contains Supervisor-related configuration
   files; the subdirectory **`programs`** contains a list of *n6* components
@@ -407,11 +407,11 @@ and Events will load. If you used different collectors you can also add filters
 
 ## Using REST API
 
-*n6* provide you with REST API, but to use it you need to set your API KEY.
+*n6* provide you with REST API, but to use it you need to set your *API key*.
 
-### Setting API KEY
+### Setting API Key
 
-To set your API KEY follow these steps:
+To set your *API key* follow these steps:
 
 - Log into *n6* Portal.
 - Click the user icon located in the top right corner.
@@ -434,8 +434,9 @@ And you should see some json data.
 
 !!! note
 
-    By default, there is no data available in the REST API. To fetch and view data, you need to run the collector—for example, by executing 
-    `n6collector_certplshield`.
+    Initially, as in the case of Portal, there is no data available via
+    REST API. To fetch and view some data, you need to run a collector
+    -- for example, by executing `n6collector_certplshield`.
 
 ## Shutdown and cleanup
 

diff --git a/docs/src/install_and_conf/opt/knowledge_base/management.md b/docs/src/install_and_conf/opt/knowledge_base/management.md
@@ -104,6 +104,6 @@ To delete article, delete particular markdown files representing article, in eve
 
 For set the right order of the article in given chapter, you need to set the rignt identifier accordingly to your needs. Articles are visible in the table of contents of the _n6_ GUI in accordance with their identifiers (ascending).
 
-### Move the article to the other chapter
+### Move the article to another chapter
 
 To move an article to another chapter, move the article file to the subfolder representing that chapter (in all language branches).
diff --git a/docs/src/install_and_conf/step_by_step/system.md b/docs/src/install_and_conf/step_by_step/system.md
@@ -483,10 +483,10 @@ solution.
 Install `libssl1.1` and `libssl1.1-dev`
 
 ```bash
-$ wget http://ftp.pl.debian.org/debian/pool/main/o/openssl/libssl1.1_1.1.1w-0+deb11u1_amd64.deb
-$ wget http://ftp.pl.debian.org/debian/pool/main/o/openssl/libssl-dev_1.1.1w-0+deb11u1_amd64.deb
-$ sudo dpkg -i libssl1.1_1.1.1w-0+deb11u1_amd64.deb
-$ sudo dpkg -i libssl-dev_1.1.1w-0+deb11u1_amd64.deb
+$ wget http://security.debian.org/debian-security/pool/updates/main/o/openssl/libssl1.1_1.1.1w-0+deb11u2_amd64.deb
+$ wget http://security.debian.org/debian-security/pool/updates/main/o/openssl/libssl-dev_1.1.1w-0+deb11u2_amd64.deb
+$ sudo dpkg -i libssl1.1_1.1.1w-0+deb11u2_amd64.deb
+$ sudo dpkg -i libssl-dev_1.1.1w-0+deb11u2_amd64.deb
 $ rm -i libssl1.1_1.1.1w-0+deb11u1_amd64.deb
 $ rm -i libssl-dev_1.1.1w-0+deb11u1_amd64.deb
 ```

diff --git a/docs/src/usage/restapi.md b/docs/src/usage/restapi.md
@@ -531,7 +531,7 @@ multiple values* of a parameter are allowed).
 
 ## API Changelog
 
-### **4.12.0** – 2024-12-23
+### **4.12.0** (2024-12-23)
 
 After this release of *n6*, any changes to *n6 REST API* will be
 recorded in this section (in addition to being included in the main