From 7026189ddf5ead6cef8c8de1eb5c632f15cccdb4 Mon Sep 17 00:00:00 2001 From: nttoole Date: Fri, 30 Aug 2024 12:21:09 -0700 Subject: [PATCH 1/2] Issue #531 - Add Security notes to the server documentation --- doc/source/server_architecture.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/source/server_architecture.rst b/doc/source/server_architecture.rst index 895d1ef1..237da1c2 100644 --- a/doc/source/server_architecture.rst +++ b/doc/source/server_architecture.rst @@ -192,3 +192,31 @@ Here is an example of how the **server** portion of **config.yaml** should look: - command_flightlike_stream output: - 3075 + + + +Notes on Security +----------------- + +AIT provides a light-weight implementation and configuration to make installation and setup straightforward for new users. +However, there are real-world security considerations that projects should take into account as part of their adaptation. +While many concerns are general, actual implementation details are expected to vary per project. +As such, those specifics should be discussed with your security and operations teams. + + +Network Security +^^^^^^^^^^^^^^^^ + +AIT uses ZeroMQ as the underlying messaging library with no security mechanisms enabled by default. +While ZeroMQ port-based input streams are supported, we recommend that adaptations not expose unprotected ports. Instead consider alternate mechanisms, such as Plugins or network service, which publish messages to ZeroMQ. +For further protection that includes authentication and encryption, we recommend utilizing CurveZMQ (http://curvezmq.org/), which provides security protocols for ZeroMQ. + + +Configuration Security +^^^^^^^^^^^^^^^^^^^^^^ + +AIT uses configurations files that provide details for telemetry, commands, databases, and much more. +These configuration files, if left unsecured, could provide an entry point for bad-actors to introduce exploits. +As such, we highly recommend that all configuration files and working directories be secured from unauthorized edits or replacement. + + From e7d905bf6968963090f3d13bed76949f650739e2 Mon Sep 17 00:00:00 2001 From: nttoole Date: Wed, 4 Sep 2024 10:08:16 -0700 Subject: [PATCH 2/2] Minor tweak to last sentence --- doc/source/server_architecture.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/server_architecture.rst b/doc/source/server_architecture.rst index 237da1c2..0e4ec583 100644 --- a/doc/source/server_architecture.rst +++ b/doc/source/server_architecture.rst @@ -217,6 +217,6 @@ Configuration Security AIT uses configurations files that provide details for telemetry, commands, databases, and much more. These configuration files, if left unsecured, could provide an entry point for bad-actors to introduce exploits. -As such, we highly recommend that all configuration files and working directories be secured from unauthorized edits or replacement. +As such, we highly recommend that all configuration files and working directories be secured from unauthorized edits or replacement via ownership and access controls.