Skip to content

Commit e179cfb

Browse files
authored
Merge pull request #193220 from batamig/dls-april
DLS version 4.2.4 - IN REVIEW
2 parents 3748d05 + db5fcb4 commit e179cfb

9 files changed

+113
-50
lines changed

articles/defender-for-iot/device-builders/concept-event-aggregation.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
22
title: Micro agent event collection (Preview)
33
description: Defender for IoT security agents collects data and system events from your local device, and sends the data to the Azure cloud for processing, and analytics.
4-
ms.date: 11/09/2021
4+
ms.date: 04/26/2022
55
ms.topic: conceptual
66
---
77

88
# Micro agent event collection (Preview)
99

10-
Defender for IoT security agents collects data, and system events from your local device, and sends the data to the Azure cloud for processing, and analytics. The Defender for IoT micro agent collects many types of device events including new processes, and all new connection events. Both the new process, and new connection events may occur frequently on a device. This capability is important for comprehensive security, however, the number of messages the security agents send may quickly meet, or exceed your IoT Hub quota, and cost limits. These messages, and events contain highly valuable security information that is crucial to protecting your device.
10+
Defender for IoT security agents collects data, and system events from your local device, and sends the data to the Azure cloud for processing.
11+
12+
If you've configured and connected a Log Analytics workspace, you'll see these events in Log Analytics. For more information, see [Tutorial: Investigate security alerts](tutorial-investigate-security-alerts.md).
13+
14+
The Defender for IoT micro agent collects many types of device events including new processes, and all new connection events. Both the new process, and new connection events may occur frequently on a device. This capability is important for comprehensive security, however, the number of messages the security agents send may quickly meet, or exceed your IoT Hub quota, and cost limits. These messages, and events contain highly valuable security information that is crucial to protecting your device.
1115

1216
To reduce the number of messages, and costs while maintaining your device's security, Defender for IoT agents aggregate the following types of events:
1317

@@ -78,7 +82,7 @@ The Login collector, collects user sign-ins, sign-outs, and failed sign-in attem
7882

7983
The Login collector supports the following types of collection methods:
8084

81-
- **Syslog**. If syslog is running on the device, the Login collector collects SSH sign-in events via the syslog file named **auth.log**.
85+
- **UTMP and SYSLOG**. UTMP catches SSH interactive events, telnet events, and terminal logins, as well as all failed login events from SSH, telnet, and terminal. If SYSLOG is enabled on the device, the Login collector also collects SSH sign-in events via the SYSLOG file named **auth.log**.
8286

8387
- **Pluggable Authentication Modules (PAM)**. Collects SSH, telnet, and local sign-in events. For more information, see [Configure Pluggable Authentication Modules (PAM) to audit sign-in events](configure-pam-to-audit-sign-in-events.md).
8488

@@ -91,9 +95,10 @@ The following data is collected:
9195
| **user_name** | The Linux user. |
9296
| **executable** | The terminal device. For example, `tty1..6` or `pts/n`. |
9397
| **remote_address** | The source of connection, either a remote IP address in IPv6 or IPv4 format, or `127.0.0.1/0.0.0.0` to indicate local connection. |
98+
| **Login_UsePAM** | Boolean: <br>- **True**: Only the PAM Login collector is used <br>- **False**: The UTMP Login collector is used, with SYSLOG if SYSLOG is enabled |
9499

95100

96-
## System information (trigger based collector))
101+
## System information (trigger based collector)
97102

98103
The data collected for each event is:
99104

@@ -118,7 +123,7 @@ The **nics** properties are composed of the following;
118123

119124
## Baseline (trigger based)
120125

121-
The baseline collector performs CIS checks periodically. Only the failed results are sent to the cloud. The cloud aggregates the results, and provides recommendations.
126+
The baseline collector performs periodic CIS checks, and *failed*, *pass*, and *skip* check results are sent to the Defender for IoT cloud service. Defender for IoT aggregates the results and provides recommendations based on any failures.
122127

123128
### Data collection
124129

@@ -127,7 +132,7 @@ The data collected for each event is:
127132
| Parameter | Description|
128133
|--|--|
129134
| **Check ID** | In CIS format. For example, `CIS-debian-9-Filesystem-1.1.2`. |
130-
| **Check result** | Can be `Error`, or `Fail`. For example, `Error` in a situation where the check can’t run. |
135+
| **Check result** | Can be `Fail`, `Pass`, `Skip`, or `Error`. For example, `Error` in a situation where the check can’t run. |
131136
| **Error** | The error's information, and description. |
132137
| **Description** | The description of the check from CIS. |
133138
| **Remediation** | The recommendation for remediation from CIS. |
@@ -144,9 +149,11 @@ The data collected on each package includes:
144149
|**Name** | The package name |
145150
|**Version** | The package version |
146151
|**Vendor** | The package's vendor, which is the **Maintainer** field in deb packages |
147-
| | |
148152

149153

154+
> [!NOTE]
155+
> The SBoM collector currently only collects the first 500 packages ingested.
156+
150157
## Next steps
151158

152159
Check your [Defender for IoT security alerts](concept-security-alerts.md).

articles/defender-for-iot/device-builders/concept-micro-agent-configuration.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Micro agent configurations (Preview)
33
description: The collector sends all current data immediately after any configuration change is made. The changes are then applied.
4-
ms.date: 12/22/2021
4+
ms.date: 05/03/2022
55
ms.topic: conceptual
66
---
77

@@ -24,7 +24,6 @@ Default values are as follows:
2424
| **Low** | 1440 (24 hours) |
2525
| **Medium** | 120 (2 hours) |
2626
| **High** | 30 (.5 hours) |
27-
| | |
2827

2928
To reduce the number of messages sent to cloud, each priority should be set as a multiple of the one below it. For example, High: 60 minutes, Medium: 120 minutes, Low: 480 minutes.
3029

@@ -42,7 +41,6 @@ For example:
4241
|--|--|--|--|
4342
| **Baseline_GroupsDisabled** | A list of Baseline group names, separated by a comma. <br><br>For example: `Time Synchronization, Network Parameters Host` | Defines the full list of Baseline group names that should be disabled. | Null |
4443
| **Baseline_ChecksDisabled** |A list of Baseline check IDs, separated by a comma. <br><br>For example: `3.3.5,2.2.1.1` | Defines the full list of Baseline check IDs that should be disabled. | Null |
45-
| | | | |
4644

4745

4846
## Event-based collector configurations
@@ -55,14 +53,12 @@ These configurations include process, and network activity collectors.
5553
| **Aggregation mode** | `True` <br>`False` | Determines whether to process event aggregation for an identical event. | `True` |
5654
| **Cache size** | cycle FIFO | Defines the number of events collected in between the times that data is sent. | `256` |
5755
| **Disable collector** | `True` <br> `False` | Determines whether or not the collector is operational. | `False` |
58-
| | | | |
5956

6057
## IoT Hub Module-specific settings
6158

6259
| Setting Name | Setting options | Description | Default |
6360
|--|--|--|--|
6461
| **IothubModule_MessageTimeout** | Positive integer, including limits | Defines the number of minutes to retain messages in the outbound queue to the IoT Hub, after which point the messages are dropped. | `2880` (=2 days) |
65-
| | | | |
6662
## Network activity collector-specific settings
6763

6864
| Setting Name | Setting options | Description | Default |
@@ -77,7 +73,6 @@ These configurations include process, and network activity collectors.
7773
|--|--|--|--|
7874
| **Process_Mode** | `1` = Auto <br>`2` = Netlink <br>`3`= Polling | Determines the process collector mode. In `Auto` mode, the agent first tries to enable the Netlink mode. <br><br>If that fails, it will automatically fall back / switch to the Polling mode.| `1` |
7975
|**Process_PollingInterval** |Integer |Defines the polling interval in microseconds. This value is used when the **Process_Mode** is in `Polling` mode. | `100000` (=0.1 second) |
80-
| | | | |
8176

8277
## Trigger-based collector configurations
8378

@@ -87,7 +82,6 @@ These configurations include system information, and baseline collectors.
8782
|--|--|--|--|
8883
| **Interval** | `High` <br>`Medium`<br>`Low` | The frequency in which data is sent. | `Low` |
8984
| **Disable collector** | `True` <br> `False` | Whether or not the collector is operational. | `False` |
90-
| | | | |
9185

9286

9387
## Next steps

articles/defender-for-iot/device-builders/how-to-investigate-cis-benchmark.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Investigate CIS benchmark recommendation
33
description: Perform basic and advanced investigations based on OS baseline recommendations.
4-
ms.date: 11/09/2021
4+
ms.date: 05/03/2022
55
ms.topic: how-to
66
---
77

@@ -12,39 +12,35 @@ Perform basic and advanced investigations based on OS baseline recommendations.
1212
> [!NOTE]
1313
> The Microsoft Defender for IoT legacy experience under IoT Hub has been replaced by our new Defender for IoT standalone experience, in the Defender for IoT area of the Azure portal. The legacy experience under IoT Hub will not be supported after **March 31, 2023**.
1414
15-
## Basic OS baseline security recommendation investigation
15+
## Basic OS baseline security recommendation investigation
1616

1717
You can investigate OS baseline recommendations by navigating to [Defender for IoT in the Azure portal](https://portal.azure.com/#blade/Microsoft_Azure_IoT_Defender/IoTDefenderDashboard/Getting_Started). For more information, see how to [Investigate security recommendations](quickstart-investigate-security-recommendations.md).
1818

19-
## Advanced OS baseline security recommendation investigation
19+
## Advanced OS baseline security recommendation investigation
2020

21-
This section describes how to better understand the OS baseline test results, and querying events in Azure Log Analytics.
21+
This section describes how to better understand the OS baseline test results, and querying events in Azure Log Analytics.
2222

23-
The advanced OS baseline security recommendation investigation is only supported by using log analytics. Connect Defender for IoT to a Log Analytics workspace before continuing. For more information on advanced OS baseline security recommendations, see how to [Configure Microsoft Defender for IoT agent-based solution](how-to-configure-agent-based-solution.md).
23+
**Prerequisites**:
2424

25-
To query your IoT security events in Log Analytics for alerts:
25+
The advanced OS baseline security recommendation investigation is only supported by using Azure Log Analytics and you must connect Defender for IoT to a Log Analytics workspace before continuing.
2626

27-
1. Navigate to the **Alerts** page.
27+
For more information, see [Configure Microsoft Defender for IoT agent-based solution](tutorial-configure-agent-based-solution.md).
2828

29-
1. Select **Investigate recommendations in Log Analytics workspace**.
29+
**To query your IoT security events in Log Analytics for alerts**:
3030

31-
To query your IoT security events in Log Analytics for recommendations:
31+
1. In your Log Analytics workspace, go to **Logs** > **AzureSecurityOfThings** > **SecurityAlert**.
3232

33-
1. Navigate to the **Recommendations** page.
33+
1. In the query editor on the right, enter a KQL query to display the alerts you want to see.
3434

35-
1. Select **Investigate recommendations in Log Analytics workspace**.
35+
1. Select **Run** to display the alerts that match your query.
3636

37-
1. Select **Show Operation system (OS) baseline rules details** from the **Recommendation details** quick view page to see the details of a specific device.
37+
For example:
3838

39-
:::image type="content" source="media/how-to-investigate-cis-benchmark/recommendation-details.png" alt-text="See the details of a specific device.":::
39+
:::image type="content" source="media/how-to-investigate-cis-benchmark/log-analytics.png" alt-text="Screenshot of the Log Analytics workspace with a Defender for I o T alert query." lightbox="media/how-to-investigate-cis-benchmark/log-analytics.png":::
4040

41-
To query your IoT security events in Log Analytics workspace directly:
42-
43-
1. Navigate to the **Logs** page.
44-
45-
:::image type="content" source="media/how-to-investigate-cis-benchmark/logs.png" alt-text="Select logs from the left side pane.":::
46-
47-
1. Select **Investigate the alerts** or, select the **Investigate the alerts in Log Analytics** option from any security recommendation, or alert.
41+
> [!NOTE]
42+
> In addition to alerts, you can also use this same procedure to query for recommendations or raw event data.
43+
>
4844
4945
## Useful queries to investigate the OS baseline resources
5046

538 KB
Loading

articles/defender-for-iot/device-builders/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ The Defender for IoT micro agent enables you to quickly improve your organizatio
3434
The Defender for IoT micro agent provides deep security protection, and visibility into device behavior.
3535

3636
- The micro agent collects, aggregates, and analyzes raw security events from your devices. Events can include IP connections, process creation, user logons, and other security-relevant information.
37-
- Defender for IoT device agents handles event aggregation, to help avoid high network throughput.
38-
- The micro agent has flexible deployment options. The micro agent includes source code, so you can incorporate it into firmware, or customize it to include only what you need. It's also available as a binary package, or integrated directly into other Azure IoT solutions. The micro agent is available for standard IoT operating systems, such as Linux and Azure RTOS.
37+
- Defender for IoT device agents handle event aggregation, to help avoid high network throughput.
38+
- The micro agent has flexible deployment options. The micro agent includes source code, so you can incorporate it into firmware, or customize it to include only what you need. It's also available as a binary package, or integrated directly into other Azure IoT solutions. The micro agent is available for standard IoT operating systems, such as Linux and Azure RTOS.
3939
- The agents are highly customizable, allowing you to use them for specific tasks, such as sending only important information at the fastest SLA, or for aggregating extensive security information and context into larger segments, avoiding higher service costs.
4040

4141

articles/defender-for-iot/device-builders/release-notes.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: What's new in Microsoft Defender for IoT for device builders
33
description: Learn about the latest updates for Defender for IoT device builders.
44
ms.topic: conceptual
5-
ms.date: 02/20/2022
5+
ms.date: 04/26/2022
66
---
77

88
# What's new
@@ -13,9 +13,23 @@ This article lists new features and feature enhancements in Microsoft Defender f
1313

1414
Noted features are in PREVIEW. The [Azure Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include other legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
1515

16-
## Versioning and support
16+
For more information, see [Upgrade the Microsoft Defender for IoT micro agent](upgrade-micro-agent.md).
1717

18-
Listed below are the support, breaking change policies for Defender for IoT, and the versions of Defender for IoT that are currently available.
18+
## July 2022
19+
20+
**Version 4.2.4**
21+
22+
- **Proxy connection updates**: Now you can connect your micro-agent to an IoT Hub via a proxy. For more information, see [Connect via a proxy](tutorial-standalone-agent-binary-installation.md#connect-via-a-proxy).
23+
24+
- **Support for TPM-backed certificates**: Now you can use OpenSSL certificates backed by TPM. For more information, see [Authenticate using a certificate](tutorial-standalone-agent-binary-installation.md#authenticate-using-a-certificate).
25+
26+
- **AMQP support**: Now you can add AMQP support after installing your micro-agent. For more information, see [Add AMQP protocol support](tutorial-standalone-agent-binary-installation.md#add-amqp-protocol-support).
27+
28+
- **Baseline collector updates**: The baseline collector now sends *pass* and *skip* checks to the cloud in addition to *failed* results. For more information, see [Micro agent event collection](concept-event-aggregation.md#baseline-trigger-based).
29+
30+
- **Login collector via UTMP**: The login collector now supports UTMP to catch SSH interactive events, telnet events, and terminal logins, including failed login events. For more information, see [Login collector (event-based collector)](concept-event-aggregation.md#login-collector-event-based-collector).
31+
32+
- **SBoM collector known issue**: The SBoM collector currently only collects the first 500 packages ingested. For more information, see [SBoM (trigger based)](concept-event-aggregation.md#sbom-trigger-based) collection.
1933

2034
## February 2022
2135

@@ -41,8 +55,7 @@ Listed below are the support, breaking change policies for Defender for IoT, and
4155

4256
For more information, see [Network Connection events (event-based collector)](concept-event-aggregation.md#network-connection-events-event-based-collector).
4357

44-
- **Login Collector**: Now supporting login collector using: SYSLOG collecting SSH login events and PAM collecting SSH, telnet and local login events using the pluggable authentication modules stack. For more information, see [Micro agent event collection (Preview)](concept-event-aggregation.md).
45-
58+
- **Login Collector**: Now supporting login collector using: SYSLOG collecting SSH login events and PAM collecting SSH, telnet and local login events using the pluggable authentication modules stack. For more information, see [Login collector (event-based collector)](concept-event-aggregation.md#login-collector-event-based-collector).
4659

4760
## November 2021
4861

@@ -66,7 +79,7 @@ Listed below are the support, breaking change policies for Defender for IoT, and
6679

6780
- **[Login collector](concept-event-aggregation.md#login-collector-event-based-collector)** - The login collectors gather user logins, logouts, and failed login attempts. Such as SSH & telnet.
6881

69-
- **[System information collector](concept-event-aggregation.md#system-information-trigger-based-collector)** - The system information collector gatherers information related to the device’s operating system and hardware details.
82+
- **[System information collector](concept-event-aggregation.md#system-information-trigger-based-collector)** - The system information collector gathers information related to the device’s operating system and hardware details.
7083

7184
- **[Event aggregation](concept-event-aggregation.md#how-does-event-aggregation-work)** - The Defender for IoT agent aggregates events such as process, login, network events that reduce the number of messages sent and costs, all while maintaining your device's security.
7285

@@ -94,4 +107,5 @@ This feature set is available with the current public preview cloud release.
94107

95108
## Next steps
96109

97-
[Onboard to Defender for IoT](quickstart-onboard-iot-hub.md)
110+
- [Onboard to Defender for IoT](quickstart-onboard-iot-hub.md)
111+
- [Upgrade the Microsoft Defender for IoT micro agent](upgrade-micro-agent.md)

0 commit comments

Comments
 (0)