Skip to content

Commit

Permalink
Updated dashboard, readme and conf.yaml file.
Browse files Browse the repository at this point in the history
  • Loading branch information
madhavpandya-cds committed Oct 8, 2024
1 parent f2faa60 commit 94550c7
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 48 deletions.
57 changes: 33 additions & 24 deletions cisco_secure_web_appliance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This integration ingests the following types of logs:
- L4TM Logs: This records all Layer-4 Traffic Monitor activity.

Out-of-the-box dashboards help you to visualize detailed insights into Web Proxy filtering and scanning activity and Layer-4 Traffic Monitor activity. Additionally, out-of-the-box detection rules are available to help you monitor and respond to potential security threats effectively.
**Disclaimer**: Your use of this integration, which may collect data that includes personal information, is subject to your agreements with Datadog. Cisco is not responsible for the privacy, security or integrity of any end-user information, including personal data, transmitted through your use of the integration.

## Setup

Expand Down Expand Up @@ -58,6 +59,7 @@ L4TM Logs can only be collected by file monitoring using SCP on Remote Server as
service: access_logs
source: cisco-secure-web-appliance
```
**NOTE**: Please make sure that `path` value should be similar to the Directory configured in `Configure SCP on Remote Server for L4TM Logs` and `Configure SCP on Remote Server for Access Logs` section respectively, forwarding /*.s

4. [Restart the Agent][3].

Expand Down Expand Up @@ -89,16 +91,28 @@ L4TM Logs can only be collected by file monitoring using SCP on Remote Server as
3. [Restart the Agent][3].
### Configuration on Cisco Secure Web Appliance portal
#### Steps to configure Syslog Push for Access Logs:
#### Steps to set time zone to GMT
Datadog expects all the logs in GMT time zone by default. Please make sure that timezone configured in your Cisco Secure Web Appliance portal must be in GMT. Here are the steps to change the timzone:
1. Go to **System Administration**, and then **Time Zone**.
2. Click on **Edit Settings**.
3. Select **GMT Offset** as the region.
4. Select **GMT** as the country.
5. Select **GMT (GMT)** as the time zone.
6. Submit and commit the changes.
#### Configure Log Subscriptions
#### Configure Syslog Push for Access Logs:
**Prerequisites:**
- The datadog-agent server hostname where you want to push the logs.
**Configuration:**
1. Log in to Cisco Secure Web Appliance UI.
2. Navigate to System Administration -> Log Subscriptions.
2. Navigate to **System Administration -> Log Subscriptions**.
3. In order to add Access Logs subscription, click on the **Add Log Subscription** button.
4. Select Log Type as Access Logs.
5. Provide Log Name.
Expand Down Expand Up @@ -126,8 +140,8 @@ L4TM Logs can only be collected by file monitoring using SCP on Remote Server as
1. Requires hostname and username (admin account username is not necessary) of VM/machine on which datadog-agent is installed.
**Configuration:**
1. Navigate to System Administration -> Log Subscriptions in Cisco Secure Web Appliance UI.
2. To add a log subscription for Traffic Monitor Logs, click on Add `Log Subscription`.
1. Navigate to **System Administration -> Log Subscriptions** in Cisco Secure Web Appliance UI.
2. To add a log subscription for Traffic Monitor Logs, click on Add **Log Subscription**.
3. Select Traffic Monitor Logs as Log Type.
4. Provide appropriate Log Name.
5. For FileName, provide a new name or keep the default added name.
Expand All @@ -137,54 +151,48 @@ L4TM Logs can only be collected by file monitoring using SCP on Remote Server as
SCP Host: \<SCP Host IP Address>
Directory: \<Path to Directory Where Logs would Get Stored>
**NOTE:** Make sure that Directory does not have any other log files.
SCP Port: \<Default Port>
Username: \<SCP Host Username>
8. Click on Submit. After submitting, SSH key(s) will get generated. Copy and save both the SSH key(s) as it is only visible once.
9. Place the given SSH key(s) into your `authorized_keys` file on the remote host so that the log files can be uploaded.
10. Click on Commit Changes at top right-side of Log Subscriptions Page.
**NOTE:** These changes will not go into effect until you commit them.
#### Steps to configure SCP on Remote Server for Access Logs.
#### Configure SCP on Remote Server for Access Logs.
**Prerequisites:**
1. Requires hostname and username (admin account username is not necessary) of VM/machine on which datadog-agent is installed.
**Configuration:**
1. In the Cisco Secure Web Appliance UI, go to System Administration, and then Log Subscriptions.
2. To add a new log subscription for Access Logs, click **Add Log Subscription** or edit an existing Access Logs Subscription.
3. If you are adding a new subscription, then follow steps 4 to 6 mentioned in the Syslog Push for Access Logs section.
3. If you are adding a new subscription, then follow steps 4 to 6 mentioned in the `Configure Syslog Push for Access Logs` section.
4. If you are editing an existing Access Logs Subscription, select SCP on the Remote Server as the Retrieval Method.
5. Provide following information:
SCP Host: \<SCP Hostname>
SCP Port: \<Default Provided>
Directory: \<Path to store the Log Files>
**Note:** Make sure that Directory does not have any other log files.
10. Username: \<SCP Server Username>
11. Click **Submit**. Once you click **Submit**, SSH key(s) are generated. Copy the SSH Key and save it somewhere as this will be only displayed once.
12. Place the given SSH key(s) into your `authorized_keys` file on the remote host so that the log files can be uploaded.
13. Click **Commit Changes** at top right of Log Subscriptions Page.
Username: \<SCP Server Username>
6. Click **Submit**. Once you click **Submit**, SSH key(s) are generated. Copy the SSH Key and save it somewhere as this will be only displayed once.
7. Place the given SSH key(s) into your `authorized_keys` file on the remote host so that the log files can be uploaded.
8. Click **Commit Changes** at top right of Log Subscriptions Page.
**Note:** These changes do not go into effect until you commit them.
#### Steps to set time zone to GMT in Cisco Secure Web Appliance
Datadog expects all the logs in GMT time zone by default. If the time zone of your Cisco Secure Web Appliance logs is not GMT, please change it to GMT. Here are the steps:
1. Go to **System Administration**, and then **Time Zone**.
2. Click on **Edit Settings**.
3. Select **GMT Offset** as the region.
4. Select **GMT** as the country.
5. Select **GMT (GMT)** as the time zone.
6. Submit and commit the changes.
##### For more information, Visit this [Cisco Secure Web Appliance official documentation for configuration][8]
### Validation
[Run the Agent's status subcommand][6] and look for `cisco-secure-web-appliance` under the Checks section.
[Run the Agent's status subcommand][6] and look for `cisco_secure_web_appliance` under the Checks section.

## Data Collected

Expand Down Expand Up @@ -265,4 +273,5 @@ For any further assistance, contact [Datadog support][1].
[4]: https://www.cisco.com/site/in/en/products/security/secure-web-appliance/index.html
[5]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[7]: https://github.com/DataDog/integrations-core/blob/master/cisco_secure_web_appliance/datadog_checks/cisco_secure_web_appliance/data/conf.yaml.example
[7]: https://github.com/DataDog/integrations-core/blob/master/cisco_secure_web_appliance/datadog_checks/cisco_secure_web_appliance/data/conf.yaml.example
[8]: https://www.cisco.com/c/en/us/td/docs/security/wsa/wsa-14-5/user-guide/wsa-userguide-14-5/b_WSA_UserGuide_11_7_chapter_010101.html#task_1686002
11 changes: 8 additions & 3 deletions cisco_secure_web_appliance/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,18 @@ files:
1. File Monitoring
- If you want to monitor CSWA logs (access_logs and l4tm_logs) using file monitoring then use type:file stanza.
2. Syslog
- If you want to monitor CSWA logs using syslog (access_logs) then use type:tcp stanza.
- If you want to monitor CSWA logs using syslog (access_logs) then use type:udp stanza.
example:
- type: file
path: /var/log/named/*.log
path: <Path to Directory Where L4TM would Get Stored>
service: l4tm_logs
source: cisco-secure-web-appliance
- type: udp
port: <PORT>s
port: <PORT>
service: access_logs
source: cisco-secure-web-appliance
## example stanza of access log file monitoring
# - type: file
# port: <Path to Directory Where access log would Get Stored>
# service: access_logs
# source: cisco-secure-web-appliance
Original file line number Diff line number Diff line change
Expand Up @@ -1250,7 +1250,7 @@
}
],
"search": {
"query": "source:cisco-secure-web-appliance service:access_logs $Source_IP $Destination_IP $Http_Method"
"query": "source:cisco-secure-web-appliance service:access_logs $Source_IP $ACL_Decision_Tag $Policy_Group_Name $Server_Type $Custom_URL_Category $Http_Method"
},
"storage": "hot"
}
Expand Down
Loading

0 comments on commit 94550c7

Please sign in to comment.