Samurai MDR Portal User Guide

• 1: Security Incidents
• 1.1: The Situation Room
• 2: Dashboard
• 2.1: Telemetry Dashboard
• 2.2: Alerts Dashboard
• 2.3: Security Incident Dashboard
• 3: Telemetry
• 3.1: Telemetry Monitoring
• 3.2: Integrations
• 3.2.1: Supported Integrations
• 3.2.2: Integration Actions
• 3.2.3: Generic Log Sources
• 3.3: Collectors
• 3.3.1: Samurai Local Collector
• 3.3.2: Samurai Cloud Native Collector
• 4: Analysis
• 4.1: Advanced Query
• 4.1.1: Advanced Query Functionality
• 4.1.2: Constructing an Advanced Query
• 4.1.3: Event field data types
• 4.2: Alerts
• 4.2.1: Alerts View
• 5: Reports
• 6: Admin
• 6.1: Management
• 7: Product Integration Guides
• 7.1: Apache HTTP Server
• 7.2: Aruba Networks ClearPass
• 7.3: Azure Virtual Networks (NSG Flow)
• 7.4: Blackberry CylancePROTECT
• 7.5: Check Point Next-Generation Firewall
• 7.6: Cisco Identity Services Engine (ISE)
• 7.7: Cisco IOS Routers and Switches
• 7.8: Cisco Meraki MX Security Appliances
• 7.9: Cisco Secure Endpoint
• 7.10: Cisco Secure Firewall (ASA Appliances)
• 7.11: Cisco Secure Firewall (Firepower Threat Defense)
• 7.12: Cisco Umbrella
• 7.13: Citrix Netscaler (Formely Netscaler ADC)
• 7.14: Claroty Continuous Threat Detection (CTD)
• 7.15: Claroty xDome
• 7.16: Crowdstrike Falcon Insight
• 7.17: CyberArk Privileged Access Security (PAS)
• 7.18: ESET PROTECT
• 7.19: F5 BIG-IP LTM
• 7.20: Fortinet FortiAnalyzer
• 7.21: Fortinet FortiGate Next-Generation Firewall
• 7.22: Fortinet FortiWeb
• 7.23: GestioIP IPAM
• 7.24: Google Workspace
• 7.25: Infoblox DDI
• 7.26: Linux Authentication
• 7.27: Microsoft Azure Activity Logs
• 7.28: Microsoft Azure Application Gateway
• 7.29: Microsoft Azure Firewall
• 7.30: Microsoft Defender Advanced Hunting
• 7.31: Microsoft DHCP Server
• 7.32: Microsoft DNS Server
• 7.33: Microsoft Entra ID
• 7.34: Microsoft Graph (Security)
• 7.35: Microsoft IIS
• 7.36: Microsoft Office 365
• 7.37: Microsoft Windows Event Log
• 7.38: Palo Alto Networks Cortex XDR Pro
• 7.39: Palo Alto Networks: Next-Generation Firewall
• 7.40: Palo Alto Networks: Panorama
• 7.41: PowerDNS Recursor
• 7.42: Proofpoint Targeted Attack Protection (TAP)
• 7.43: Samba AD
• 7.44: Sophos Central
• 7.45: Squid Cache
• 7.46: Trellix Endpoint Security (ENS)
• 7.47: Trellix Endpoint Security (HX)
• 7.48: Trend Micro Vision One
• 7.49: VMware Carbon Black Cloud Enterprise EDR
• 7.50: WatchGuard Firebox
• 7.51: Zscaler Internet Access (ZIA)

1 - Security Incidents

Security Incidents represent actionable security concerns or threat(s) identified as a result of an investigation by our SOC analysts. The security incident contains information about the threat(s) and how best to mitigate or minimize the risk.

Security Incidents are reported to you following our Incident Management process and are associated with tickets within the Samurai MDR portal and downloadable in PDF format if desired.

Security Incident Notification

As per the Managed Detection and Response Service Description, notifications are provided by telephone or email based on severity:

• Critical severity: Phone / E-mail notifications.
• Low, Medium, High severity: E-mail notifications.

Information capture for notifications are completed during the MDR on-boarding process, however you can update contact details or telephone numbers by raising a ticket, during Threat Reviews or contact with your Customer Success Manager (CSM).

Viewing Security Incidents

To access Security Incidents, click on Security Incidents from the main menu.

A visual indicator is displayed beside the Security Incidents menu item displaying the total number of Security Incidents that require your attention and are awaiting your response/action.

Figure 1: Example Security Incidents

Security Incident Dashboard

Figure 2: Example dashboard

The Security Incidents dashboard panel displays summary information as:

• Awaiting feedback - Security Incidents awaiting your feedback and/or action
• Awaiting SOC - Security Incidents awaiting response from the SOC
• Closed - all closed Security Incidents
• Total - Total Security Incidents

Security Incident Fields

Find information related to all Security Incident fields (outlined red in Figure 1):

1. Reference

• Reference number of the Security Incident.

2. Severity

• All Security Incidents are categorized with a severity that describes the reported threat.

• The (MDR) Security Analyst will make an informed decision in assigning the threat severity taking into consideration the specific situation and past experience.
• The assigned severity level will provide you an easy means to quickly assess how important a threat is, and the level of priority which should be assigned in addressing it. This will allow you to re-prioritize your actions so that you can start mitigating any threats quickly.
• Hopefully you will not experience any Critical security incidents!

3. State

• Each Security Incident has an assigned state which quickly allows you to determine who is responsible for follow up.

4. Title

• A “one-liner” that describes the content of the reported Security Incident. This field is used when listing tickets and within notifications.

5. Categories

• To make it easier to understand the threat and perform additional mitigations actions, we categorize a threat according to a tactic in the MITRE ATT&CK IT and OT framework.

A threat can be categorized with multiple MITRE tactics.

• For more details about MITRE ATT&CK tactics:

  • IT: Enterprise Matrix
  • OT: ICS Matrix

• Reflecting the MITRE tactics, provides the possibility to use MITRE techniques to do additional threat hunting and mitigation.

6. Revision

• If a threat changes, emerges or new relevant info is available, a new revision of the Security Incident will be created. The revision number is reflected in this field.

7. Created

• Date and time of creation of the Security Incident in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC).

8. Updated:

• Date and time of last update to the Security Incident in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC).

You can filter and sort on any of the available fields as well as disable and enable for your desired view. You can also export the list to CSV for download.

What now?

Click on a Security Incident to view more detail and work directly within our SOC within the Situation Room.

1.1 - The Situation Room

We adopted the term ‘Situation Room’, often used by military and political establishments as an intelligence management center to monitor and deal with crisis situations.

The Samurai MDR Situation Room is where you will find detailed information for any given Security Incident reported to you and allows you to communicate with our SOC Analysts.

Enter The Situation Room

To enter the Situation Room, click a Security Incident reported to you from the Security Incident List.

See the Security Incidents article for additional information.

Figure 1: Example Situation Room

The Situation Room is structured as follows, click on the links to learn more:

• Security Incident Information
• Communication Channel
• Details
• Evidence

Security Incident Information

Figure 2 - Example incident information

To the left of the window, high level information about the Security Incident will be displayed, some of which is also summarized under the all Security Incidents menu. For clarity we have also included the field information below:

1. Incident Reference # / Title

• Reference number of the Security Incident
• A “one-liner” that describes the content of the reported Security Incident.

2. Severity

• All Security Incidents are categorized with a severity that describes the reported threat.

3. MITRE Categories

• To make it easier to understand the threat and perform additional mitigation actions, we categorize a threat according to tactics in the MITRE ATT&CK IT and OT framework.

A threat can be categorized under multiple MITRE tactics.

• For more details about MITRE ATT&CK tactics:

  • IT: Enterprise Matrix
  • OT: ICS Matrix

• Reflecting the MITRE tactics, provides the possibility to use MITRE techniques to conduct additional threat hunting, respond and mitigate threats.

4. Status

• Each Security Incident has an assigned status which quickly allows you to determine who is responsible for follow up.

State	Icon	Description
Awaiting Feedback		Security Incident has been created or updated and is awaiting your feedback / response
Awaiting SOC		Security Incident is currently awaiting feedback / input from the SOC.
Closed		The Security Incident is Closed.

7. Created

• Date and time of creation of the Security Incident in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC).

8. Summary

• A short summary of the Security Incident.

Towards the top of the window additional information is displayed:

Figure 3 - Additional information

9. Revision

• If a threat changes, emerges or new relevant information is available, a new revision of the Security Incident will be created and the revision number displayed. e.g Revision 2,3,4.
• You are notified of any new revisions (which is also displayed within the Communication Channel) with the latest revision being displayed as default.
• Selecting the drop down allows you to select the revision number which will update details and evidence appropriately.

10. PDF

• Allows you to download the Security Incident and all details in PDF format.

11. Close Incident

• Allows you to Close the Security Incident.

12. Status

• Icon depiction of the current Security Incident Status. See item (4).

Communication Channel

The Communications Channel provides messaging functionality allowing you to communicate with SOC Analysts in real-time. The editor allows you to construct and format text as desired, your messages are displayed to the left of the Communications Channel whilst all SOC messages are displayed to the right.

Figure 4 - Communications channel

After typing your message ensure to click on Send Message

Details

Security Incident details are included within this section as:

Recommendations

A set of actionable mitigation step(s) that can be performed by you to mitigate the threat and bring it to closure.

The Recommendations might not be the only way to mitigate the threat. Rather, they provide a suggested approach from the SOC. Ultimately, the choice of the most appropriate mitigation approach rests with the client. When performing mitigation, it is also necessary to understand risks associated with mitigation actions, as there could be impacts on availability and in some cases even data loss could occur. These kinds of impacts may either be known side-effects of mitigation or there may be potential risks associated with errors which could occur during mitigation.

Description

In this section, the SOC clearly describes the relevant threat and outlines why this poses a risk. The description includes steps and findings through the analysis process where the SOC has used enrichment data and performed Threat Hunting and correlation. The SOC will add Evidence data to support the findings.

The Incident Description can be short or extensive depending on the what is needed to accurately describe the reported threat and associated risk.

Evidence

Evidence is provided with any given Security Incident to corroborate a SOC analyst investigation and ultimately the Security Incident.

Evidence may be included by the SOC analysts or by a user and will display a timestamp of when it was added building a timeline. Evidence may include:

• Alert data - vendor/product alerts and/or Samurai platform alerts
• Log data- log data
• Files - e.g PCAP files if available

You can also upload supporting evidence for the security incident, click on Upload File and provide a description (optional) and select the file to upload. The maximum size limit for the file is 50MB.

Selecting the drop down allows you to view or download the Evidence. For Log data you can pivot to Advanced Query by clicking the link to view the log data and complete further investigation as required.

What Now?

Please refer to our Incident Management process as it is important you understand what is expected of you in the result of a Security Incident as well as our responsibilities.

2 - Dashboard

2.1 - Telemetry Dashboard

The Telemetry dashboard provides a simple self explanatory high level view of your Managed Detection and Response service telemetry metrics.

Summary Panels

Within the dashboard are various summary panels which can be updated based on a specified time period and includes:

• Total number of events ingested into the Samurai platform
• Total log volume
• Number of integrations (this is current state and not affected by the specified time period)
• Integrations with no events in the last 12 hours (these integrations likely need action, please review the Telemetry Monitoring article for further information)

The dashboard panel uses aggregated data and may not be completely up to date with the latest events.

Figure 1: Example summary panels

Time period

You can update relevant panels to specific date and time ranges. We have included Quick time ranges or you can specify a date and time period.

Figure 2: Date and time selection

Detail Panels

Additional panels provide event data based on products you have integrated with the Samurai platform.

Hover over any area of the bar or chart for specific time period and total events

Events per product

Figure 3: Example events per product bar graph

Events per product

Figure 4: Example events per product pie chart

Data ingested per product

Table 1: Example data ingested per product table

If you wish to drill down into the events we recommend you use the Advanced Query feature. Review Advanced Query Introduction for more information.

2.2 - Alerts Dashboard

The alerts dashboard provides valuable insights into your organization’s security landscape, despite all alerts being handled by the Samurai Security Operation Center (SOC) it provides visibility into the volume of alerts which potentially lead to validated threats and reported to you as a security incident. Additionally we provide transparency by categorizing the alerts by detection engine and highlighting top threat signatures, whilst you do not need to act upon these alerts, this information demonstrates the Samurai MDR service’s scale and effectiveness.

Outlined below are examples and an explanation of each panel within the dashboard:

Select the time period to adjust all panels in the dashboard, note the results can provide upto the last 12 months of alert data. Hover over any area of a bar or chart for specific time period and totals.

Monitoring, Detection and Response summary

The funnel outlines telemetry ingested (events) by the Samurai platform from your configured integrations, the security detections (alerts) made by the Samurai platform detection engines and third party vendors which are triaged and investigated by the Samurai SOC, and the number of security incidents reported to your organization. The funnel infers the value of the service based on the data analyzed focusing on detecting and reporting threats to your organization.

Figure 1: Example summary

Number of alerts

The total number of alerts analyzed by the Samurai platform and SOC analysts.

Figure 2: Example number of alerts

Number of unique signatures

The total number of unique alert signatures.

Figure 3: Example unique signatures

Alerts per detection method

Donut chart showing the alerts per detection method. For a brief explanation of the detection engines please refer to Alerts.

Figure 4: Example alerts per detection method chart

Alerts timeline per detection method

Bar graph showing alerts over the time period per detection method.

Figure 5: Example alerts timeline per detection method graph

Top 10 signatures

Top 10 alert signatures from all detection methods.

Figure 6: Example top 10 signatures

Top 10 signatures for Hunting Engine

Top 10 alert signatures for the Samurai hunting engine.

Figure 7: Example top 10 signatures for hunting engine

Top 10 signatures for Real-time Engine

Top 10 alert signatures for the Samurai real-time engine.

Figure 8: Example top 10 signatures for real-time engine

Top 10 signatures for vendor

Top 10 alert signatures from your vendor product integrations.

Figure 9: Example top 10 signatures for vendor

2.3 - Security Incident Dashboard

The Security Incidents dashboard provides a simple self explanatory high level view of your Managed Detection and Response service security incidents.

The Security Incidents dashboard covers up to the last 12 months worth of security incident data.

Current open security incidents per severity

For more information on severity definitions, refer to Security Incident Fields.

Figure 1: Example current open security incidents by severity

Current open security incidents by state

For more information on state definitions, refer to Security Incident Fields.

Figure 2: Example current open security incidents by state

Current open security incidents (days)

This graph helps you understand how long (in days) a security incident has remained open - this could be in ‘Awaiting feedback’ or ‘Awaiting SOC’ states. Ideally the goal is to remediate and close a security incident as quickly as possible to mitigate risk.

Figure 3: Example current open security incidents (days)

New security incidents per month by severity

Figure 4: Example new security incidents per month by severity)

Security incidents average closing time by severity (days)

This graph shows the average closing time (in days) of security incidents per severity. Ideally the goal should be to keep this average closing down to a minimum.

Figure 5: Example security incidents average closing time by severity (days))

Security incidents total opened/closed per month

Figure 6: Example Security incidents total opened/closed per month))

3 - Telemetry

3.1 - Telemetry Monitoring

It is important to understand and keep track of the health of Integrations you have configured.

The Samurai platform monitors telemetry ingested from your integrations displaying the applicable status (refer to View Integration Status), if problems are encountered after specific time periods the integration is highlighted within the Telemetry Monitoring view and triggers an email notification after 24 hours.

For an integration to be monitored, the Samurai platform must recieve event data consistently every hour over a 24hour period, this is because we cannot guarantee accurate monitoring for telemetry sources that may log intermittently.

Access Telemetry Monitoring

Click Telemetry and select Telemetry Monitoring from the main menu.

Figure 1: Telemetry monitoring menu and visual indicator  

A visual indicator will be displayed beside the Telemetry Monitoring menu item showing the total number of integrations which may require attention.

Figure 2: Example telemetry monitoring table

Telemetry Monitoring View

The Telemetry Monitoring view displays summary information (as applicable):

• Number of integrations with no events seen in the last 24 hours by the Samurai platform
• Number of integrations with no events seen in the last 12 hours by the Samurai platform
• Unknown integration (unsupported)
• Number of provisioning integrations
• Number of healthy integrations

Figure 3: Example summary information

Telemetry Monitoring Table

Integrations are displayed in the table if the Samurai platform has not received any events in the last 12 hours.

Figure 4: Example detail table

The list shows the details of the integrated telemetry sources which are considered unhealthy as per the table below:

Clicking on the Integration will navigate you to the Integration Details. For integrations of type Log an events graph will be displayed which may help in troubleshooting.

For information on Integration types refer to What are the Integration fields? in the Integration Actions article.

The table may also display:

• Unsupported integrations

  • These integrations are displayed as Product - unknown and Vendor - unknown - for you convenience the Samurai platform does monitor these telemetry event sources but does not send email notifications.
  • Info will display the following: This integration is currently not supported and will not trigger a notification if it stops sending events.

• Integrations where the Samurai platform ingests events intermittantly

  • If the Samurai platform does not receive events every hour over any 24 hour period, the integration will still be displayed but will not trigger a notification.
  • Info will display the following: This integration does not send enough events to trigger a notification if it stops sending events altogether.

The above integrations will be highlighted with an Info icon () and when hovering over will display the applicable text highlighted above.

For your convenience you may want to display the integrations above in a different view, in doing so you remove from view integrations that will not trigger notifications - Hide Log Integrations provides this functionality.

Hide Log Integrations

Only integrations of type Log can be hidden - these are telemetry sources that typically send event data via syslog consistently. Example reasons why you may want to hide an integration include:

• It is an unsupported/generic log source integration.
• You do not want to recieve an email notifications if there is an issue with telemetry ingestion to the Samurai platform.

To hide an integration from the Telemetry Monitoring view:

1. Find the relevant Log integration within the table
2. Click on more options () to the left of the integration and select Hide integration
3. A Hide Log Integration window will be displayed warning you it will be removed from the Integrations and Telemetry Monitoring pages, click Confirm

To view hidden integrations from the Telemetry Monitoring view:

1. Click on more options () at the top right of the window and select Hidden log integrations
2. A Hidden Log Integrations window will be displayed
3. The integrations will display an Info icon () amd whem hopvering over will display the following Notifications for this integration has been disabled

Unhide Log Integrations

To unhide log integrations from the Telemetry Monitoring view:

1. Click on more options () at the top right of the window and select Hidden log integrations
2. A Hidden Log Integrations window will be displayed
3. Find the relevant hidden integration
4. Click on more options () within the integrations table and select Unhide integration

Hide, view and unhide functionality is also available within the Integrations View view.

Muted Integration

Muted integrations do not send an email notification if there is an issue with telemetry ingestion to the Samurai platform. This could be based on one of the categories mentioned above (unsupported or sends events intermittently) The Telemetry Monitoring view will display muted integrations by default. For convenience you can disable displaying muted integrations from the Telemetry Monitoring view:

1. Click on more options () at the top right of the window and deselect Show muted integrations

If you have hidden a log integration it will not be displayed when Show muted integrations is enabled.

Telemetry Monitoring Notifications

Samurai will send email notifications to registered application users if no events are seen for an integration over 24 hours. You can opt-in to receive notifications by raising a request via the Samurai MDR portal or in discussion with the SOC during MDR onboarding.

The Samurai platform does not send notifications for unsupported (displayed as unknown) integrations or integrations that send event data intermittently.

If you want additional information on Integration health, please review How do I know if my integration is functioning?

3.2 - Integrations

What is an Integration?

A data source integrated with the Samurai platform. An integration allows us to collect and ingest telemetry data from multiple sources, including network, endpoint and cloud.

What integrations are available?

We have pre-built integrations to a comprehensive array of 3rd party products and services. Select Supported Integrations to view what is available.

For syslog sources, even if events do not match a supported Integration, we will still ingest events into our data lake as a Generic Log Source. You will still be able to process this data using Advanced Query, and include events from generic log sources within your queries.

How do I integrate data sources?

Select Integration for steps that can be taken with integrations within the Samurai MDR portal.

Integration Health

Once you have configured Integrations to bring your data into the Samurai platform, you will also want to make sure that your data sources are healthy. For more details on how to maintain Integration health and troubleshoot problems, please read our article about Integration Health.

What’s Next?

Upon completion of your integrations and validation of health, the platform will start collecting and ingesting telemetry data. Dependent on your phase of MDR onboarding our team will be in contact with you.

3.2.1 - Supported Integrations

Samurai Integrations facilitate the ingestion of data sources from a wide range of third party vendors. Our Integrations are updated regularly as new and emerging technologies are released.

Each Integration typically requires a configuration guide outlining steps you must follow to integrate your data source to the Samurai platform.

For details such as transport methods and logs collected please refer to each supporting vendor configuration guide by clicking the link in the table or browsing directly to Product Integration Guides.

All supported integrations are categorized according to our Detection Categorization. For further information refer to the following article: Telemetry Data Source Categorization.

If you do not see an integration guide available, please reach out to your NTT contact for further information as we are constantly developing support for additional data sources.

Available configuration guides

In the pipeline

Outlined below are integrations we have in the pipeline however have no committed dates for support. Please note any integration may be influenced by changing business opportunities and client requirements. Please contact NTT for further information or if you require additional support.

3.2.2 - Integration Actions

Select the action you wish to take and jump to the relevant section:

• Create Integration
• View Integrations
  • What are the Integration fields?
  • Views
• View Integration Details
• Integration Status
• Hide Integration
  • Unhide Integration
• Delete Integration

If you are new to integrations you should review Integrations Overview

Create Integration

1. From your Samurai MDR portal tenant click Telemetry and select Integrations from the main menu
2. Click Create integration
3. Select the product you wish to integrate with the Samurai platform
4. Click Next. Dependent on how we collect telemetry, the product may be integrated via a Cloud Collector, a Cloud Native Collector or Local Collector. Follow the steps based on the Collector type:

Cloud Collector

1. If the integration is cloud-based it will be added to the Cloud Collector which shall be displayed - Select Next
2. Select Configuration Guide which will direct you to Samurai documentation outlining how to configure your product and obtain required fields.
3. Once you have configured your product, complete the required fields
4. Select Finish

Cloud Native Collector

1. Your Cloud Native Collector(s) will be listed. Select the Cloud Native Collector that you will integrate the product/service with. If you do not have a Cloud Native Collector listed per setup, follow the steps in our Samurai Cloud Native Collector article.
2. Click Next
3. Your cloud resource information will be displayed for your confirmation and to use if following the configuration guide.
4. Click Configuration Guide which will direct you to Samurai documentation outlining how to configure your product/service.
5. Click Finish

Local Collector

1. Your Local Collector(s) will be listed. Select the Local Collector that you will integrate the product with.
2. Click Next (typically this is the syslog destination host when configuring your device). If you do not have a Local Collector setup and deployed, follow the steps in our Samurai Local Collector article.
3. The Local Collector IP Address will be displayed, copy the IP address or take note of it.
4. Click Configuration Guide which will direct you to Samurai documentation outlining how to configure your product.
5. Based on the product, Extended Data Collection may be displayed, if so jump to Extended Data Collection.
6. Click Finish

You do not need to follow the steps above for a Local Collector integration, however we advise you follow the steps to determine if extended data collection is available for the product, and if you wish to enable it. You may choose to follow our configuration guides to send logs directly to your Local Collector, the Samurai platform will auto detect the vendor and product for supported integrations. If we do not support the product, your integration will be displayed as unknown under the Vendor and Product fields, however the Samurai platform will store the telemetry data.

Extended Data Collection

For many products we are able to collect extended data enhancing our threat detection capabilities and accuracy, for example Packet Capture (PCAP) data. This option will be displayed during configuration of an integration.

1. If extended data collection is available for the product, you can choose to enable or disable via the toggle. If you choose to disable, Select Finish
2. If you choose to enable extended data collection you must complete all the necessary fields. The parameters for each field are derived from following the associated product configuration guide. Once complete, Select Finish

You can choose to follow the configuration guide at anytime during the process, however if your product is not configured, the Samurai platform will obviously not receive any telemetry.

All supported third-party product configuration guides can be found here.

View Integration

There are multiple methods of viewing your integrations.

If you wish to view integrations associated with a specific collector:

1. From your Samurai MDR portal tenant click Telemetry and select Collectors from the main menu
2. Select the relevant Collector
3. All integrations associated with the Collector will be displayed with associated information

You can also view all integrations regardless of collector:

1. Click Telemetry and select Integrations in the main menu
2. All of your Integrations will be listed

A single product integration may be displayed multiple times based on telemetry data ingested. For example, if you enabled Extended Data Collection whilst creating an integration the individual product will be displayed multiple times with different Type fields associated - see below for further explanation.

What are the Integration fields?

• Status: Color indication of integration status

• Status Description: Description of the status

• Info: An info icon () will be displayed if:

  • the integration is unsupported (unknown Vendor and Product)
  • the integration does not send enough events to trigger a telemetry monitoring notification. Refer to Telemetry Monitoring for additional information

• ID: Universally Unique Identifier (UUID) for integration

• Vendor: Vendor name of the product

• Product: Product name

• Type: Integration type used to gather or ingest telemetry. Potential entries you could see here include:

  • Log: Displayed when a telemetry source sends logs (typically via syslog)
  • Local: Displayed when we leverage an API from a Samurai local collector to gather telemetry
  • Cloud: Displayed when we leverage an API from a Samurai cloud collector to gather telemetry
  • Cloud Native: Displayed when we leverage a cloud native collector to ingest data from your cloud storage

• Name: Integration name you provided during configuration

• IP Address: IP address of the host

• Collector: Collector name associated with the integration

• Description: Optional description you provided during integration configuration

• Last Event Seen: The last event seen from the telemetry source in the format [yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC).

• Created: Date and time of integration creation in the format[yyyy:mm:dd], [hh:mm:ss] with time represented in Universal Time Coordinated (UTC).

Select Columns to enable or disable visible fields and Filters to filter on fields.

Views

You can save filters you set through views. This is useful if, for example, you have a large number of integrations and wish to view only specific products or types of integration.

Click Views to save/reset/delete your different filters. Once saved you can toggle between views.

View Integration Details

There are multiple methods of viewing your integration details. If you wish to view integration details associated with a specific Collector:

1. From your Samurai MDR portal click Telemetry and select Collectors from the main menu
2. Select the relevant collector for your list
3. All integrations associated with the collector will be displayed
4. Find and click on your integrated product

You can also view all integration configuration regardless of collector:

1. Click Telemetry and select Integrations from the main menu
2. Find and click your integrated product
3. Configuration parameters will be displayed

For integrations of type Log an events graph will be displayed. This is a useful indicator of the number of events over a given period and may show spikes and drops in events.

You can also pivot directly into Advanced Query by selecting the magnifying glass icon () to view the underlying event data.

By clicking the time period you can update the events graph to a specific date and time range. We default to the Last 7 days however have included Quick time ranges or you can specify a date and time period.

You can edit and update the integration description to help you keep track of your integrations.

View Integration Status

There are multiple methods of viewing your Integration status.

If you wish to view integration status associated with a specific Collector:

1. From the Samurai MDR portal Telemetry and select Integrations from the main menu
2. Select the relevant collector from your list
3. All integrations listed related to the collector will be displayed with status color and description (if enabled)

You can also view status of all integrations regardless of collector:

1. From your Samurai MDR portal Telemetry and select Integrations from the main menu
2. All integrations shall be displayed with a status color and description (if enabled)

Potential status displayed are included in the table below:

For more information about Integration status, please see the article on how to manage Integration Health.

Hide Integration

Hiding an integration will remove it from the integrations displayed and also from the Telemetry Monitoring view. Additionally if the integration is supported and the Samurai platform ingests no events, you will not receive an email notification.

Only integrations of type Log can be hidden. Some reasons why you may want to hide an integration include:

• You may want to hide all of your unsupported/generic log source integrations, the Samurai platform does monitor unsupported integrations for your convenience however does not notify you if events are not seen in 24 hours.
• You do not want to recieve any notifications if there is an issue with telemetry ingestion to the Samurai platform.

To hide an integration:

1. Click Telemetry and select Integrations from the main menu
2. Find the relevant Log integration
3. Click on (more options) within the integrations table and select Hide integration
4. A Hide Log Integration window will be displayed, click Confirm

To view any hidden integrations:

1. Click Telemetry and select Integrations from the main menu
2. Click (more options) at the top right of the window select Hidden log integrations
3. A Hidden Log Integrations window will be displayed

Unhide Integration

1. Click Telemetry and select Integrations from the main menu
2. Click (more options) at the top right of the window select Hidden log integrations
3. A Hidden Log Integrations window will be displayed
4. Find the relevant hidden integration
5. Click on (more options) within the integrations table and select Unhide integration

Hide, view and unhide functionality is also available within the Telemetry Monitoring view.

Delete Integration

If you delete an integration, it cannot be reversed! but events from the telemetry source will remain within the Samurai platform. However if the integration is auto-detected, it will reappear as type log if your telemetry source remains sending logs.

If you wish to delete an integration associated with a specific Collector:

1. From your Samurai MDR portal Telemetry and select Collectors from the main menu
2. Select the relevant collector from your list
3. You will now see all integrations associated with the collector
4. Select your integrations
5. On the right hand side of the relevant integration, click on (more options) and select Delete Integration
6. The following warning will appear: ‘Warning: This is a destructive action and cannot be reversed.’. To ensure you intended to delete the integration you will need to type in the highlighted ‘Integration’s Hostname’ and select Delete Integration

You can also delete from the Integrations menu item:

1. Click Telemetry and select Integrations from the main menu
2. Find and select your integrated product
3. On the right hand side of the relevant integration, click on (more options) and select Delete Integration

3.2.3 - Generic Log Sources

While we make an effort to support a wide variety of Integrations and different types of log sources, it is possible that there may be a log source that you would like to ingest into the Samurai platform which we are not able to parse and analyze. This is especially true for events generated via syslog log sources.

The fact that we are not able to use a log source for detections doesn’t mean that it won’t still be useful to ingest into the Samurai platform. We will ingest any event data, provided via syslog (sent to a Samurai local collector), into our data lake and you will still be able to analyze that event data using Advanced Query. This allows you to include events from generic log sources when you are performing queries.

If you configure an unsupported log source to send syslog to a Samurai local collector it will be displayed in the Samurai MDR portal under Vendor and Product as unknown. However you can provide a description to allow you to keep track of them. Refer to Integration Actions for providing a description.

If a log source, ingested via syslog, does not match one of our supported integrations, we will ingest the log events, which will still contain, amongst others, the following fields:

• timestamp: the time at which the log message was ingested
• collector: the id of the collector which ingested the event
• host: the source host from which the event was received
• raw: the complete raw log message

You can then proceed to query these events using Advanced Query. For example, the following KQL query finds all the attempts to connect to a host using invalid user ids and then counts the attempts by source IPv4 or IPv6 address:

events | where host == "10.1.1.1" and i(raw contains "Invalid" or raw contains "failed") and raw !contains "connect" | project timestamp, user = extract("user ([a-zA-Z0-9\\-]+) from ", 1, raw), ipaddr = extract(".+ ([0-9a-f]+[\\:\\.][0-9a-f\\.\\:]+) ", 1, raw) | summarize num_attempts = count() by ipaddr| order by num_attempts

The output is ordered by the number of attempts from each IP address, producing a table like the following:

3.3 - Collectors

Samurai Collectors are used to receive and transport telemetry from your security controls, network devices or cloud services to the Samurai platform.

There are three types of collectors:

1. Cloud Collector

• deployed within the Samurai platform and is used to gather telemetry from cloud services and/or security controls. For a cloud collector you simply need to complete the relevant integration.

2. Cloud Native Collector

• a transport method to gather telemetry from public cloud products and services, specifically Microsoft Azure, Amazon Web Services (AWS) and supported third parties. This collector type is used for monitoring cloud storage (Azure Blob and/or AWS S3) to pull data into the Samurai ingestion pipeline.

3. Local Collector

• deployed within your environment and is used to gather telemetry from your security controls and network devices. We have packaged the local collector to support multiple formats and envionments.

What type of Collector do you require?

This is dependent on the products you want to integrate with Samurai:

• For products deployed in your internal network, a Local Collector will be required to gather (pull & push) telemetry data and securely transfer it to the Samurai platform.
• For cloud based products providing API endpoints, a Cloud Collector will be used to pull the telemetry data and securely transfer it to the Samurai platform.
• For cloud based products utilizing streaming of telemetry data, a Cloud Native Collector will be required to receive the telemetry data and securely transfer it to the Samurai platform.

Next steps:

• Review our Supported Integrations and associated Integration Guides to determine the collector type(s) required. Within each Integration Guide there is a table denoting use of a Local, Cloud or Cloud Native Collector, alternatively this is displayed in the Samurai MDR portal when working through an integration.
• You may also choose to jump directly to the Samurai MDR portal and review integrations
• If you have determined you require a local collector then click on Samurai Local Collector and follow the steps to create, configure and install.
• If you have determined you require a Cloud Native collector then click on Samurai Cloud Native Collector and follow the steps to create and configure.

3.3.1 - Samurai Local Collector

If you have determined that you require a local collector then follow the steps below to learn what you need to get started, create, configure and download a local collector from the Samurai MDR portal and ensure it is working as expected.

1. Take a moment to understand what you need to get started
2. Create, configure and download a Collector
3. Install a Collector
4. Validate Collector Status
5. Collector Status Notifications
6. What’s next?
7. Deleting a Collector

What you need to get started

• Access to the Samurai MDR portal and your specific tenant.

• A hypervisor to run the virtual machine, for example VMware vSphere, Microsoft Hyper-V, Amazon EC2 or Azure Virtual Machine

  • View virtual machine requirements below.

• Ensure to make any necessary updates to comply with the collectors connectivity requirements.

• A static IP address for the collector and DNS server IP addresses unless you decide to use DHCP.

• Access to your products to make necessary changes outlined within the relevant integration guide.

Minimum Virtual Machine Requirements

The following machine requirements will support up to 15K events per second (EPS) peak, 10K EPS sustained over a 24hr period, approx 800GB per day.

Connectivity required for the Collector

The collector requires connectivity to resources outlined within the table below, you may need to update your security controls e.g firewall to allow this connectivity.

Create, Configure and Download a Collector

1. From your Samurai MDR portal tenant, click Telemetry and select Collectors from the main menu

2. Select Create Collector

3. Select Local collector

4. Complete the fields as required.

5. Select Create Collector once you have completed all relevant fields

6. Select the Collector you created by clicking the Name used in Step 2

7. Select Download

• The files you need to download are based on your Hypervisor. The options available for download are:

  • Configuration
    • iso - configuration file for your collector, this file is always required
  • Cloud init
    • AWS - used to provide cloud-init data to AWS instance
    • Azure - used to provide cloud-init data to Azure instance
  • Virtual machine
    • vmdk - disk image (not needed if using the ova)
    • vhdx - virtual hard disk format used for Hyper-V
    • ova - virtual machine that the collector will run (includes disk image) for VMware

8. Download the iso configuration file and also the relevant file needed for your hypervisor.

If you are creating multiple collectors, you only need to download the ova file once and can use it multiple times, the important file per collector is the configuration file (iso).

Install a Collector

Based on your hypervisor follow the relevant section:

• VMware vSphere
• Microsoft Hyper-V
• Amazon EC2
• Azure Virtual Machine

VMware vSphere

Follow the documentation from VMware:

• Deploy a Virtual Machine from an OVF or OVA File in the VMware Host Client

1. When asked to provide a virtual machine name, we suggest samurai-nttsh-collector
2. Be sure to select the .ova file you downloaded when asked for the file to deploy your virtual machine from.

Once complete follow the VMware article to configure a datastore ISO file

• Configure a Datastore ISO File for the CD-DVD

1. Be sure to select the .iso file you downloaded when asked to select file

The VM is now ready to be powered on.

The .iso file must be mounted at first boot to configure the Collector. Once you have validated the Collector status is Healthy in the Samurai MDR portal you must ensure the .iso is dismounted.

Microsoft Hyper-V

Follow the documentation from Microsoft:

• Create a virtual machine in Hyper-V

1. When asked to provide a virtual machine name, we suggest samurai-nttsh-collector
2. Use the Virtual Machine Requirements when configuring memory and network
3. When asked to Connect Virtual Hard Disk ensure to use the .vhdx file you previously downloaded
4. For Installation Options ensure you use the .iso file you previously downloaded

Once you have completed setup of your Collector you should ensure it is running and validate the status within the Samurai MDR portal, upon initial setup this can take a little while.

Amazon EC2

Prerequisitve steps:

1. Ensure you have the AWS cloud-init.yaml file you downloaded from Create, Configure and Download a Collector.. This file will be used later during EC2 instance deployment.

Follow the vendor documentation from Amazon to launch a EC2 instance:

• Launch an instance

Perform the following adjustments to the vendor documentation when launching the instance:

1. During step 4.a, select Ubuntu as AMI.

2. During step 4.b*,* select the latest Ubuntu AMI

3. During step 5*,* select a suitable Instance Type based on estimated performance requirements while fulfilling the Minimum Virtual Machine Requirements.

4. During step 6 & 7, Set Key pair & Network Settings as per your AWS policies. Ensuring the the Network settings still fulfills the Connectivity required for the Collector.

5. Before step 8, modify the Configure storage section with the following settings:

   1. Adjust the Root Volume to be at least 64 GiB.
   2. Add a secondary volume with at least 500 GiB according to the Minimum Virtual Machine Requirements.
      Secondary disk volume will be used for spooling, size it according to estimated log volume and max downtime.

6. Before step 8, expand the section Advanced details and paste in the content of the cloud-init.yaml file into the User data section. Ensure that the check box User data has already been base64 encoded is not enabled.

7. Proceed with step 8 and finish the rest of the installation as per the vendor documentation.

Azure Virtual Machine

Prerequisite steps:

1. Ensure you have the Azure cloud-init.yaml file you downloaded from Create, Configure and Download a Collector.. This file will be used later during the Virtual Machine instance deployment.

Follow the vendor documentation from Microsoft to launch a Virtual Machine instance:

• Create a virtual machine

Perform the following adjustments to the vendor documentation when launching the instance:

1. Under the Basic tab, select Ubuntu Server 22.04 LTS as image
2. Under the Basic tab, select a suitable Size based on estimated performance requirements while fulfilling the Minimum Virtual Machine Requirements.
3. Under the Disk tab, add one data disk with at least 500 GiB according to the Minimum Virtual Machine Requirements.
   Data disk volume will be used for spooling, size it according to estimated log volume and max downtime.
4. Under the Advanced tab, paste the contents of cloud-init.yaml in the Custom datafield.

All other settings such authentication, network configuration and monitoring should be configured according to company policy and best practices.

Validate Collector Status

1. Click Telemetry and select Collectors from the main menu

2. Select the relevant Collector from the presented list

3. View Status

After you provision a Collector VM and start it, it will go through a process of installing updates and modules specified in the configuration ISO file which you downloaded. The time taken for this process is dependent on factors like the speed of the hardware you are running the Collector on and connectivity to the repositories that it downloads updates from. In some cases this process can take around 30 minutes.

The Collector may show as “Offline” during the initial provisioning steps. This is not any cause for alarm.

If you have any problems, please submit a ticket via the Samurai MDR portal.

Collector Status Notifications

Samurai will send email notifications to registered application users should your Local Collector status change from Healthy to Not-Healthy or Unavailable. Once any issues have been resolved, you will also be notified again when a Healthy status is reached.

If your Local Collector be restarted, during final startup you may notice the Status change from Healthy to Not-Healthy, this is not cause for alarm as this typically occurs for a short period of time as processes restart. Once complete your Local Collector status will be displayed as Healthy.

What’s next?

You should now have a collector running within your environment!

The next step is to start configuring integrations which will allow the Samurai platform to start receiving your telemetry data.

Select Integrations Overview for more information on integrations and where to start.

If you require high availability for your collector, this can be achieved using the capabilities of your virtualization platform.

Deleting a Collector

If you delete a local collector it cannot be reversed! In addition, all of your integrations related to the local collector will also be deleted!

If you need to delete a local collector you can do so by following the steps below:

1. From your Samurai MDR portal click Telemetry and select Collectors
2. Select the relevant collector from your list
3. On the right hand side of the relevant collector, click on (more options) and select Delete Collector
4. The following warning will appear: ‘Warning: This is a destructive action and cannot be reversed.’. To ensure you intended to delete the collector you will need to type DELETE in the field and select Delete Collector

Replacing a Collector

If for some reason a Local Collector VM is lost due to corruption or damage, such as in the case of a major disk storage failure, you may need to replace your Collector. If this happens, you will need to delete the old Collector in the Samurai MDR portal, discard your old Collector VM image and then create a new Collector using the process described to Install a Collector.

Important Notes:

• If you need to replace a Collector VM, you cannot re-download the installer ISO for an existing Collector and redeploy it. You must delete the old Collector and replace it with a new one.
• You can re-use the same IP address as your old Collector. This allows you to replace a Collector without re-configuring any log sources which were sending logs to the old Collector.
• When replacing a Collector, any Integrations which were automatically detected and attached to the original Collector will be automatically detected and attached to the new Collector.
• Once you have created the new Collector, you will need to add any Integrations which you were previously using and which you had to previously manually add to the old Collector.

3.3.2 - Samurai Cloud Native Collector

The Cloud Native Collector is used to ingest data from public cloud storage. The Collector itself is agnostic to the data sent to cloud storage and monitors for new or updated files and pulls the data to the Samurai platform for ingestion - therefore there are minimum cloud storage retention requirements.

We recommend a minimum cloud storage retention period of 7 days

The Cloud Native Collector is used for specific integrations and is typically a requirement for Samurai to ingest events from Microsoft Azure, Amazon Web Services and third parties that leverage cloud storage. This will be clearly indicated within the Product Integration Guide.

If you have determined that you require a Cloud Native Collector then follow the steps below to configure and create the collector from the Samurai MDR portal and ensure it is working as expected.

Create Cloud Native Collector

1. From your Samurai MDR portal tenant, click Telemetry and select Collectors from the main menu

2. Select Create Collector

3. Select Cloud collector

4. Complete the fields as required.

5. Select Create Collector

6. Based on your Provider selection a Deploy to <Provider> will be displayed

7. Select Deploy to <Provider> - this will launch a template you should follow based on your Provider.

8. Click Close and follow the relevant section below based on your Provider.

The deployment button will only be displayed once after selecting Create Collector, therefore be sure to click the button before closing the dialog window.

Microsoft Azure

Selecting Microsoft Azure will launch an Azure Resource Manager (ARM) template. Follow the steps.

1. Complete the necessary fields within the template:

Project Details

Instance Details

2. Select Next

3. Select Review and Create

4. You are now complete and can navigate to the Samurai MDR portal.

Validate Collector Status

1. Select Collectors from the left-hand menu

2. Select the relevant Collector from the presented list

3. View Status

What’s next?

You should now have a collector running!

The next step is to start configuring integrations which will allow the Samurai platform to collect your telemetry data.

Select Integrations Overview for more information on integrations and where to start.

Deleting a Collector

If you delete a Cloud collector it cannot be reversed! In addition, all of your integrations related to the local collector will also be deleted!

If you need to delete a Cloud collector you can do so by following the steps below:

1. From your Samurai MDR portal click Telemetry and select Collectors from the main menu
2. Select the relevant collector from your list
3. On the right hand side of the relevant collector, click on (more options) and select Delete Collector
4. The following warning will appear: ‘Warning: This is a destructive action and cannot be reversed.’. To ensure you intended to delete the collector you will need to type DELETE in the window and select Delete Collector

4 - Analysis

4.1 - Advanced Query

Advanced Query provides a powerful interface that enables you to query your event data ingested into the Samurai platform. For instance, you can query for matching events which were logged or triggered in the past in order to fully understand the context.

After a threat has been responded to, Advanced Query can also play an important role in the forensic investigation of the threat, in order to determine both its extent and the sequence of events which occurred.

Advanced Query provides a very flexible interface which is based on Microsoft’s Kusto Query Language (KQL). This means that you can perform tasks ranging from simplistic queries all the way through to complex and powerful threat hunts in search of evasive threats.

The Advanced Query interface provides you with a graphical view showing the distribution of query matches over time. This allows you to easily spot deviations from the norm, and to identify the time when important events occurred.

Some examples of the functionality provided by Advanced Query include:

• Ability to use the KQL query language to cover simplistic searches across your data to running complex queries in support of Threat Hunting activities. 
• Ability to query the Samurai data lake for events over the entirety of your full retention period.
• Ability to provide a time-based visualization of the results matching your query enabling you to spot deviations from normal activity.
• Ability to easily filter in/filter out values.
• Ability to easily drill in and out using a graph of the overview, enabling you to quickly pivot across anything from small result sets, to ones containing millions of data points.
• Ability to query over a user-defined time period.
• Ability to easily search/filter the results and export the selected results.

Some example use cases, which can be covered by Advanced Query include:

• Verifying activity of an endpoint over a specified time period
• Tracking lateral movement of a threat actor
• Finding other endpoints which may have been affected by a breach
• Tracing the sequence of events in a breach
• Find all activity related to a specific attacker
• Confirming that new log sources are generating data and verify these are configured correctly.

The Advanced Query user interface is divided into a number of panes which provide:

• A time-picker allowing the user to easily select a time-period to apply a query. 
• An interactive KQL query editor.
• A filters panel, reflecting all the Fields available in the current result. This allows you to quickly filter in/out, search across the filter values and visually see the split between various values. This also allows you to quickly narrow down a query.
• A Results panel, showing all matching Alert and Event data, both in parsed and raw format. This allows you to easily search and filter cross the viewed result and export results of relevance.
• A User Tips panel, showing some quick Tips to assist the user in getting started in writing their first KQL queries.

To learn all about the feature within the Samurai MDR portal please review Advanced Query Functionality.

4.1.1 - Advanced Query Functionality

Advanced Query allows you to query all of your telemetry data ingested into the Samurai platform using Microsoft’s Kusto Query Language (KQL). You can use KQL to perform simple exploration of your data through to sophisticated threat hunting in search of security anomalies and evasive cyber security threats. 

In this article we provide an overview of each element of the interface within the Samurai MDR portal and its’s usage to enable you to maximize your query results.

Navigate to the Advanced Query Interface

1. Login to the Samurai MDR portal
2. Click Analysis and select Advanced Query located on the main menu

Figure 1: Advanced Query interface

Advanced Query Panels

Query Panel

The Query panel is where you write KQL queries. As you construct a query the interface auto-completes suggesting operators or schema.

Figure 2: Query panel auto-complete example

Click KQL quick reference for a list of operators/functions and their descriptions. You can also access our Tips by selecting the information icon ().

Figure 3: Advanced query Tips

Once you have completed writing your query click Run Query

Figure 4: Run Query

Time Period

Any query you run is based on a time period. Select a relevant time period when constructing a query to display results based on this time period.

If you use a timestamp operator within a query, the Time Period will be overridden and be viewed as ’Set in Query’.

Figure 5: Time period

Query History

To view your historical queries click (). This displays the latest 50 queries executed by you with time of execution and an option to add the query to a library. To save the query to a library, click () .For more information on saving a query jump to Save New Query.

Figure 6: Query history

Query Library

A library is where queries are saved for future use. There are different types of query libraries:

1. Standard library - useful queries provided and populated by NTT.
2. Organization library - queries saved within folders are available to any of your organization’s users with access to the MDR portal.
3. My library - queries saved within folders are only available to you.

Figure 7: Query library

Within ‘Organization library’ and ‘My library’ you can create folders to categorize and save your queries.

Save New Query

Click Add to save a query and select the Folder to save it in (you can also create a new folder here). You can optionally add a Description and MITRE ATT&CK category from the prepopulated list. Once complete click Save.

Figure 8: New query

Edit/Duplicate/Delete Queries

Click more options () if you need to edit or duplicate existing queries to refine them or alternatively delete.

Figure 9: Edit, duplicate and delete options

Editing or deleting queries in the ‘Organization Library’ will be seen by all users of your organization so be careful to ensure queries are not lost.

Fields Panel

The Fields panel displays all fields available based on the query. By default we query the events table which displays all fields available from your telemetry, this is divided into Favorite Fields and Other Fields.

Apply a filter to the fields by typing in the Filter window.

Each Field displays a count which represents the hits within the entirety of the query result.

Figure 10: Fields and count

By selecting a Field you can expand on the values within that field. For example, the graphic below highlights the ‘dest_ip’ field which displays all values with a Count and percentage of total

Figure 11: Field selection showing values

Samurai has default Favorite Fields, however you can update your Favorite Fields by selecting the Field and either select or deselect as a favorite by clicking .

Samurai prioritizes processing of Favorite Fields over Other Fields to optimize results and improve efficiency. Therefore activating ‘Favorite’ on a field will result in the data collection and count being prioritized and returned faster. Conversely, deactivating Favorite on Fields may also increase overall performance of the Favorite section.

To simplify query building you have the ability to select one or more values when you expand the field using the “+ - " symbols, this appends the value to include (==) or exclude (!=) from the query.

Figure 12: Add value to query

Based on the field you also have the ability to search and check the value against VirusTotal and/or AbuseIPDB (Click on the links to learn more). You can check public IP addresses against both databases or domain/filehash/url against VirusTotal.

Results Overview Panel

Query results are presented in a graphical overview, this may allow you to visually identify patterns or deviations in the results. The graph takes into consideration selected time-period, number of results matching the query and is presented with date/timestamp and total for each bar in the graph. Hovering over any bar in the graph will display the date/timestamp and total results.

Figure 13: Graphical result overview

Due to the way we process your telemetry, if your query includes the current time period there may be a slight delay in event data displayed in your results. 

The graph is also interactive, by clicking on any bar in the graph or by left click selection and highlighting multiple bars, the Fields and Results Panel are adjusted to display data in the selected time-period. You can also zoom in to specific results by selecting Zoom to Selection ()

Figure 14: Result selection

Additionally you can Zoom out () from any result set to view a larger time-period in relation to the active result. The Zoom out increment is based on the time period between the first result and last result and added to the ‘from’ and ’to’ time.

For example: First result at 13:00 and Last result at 14:00, is a 1 hour time difference. If you Zoom out this adjusts the time period 1 hour, therefore , 13:00, updates to 12:00 and 14:00 adjusts to15:00. Increasing the viewed time-period from 1 hour, to 3 hours.

By default a column chart type is displayed, however you also have the options to select from multiple chart types options, based on the chart type.

Figure 15: Chart types

If you wish to display results in an alternative chart type it is recommended to narrow down and refine your query through time period, fields and filters as visualizing results in a large data set may cause a ’too many data points’ notification.

Results Panel

The results panel displays an Events view (with timestamp and raw data) or Table view (with all events displayed in rows and each field in columns). The results panel will display up to 2000 results. 

Figure 16: Results panel

To optimize user experience and performance Samurai limits the results panel to a maximum of 2000 results. 2000 results could be a subset of a much larger result set based on your query, in these cases we recommend refining your query by adjusting the time period or adding specific filters - after all you would not want to review results which could potentially be in the 10’s or 100’s of thousands!

Results Panel Options

By selecting more options () displayed on the top right of the the result panel you can:

• Show favorite fields
• Show empty fields
• Autosize visible columns
• Clear all filters
• Clear all sorting
• Export to CSV - export the results displayed to CSV. This functionality takes into consideration result selections and active filters making it very easy to export specific results.

Figure 17: Results panel options

Expand the Result

You can view all event data in a vertical view by selecting expand () in both Event and Table views.

Filter the Result

You can create filters against any of the results by selecting () and choosing a filter option and parameter.

Figure 18: Filter options

You can also easily filter results from the Filter located at the top right of the Results Panel.

Filter / Copy based on value

By selecting more options () on any given field result you can copy to clipboard () or Add or Exclude filter to your query.

Figure 19: More options

When adding or excluding a specific field result to your query, Samurai attempts to automatically update the KQL query for you to run again!

What’s Next?

If you are new to KQL please refer to Constructing an Advanced Query or for comprehensive documentation refer to Microsoft KQL documentation.

4.1.2 - Constructing an Advanced Query

The Advanced Query feature within the Samurai MDR portal uses Microsoft’s Kusto Query Language (KQL). In this article we discuss the basics of KQL, the logic of a query and provide some examples to get you started.

What is KQL?

In short, KQL is as it states, a Query Language.

The “K” in KQL (Kusto) is named after Jacques Cousteau, the infamous ocean explorer! Just like Jacques’s exploration into the depths of the oceans, finding previously unknown volcanic basins, KQL provides you the ability to explore the expanse of your telemetry data.

Why and when use KQL?

Of course, you are not going to find any volcanic basins or new species of dolphin in your data, however in the cybersecurity context it will allow you to find actionable information. Use of KQL will allow you to investigate your data to answer simple questions such as ‘is my log source generating data’ through to tracing the sequence of events in a breach. You may be familiar with the term Threat Hunting, effectively searching for malicious, suspicious or nefarious activity - whether that be proactive via determining a hypothesis through to hunts based on Indicators of Compromise (IOCs) and Indicators of Attack (IOAs). In essence, using KQL helps you answer the following questions:

1. Does X exist
2. Where does X exist?
3. Why does X exist?
4. How to respond?

KQL Logic

A typical query is structured to search, locate information and produce results.

The structure may include:

1. What? table to query
2. Pipe (|) for command separation
3. Filter
4. Order data
5. Modify Columns in results

Lets walk through some simple examples to understand the logic.

Find events between two hosts

events | where src_ip == "10.170.236.50" and dest_ip == "10.179.236.106"

1. The first step in this query outlines what to query, in this example it is the “events” table. By default Samurai always queries the “events” table.
2. The pipe ( | ) command is always used for command separation.
3. We then use a ‘where’ operator to filter within the query for the source ip address (src_ip) of “10.170.236.50” and a destination IP address (dst_ip) of “10.179.236.106”

When looking at the results of a query, you will be presented with associated Fields based on the query which allows you to narrow down your search. KQL query statements work like a funnel, starting with a large data set and passing it through multiple operators until it is filtered, summarized or rearranged as required.

By selecting a Favorite Field or Other Field you can start to narrow down your results to your requirements. Alternatively you may choose to include the fields within the query itself or use the ***Project operator ***to include specific column fields within your result.

Refer to Advanced Query Functionality to understand more on Favorite Fields and Other Fields.

Search for events with source IP 10.170.236.50 and display a table with a few selected columns

The pipe ( | ) command is always used for command separation

events | where src_ip == "10.170.236.50" | order by timestamp|project timestamp, action, src_ip, src_port, dest_ip, dest_port

1. Query the ’events’ table
2. Filter events using the where operator for source IP address “10.170.236.50”
3. Use the order operator to order results by timestamp
4. Use the project operator to include the column fields “timestamp, action, src_ip, src_port, dest_ip, dest_port”

The simple examples above make use of common operators, use the KQL quick reference guide for more info on operators which includes a comprehensive list with definitions.

Complex Examples

Lets now walk through some more complex examples.

Frequency of Events

A common requirement is to find the frequency of occurrence of an event. For instance, in this example we are reviewing Amazon VPC Flow logs and finding which destination IP addresses are receiving the most connections to port numbers below 1024.

events| where product == "Secure Firewall (FTD)" and toint(dest_port) <1024| summarize connections = count() by dest_ip |order by connections

What is also worth noting in this example is that we first need to convert the destination port number to an integer type (as it is a text field) before checking if it is a low-numbered port (less than 1024). For more information on the data types used in the data lake, you can refer to the article on event field data types.

This query produces output which looks something like this:

The result helps us to see which IP addresses are accepting the most connections to privileged ports.

Querying raw logs

Advanced Query isn’t only able to query logs from sources which originate from supported integrations. The fact that logs from any kind of syslog source can be ingested into the Samurai platform makes it possible to query the raw content of these logs using Advanced Query.

In the example below, we are taking authentication logs from a host, and querying for failed authentication attempts. We are able to use the extend operator and extract function to create our own fields from the log lines, parsing them using regular expressions.

events| where host == "10.1.1.1" and (raw contains "Invalid" or raw contains "fail") and raw !contains "connect"| extend message = substring(raw,16)| extend src_host = extract("([A-Za-z0-9\\-]+).+",1, message)|extend msg_info = extract("\\[[0-9]+\\]\\:(.+)",1, message)| extend app_src = extract("[A-Za-z0-9\\-]+([a-zA-Z0-9\\-]+).+",1, message)| extend user = extract("([A-Za-z0-9\\-]+) from",1, msg_info)| extend src_ip = extract("from([0-9a-f\\.\\:]+)",1, msg_info)| project timestamp, host, src_host, app_src, user, src_ip, msg_info| summarize attempts = count()by src_ip| order by attempts

Once we have extracted the fields we want, we can then go on to perform more operations. In this case we are summarizing the logs by counting the failed authentication attempts by source IP address, and ordering the list so that the IP address with the most failed attempts is listed first. In this case, this helps us to find potential brute force attackers who are trying to guess passwords through brute force tactics.

Tips!

Be Specific when constructing queries!

Used correctly, Advanced Query can perform sophisticated queries matching against a data set measured in terabytes within seconds! However poorly constructed queries can cause problems, cause dreaded browser slowdowns, or even trigger a query time-out when exceeding the maximum allowed query wait time. The more specific you are with your query, the quicker you are able to will get to the Result.

Refer to the Microsoft documentation Query Limits for further information on limitations.

Lets look at an example:

• Try not run a query with no criteria (for example simply ‘events’) against a long timer period. Whilst this might be tempting to view all events, this will match ALL events in your Samurai tenant, delivering a sub optimal experience - results for such a query could potentially be measured in Gigabytes or at times Terabytes!

Instead, try to be as specific as possible:

• If you are querying activity for a specific source host, add a where statement specifically asking for results from a specific source:

events  where src == "172.21.33.99"

• Example:

  • matching results: 9 100 000 events
  • Approx time to completion: Partial results in 45 seconds.

• If you are researching activity related to a specific source type, extend the query to specifically ask for results matching a type:

events  where src == "172.21.33.99" and type == "WEBPROXY"

• Example:

  • matching results: 3 700 000 events
  • Approx time to completion: Full Results in 40 seconds.

• If you are looking for specific fields, extend the query to specifically project specific fields:

events | where src == "172.21.33.99" and type == "WEBPROXY" | project timestamp, src, url

• Example:
  • matching results: 3 700 000 events
  • Approx time to completion: Full Results in 7 seconds

What Now?

As you may have realized from reading this article, Advanced Query is a powerful tool - only limited by your own understanding of KQL and in determining what questions or hypothesis against your data you may have. We recommend you start by writing a few simple queries and review the Microsoft documentation. If you need a reminder of usage in the Samurai MDR portal, be sure to review Advanced Query Functionality.

4.1.3 - Event field data types

When using Advanced Query to analyze Events stored in the data lake, it is sometimes necessary to be aware of the data types of the fields of the records being processed.

For instance if you want to perform a numeric comparison on the value of a field, you need to ensure that it has a numerical data type (such as an integer) or otherwise type-cast it first. For instance, in the following example, we are testing for privileged port numbers (below 1024), but the dest_port field is a string:

events| where  product == "VPC Flow Logs" and toint(dest_port) < 1024

Here we are using the toint() statement to convert the dest_port field to an integer before making a numerical comparison.

This raises the question of how to determine the data types of fields. You can use the getschema  statement to display the data types of fields. The following query will display the types of the fields of the entire schema:

events  | getschema

This example produces output something like this:

To find the type of a specific field, you can use the search bar above the output:

This example selects all the fields whose names contain the substring “port”.

If you know the name of the field whose type you want to query, you can use the project statement to filter out only that field:

4.2 - Alerts

What is an alert?

An alert is a security detection made by the Samurai platform or third party vendor where Samurai is ingesting telemetry.

How are alerts triggered?

Alerts are triggered by detection engines based on single or multiple events. The Samurai MDR portal displays alerts categorized according to the underlying detection engine. These categories include:

• Samurai platform

  • Real-time engine - Proprietary NTT developed detection engine that leverages behaviour modeling, machine learning, and the latest threat research to automatically identify suspected threats during real-time analysis of ingested telemetry into the Samurai platform.
  • Hunting engine - Intelligence-driven detection engine based on the Sigma project but customized by NTT with additional detection capabilities. The Samurai hunting engine performs automated threat hunting to idenfiy and alert on possible adversary activity.

• Vendor

  • Alerts generated by and collected from third-party vendor technologies which are integrated with the Samurai platform (e.g Endpoint Detection & Response (EDR) and Firewall technologies)

We are working on additional documentation which will walk through the Samurai platform concepts and usage in more depth so look out for updates!

What alerts are displayed within the Samurai MDR portal?

We display the same alerts as our Samurai Security Operation Centre (SOC) analysts view.

Do I need to review and act on alerts?

No. The Samurai SOC analysts triage, investigate and validate alerts as part of your Managed Detection & Response (MDR) service. As alerts are validated by the Samurai SOC analysts and investigated, they may potentially lead to a reported Security Incident and are marked accordingly. Our strategy includes visibility and transparency of the service we provide to you therefore this feature provides you that visibility showcasing the value of the service. Refer to the Alert Dashboard which provides some key alert metrics over a given time period.

Next Steps

To further understand Alerts within the Samurai MDR portal we recommend you review the Alerts View article.

4.2.1 - Alerts View

In this article, all elements of the Alert View are outlined to help you understand the alerts displayed.

Navigate to Alert View

1. Login to the Samurai MDR portal
2. Click Analysis and select Alerts on the main menu

Figure 1: Alert view example

Alerts Summary

Alerts are summarized in a panel which can be updated based on a specified time period and includes:

• Security Incidents - the total number of security incidents reported to you that may correspond to one or more alerts.
• Alerts - the total number of alerts detected by the Samurai platform and third party vendor integrated with the Samurai platform.
• Real-time engine - the total number of alerts detected by the Samurai real-time engine
• Hunting engine - the total number of alerts detected by the Samurai hunting engine
• Vendor - the total number of alerts collected from third-party vendor products integrated with the Samurai platform

Figure 2: Alerts summary example

Filters

Various filters are available to determine the alerts to be displayed.

Figure 3: Time and Display filter

The total number of alerts within the alerts table in displayed to the left of the Time Period filter.

Time period

You can update all panels to specific date and time ranges. We default to the Last 24 hours however have included Quick time ranges.

Figure 4: Date and time selection

Display Filter

Enter any values you wish to filter and highlight within the display filter.

Figure 5: Display filter

Alert Column Filter

Adjust and show/hide any of the column values within the Alert Table.

Figure 6: Alert column filter

Alerts Table

All alerts are listed within the alert table, important to note is that the table is limited to 10,000 alerts therefore apply filters to narrow the results.

What are the Alert table fields?

Review the table below outlining each field displayed:

If MULTI is displayed in any of the fields it denotes multiple entries e.g multiple destinations are represented as MULTI. Some fields may also be blank if the Samurai platform does not have the underlying data.

5 - Reports

Reporting provides you valuable insight into your service and includes metrics which help you understand your organizations security posture and the value of Samurai MDR.

A standard template entitled Executive Overview is currently available which has been designed to address common needs and highlights different facets of the service.

Create a Report

To create a PDF report from the standard template:

1. Login to the Samurai MDR application
2. Select Reports from the main menu
3. Select Create Report
4. Enter a Title for the report (if a title is not provided it will default to the template name)
5. Select a Report start date (this will be from 00:00:00 UTC of start date)
6. Select a Report end date (if the current date is selected, the current time will be used. If the current date is not selected the end of day 23:59:59 is used)
7. Select Create Report

Report Status

As a report is generated, the status flag can get the following states:

Should your report fail, click on retry. If it continues to fail check your report start and end date. If all else fails raise a ticket with us!

Viewing a Report

You can view a report once generation has completed by downloading in PDF format, simply click on download ().

The report will be saved in the following format: ‘Title’_‘start-date’_-_’end-date’.pdf.

Reporting Functionality

• Column Filtering ()

  • Select Columns to toggle on or off any of the column fields to optimize your view of all report

• Filtering ()

  • Filter your report list view by any of the fields

• Export Report List ()

  • You can export your report list to a CSV file

• Refresh ()

  • Refresh your page view

The Executive Overview Template

The executive overview template was designed to provide insight into the MDR service over a reporting time period you can specify. The report itself is intuitive and self explanatory however below is an outline and description of each report section:

Service Activity

This section of the report focuses on activity related to security incidents, general tickets submitted by your organization via the Samurai MDR application and integration data within the specified reporting period of the report. This includes:

• The number of new and closed Security incidents reported to your organization over the reporting period selected.

• The number of new and closed General tickets submitted by your organization over the reporting period selected.

• New security incidents by severity

  • If new security incidents were reported to you within your selected reporting period then a graph will be displayed depicting the number of open security incidents by severity.
  • Review Security Incidents for additional information on security incident reporting and severities and MDR Incident Management for our incident management process.

• Closed security incidents by severity

  • If security incidents were closed during your selected reporting period then a graph will be displayed depicting the number of closed security incidents by severity.

• New security incidents by MITRE ATT&CK category

  • If new security incidents were reported to you within your selected reporting period then a table will be displayed outlining the number of security incidents reported ranked by MITRE ATT&CK category.

• Security incidents

  • A table providing additional information of each security incident within the reporting period ranked by creation date.

• Security Monitoring Funnel

  • The funnel graphic depicts the total number of events from your telemetry sources ingested into Samurai, the alerts that were analyzed and validated security incidents reported to your organization. This funnel infers the value of the service based on the data analyzed focusing on detecting and reporting threats to your organization.

• Data Usage

  • This graphic is helpful for you to understand your subscription quota against actual usage.

• Data ingested per product

  • Graph depiction of data usage per integrated telemetry data source within the reporting period.

• Data Ingested

  • Further detail on data ingested per integrated telemetry data source within the reporting period.

• Alerts Analyzed per vendor

  • Graph depiction of alerts analyzed per vendor within the reporting period. The graph shows both vendor alerts and detection made by the Samurai platform (shown as NTT).

• Alerts Analyzed

  • A table providing alert counts per vendor within the reporting period. The table shows both vendor alerts and detections made by the Samurai platform based on the ingested data.

• New general tickets by priority

  • If your organization submitted any general tickets during your selected reporting period then a graph will be displayed depicting the number of general tickets by priority.

• Closed general tickets by priority

  • If your organization’s general tickets were closed during your selected reporting period then a graph will be displayed depicting the number of general tickets by priority

• New general tickets by category

  • If new general tickets were submitted by your organization within your selected reporting period then a table will be displayed outlining the number of general tickets ranked by category.

• General Tickets

  • A table providing additional information of each general ticket submitted by your organization within the reporting period ranked by creation date.

Current Status

This section of the report focuses on all reported security incidents and also general tickets submitted by your organization as of your reporting end date. This includes:

• All open Security Incidents as of reporting end date

• All open general tickets submitted by your organization as of the reporting end date

• Open security incidents severity

  • A graph depicting all open security incidents reported to you by severity as of the reporting end date.

• Open security incidents by status

  • A graph depicting all open security incidents reported to you by status as of the reporting end date. 

• Open security incidents by age

  • A graph depicting all open security incidents reported to you by ages in days as of the reporting end date.

• Open security incidents

  • A table providing additional information of all security incidents reported to you as of the reporting end date ranked by age in days. 

• Open general tickets by priority

  • A graph depicting all open general tickets submitted by your organization ranked by priority as of the reporting end date. 

• Open general tickets by status

  • A graph depicting all open general tickets submitted by your organization ranked by status as of the reporting end date. 

• Open general tickets by age

  • A graph depicting all open general tickets submitted by your organization ranked by age days as of the reporting end date.

• Open general tickets

  • A table providing additional information of all general tickets submitted by your organization as of the reporting end date ranked by age in days. 

Trending

This section of the report focuses on historical trends related to open and closed security incidents and general tickets submitted by your organization over the last 13 months from the end date of the reporting period. The start date is when data became available over the 13 month period.

• Opened and closed security incidents

  • A graph highlighting opened and closed security incidents by month illustrating historical trends over the last 13 months from the reporting end date.

• Opened and closed security incidents cumulative

  • A cumulative graph highlighting opened and closed security incidents by month illustrating historical trends over the last 13 months from the reporting end date.

• Average time to close security incidents

  • A graph highlighting the average number of days to close a security incident over the last 13 months from the reporting end date.

• Opened and closed general tickets

  • A graph highlighting opened and closed general tickets submitted by your organization by month illustrating historical trends over the last 13 months from the reporting end date.

• Opened and closed general tickets cumulative

  • A cumulative graph highlighting opened and closed general tickets submitted by your organization by month illustrating historical trends over the last 13 months from the reporting end date.

• Average time to close general tickets

  • A graph highlighting the average number of days to close a ticket submitted by your organization over the last 13 months from the reporting end date.

• Data usage

  • A graph highlighting data usage over the last 13 months from the reporting end date.

6 - Admin

6.1 - Management

Profile Settings

Select your user account at the top left of the Samurai MDR portal to access your settings.

User Preferences

Sign out

Click to sign out, this will ensure your session is securely shutdown.

Appearance

Choose between a light or dark appearance for the application by toggling between the two modes.

Language

Toggle between the supported languages - English, Swedish or Japanese.

Tenants

Tenants that you belong to are listed. If you have multiple tenants simply select the tenant you wish to view.

News Feed

The news feed is populated by Samurai Security Operation Center (SOC) analysts and may include news such as how we are handling new and emerging threats, blog posts on interesting security research as well as updates on new releases.

The news feed is viewed by clicking on the news icon (), with the latest title and an indication of any unread news displayed. The latest 15 news items are displayed and more can be fetched by clicking on more at the bottom of the list.

Important news items will be highlighted and include a warning icon beside the title in the feed.

Admin

User Management

To view all users of your tenant select Admin - User Management from the main menu.

Within User Management you can view all users including when they were created. You also have the ability to export you user list to CSV by selecting Export.

If you need to remove users please contact the SOC by raising a request in the Samurai MDR portal (we are working on enhancing user management so please watch this space!)

Invite Users

To add new users you can send an invite from the MDR portal, this will send an email allowing the user to register their account.

1. Login to the Samurai MDR portal and select Admin - User Management
2. Select Invite Users and add the email address of the user. You can add multiple email addresses as needed.
3. An email will be sent from no-reply@security.ntt to each user requesting them to Register Account and complete Account Details.
4. Further registration information can be found in Getting Started with Samurai MDR

7 - Product Integration Guides

7.1 - Apache HTTP Server

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Apache HTTP Server hosted on a Linux host to send access and error logs to a Samurai Local Collector deployed on your network by configuring rsyslog.

Connectivity Requirements

Configure Apache HTTP Server

Ensure that Apache HTTP Server is configured to log to syslog
Add or modify the ErrorLog and CustomLog directives in your Apache configuration file, normally located at /etc/apache2/apache2.conf:

ErrorLog "|/usr/bin/logger -p local6.error -t apache_error"CustomLog "|/usr/bin/logger -p local6.info -t apache_access" combined

Restart the Apache service to apply the configuration:

sudo systemctl restart apache2

Configure log forwarding with rsyslog

Follow the below steps to configure rsyslog to forward Error and Access events.

Rsyslog prerequisites

Ensure the following statement is included in the main rsyslog configuration file, normally located at /etc/rsyslog.conf:

$IncludeConfig /etc/rsyslog.d/*.conf

If no IncludeConfig statement exist for the /etc/rsyslog.d/ directory, append it to the end of rsyslog.conf.

Create /etc/rsyslog.d/ntt_apache.conf

Create /etc/rsyslog.d/ntt_apache.conf and insert the below configuration block, enter the Local Collector IP in the Target field.

template(name="apache-log" type="string" string="<%PRI%>1 %TIMESTAMP:::date-rfc3339% %HOSTNAME% %APP-NAME% %PROCID% apache_log %STRUCTURED-DATA% %msg%\n")if $programname == 'apache_error' then { action(  queue.type="LinkedList" queue.size="10000" type="omfwd" template="apache-log" Target="<Local Collector IP>" Port="514" Protocol="tcp" )}if $programname == 'apache_access' then {action(queue.type="LinkedList" queue.size="10000" type="omfwd" template="apache-log" Target="<Local Collector IP>" Port="514" Protocol="tcp")}

Validate and restart service

Confirm that rsyslog can parse the configuration without any errors by running:

rsyslogd -N1

Then restart the rsyslog service:

sudo systemctl restart rsyslog

The log messages will now be forwarded to the Samurai Local Collector.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.2 - Aruba Networks ClearPass

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Aruba Networks ClearPass to send logs to a Samurai Local Collector deployed in your network.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Syslog Configuration

Follow the below steps in ClearPass Policy Manager to enable syslog output to the local collector.

1. Add a Syslog Target using the following parameters:

   Parameter	Value
   Host Address	IP of the Samurai Local Collector
   Protocol	TCP
   Server Port	514

2. Create Syslog Export Filters for each event type using the following parameters:

   Parameter	Value
   Export Template	Audit Records, Insight Logs and Session Logs
   Export Event Format Type	CEF
   Syslog Servers	Syslog target created in the above step

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.3 - Azure Virtual Networks (NSG Flow)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure a Network Security Group to send flow diagnostic logs to Samurai via a cloud native collector.

Prerequisites

Ensure that a cloud native collector has been deployed via the Samurai MDR portal. 

• Guide available here

The storage account created via the cloud native collector needs to reside in the same region as the telemetry sources which will be ingested into the Samurai platform. For ingesting telemetry from multiple regions you need to create additional cloud native collector(s) for each region.

Take note of the name of the storage account created and which subscription it resides in. This will be used later when setting up the telemetry sources.

If you are planning to reuse an already deployed cloud native collector, the information about the created storage account and subscription can be found via:

1. Navigate to the Samurai MDR portal.
2. On the left navigation pane, click Telemetry and select Collectors.
3. Click on the name of the desired collector.
4. Note down information about the:
   1. Subscription
   2. Storage account name

Alternatively, you can utilize the integration setup wizard via the Samurai MDR portal for the desired telemetry source listed on Product Integration Guide page which shall provide you the same information required to setup your telemetry source.

Enabling NSG flow logs

Follow the vendor documentation guide to enable NSG flow logs.

• Create a flow log - Via Azure Portal

When following the vendor documentation, please perform the following adjustments:

• Ensure when configuring the Storage Account setting that it’s referencing the storage account that was setup during the creation of the cloud native collector.
• Ensure that version 2 for the Flow Logs Version is configured. This should be the default value when configuring via the Azure Portal.
• Ensure the retention period aligns with your storage policies however we recommend at minimum 7 days.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.4 - Blackberry CylancePROTECT

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure CylancePROTECT to send logs to a Samurai Local Collector deployed on your network. CylancePROTECT requires access to the Local Collector via syslog on port 514/TCP.

To complete this Integration you will need to:

1) From the Cylance Console

• Cylance syslog configuration

Cylance syslog configuration

Samurai Local Collector only supports on-premise deployments of CylancePROTECT

Only CylancePROTECT events are supported

Follow the steps outlined within the Blackberry documentation:

• Configure Cylance Endpoint Security to send events to a SIEM solution or syslog server

Use the following parameters when completing the steps:

Default settings should be used unless otherwise specified in the listed parameters

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.5 - Check Point Next-Generation Firewall

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

To complete this Integration you will need to:

1) Ensure Connectivity Requirements are in place

• Connectivity Requirements

2) From Check Point Management Console:

• Configure Syslog Settings
• Create an NTT Account 
• Defining Trusted Clients
• Enable Packet Capture for IPS Protections
• Enable Packet Capture for IPS Core Protections

3) From the Samurai MDR portal:

• Complete the Check Point Next-Generation Firewall Integration

Connectivity Requirements

Check point logs will be sent from the management server to the Samurai Local Collector via syslog.

Configure Syslog Settings

The syslog exporter package must be installed. Dependent on your Check Point version you may need to update. To validate requirements review the Check Point documentation found at:

• Log Exporter - Check Point Log Export

Once you have validated or updated your Check Point version follow the steps outlined in the Check Point documentation section Advanced Deployment:

• Log Exporter - Check Point Log Export - Advanced Deployment 

Use the following parameters when completing the Advanced Deployment :

Table 1: Log Exporter

An example of the command to run based on the table above is:

cp_log_export add name NTT-LOGEXPORT target-server <SAMURAI Local Collector IP> target-port 514 protocol tcp format default read-mode semi-unified export-attachment-ids true

Create an NTT Account 

When you Complete the Check Point Next-Generation Firewall Integration in the Samurai MDR portal you can choose to use a username/password or API key for authentication. Note the authentication method when following the steps below.

Follow the Check Point documentation to create an NTT Account with password authentication:

• Creating an Administrator Account with Check Point Password Authentication

Follow the Check Point documentation to create an NTT Account with API key authentication:

• Creating an Administrator Account with API Key Authentication

The URL provided directs you to R81 Check Point administrators guide, be sure to follow the steps for your specific version.

Use the following parameters when completing the steps:

Table 2: NTT User creation

If selecting API authentication then be sure to copy the key to Complete the Check Point Next-Generation Firewall Integration.

Defining Trusted Clients

In order to allow the NTT Account to access the Security Management Server via either username/password or API key it may be needed to configure Trusted Clients in the Check Point Management Console.

Follow the Check Point documentation when defining trusted clients:

• Defining Trusted Clients

General recommendation is to limit access to IPv4 Address and specifying the IP address of the Samurai Local Collector.

IPv4 Address filtering do not always work on all Check Point Management Console versions and one therefore needs to resort to utilize Any instead.

Enable Packet Capture for IPS Protections

Follow the Check Point documentation to enable packet capture for specific profiles:

• Activating Protections for a Specified Profile

The URL provided directs you to R81 Check Point Threat Prevention guide, be sure to follow the steps for your specific version.

It is recommended to enable packet capture for all signatures that are active within the used profile.

Use the following parameters when completing the steps:

Table 3: IPS Protections

Enable Packet Capture for IPS Core Protections

Follow the Check Point documentation to enable packet packet for IPS Core Protections:

• Editing Core IPS Protections

The URL provided directs you to R81 Check Point Threat Prevention guide, be sure to follow the steps for your specific version.

It is recommended to enable packet capture for all signatures that are active within the used profile.

Use the following parameters when completing the steps:

Table 4: IPS Core Protections

Complete the Check Point Next-Generation Firewall Integration

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations from the main menu

3. Click Create

4. Find and select Check Point Next-Generation Firewall

5. You will be presented with the Local Collector IP Address on the left of the screen

6. To configure Extended Telemetry Collection ensure it is enabled via the toggle

7. Enter the following information:

   • Name for the Integration - the name will appear in the Samurai MDR portal for you to easily reference
   • Description - optional but if completed will appear in the Samurai MDR portal for you to easily reference)
   • Devicename - an arbitrary name to identify the Check Point device
   • IP - IP address of host - this can include multiple separated by a comma (,)
   • API-key (optional) - if this is not specified will default to Username/Password
   • Domain (optional) - if the user is created in a specific domain, specify the domain
   • Username (optional) - enter a username if not using an API-Key
   • Password - specify password to use
   • Port - if you have changed the default port enter the port number, if not, we default to 443

8. Click on Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.6 - Cisco Identity Services Engine (ISE)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Cisco Identity Services Engine to send logs to a Samurai Local Collector deployed in your network.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Configure Syslog

Follow the steps outlined in Remote Logging Target Settings using the following parameters:

With the following logging categories enabled:

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.7 - Cisco IOS Routers and Switches

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Cisco IOS to send logs to a Samurai Local Collector deployed on your network. Your Cisco IOS device(s) require access to the Local Collector via syslog on port 514/UDP.

To complete this Integration you will need to:

1) From your Cisco IOS device

• Configure Log
• Test the logging configuration
• Configure ACL log

Configure Log

Use these instructions to configure Cisco IOS.

1. Log into the Cisco IOS device and specify the following commands:

1. en  
2. conf t  
3. no logging on  
4. archive
5. log config
6. logging enable
7. logging size 1000
8. notify syslog contenttype plaintext
9. hidekeys
10. exit
11. exit

The preceding exit commands will take you from the config-archive-log-cfg command mode to the config command mode.

12. logging host [Local Collector IP Address] where [Local Collector IP Address] is the IP address of the Samurai Local Collector deployed on your network.
13. logging trap 6
14. login on-failure log every 1
15. login on-success log every 1
16. logging origin-id hostname
17. logging source-interface [Interface Name] where [Interface Name] is the name of the interface that has access to the Samurai Local Collector.
18. no service sequence-numbers
19. no service timestamps
20. service timestamps log datetime localtime show-timezone
21. no logging message-counter syslog
22. no logging console
23. no logging monitor
24. logging buffered 16384 informational
25. logging on
26. end
27. wr mem  

Test the logging configuration

1. Execute the following commands to generate a %SYS-5-CONFIG_I log.

conf t
end

This will test the configuration and connectivity to the Samurai Local Collector.

Configure ACL log

To configure logging of specific ACLs, add the option log to the end of the ACL to be monitored. For example:

access-list 101 deny tcp any host 192.168.35.0/24 25 log

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.8 - Cisco Meraki MX Security Appliances

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Cisco Meraki Security Appliances to send logs to a Samurai Local Collector deployed on your network. Cisco appliances require access to the Local Collector via syslog on port 514/UDP.

To complete this Integration you will need to:

1) From the Meraki Dashboard:

• Meraki syslog configuration

Meraki syslog configuration

Log in to the Meraki Dashboard and complete the following steps:

1. Click Network-wide.
2. Click General.
3. Click Add a syslog server.
4. In the Server IP field, enter the IP address of the Collector appliance deployed on your network.
5. Specify the Port as 514.
6. Select all the available Roles.
7. Click Save.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.9 - Cisco Secure Endpoint

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

Cisco Secure Endpoint logs and data are collected via REST API.

To complete this Integration you will need to:

1) Within the Cisco Secure Endpoint web interface

• Determine API Endpoint
• Generate API Credentials

2) From Cisco Secure Malware Analytics

• Generate Secure Malware Analytics API Credentials

3) From the Samurai MDR portal:

• Complete the Cisco Secure Endpoint

Determine API Endpoint

The URL for API access Secure Endpoint depends on the region the instance is located, at the time of writing the following are available:

• api.amp.cisco.com
• api.apjc.amp.cisco.com
• api.consumer.amp.cisco.com
• api.eu.amp.cisco.com

The URL for API access to Secure Malware Analytics depends on the region the instance is located, at the time of writing the following are available:

• https://panacea.threatgrid.com
• https://panacea.threatgrid.eu

Take note of the appropriate URLs as it will be required when completing the Integration within the Samurai MDR portal.

Generate API Credentials

Use the steps below to generate API credentials to allow a Samurai cloud collector to gather telemetry from Secure Endpoint:

You can also refer to Cisco documentation for further information at Generate and Delete API Credentials

1. Log in to your Cisco Secure Endpoint Instance.

2. Click Accounts > API Credentials

3. Click + New API Credential

4. Add a new API key with the following information:

   • In the Application name field, enter an appropriate name

   • From the Scope list, ensure Read & Write is selected

   • Click Create

5. The API credentials are displayed

6. Make a note of the 3rd Party API Client ID and API Key values

The Read & Write scope is required to create the stream for collecting events.

You will need the API Client ID and API Key when completing the integration within the Samurai MDR portal.

Generate Secure Malware Analytics API Credentials

Use these steps to generate API credentials to allow Samurai to gather telemetry from Secure Malware Analytics:

1. Log in to your Cisco Secure Malware Analytics Instance.

2. In the top-right click on your account name,then My Account

3. If no API key has been generated previously, click Generate API Key

4. Make a note of the API Key

You will need the API Key when completing the integration within the Samurai MDR portal.

Complete the Cisco Secure Endpoint Integration

You will need:

• Devicename (arbitrary name)
• API Endpoint (from Determine API Endpoint)
• API Client ID (from Generate API Credentials)
• API Key (from Generate API Credentials)
• Secure Malware Analytics API Key (from Generate Secure Malware Analytics API Credentials)

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations

3. Select Create

4. Locate and click Cisco Secure Endpoint

5. Click Next (we leverage a Samurai Cloud Collector)

6. Enter a Name of Integration

7. Enter a Description (Optional)

8. Enter your Devicename 

9. Enter your API Endpoint

10. Enter your API Client ID

11. Enter your API Key

12. Enter your Secure Malware Analytics Endpoint

13. Enter your Secure Malware Analytics API Key

14. Click Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.10 - Cisco Secure Firewall (ASA Appliances)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Cisco Secure Firewall (ASA Appliances) to send logs to a Samurai Local Collector deployed on your network. Your Cisco appliances require access to the Local Collector via syslog on port 514/UDP.

To complete this Integration you will need to:

1) From your Cisco Firewall:

• Configure syslog

Configure syslog

Perform the following steps to configure syslog:

1. Log in to the Cisco ASA

2. From the command line specify the following commands to setup logging:

en
conf t
logging enable
logging timestamp
logging device-id
logging standby
logging trap debugging
logging queue 1024
logging host [interface name] [Local Collector IP Address]

where:

[interface name] is the name of the interface closest/routable to the Local Collector, and
[Local Collector IP Address ] is the IP address of the Samurai Local Collector deployed on your
network .

For further information from Cisco on CLI configuration you can refer to Cisco ASA Series General Operations CLI Configuration Guide.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.11 - Cisco Secure Firewall (Firepower Threat Defense)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Cisco Secure Firewall Threat Defense (FTD) (previously entitled Firepower Threat Defense) to send syslog to a Samurai Local Collector. 

Cisco Secure Firewall Management Center (FMC) is required.

1) Ensure Connectivity Requirements are in place

• Connectivity Requirements

2) From Cisco Secure Firewall Management Center console:

• Send Security Event Syslog Messages from FTD Devices
• Enabling External Access to the Database
• Database User Creation

3) From the Samurai MDR portal

• Complete the Cisco Firepower Threat Defense Integration

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Send Security Event Syslog Messages from FTD Devices

Follow the steps outlined within the Cisco documentation:

• Send Security Event Syslog Messages from FTD Devices

Default settings should be used unless otherwise specified in the listed parameters

Cisco Documentation Step 1:

Use the following parameters:

You can also refer to Configure a Syslog Server if you have queries based on options available

Table 2: Syslog settings

Cisco Documentation Step 2:

Use the following parameters:

Table 3: General logging settings

Cisco Documentation Step 3:

Complete the steps outlined.

Cisco Documentation Step 4:

Use the following parameters:

Cisco Documentation Step 5:

Complete the steps outlined.

This step if only applicable if using Snort 2

Enabling External Access to the Database

Follow the steps outlined within the Cisco documentation:

• Enabling External Access to the Database

Use the following parameters when completing the steps:

Table 6: Enable external access to database

Database User Creation

Follow the steps outlined within the Cisco documentation:

• Add an Internal User

Use the following parameters when completing the steps:

Table 7: User for Database Access

Complete the Cisco Secure Firewall (Firepower Threat Defense) Integration

1. Login to the Samurai MDR portal
2. Click Telemetry and select Integrations from the main menu
3. Click Create
4. Find and select Cisco Secure Firewall (Firepower Threat Defense)
5. Select the relevant Local Collector and click Next
6. You will be presented with the Local Collector IP Address 
7. Click Next
8. Complete the fields required including the Database Username and Password you created in Database user creation
9. Click on Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.12 - Cisco Umbrella

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes all steps required to configure Cisco Umbrella to send logs to an S3 bucket and allows Samurai to access (read-only) and ingest the logs.

Cisco Umbrella integration requires a self managed AWS S3 bucket. For more information on Cisco Umbrella logging refer to the Cisco documentation Manage Your Logs.

If you already have an AWS S3 bucket configured and have enabled Cisco Umbrella logging then jump straight to Configure an existing AWS S3 bucket to allow Samurai access

If you have not enabled Cisco Umbrella logging to an AWS S3 bucket then follow the steps below to complete the integration:

1) Ensure you have been provided the following parameters from NTT

• IntegrationsID
• Passkey

These parameters will be made available to you during onboarding

2) Have an Amazon AWS Account

• If you do not have an AWS Account you can refer directly to Cisco Umbrella documentation Enable Logging to your own S3 bucket. This document makes reference to Amazon’s S3 documentation.

3) Decide on an S3 Data Retention Period

• Defined by you and your retention policy, this refers to automatic deletion of objects in the S3 bucket after X number of days. The default is 7 days, however you can override the value and select a maximum of 365 days.

4) From your browser

• Launch the integration stack and complete

5) From your Cisco Umbrella console

• Enable logging

Launch the integration stack and complete

Complete the following steps from your browser:

1. Browse to:

• https://github.com/NTTS-Innovation/samurai-xdr-cloud-integrations/tree/main/providers/aws

We have simplified the integration through use of a CloudFormation Template that creates the following resources:

• SNS Topic
• S3 Bucket with SNS Notification of ObjectCreated Events
• Secure Bucket Policy, Allowing Samurai RO access
• SNS HTTPS Webhook Subscription to the Samurai Platform

2. Click on Launch Stack 

3. Sign in to your AWS Account with administrative permissions

4. The Create Stack page will be shown: 

5. Select your AWS region to deploy the stack:

6. Click on Next

7. The Specify stack details page will be shown:

• Specify a unique Stack name (optional) we default to NTTSamuraiS3Stack 

• Enter the following parameters previously provided to you by NTT:

  • Samurai Cloud IntegrationsId
  • Samurai Cloud Integrations Pass Key

• Select Yes under Enabled Cisco Umbrella access to Cloud Integrations S3 Bucket via Bucket Policy

• Leave The name of an existing Cisco Umbrella Bucket blank

• Update the Samurai Cloud Integrations Bucket Data Retention period (as needed) 

The default retention period is 7 days (we recommend 7 days but based on your retention policy you can override the value as necessary)

8. Click Next

9. The Configure stack options will be shown:

10. Click Next

11. You can now Review the steps worked through:

12. Click Create Stack

13. You will now be shown the stack Events:

14. Select the Resources tab:

15. Make note of the S3 bucket name as you will need this when configuring Cisco Umbrella. The S3 bucket name is the Physical ID of the S3 Bucket and is also a hyperlink.

16. To verify the webhook has registered with Samurai, click on the hyperlink of the Physical ID of the SamuraiSNS Topic (Logical ID)

17. The Topic details page will open, you should see Status as Confirmed (see example below):

From your Cisco Umbrella console

Follow the Enable Logging section (Steps 1-3) in the Cisco Umbrella documentation:

Ensure you have the exact name of the AWS S3 bucket

• Enable Logging

Your integration is now complete. If you have any problems or questions please raise a ticket or reach out to your NTT point of contact.

Configure an existing AWS S3 bucket to allow Samurai access

If you already have Cisco Umbrella logging to a self managed AWS S3 bucket then follow the steps below:

1) Ensure you have been provided the following parameters from NTT

• IntegrationsID
• Passkey

These parameters will be made available to you during onboarding

2) From your browser

• Launch the integration stack and complete

Launch the integration stack and complete

Complete the following steps from your browser:

1. Browse to:

• https://github.com/NTTS-Innovation/samurai-xdr-cloud-integrations/tree/main/providers/aws

We have simplified the integration through use of a CloudFormation Template that creates the following resources:

• SNS Topic
• SNS HTTPS Webhook Subscription to the Samurai Platform

2. Click on Launch Stack 

3. Sign in to your AWS Account with administrative permissions

4. The Create Stack page will be shown: 

5. Select your AWS region to deploy the stack:

6. Click on Next

7. The Specify stack details page will be shown:

• Specify a unique Stack name (optional) we default to NTTSamuraiS3Stack 

• Enter the following parameters previously provided to you by NTT:

  • Samurai Cloud IntegrationsId
  • Samurai Cloud Integrations Pass Key

• Select Yes under Enabled Cisco Umbrella access to Cloud Integrations S3 Bucket via Bucket Policy

• Under The name of an existing Cisco Umbrella Bucket enter the name of your existing S3 Bucket (an example is depicted in the graphic)

• Update the Samurai Cloud Integrations Bucket Data Retention period (as needed) 

The default retention period is 7 days (we recommend 7 days but based on your retention policy you can override the value as necessary)

8. Click Next

9. The Configure stack options will be shown:

10. Click Next

11. You can now Review the steps worked through:

12. Click Create Stack

13. You will now be shown the stack Events

14. You can view Resources created:

15. You must now Create Event Notifications. Browse to your existing S3 Bucket Properties

16. Click Create Event Notification

17. The Create event notification window will be shown:

Scroll down for Destination

18. Complete the following fields with the following parameters: (leave all other fields as default)

19. Click Save Changes

20. You now need to add an S3 bucket policy. Browse to your existing S3 Bucket Properties

21. Select Edit and add the following statements:

{   "Effect": "Allow",   "Principal": {      "AWS": "arn:aws:iam::600502389717:user/samurai-xdr-s3-reader-user"   },   "Action": [      "s3:GetObject",      "s3:ListBucket"   ],   "Resource": [   "arn:aws:s3:::samurai-12a98319b803",   "arn:aws:s3:::samurai-12a98319b803/*"   ]}

21. Click Save changes

22. To verify the webhook has registered with Samurai. Go to the Resources tab of the Samurai Stack and click on the hyperlink of the Physical ID of the SamuraiSNS Topic*(Logical ID)***

23. The Topic details page will open, you should see Status as Confirmed (see example below):

24. You now need to ensure the S3 Object Ownership of your existing S3 bucket to ensure Samurai is able to download the logs. Sign-in to the AWS Management Console and open the Amazon S3 console (if you have not already done so!) at https://console.aws.amazon.com/s3/

25. In the Buckets list choose the name of the bucket that you want to apply an S3 Object Ownership setting to

26. Choose the Permissions tab

27. Under the Object Ownership, choose Edit

28. Under Object Ownership ensure Bucket owner preferred is enabled (as depicted in the graphic below)

29. Click Save changes

30. If you have ACLs disabled, your integration is now complete***.***

31. If you have ACLs enabled you will need to edit the ACL

32. In the Buckets list choose the name of the bucket that you want to set permission for

33. Choose Permissions

34. Under Access control list, choose Edit

35. Under Access for other AWS account, click Add grantee

36. Enter 5501afb2b26d7609fe4051b3d23916c6c185da004301607ebbb71883d12d4142 as the canonical ID

37. Click List (under Objects) and Read (under Bucket ACL)

38. Click Save Changes

Your integration is now complete. If you have any problems or questions please raise a ticket or reach out to your NTT point of contact.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.13 - Citrix Netscaler (Formely Netscaler ADC)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Citrix Netscaler to send logs to a Samurai Local Collector deployed on your network. Citrix Netscaler requires access to the Local Collector via syslog on port 514/UDP.

To complete this Integration you will need to:

1) From your Citrix Netscaler Appliance :

Follow the steps outlined within the Citrix documentation:

• Configuring Netscaler appliance for audit logging

Use the following parameters when completing the steps:

Table 1: Audit-log Action

Table 2: Audit-log Policy

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.14 - Claroty Continuous Threat Detection (CTD)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Claroty CTD to send logs to a Samurai Local Collector deployed on your network. Claroty CTD requires access to the Local Collector via syslog on port 514/TCP.

Prerequisites

This document supports Claroty CTD versions 3.x, and 4.x.

The following integration will configure Rules for Baseline, Event and Alert Logs. A user account is also created for read-only API access to gather additional telemetry.

To complete this Integration you will need to:

1) From the Claroty Web management user interface

• Configure Save CAPs and Detect Known Threats

• Configure Rules for:

  • Baseline Rule
  • Events Rule
  • Alert Rule

• Create an account for API access

• Create a Group with permissions for the API access account

2) From the Samurai MDR portal

• Complete the Claroty Continuous Threat Detection (CTD) Integration

Configure Save CAPs and Detect Known Threats

1. Log in to Claroty’s web configuration dashboard.
2. Click the Configuration tab.
3. In the Networks area:
   • Select the checkbox to enable Save Caps
   • Select the checkbox to enable Detect Known Threats

Configuration of Rules

If a field is not mentioned, please leave it unchanged

Baseline Rule

1. Log in to Claroty’s web configuration dashboard.

2. On the main menu on the left, click Configuration

3. Select Integrations > SIEM Syslog

4. Complete the following steps to add a rule to send baseline logs:

5. In the SIEM Syslog screen click on the “+” button

6. In the From list, click the relevant site(s)

7. The Add new Syslog screen will appear

8. Update the following fields:

   • Uncheck the LOCAL checkbox
   • From the MESSAGE CONTENTS list, click Baselines
   • From the MESSAGE FORMAT list, click CEF
   • Protocol - select all from the available list
   • Communication Type - select all available options
   • Access Type - select all available options
   • Server - enter in the IP address of your Samurai Local Collector
   • Port - enter 514
   • Protocol - TCP

9. Click Save

Events Rule

1. Log in to Claroty’s web configuration dashboard.

2. On the main menu on the left, click Configuration

3. Select Integrations > SIEM Syslog

4. Complete the following steps to add a rule to send Events logs:

5. In the SIEM Syslog screen click on the “+” button

6. In the From list, click the relevant site(s)

7. The Add new Syslog screen will appear

8. Update the following fields:

   • Uncheck the LOCAL checkbox
   • From the MESSAGE CONTENTS list, click Events
   • From the MESSAGE FORMAT list, click CEF
   • Below Select Filters for the corresponding alerts configure:
   • Category - select all available selections
   • Protocol - select all from the available list
   • Server - enter in the IP address of your Samurai Local Collector
   • Port - enter 514
   • Protocol - TCP

9. Click Save

Alert Rule

1. Log in to Claroty’s web configuration dashboard.

2. On the main menu on the left, click Configuration

3. Select Integrations > SIEM Syslog

4. Complete the following steps to add a rule to send Alerts logs:

5. In the SIEM Syslog screen click on the “+” button

6. In the From list, click the relevant site(s)

7. The Add new Syslog screen will appear

8. Update the following fields:

   • Uncheck the LOCAL checkbox
   • From the MESSAGE CONTENTS list, click Alerts
   • From the MESSAGE FORMAT list, click CEF
   • Category - select all available selections
   • Protocol - select all from the available list
   • Server - enter in the IP address of your Samurai Local Collector
   • Port - enter 514
   • Protocol - TCP

9. Click Save

Create an account for API access

1. Log in to Claroty’s web configuration dashboard.
2. On the main menu select Configuration and Users
3. In the User Management configuration screen, Click Add new users
4. Enter a Username
5. Enter a Full Name
6. Enter a Password
7. Repeat the Password
8. Click Add

You will need to provide these credentials to NTT during onboarding

If your Security and Authentication > Password Expires are not set to 0 (0=unlimited) you will need to ensure you update the password before it expires.

Create a Group with permissions for the API access account

If a field is not mentioned, please leave it unchanged

1. Log in to Claroty’s web configuration dashboard.
2. On the main menu select Configuration and Groups
3. In the Group Management configuration screen, Click Add new groups
4. Enter a Group Name
5. Select the user created in Create an account for API access from the Add User dropdown list
6. In the Systems Permissions area, Click Add permission
7. Select specific sites to which the permissions applies, or All Sites
8. From the All dropdown list, select relevant option
9. Set the appropriate permission level to Read
10. Click Save

Complete the Claroty Continuous Threat Detection (CTD) Integration

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations from the main menu

3. Click Create

4. Find and select Claroty Continuous Threat Detection (CTD)

5. Select the relevant Local Collector and click Next

6. You will be presented with the Local Collector IP Address on the left of the screen

7. To configure Extended Telemetry Collection ensure it is enabled via the toggle

8. Enter the following information:

   • Name for the Integration - the name will appear in the Samurai MDR portal for you to easily reference
   • Description - optional but if completed will appear in the Samurai MDR portal for you to easily reference)
   • Devicename - an arbitrary name to identify the Claroty CTD device
   • IP Address - the IP address of Claroty CTD
   • Username - enter the username you created in Create an account for API access
   • Password - enter the password you created in Create an account for API access
   • Port (Optional)- if you have changed the default port enter the port number, if not, we default to 5000

9. Click on Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.15 - Claroty xDome

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Claroty xDome to send logs to a Samurai Local Collector deployed in your network.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Configure Claroty Syslog

Follow the steps outlined in About Claroty Syslog (Claroty login is required) using the following parameters:

Table 2: Claroty Syslog Configuration

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.16 - Crowdstrike Falcon Insight

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

To complete this Integration you will need to:

1) From the Crowdstrike Falcon Console:

• Submit a Support case with Crowdstrike
• Create credentials for basic authentication
• Create a new API client

Crowdstrike credentials are required

2) From the Samurai MDR portal:

• Complete the Crowdstrike Falcon Insight Integration

3) Complete and send authorization form

Submit a support case with Crowdstrike

As our integration leverages the ‘Legacy API Credentials’ for the ‘Threat Graph API’ you must submit a support case directly with Crowdstrike for enablement. Please refer to the following Crowdstrike documentation.

Please note Crowdstrike key-based APIs are deprecated however with the exception of Threat Graph API and Tailored Intel API as per the Crowdstrike documentation

Create credentials for basic authentication

To create credentials for basic authentication, perform the following steps:

1. Log in to the Crowdstrike Falcon Console

2. Click the Support and resources icon in the left menu pane.

3. Under Resources and tools select API Clients and Keys. The API Clients and Keys page is displayed.

4. Select the Legacy API Credentials tab.

5. Click Create Credentials

6. Copy the Username and Password. You will need the credentials to Complete the Crowdstrike Falcon Insight Integration

Figure 1: Credentials for basic authentication

Create a new API client

To create a new API client follow the steps below:

1. Log in to the Crowdstrike Falcon Console

2. Click the Support and resources icon in the left menu pane.

3. Under Resources and tools select API Clients and Keys. The API Clients and Keys page is displayed.

4. Click Create API client. The Create API client page appears.

5. Perform the following steps:

5.1 Specify NTT API Client in the CLIENT NAME field.

5.2 Specify API client for NTT in the DESCRIPTION field.

5.3 Under API SCOPES, perform the following steps:

5.4 Select the Read checkbox for:

• Detections
• Host
• Host groups
• Prevention policies
• Event Streams,
• User Management.

5.5 Select the Write checkbox for:

• Hosts.

6. Click Add.

Figure 2: Add new API client

7. Copy and record the values :

• CLIENT ID
• SECRET

Figure 3: Client ID and Secret

The Secret is displayed only once so ensure to record it for use during Complete the Crowdstrike Falcon Insight Integration

8. Take note of your Cloud location which is dervived from the Base URL as per the table below, you will need to specify the cloud location under Complete the Crowdstrike Falcon Insight Integration.

The table below outlines the Cloud location and Base URL:

9. Click DONE.

Complete the Crowdstrike Falcon Insight Integration

You will need:

• OAuth Client ID: (from Step 7 under Create a new API client)
• OAuth Secret: (from Step 7 under Create a new API client)
• Basic User: (from Step 6 under Create credentials for basic authentication)
• Basic Password: (from Step 6 under Create credentials for basic authentication)
• Cloud location: (from Step 8 under Create a new API client)

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations from the main menu

3. Select Create

4. Locate and click Crowdstrike Falcon Insight

5. Click Next (we leverage a Samurai Cloud Collector)

6. Enter a Name of Integration

7. Enter a Description (Optional)

8. Enter a Devicename

9. Enter your OAuth Client ID

10. Enter your OAuth Secret

11. Enter your Basic User

12. Enter your Basic Password

13. Select your Cloud Location (US-1 is default). 

14. Click Finish

Complete and send authorization form

Our SOC requires access to your Crowdstrike GUI in order to:

• Perform deeper investigations
• Access data not present in the APIs
• Perform remote isolation tasks

To ensure the SOC has access please complete this form Authorization Form for Access to Crowdstrike Falcon Host by MSP Personnel. Once you have completed, email the form to mssp@crowdstrike.com.

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.17 - CyberArk Privileged Access Security (PAS)

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure CyberArk PAS to send logs to a Samurai Local Collector deployed on your network. Your CyberArk PAS Vault deployment requires access to the Local Collector via syslog on port 514/UDP.

To complete this Integration you will need to:

1) From CyberArk Vault

• Configure Vault to forward syslog messages

Configure Vault to forward syslog messages

Follow the steps below, you may also wish to refer to CyberArk documentation.

1. Download ntt.xsl.

2. Log in to the (primary) CyberArk PAS Vault server as the administrator user

3. Navigate to the <CyberArk install folder>\Server\Syslog directory.

• By default, the subdirectory is: C:\Program Files (x86)\PrivateArk\Server\Syslog

4. Copy the ntt.xsl file into the directory.

5. Navigate to the <CyberArk install folder>\Server\ directory.

• By default, the subdirector is: C:\Program Files (x86)\PrivateArk\Server\

6. Copy the existing DBParm.ini file to DBParm.ini.bak file within the same directory (in case you need to rollback)

7. Edit the DBParm.ini file and make the following configuration changes:

If you are configuring more than one syslog destination, each parameter must match the number of hosts in SyslogServerIP. Each CSV position in SyslogServerIP will correspond with the same CSV position in other fields.

For example:

SyslogServerIP=1.1.1.1,2.2.2.2

SyslogServerPort=514,6514

In the above example, server 1.1.1.1 would match with port 514, while server 2.2.2.2 would match with port 6514.

• For SyslogServerIP, enter the IP address of the Samurai Local Collector deployed on your network.
• For SyslogServerPort, enter 514
• For SyslogServerProtocol, enter TCP
• For SyslogTranslatorFile, enter Syslog\ntt.xsl
  This is the file mentioned in step 1 & 4
• For SyslogMessageCodeFilter, enter 0-999.
• For UseLegacySyslogFormat, enter No.

The changes to DBParm.ini should look like the following example:

[SYSLOG]SyslogServerIP=1.1.1.1SyslogServerPort=514SyslogServerProtocol=TCPSyslogTranslatorFile=Syslog\ntt.xslSyslogMessageCodeFilter=0-999UseLegacySyslogFormat=No

Apart from the SyslogServerIP parameter, ensure that the parameter statements match those shown above. If you are copying and pasting from this document, ensure that each parameter statement is on a separate line and that no unwanted spaces are introduced.

8. Save the file

9. Restart the Vault server

Ensure that there are no errors in the log file. A list of possible messages that could appear in the log file are included in CyberArk documentation - Syslog Messages

10. If applicable. perform the procedure on all Primary and Satellite Vaults.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.18 - ESET PROTECT

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure ESET PROTECT On-Prem to send logs to a Samurai Local Collector deployed in your network.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Syslog Configuration

Follow the steps described in Export logs to Syslog using the following parameters:

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.19 - F5 BIG-IP LTM

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

Ensure correct network connectivity

You must ensure the following connectivity requirements are fulfilled:

Follow steps in F5 documentation

Perform the steps outlined in the vendor documentation to configure and implement a Request Logging profile:

• Configuring Request Logging

You may also refer to the F5 Knowledgebase article for more information K00847516: Configuring request logging using the Request Logging profile

Perform the below settings adjustments under the relevant section. In case a setting property is not referenced below, simply use the default value.

Creating a pool with request logging to manage HTTP traffic

• IP address of logging server: Insert the IP address of the Samurai Local Collector.
• Service Port: 514

Creating a request logging profile

• HSL Protocol: TCP
• Custom Request Settings: BIGIP_LTM_WEB $BIGIP_HOSTNAME $VIRTUAL_NAME $NCSA_COMBINED

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.20 - Fortinet FortiAnalyzer

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

To complete this Integration you will need to:

1) Ensure Connectivity Requirements are in place

• Connectivity Requirements

2) From the FortiAnalyzer

• Create a restricted profile
• Configure log forwarding
• Create a new administrator

3) From your Fortigate devices (if using Fortigate devices)

• Enable FortiGate to send logs and PCAP to FortiAnalyzer

4) From your FortiWeb devices (if using Fortiweb devices)

• Configure FortiAnalyzer policies

5) From the Samurai MDR portal:

• Complete the FortiAnalyzer integration for each Fortigate

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Create a reduced restricted profile

Follow the steps outlined in the Fortinet documentation:

• Clone the restricted user system profile (V7.x)

Select Administrator Profiles to read more about Fortinet profiles (v7.x)

Use the following parameters when completing the steps:

Configure log forwarding

Follow the steps outlined in the Fortinet documentation:

• Configuring log forwarding (V7.x)

Use the following required parameters when completing the steps:

Create a new administrator

Follow the steps outlined in the Fortinet documentation:

• Create a new administrator

Use the following parameters when completing the steps:

Enable FortiGate to send logs and PCAP to FortiAnalyzer

All FortiGate devices in scope must be connected to the FortiAnalyzer to send logs and PCAP.

Follow the steps outlined in the Fortinet documentation:

• Log settings and targets

Use the following required parameters when completing the steps:

 If this is the first time remote logging is configured and the FortiGate device was not previously added to FortiAnalyzer, the device needs to be authorized under FortiAnalyzer Device Manger to be able to upload its logs. Perform this on the FortiAnalyzer

Disk backed log buffer is recommended on Fortigates with an SSD disk. 

Follow the steps outlined in the Fortinet documentation:

• Log buffer on Fortigates with an SSD disk

Configure FortiAnalyzer policies for FortiWeb

Follow the steps in the section entitled ‘Configuring FortiAnalyzer policies’ outlined in the Fortinet FortiWeb documentation:

• Logging

Complete the Fortinet FortiAnalyzer Integration

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations from the main menu

3. Click Create

4. Find and select Fortinet FortiAnalyzer

5. Select the relevant Local Collector and click Next

6. Enter the following information

   • Name for the Integration - the name will appear in the Samurai MDR portal for you to easily reference
   • Description - optional but if completed will appear in the Samurai MDR portal for you to easily reference)
   • The Username and Password you created in Create a new administrator
   • Select Enable PCAP (only applicable to FortiGate devices) which was enabled in Enable FortiGate to send logs and PCAP to FortiAnalyzer
   • Hostname/IP - enter FortiAnalyzer hostname or IP address
   • ***Port (Optional) -***if you have changed the default port enter the port number, if not, we default to 443
   • adom (optional) - if not specified we default to “root”

7. Click on Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.21 - Fortinet FortiGate Next-Generation Firewall

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

1) Ensure Connectivity Requirements are in place

• Connectivity Requirements

2) From FortiGate Next-Generation Firewall console:

• Configure Syslog Forwarding Settings
• Configure Log Settings for Each Security Features
• Configure IPS Packet Logging
• Configure the Storage Settings
• Configure API Access Permission and Create API Key

3) If you have configured the options above, from the Samurai MDR portal:

• Complete the Fortinet FortiGate Next-Generation Firewall Integration

CLI commands may depend on Forti OS version. Refer to the relevant Fortinet documentation if needed.

This guide assumes that you are not using the VDOM feature.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Configure Syslog Forwarding Settings

Execute the CLI commands outlined in the FortiGate Next Generation Firewall documentation.

• config log syslogd4 setting

config log syslogd4 setting
   set status enable  
   set server [IP address of your Samurai Collector]
   set mode udp
   set port 514
   unset source-ip
   set format default
end

• config log syslogd4 filter

config log syslogd4 filter
   set filter [see table 1]
   set filter-type include  
end

The following table shows the value indicating the send log for each security function.

Table 1: Security Features Logs To Be Sent

Configure Log Settings for Each Security Features

Execute the CLI commands outlined in the FortiGate Next Generation Firewall documentation.

• config firewall policy

config firewall policy
   edit [Policy ID]
       ...
   set logtraffic [utm or all]
   set logtraffic-start disable
       ...
   next
end  

• config antivirus profile

config antivirus profile   edit [Profile Name]      ...      set extended-log enable      ...   nextend

• config webfilter profile

config webfilter profile
   edit [Profile Name]
      ...
    set log-all-url disable
    set web-content-log enable
    set web-filter-activex-log enable
    set web-filter-command-block-log enable
    set web-filter-cookie-log enable
    set web-filter-applet-log enable
    set web-filter-jscript-log enable
    set web-filter-js-log enable
    set web-filter-vbs-log enable
    set web-filter-unknown-log enable
    set web-filter-refere-log enable
    set web-filter-cookie-removal-log enable
    set web-url-log enable
    set web-invalid-domain-log enable
    set web-ftgd-err-log enable
    set web-ftgd-quota-usage enable
    set extended-log enable
    set web-extended-all-action-log enable
   next  
end  

• config ips sensor

config ips sensor
   edit [Sensor Name]
      ...
     set extended-log enable
        config entries
           edit [ID]
           set location all
           set severity info low
           set protocol all
           set os all
           set application all
           set status [enable or default]
            (please refer to the table below)
           set log enable
           set log-packet disable
           set log-attack-context disable
           set action [pass or block or reset or default]
            (please refer to the table below)
            ...
           next
           edit [ID]
              set location all
              set severity medium high critical
          set protocol allset os all
          set application all
          set status [enable or default]
               (please refer to the table 2)
          set log enable
          set log-packet enable
          set log-attack-context disable
          set action [pass or block or reset or default]
              (please refer to the table 2)
              ...

Tip: Ensure evaluation order of IPS sensor entries so that the above settings apply properly.

Table 2: Matching Actions to Status

Configure IPS Packet Logging

Execute the CLI command outlined in the FortiGate Next Generation Firewall documentation.

• config ips settings

config ips settings   set packet-log-history 5   set packet-log-post-attack 10   set ips-packet-quota 0end

Configure the Storage Settings

After checking [HD logging space] with the following command, determine the size of [log-quota] with the following calculation:

[log-quota] = [Total HD logging space] / 2 

[log-quota] should be rounded down to the nearest thousand. In the following example, the [log-quota] is 88000.

diagnose sys logdisk usage
Total HD usage: 236286 MB/333 MB
Total HD logging space: 177214 MB
HD logging space usage for vdom "root": 106 MB/177214 MB  

Execute the CLI command outlined in the FortiGate Next Generation Firewall documentation.

• config log disk setting

config log disk setting
   set status enable  
   set ips-archive enable  
   set max-policy-packet-capture-size 100  
   set log-quota [calculated value above,for example here, 88000]  
   set maximum-log-age 5  
   set full-first-warning-threshold 75  
   set full-second-warning-threshold 90  
   set full-final-warning-threshold 95  
   set max-log-file-size 20  
   set roll-schedule daily  
   set diskfull overwrite
...  

Configure API Access Permission and Create API Key

Follow the steps outlined in the FortiGate Next Generation Firewall documentation.

• Administrator profiles 

Use the following parameters when completing the deployment:

Table 3: Administrator Profile

• Create new REST API admin

Use the following parameters when completing the deployment:

Table 4: REST API Admin

Complete the Fortinet FortiGate Next-Generation Firewall Integration

1. Login to the Samurai MDR portal

2. Click Telemetry and select Integrations from the main menu

3. Click Create

4. Find and select Fortinet FortiGate Next-Generation Firewall

5. Select the relevant Local Collector and click Next

6. You will be presented with the Local Collector IP Address on the left of the screen

7. To configure Extended Telemetry Collection ensure it is enabled via the toggle

8. Enter the following information:

   • Name for the Integration - the name will appear in the Samurai MDR portal for you to easily reference
   • Description - optional but if completed will appear in the Samurai MDR portal for you to easily reference)
   • Devicename - an arbitrary name to identify the Fortinet device
   • API-Key - you generated under Create new Rest API Admin
   • Select Enable PCAP
   • Hostname/IP - hostname or IP address of Fortinet device to collect alerts from
   • Port - if you have changed the default port enter the port number, if not, we default to 443

9. Click on Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.22 - Fortinet FortiWeb

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Fortinet FortiWeb to send logs to a Samurai Local Collector deployed on your network. FortiWeb requires access to the Local Collector via syslog on port 514/UDP. 

If you have deployed a FortiAnalyzer, please refer to the Fortinet FortiAnalyzer integration guide.

1) From FortiWeb console:

• Configure syslog policy
• Configure trigger Policy
• Configure log destination
• Enable log types

We reference version 7.0.4 documentation, be sure to select the version applicable to your FortiWeb

For more information on FortiWeb logging refer to Fortinet documentation ‘Logging’.

Configure syslog policy

Follow the steps outlined in the section entitled ‘Configuring Syslog settings’ located within the Fortinet documentation:

• Logging

Use the parameters defined in the table below for each field:

Table 1 - Syslog settings

Configure trigger policy

Follow the steps outlined in the section entitled ‘Configuring triggers’ within the Fortinet documentation:

• Configuring triggers

Use the parameters defined in the table below for each field:

Table 2 - Trigger policy

Configure log destination

Follow the steps outlined in the section entitled ‘Configure log destinations’ within the Fortinet documentation:

• Configure log destinations

Use the parameter defined in the table below for each field:

Table 3 - Log destination

Enable log types

Follow the steps outlined within the Fortinet documentation:

• Enabling log types, packet payload retention, & resource shortage alerts

Use the parameter defined in the table below for each field:

Table 4 - Log types

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.23 - GestioIP IPAM

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure GestioIP asset information retrieval from a Samurai Local Collector deployed in your network.

The API access used by this integration requires the commercial edition of GestioIP.

This integration only provides contextual data for use by the MDR SOC. No data from this integration will be visible in the Samurai MDR portal.

Connectivity Requirements

Create GestioIP User

Follow the steps outlined in section 8.1.1.1 GestioIP Documentation to create a local user or section 8.1.2.2 if using LDAP. If using the authorization feature of GestioIP, ensure that the created user is added to the Read Only default group.

Complete the GestioIP IPAM Integration

1. Login to the Samurai MDR portal
2. Click Telemetry and select Integrations from the main menu
3. Select Create
4. Locate and click GestioIP IPAM
5. Select a Samurai Local Collector
6. Enter the URL to your GestioIP instance
7. Enter User and Password as created in Creating GestioIP User
8. Click Finish

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.24 - Google Workspace

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

To complete this Integration you will need to perform steps in both Google Workspace and the Samurai MDR portal.

The Google Workspace integration leverages two APIs which are part of the Admin SDK API

1. Google Workspace Reports API
2. Google Workspace Alert Center API

Follow the steps below:

1. From Google Workspace

• Enable the Admin SDK API
• Create a service account
• Create credentials for the service account
• Delegate domain-wide authority to the service account

2. From the Samurai MDR portal

• Complete the Google Workspace Alert Center integration

Enable the Admin SDK API

Follow the Google API Console Help documentation:

• Enable and disable APIs

A Google API Console project is required and will be created during the steps.

Ensure you login to the Google Console as a super administrator and use the following parameters when completing the steps:

Review the API Console Help pages if you require more information on Google APIs.

Create a service account

Follow the steps outlined within the Google documentation:

• Create a service account

Ensure you have the Project selected that you created in Enable the Admin SDK API

Ignore the optional steps 4 and 6 when creating the service account.

Use the following parameters when completing the steps:

Take note of the Service Account email address in Step 3 as it will be needed when you Complete the Google Workspace integration

Create credentials for the service account

Follow the steps outlined within the Google documentation:

• Create credentials for a service account

Download the json file as it will be required when you Complete the Google Workspace integration

Delegate domain-wide authority to the service account

Follow the steps outlined within the Google documentation:

• Set up domain-wide delegation for a service account

Ensure you login with a super admin account and take note of the associated email address as you will need in when you Complete the Google Workspace integration

Use the following parameters when completing the steps:

Complete the Google Workspace integration

You will need:

• JSON file you downloaded in Create credentials for the service account
• The admin account email used in Delegate domain-wide authority to the service account

1. Login to the Samurai MDR portal
2. Click Telemetry and select Integrations from the main menu
3. Select Create
4. Locate and click Google Workspace 
5. Click Next (we leverage a Samurai Cloud Collector)
6. Enter a Name of Integration
7. Enter a Description (Optional)
8. Enter your Service Account JSON (copy and paste from the json file you downloaded)
9. Enter your Domain-Wide delegation account (the admin account email used for domain-wide delegation)
10. Click Finish

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.25 - Infoblox DDI

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure an on-premise Infoblox DDI device to send logs to a Samurai Local Collector deployed in your network.

To complete this Integration you will need to:

1. Ensure correct network connectivity
2. Perform Grid Configuration
3. Perform Data Management Configuration

Ensure correct network connectivity

You must ensure the following connectivity requirements are fulfilled:

Perform Grid Configuration

Perform the steps outlined in the vendor documentation to add an external syslog server:

• Specifying Syslog Server

Perform the below settings adjustments. In case a setting property is not referenced below, simply use the default value:

• Address: Insert the IP address of the Samurai Local Collector.
• Transport: Select TCP.
• Node ID: Select Host Name.
• Severity: Select Info.
• Logging Category: Select Send selected categories and then enable all logging categories.

This is performed to enable prefixing of the log messages instead of using the Send all option when configuring Send selected categories.

Perform Data Management Configuration

Perform the steps outlined in the vendor documentation to configure DNS logging categories:

• Setting DNS Logging Categories

Perform the below settings adjustments. In case a setting property is not referenced below, simply use the default value:

• Logging Category: Select all the available categories.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.26 - Linux Authentication

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Linux hosts to send authentication logs to a Samurai Local Collector deployed on your network by configuring rsyslog.

Connectivity Requirements

You must ensure the following connectivity requirements are available:

Table 1: Connectivity requirements

Configure log forwarding with rsyslog

Follow the below steps to configure rsyslog to forward authentication events.

Rsyslog prerequisites

Ensure the following statement is included in the main rsyslog configuration file, normally located at /etc/rsyslog.conf:

$IncludeConfig /etc/rsyslog.d/*.conf

If no IncludeConfig statement exist for the /etc/rsyslog.d/ directory, append it to the end of rsyslog.conf.

Create /etc/rsyslog.d/ntt_auth.conf

Create /etc/rsyslog.d/ntt_auth.conf and insert the below configuration block, enter the Local Collector IP in the Target field.

template(
  name = "linux-auth"
  type = "string"
  string = "<%PRI%>1 %TIMESTAMP:::date-rfc3339% %HOSTNAME% %APP-NAME% %PROCID% linux_auth %STRUCTURED-DATA% %msg%"
)

if ($syslogfacility-text == "auth" or $syslogfacility-text == "authpriv") then {
  action(
    queue.type="LinkedList"
    queue.size="10000"
    type="omfwd"
    template="linux-auth"
    Target="<Local Collector IP>"
    Port="514" Protocol="tcp")
}     

Validate and restart service

Confirm that rsyslog can parse the configuration without any errors by running:

rsyslogd -N1

Then restart the rsyslog service:

sudo systemctl restart rsyslog

The authentication messages will now be forwarded to the Samurai Local Collector.

For integrations that utilize a Local Collector where we ingest syslog only, you do not need to follow specific steps in the Samurai MDR portal as we auto detect the vendor and product. The only reason you need to use the Samurai MDR portal is if you need to determine the Local Collector IP address. Of course you will still need to ensure the integration is functioning! See Integrations for more information on checking status.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.27 - Microsoft Azure Activity Logs

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Microsoft Azure to send Activity Logs to Samurai via a cloud native collector.

Ensure that a cloud native collector has been deployed via the Samurai MDR portal. 

• Guide available here

The storage account created via the cloud native collector needs to reside in the same region as the telemetry sources which will be ingested into the Samurai platform. For ingesting telemetry from multiple regions you need to create additional cloud native collector(s) for each region.

Take note of the name of the storage account created and which subscription it resides in. This will be used later when setting up the telemetry sources.

If you are planning to reuse an already deployed cloud native collector, the information about the created storage account and subscription can be found via:

1. Navigate to the Samurai MDR portal.
2. Click Telemetry and select Collectors from the main menu
3. Click on the name of the desired collector.
4. Note down information about the:
   1. Subscription
   2. Storage account name

Alternatively, you can utilize the integration setup wizard via the Samurai MDR portal for the desired telemetry source listed on Product Integration Guide page which shall provide you the same information required to setup your telemetry source.

Enabling Azure Activity logs

Follow the vendor documentation guide to enable Microsoft Azure Activity logs.

• Create diagnostic settings in Azure Monitor

When following the vendor documentation, please perform the following adjustments:

• Select the following log categories

  • Administrative
  • Policy

• Ensure when configuring the Storage Account setting that it’s referencing the storage account that was setup during the creation of the cloud native collector.

• Ensure the retention period aligns with your storage policies however we recommend at minimum 7 days.

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.28 - Microsoft Azure Application Gateway

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes all steps required to configure Microsoft Azure Application Gateway to send logs to a Storage account for ingestion to Samurai MDR.

Ensure that a cloud native collector has been deployed via the Samurai MDR portal.

• Guide available here

The storage account created via the cloud native collector needs to reside in the same region as the telemetry sources which will be ingested into the Samurai platform. For ingesting telemetry from multiple regions you need to create additional cloud native collector(s) for each region.

Take note of the name of the storage account created and which subscription it resides in. This will be used later when setting up the telemetry sources.

If you are planning to reuse an already deployed cloud native collector, the information about the created storage account and subscription can be found via:

1. Navigate to the Samurai MDR portal.
2. Click Telemetry and select Collectors from the main menu
3. Click on the name of the desired collector.
4. Note down information about the:
   1. Subscription
   2. Storage account name

Alternatively, you can utilize the integration setup wizard via the Samurai MDR portal for the desired telemetry source listed on Product Integration Guide page which shall provide you the same information required to setup your telemetry source.

Configure logging for Application Gateway

Follow the vendor documentation guide to enable Azure Application Gateway logs through the Azure Portal:

• Enable logging through the Azure portal

When following the vendor documentation, please perform the following adjustments:

• Select the following log categories

  • ApplicationGatewayAccessLogs
  • ApplicationGatewayFirewallLogs

• Ensure when configuring the Storage Account setting that it’s referencing the storage account that was setup during the creation of the cloud native collector.

• Ensure the retention period aligns with your storage policies however we recommend at minimum 7 days.

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.29 - Microsoft Azure Firewall

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure a Microsoft Azure Firewall to send logs to Samurai via a cloud native collector.

Prerequisites

Ensure that a cloud native collector has been deployed via the Samurai MDR portal. 

• Guide available here

The storage account created via the cloud native collector needs to reside in the same region as the telemetry sources which will be ingested into the Samurai platform. For ingesting telemetry from multiple regions you need to create additional cloud native collector(s) for each region.

Take note of the name of the storage account created and which subscription it resides in. This will be used later when setting up the telemetry sources.

If you are planning to reuse an already deployed cloud native collector, the information about the created storage account and subscription can be found via:

1. Navigate to the Samurai MDR portal.
2. Click Telemetry and select Collectors from the main menu
3. Click on the name of the desired collector.
4. Note down information about the:
   1. Subscription
   2. Storage account name

Alternatively, you can utilize the integration setup wizard via the Samurai MDR portal for the desired telemetry source listed on Product Integration Guide page which shall provide you the same information required to setup your telemetry source.

Enabling Azure Firewall logs

Follow the vendor documentation guide to enable Microsoft Azure Firewall logs.

• Enable Structured Logs

When following the vendor documentation, please perform the following adjustments:

• Select the following log categories

  • Network Rule
  • Application Rule
  • Nat Rule
  • Threat Intelligence
  • IDPS Signature
  • DNS query

• Ensure when configuring the Storage Account setting that it’s referencing the storage account that was setup during the creation of the cloud native collector.

• Ensure the retention period aligns with your storage policies however we recommend at minimum 7 days.

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.30 - Microsoft Defender Advanced Hunting

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

This guide describes the steps required to configure Microsoft Defender to send Advanced Hunting Logs to Samurai via a cloud native collector.

Ensure that a cloud native collector has been deployed via the Samurai MDR portal. 

• Guide available here

The storage account created via the cloud native collector needs to reside in the same region as the telemetry sources which will be ingested into the Samurai platform. For ingesting telemetry from multiple regions you need to create additional cloud native collector(s) for each region.

Take note of the name of the storage account created and which subscription it resides in. This will be used later when setting up the telemetry sources.

If you are planning to reuse an already deployed cloud native collector, the information about the created storage account and subscription can be found via:

1. Navigate to the Samurai MDR portal.
2. Click Telemetry and select Collectors from the main menu
3. Click on the name of the desired collector.
4. Note down information about the:
   1. Subscription
   2. Storage account name

Alternatively, you can utilize the integration setup wizard via the Samurai MDR portal for the desired telemetry source listed on Product Integration Guide page which shall provide you the same information required to setup your telemetry source.

Enabling Defender Advanced Hunting Logs

Follow the vendor documentation guide to enable Advanced Hunting Logs data streaming to blob storage.

• Configure Microsoft Defender for Endpoint to stream Advanced Hunting events to your Storage account

• Ensure when configuring the Storage Account setting that it’s referencing the storage account that was setup during the creation of the cloud native collector.

• Ensure the retention period aligns with your storage policies however we recommend at minimum 7 days.

For general information on Integrations refer to the Integrations article.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.31 - Microsoft DHCP Server

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

Use this document to install and configure the Filebeat agent to send Microsoft DHCP Server logs to Samurai using the Samurai Local Collector deployed in your network.

To complete this Integration you will need to:

1. Ensure correct network connectivity
2. Download & Install Filebeat
3. Configure & Enable DHCP Server Audit Logging
4. Configure & Start Filebeat

This guide is based on the premise of a single Samurai Local Collector installation with deployment of a single Windows host with the DHCP Server service enabled and configured. Repeat these steps outlined in this guide for each Microsoft DHCP Server and site.

Ensure correct network connectivity

You must ensure the following connectivity requirements are fulfilled:

Download & Install Filebeat

Perform the steps outlined in Step 1: Install Filebeat as per the vendor documentation.

Make sure to click the Windows tab for OS selection.

Configure & Enable DHCP Server Audit Logging

DHCP Server Audit Logging should be enabled by default and these steps are used to validate that logging is enabled and determine the logging path.

Configure via Powershell

1. To view the DHCP Audit logging config, run the command Get-DhcpServerAuditLog.

   PS C:\> Get-DhcpServerAuditLogPath : C:\Windows\system32\dhcpEnable : TrueMaxMBFileSize : 70DiskCheckInterval : 50MinMBDiskSpace : 20
   

2. Verify that the flag Enabled is set to True.

   1. In case logging is not enabled, run the commend Set-DhcpServerAuditLog. Example command with arguments is presented below.

      PS C:\> Set-DhcpServerAuditLog -Enable $True -Path C:\dhcp
      

   2. The DHCP server needs to be restarted after logging has been enabled, run the following command to restart the service.

      PS C:\> Restart-Service DHCPServer
      

3. Note down the file path that has been configured, this will be used later in the section Configure & Start Filebeat.

Configure & Start Filebeat

1. Access the Filebeat installation folder and open and edit the file filebeat.yml.
2. Modify the below template by replacing the section IP_OF_LOCAL_COLLECTOR with the IP address of the Samurai Local Collector.
3. Modify the paths section of the template to use the path that was configured for the DHCP Server Audit log file location from Configure & Enable DHCP Server Audit Logging.
   Follow the vendor documentation when configuring the paths section.

# ============================== Filebeat inputs ===============================
filebeat.inputs:
  - type: filestream
    id: win_dhcp
    enabled: true
    paths:
      - 'C:\Windows\System32\dhcp\Dhcp*'
    include_lines: ['^\d+,(\d+\/){2}\d+,.*$']
    tags: [win_dhcp_server]
#------------------------------ Logstash Output -------------------------------
output.logstash:
  hosts: ["IP_OF_LOCAL_COLLECTOR:5044"]

4. Replace the default configuration of filebeat.yml with the modified template and save the file.

5. Perform the steps outlined in Step 5: Start Filebeat as per the vendor documentation to start the service.

   Make sure to click the Windows tab for OS selection.

Our Integration guide was accurate at the time of writing but vendors change things frequently! If you find errors or anything is outdated, let us know by raising a request in the Samurai MDR application and we shall get it updated.

7.32 - Microsoft DNS Server

Samurai [Local] Collector	Samurai [Cloud] Collector	Samurai [Cloud Native] Collector

Use this document to install and configure the Filebeat agent to send Microsoft DNS Server logs to Samurai using the Samurai Local Collector deployed in your network.
To complete this Integration you will need to:

1. Ensure correct network connectivity
2. Download & Install Filebeat
3. Configure & Enable Microsoft DNS Server Debug Logging
4. Configure & Start Filebeat