This integration provides the following benefits:
- Validates that security tools are writing log events to LogRhythm Elastic to ensure compliance with security policies and regulations
- Collects events generated by security tools that write to LogRhythm Elastic to test the efficacy and configuration of security controls using Security Validation jobs
Use this document to configure the integration using one of the following methods:
- MSI (Supported and recommended for new integration configurations)
- Legacy (Supported for existing integration configurations)
Configure MSI Integration
This document covers the the MSI method of creating an integration. This method is the recommended approach for configuring new integrations in Security Validation.
API Calls
| API | Usage |
|---|---|
/_search |
Query for events from LogRhythm Elastic |
/_nodes |
Used to test connectivity and authentication settings |
Supported Versions
- LogRhythm Elasticsearch 7.2.x
- LogRhythm Elasticsearch 7.3.x
Before You Begin
To configure this integration, you need:
- A valid username and password for a user with permissions to use the API endpoints described in the previous step
- The hostname or IP address of your LogRhythm Elastic instance
Configure Security Validation
-
Go to Settings > Integrations.
- From the Integrations table, click Add Integration > LogRhythm Elastic.
You can add this as either a Direct or Remote Integration.
- Enter a meaningful Integration Name.
- Optional: From the Proxy drop-down, choose a proxy profile if one is available. If one isn't available and all outbound connections go through a proxy, first, set up a Proxy Rule.
- Change the HttpProtocols to use for requests. (Https or Http.)
- For the Host, enter the hostname of your LogRhythm Elastic instance instance.
- Enter a Port value. The default is 443.
- Enter the Username and Password for the user account with permissions to use API endpoints.
- Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
- Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
- Optional: Change the Page Size for each request to the upstream server. The default is 500.
- Optional: Add or remove Queries, as needed. Default values are provided.
- Optional: Modify the Max Pages to change the maximum number of calls to the upstream server. The default is 100.
- Optional: Modify the Field Map values, as necessary.
- Each field map box can hold a JSON-formatted comma-separated list of columns returned by the API to be considered for each field when translating into the normalized event object format. Example: description could be configured to be 'msg_s' or 'SyslogMessage' in some environments. The field map tries both if set to: ['msg_s','SyslogMessage'] and whichever matches first is the column that is used.
- When configuring an integration in Security Validation, you can assign additional host values in the Field Map settings. If none of the assigned fields return a valid host name, Network Actions may miss matched events from the third-party technology. Additional hosts values helps ensure the likelihood of a match between the two environments.
-
Optional: Expand Advanced options and update the information as necessary.
- Update Query Time and Delay Time.The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.
- Update Query Interval (seconds).
- If supported by your integration, configure correlation queries:
- Select Correlation Query Enabled and fill in the Correlation Query.
- Modify the Correlation Query Interval, if necessary (minutes).
- Select
Discover network devices automatically, the default and recommended option.If unselected, reported events won't include product information for any matching network security technology.
- Select Save Suspicious Events.
- Modify the Event Time Adjustment (seconds). The default is 0.
Modify the Limit value if you need to prevent a flood of results. This value is set to 10000 by default. This limit applies to both events and alerts individually, so if you set it to 10, you can still see a maximum of 10 events and 10 alerts.
- Update Query Time and Delay Time.
-
Click Save.
Verify connectivity
- Go to Settings > Integrations.
- From the Direct Integrations table, click
> Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.
For more information on setting up queries, see Manage Integrations.
Configure Legacy Integration
This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
Update LogRhythm Elasticsearch
Prerequisites
- Ensure network connectivity between the DX and the Security Validation Director.
- Identify the IP address used to access Elasticsearch. This could be direct access to an Elasticsearch node, Primary node, or something such as an nginx reverse proxy.
Configuration
Complete the following steps on the LogRhythm Server (if single-tiered deployment) or DX (administrative access not required).
On the LogRhythm Server
SSH from the LogRhythm DX to the Validation Platform Director.
-
On a Microsoft(R) Windows(R) host, plink.exe can be used as follows:
plink -R 9200:localhost:9200 nodeone@DIRECTORIP -
If linux DX, use normal ssh instead of plink:
ssh -N -R 9200:localhost:9200 nodeone@DIRECTORIP
On the Validation Platform Director (CLI)
-
SSH to the Security Validation Director using the "nodeone" password.
-
ssh nodeone@DIRECTOR_IP
-
-
Assume root access.
-
sudo su -
-
-
Add the following custom iptables rule to allow communication to Elastic over the SSH tunnel:
-
iptables -A INPUT -p tcp -s 127.0.0.1 --dport 9200 -j ACCEPT
-
-
Add the following configuration lines to
/etc/ssh/sshd_config.TCPKeepAlive yes-
ClientAliveInterval 15
-
Restart the SSH service.
service sshd restart
Update the Validation Platform
Prerequisites
Information to gather before you start:
- Identify the port for Elasticsearch communication (default is 9200).
- Identify whether the protocol is HTTP or HTTPS for connections to the Elasticsearch port.
-
Identify the field name mappings for the following (there could be multiple of each, depending on log sources and configuration):
- Source IP
- Destination IP
- Source Port
- Destination Port
- Event Start Time (timestamp)
- Event Unique ID
- Event Signature ID
- Event Description
- Event Source Host
Configuration
To add the LogRhythm Elasticsearch integration
-
Go to Settings > Integrations.
-
Click Add Integration > LogRhythm Elasticsearch.
-
Enter the Host.
This will almost always be either "localhost" or "127.0.0.1".
- Enter the Port, Protocol, and if using, the Username and Password.
-
Select the appropriate version.
This may adjust the default query and field name mapping section.
-
Review and update the Query, if necessary.
-
Expand Advanced options.
-
(Optional) Update Query time and Delay time.
The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors. -
(Optional) Enable the special query for Host CLI Actions and review the Query.
If you enable the Host CLI Actions query and use the %HOST_CLI_ACTOR_HOSTNAMES% variable, the platform will substitute the plain hostname and the information from the Alternate Hostname field on the Actor configuration page.
-
(Optional) Select Discover network devices automatically.
-
Review and update the field name mapping section.
- Inputs are enclosed by square brackets
[ ]. - Inputs point to the path location (
["_id"]). - Nested locations should be enclosed in one set of brackets, encompassed in quotes, and separated by commas (
["_source","src_ip"]).
- Inputs are enclosed by square brackets
-
Modify the Query Interval and Event Time Adjustment, if necessary.
-
(Optional) Assign a Name.
-
(Optional) Choose Yes to save suspicious events.
-
Click Submit.
Verify connectivity
To verify connectivity to LogRhythm Elasticsearch
Click Test to verify that:
- The Director can communicate with the Elasticsearch host IP address on the port specified.
- The Elasticsearch credentials can perform queries on the index or indexes with relevant data.
Updating the Integration
If you update LogRhythm, you will need to update the integration within the Validation Platform. Modifying the version may adjust the default query and the field name mapping section.
Any changes you made previously to the query and field mapping will be retained. Review the default query and the field name mapping sections to verify that no additional changes are required.