Skip to content

Commit b92528b

Browse files
committedJan 17, 2025··
documentation for workaround for UFW software firewall for Malcolm ISO should automatically open ports for syslog cisagov#560)
1 parent 8115771 commit b92528b

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed
 

‎docs/malcolm-config.md

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Although the configuration script automates many of the following configuration
4343
- The following variables configure Malcolm's ability to [accept syslog](https://www.elastic.co/guide/en/beats/filebeat/current/syslog.html) messages:
4444
+ `FILEBEAT_SYSLOG_TCP_LISTEN` and `FILEBEAT_SYSLOG_UDP_LISTEN` - if set to `true`, Malcolm will accept syslog messages over TCP and/or UDP, respectively
4545
+ `FILEBEAT_SYSLOG_TCP_PORT` and `FILEBEAT_SYSLOG_UDP_PORT` - the port on which Malcolm will accept syslog messages over TCP and/or UDP, respectively
46+
* If Malcolm is running in an instance installed via the [Malcolm installer ISO](malcolm-iso.md#ISO), please see also [ISO-installed Desktop Environment Firewall](third-party-logs.md#SyslogISOFirewall).
4647
+ `FILEBEAT_SYSLOG_TCP_FORMAT` and `FILEBEAT_SYSLOG_UDP_FORMAT` - one of `auto`, `rfc3164`, or `rfc5424`, to specify the allowed format for syslog messages over TCP and/or UDP, respectively (default `auto`)
4748
+ `FILEBEAT_SYSLOG_TCP_MAX_MESSAGE_SIZE` and `FILEBEAT_SYSLOG_UDP_MAX_MESSAGE_SIZE` - defines the maximum message size of the message received over TCP and/or UDP, respectively (default: `10KiB` for UDP, `20MiB` for TCP)
4849
+ `FILEBEAT_SYSLOG_TCP_MAX_CONNECTIONS` - specifies the maximum current number of TCP connections for syslog messages

‎docs/malcolm-hedgehog-e2e-iso-install.md

+1
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@ The [configuration and tuning](malcolm-config.md#ConfigAndTuning) wizard's quest
241241
+ Answer **Y** for Malcolm to accept syslog messages according to the RFC3164 and RFC5424 standards over TCP or UDP.
242242
* **Enter port for syslog over TCP (e.g., 514) or 0 to disable** and **Enter port for syslog over UDP (e.g., 514) or 0 to disable**
243243
- Specify the port numbers on which to accept syslog messages for TCP or UDP, respectively. Other options for configuring how Malcolm accepts and processes syslog messages can be configured via environment variables in [`filebeat.env`](malcolm-config.md#MalcolmConfigEnvVars).
244+
- If Malcolm is running in an instance installed via the [Malcolm installer ISO](malcolm-iso.md#ISO), please see also [ISO-installed Desktop Environment Firewall](third-party-logs.md#SyslogISOFirewall).
244245
* **Enable file extraction with Zeek?**
245246
- Answer **Y** to indicate that Zeek should [extract files](file-scanning.md#ZeekFileExtraction) transfered in observed network traffic.
246247
- **Select file extraction behavior**

‎docs/third-party-logs.md

+13
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The types of third-party logs and metrics discussed in this document are *not* t
2323
- [Convenience Script for Windows](#FluentBitPowerShell)
2424
* [Beats](#Beats)
2525
* [Syslog](#Syslog)
26+
- [ISO-installed Desktop Environment Firewall](#SyslogISOFirewall)
2627
* [Uploading Third-Party Logs](#ThirdPartyUpload)
2728
* [Data Format and Visualization](#Data)
2829
* [Document Indices](#Indices)
@@ -324,6 +325,18 @@ Malcolm can accept [syslog](https://en.wikipedia.org/wiki/Syslog) messages direc
324325

325326
Other options for configuring how Malcolm accepts and processes syslog messages can be configured via environment variables in [`filebeat.env`](malcolm-config.md#MalcolmConfigEnvVars).
326327

328+
329+
### <a name="SyslogISOFirewall"></a>ISO-installed Desktop Environment Firewall
330+
331+
If Malcolm is running in an instance installed via the [Malcolm installer ISO](malcolm-iso.md#ISO), the system's software firewall needs to be manually updated to open the port(s) for Syslog messages. This can be performed via the command line inside a terminal on the Malcolm system, using the port(s) specified during the configuration mentioned above. For example:
332+
333+
```bash
334+
$ sudo ufw allow 514/tcp
335+
Rule added
336+
$ sudo ufw allow 514/udp
337+
Rule added
338+
```
339+
327340
## <a name="ThirdPartyUpload"></a>Uploading Third-Party Logs
328341

329342
### Microsoft Windows Event Logs

0 commit comments

Comments
 (0)
Please sign in to comment.