|
| 1 | +## Overview |
| 2 | + |
| 3 | +[WatchGuard Firebox][4] is a network security platform offering comprehensive threat protection, including firewall, networking, and other security features, suitable for various network environments, from small offices to large enterprises. |
| 4 | + |
| 5 | +This integration enriches and ingests the following events: |
| 6 | + |
| 7 | +- **Firewall Events**: Represents log messages generated by your Firebox for events that occur on the Firebox and for traffic managed by packet filter policies. In addition to normal traffic, this can include messages related to feature keys, subscription services, server load balancing, and other features configured on your Firebox. |
| 8 | +- **Networking Events**: Represents log messages generated for traffic related to the connections through your Firebox. This can include events related to interface activity, dynamic routing, PPPoE connections, and DHCP server requests. |
| 9 | +- **Management Events**: Represents log messages generated for activity on your Firebox. This includes when changes are made to the device configuration and Device Management user accounts, for user authentication to the Firebox, and actions related to system settings. |
| 10 | +- **VPN Events**: Represents log messages generated for processes related to the all VPNs configured on your Firebox. This includes changes to the VPN configuration, tunnel status, and daemon activity. |
| 11 | +- **Proxy Policy Events**: Represents log messages generated for traffic managed by the proxy policies configured on your Firebox. This can include events related to traffic through the proxy, proxy actions, and security services. |
| 12 | + |
| 13 | +This integration seamlessly collects all the above listed logs, channeling them into Datadog for analysis. Leveraging the built-in logs pipeline, these logs are parsed and enriched, enabling effortless search and analysis. The integration provides insight into firewall, networking, management, VPN, and proxy policy events through the out-of-the-box dashboards. Additionally, it includes ready-to-use Cloud SIEM detection rules for enhanced monitoring and security. |
| 14 | + |
| 15 | +## Setup |
| 16 | + |
| 17 | +### Installation |
| 18 | + |
| 19 | +To install the WatchGuard Firebox integration, run the following Agent installation command and the steps below. For more information, see the [Integration Management][5] documentation. |
| 20 | + |
| 21 | +**Note**: This step is not necessary for Agent version >= 7.66.0. |
| 22 | + |
| 23 | +Linux command: |
| 24 | + |
| 25 | + ```shell |
| 26 | + sudo -u dd-agent -- datadog-agent integration install datadog-watchguard-firebox==1.0.0 |
| 27 | + ``` |
| 28 | + |
| 29 | +### Configuration |
| 30 | + |
| 31 | +#### Log collection |
| 32 | + |
| 33 | +1. Collecting logs is disabled by default in the Datadog Agent. Enable it in `datadog.yaml`: |
| 34 | + |
| 35 | + ```yaml |
| 36 | + logs_enabled: true |
| 37 | + ``` |
| 38 | +
|
| 39 | +2. Add this configuration block to your `watchguard-firebox.d/conf.yaml` file to start collecting your WatchGuard Firebox logs. See the sample [watchguard-firebox.d/conf.yaml][6] for available configuration options. |
| 40 | + |
| 41 | + ```yaml |
| 42 | + logs: |
| 43 | + - type: udp |
| 44 | + port: <PORT> |
| 45 | + service: watchguard-firebox |
| 46 | + source: watchguard-firebox |
| 47 | + ``` |
| 48 | + |
| 49 | + Note: |
| 50 | + - PORT: Port should be identical to the port provided in **Configure Syslog Message Forwarding from WatchGuard Firebox Server**. |
| 51 | + - It is recommended not to change the service and source values, as these parameters are integral to the pipeline's operation. |
| 52 | + |
| 53 | +3. [Restart the Agent][1]. |
| 54 | + |
| 55 | +#### Configure Syslog Message Forwarding from WatchGuard Firebox Server |
| 56 | + |
| 57 | +1. Log in to **Fireware Web UI** with an administrator account. |
| 58 | +2. Select **System** > **Logging**. |
| 59 | +3. Select the **Syslog Server** tab. |
| 60 | +4. Select the **Send log messages to these syslog servers** check box. |
| 61 | +5. Click **Add** to open the Syslog Server dialog box. |
| 62 | +6. In the **IP Address** text box, enter the IP address of the server on which datadog-agent is installed. |
| 63 | +7. In the **Port** text box, enter the port you configured to receive the Firebox logs. |
| 64 | +8. From the **Log Format** drop-down list, select **Syslog**. |
| 65 | +9. Select **The time stamp** and **The serial number of the device** check boxes. |
| 66 | +10. Click **OK**. |
| 67 | + |
| 68 | +### Validation |
| 69 | + |
| 70 | +[Run the Agent's status subcommand][2] and look for `watchguard-firebox` under the Checks section. |
| 71 | + |
| 72 | +## Data Collected |
| 73 | + |
| 74 | +### Logs |
| 75 | + |
| 76 | +The WatchGuard Firebox integration collects firewall, networking, management, VPN, and proxy policy Events. |
| 77 | + |
| 78 | +### Metrics |
| 79 | + |
| 80 | +The WatchGuard Firebox integration does not include any metrics. |
| 81 | + |
| 82 | +### Events |
| 83 | + |
| 84 | +The WatchGuard Firebox integration does not include any events. |
| 85 | + |
| 86 | +## Troubleshooting |
| 87 | + |
| 88 | +### WatchGuard Firebox |
| 89 | + |
| 90 | +**Permission denied while port binding:** |
| 91 | + |
| 92 | +If you see a **Permission denied** error while port binding in the Agent logs, see the following instructions: |
| 93 | + |
| 94 | + 1. Binding to a port number under 1024 requires elevated permissions. Grant access to the port using the `setcap` command: |
| 95 | + |
| 96 | + - Grant access to the port using the `setcap` command: |
| 97 | + |
| 98 | + ```shell |
| 99 | + sudo setcap CAP_NET_BIND_SERVICE=+ep /opt/datadog-agent/bin/agent/agent |
| 100 | + ``` |
| 101 | + |
| 102 | + - Verify the setup is correct by running the `getcap` command: |
| 103 | + |
| 104 | + ```shell |
| 105 | + sudo getcap /opt/datadog-agent/bin/agent/agent |
| 106 | + ``` |
| 107 | + |
| 108 | + With the expected output: |
| 109 | + |
| 110 | + ```shell |
| 111 | + /opt/datadog-agent/bin/agent/agent = cap_net_bind_service+ep |
| 112 | + ``` |
| 113 | + |
| 114 | + **Note**: Re-run this `setcap` command every time you upgrade the Agent. |
| 115 | + |
| 116 | + 2. [Restart the Agent][1]. |
| 117 | + |
| 118 | +**Data is not being collected:** |
| 119 | + |
| 120 | +Make sure that traffic is bypassed from the configured port if the firewall is enabled. |
| 121 | + |
| 122 | +**Port already in use:** |
| 123 | + |
| 124 | +If you see the **Port <PORT_NUMBER> Already in Use** error, see the following instructions. The example below is for a PORT_NUMBER equal to 514: |
| 125 | + |
| 126 | +On systems using Syslog, if the Agent listens for events on port 514, the following error can appear in the Agent logs: `Can't start UDP forwarder on port 514: listen udp :514: bind: address already in use`. |
| 127 | + |
| 128 | +This error occurs because by default, Syslog listens on port 514. To resolve this error, take **one** of the following steps: |
| 129 | + |
| 130 | +- Disable Syslog. |
| 131 | +- Configure the Agent to listen on a different, available port. |
| 132 | + |
| 133 | +For any further assistance, contact [Datadog support][3]. |
| 134 | + |
| 135 | +[1]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent |
| 136 | +[2]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information |
| 137 | +[3]: https://docs.datadoghq.com/help/ |
| 138 | +[4]: https://www.watchguard.com/wgrd-products/network-security |
| 139 | +[5]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install |
| 140 | +[6]: https://github.com/DataDog/integrations-core/blob/master/watchguard-firebox/datadog_checks/watchguard-firebox/data/conf.yaml.example |
0 commit comments