Skip to content

Commit f0b7e42

Browse files
committed
Pre-GA reviews and fixes from PM and ENG
1 parent 8ff1018 commit f0b7e42

14 files changed

+92
-77
lines changed

articles/asc-for-iot/concept-recommendations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Device recommendations provide insights and suggestions to improve device securi
3232

3333
| Severity | Name | Data Source | Description |
3434
|----------|-----------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
35-
| Medium | Open Ports on device | Agent | A listening endpoint was found on the device |
35+
| Medium | Open Ports on device | Agent | A listening endpoint was found on the device . |
3636
| Medium | Permissive firewall policy found in one of the chains. | Agent | Allowed firewall policy found (INPUT/OUTPUT). Firewall policy should deny all traffic by default, and define rules to allow necessary communication to/from the device. |
3737
| Medium | Permissive firewall rule in the input chain was found | Agent | A rule in the firewall has been found that contains a permissive pattern for a wide range of IP addresses or ports. |
3838
| Medium | Permissive firewall rule in the output chain was found | Agent | A rule in the firewall has been found that contains a permissive pattern for a wide range of IP addresses or ports. |
39-
| Medium | Operation system baseline validation has failed | Agent | Device doesn't comply with [CIS Linux benchmarks](https://www.cisecurity.org/cis-benchmarks/) |
39+
| Medium | Operation system baseline validation has failed | Agent | Device doesn't comply with [CIS Linux benchmarks](https://www.cisecurity.org/cis-benchmarks/). |
4040

4141
### Operational recommendations for IoT devices
4242

@@ -46,7 +46,7 @@ Operational recommendations provide insights and suggestions to improve security
4646
|----------|-----------------------------------------|-------------|-----------------------------------------------------------------------------------|
4747
| Low | Agent sends unutilized messages | Agent | 10% or more of security messages were smaller than 4kb during the last 24 hours. |
4848
| Low | Security twin configuration not optimal | Agent | Security twin configuration is not optimal. |
49-
| Low | Security twin configuration conflict | Agent | Conflicts were identified in the security twin configuration. |
49+
| Low | Security twin configuration conflict | Agent | Conflicts were identified in the security twin configuration. | |
5050

5151

5252
## Recommendations for IoT Hub

articles/asc-for-iot/concept-security-agent-authentication-methods.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ This article explains the different authentication methods you can use with the
2626
For each device onboarded to Azure Security Center for IoT in the IoT Hub, a security module is required. To authenticate the device, Azure Security Center for IoT can use one of two methods. Choose the method that works best for your existing IoT solution.
2727

2828
> [!div class="checklist"]
29-
> * Security Module option
29+
> * SecurityModule option
3030
> * Device option
3131
3232
## Authentication methods
3333

3434
The two methods for the AzureIoTSecurity agent to perform authentication:
3535

36-
- **Module** authentication mode<br>
37-
The Module is authenticated independently of the device twin.
36+
- **SecurityModule** authentication mode<br>
37+
The agent is authenticated using the security module identity independently of the device identity.
3838
Use this authentication type if you would like the security agent to use a dedicated authentication method through security module (symmetric key only).
3939

4040
- **Device** authentication mode<br>
@@ -46,7 +46,7 @@ See [Security agent installation parameters](#security-agent-installation-parame
4646

4747
## Authentication methods known limitations
4848

49-
- **Module** authentication mode only supports symmetric key authentication.
49+
- **SecurityModule** authentication mode only supports symmetric key authentication.
5050
- CA-Signed certificate is not supported by **Device** authentication mode.
5151

5252
## Security agent installation parameters
@@ -55,19 +55,18 @@ When [deploying a security agent](how-to-deploy-agent.md), authentication detail
5555
These arguments are documented in the following table.
5656

5757

58-
|Parameter|Description|Options|
59-
|---------|---------------|---------------|
60-
|**identity**|Authentication mode| **Module** or **Device**|
61-
|**type**|Authentication type|**SymmetricKey** or **SelfSignedCertificate**|
62-
|**filePath**|Absolute full path for the file containing the certificate or the symmetric key| |
63-
|**gatewayHostname**|FQDN of the IoT Hub|Example: ContosoIotHub.azure-devices.net|
64-
|**deviceId**|Device ID|Example: MyDevice1|
65-
|**certificateLocationKind**|Certificate storage location|**LocalFile** or **Store**|
58+
|Linux Parameter Name | Windows Parameter Name | Shorthand Parameter |Description|Options|
59+
|---------------------|---------------|---------|---------------|---------------|
60+
|authentication-identity|AuthenticationIdentity|aui|Authentication identity| **SecurityModule** or **Device**|
61+
|authentication-method|AuthenticationMethod|aum|Authentication method|**SymmetricKey** or **SelfSignedCertificate**|
62+
|file-path|FilePath|f|Absolute full path for the file containing the certificate or the symmetric key| |
63+
|host-name|HostName|hn|FQDN of the IoT Hub|Example: ContosoIotHub.azure-devices.net|
64+
|device-id|DeviceId|di|Device ID|Example: MyDevice1|
65+
|certificate-location-kind|CertificateLocationKind|cl|Certificate storage location|**LocalFile** or **Store**|
66+
|
6667

6768

68-
When using the install security agent script, the following configuration is performed automatically.
69-
70-
To edit the security agent authentication manually, edit the config file.
69+
When using the install security agent script, the following configuration is performed automatically. To edit the security agent authentication manually, edit the config file.
7170

7271
## Change authentication method after deployment
7372

@@ -76,7 +75,7 @@ When deploying a security agent with an installation script, a configuration fil
7675
To change authentication methods after deployment, manual editing of the configuration file is required.
7776

7877

79-
### C# based security agent
78+
### C#-based security agent
8079

8180
Edit _Authentication.config_ with the following parameters:
8281

@@ -91,7 +90,7 @@ Edit _Authentication.config_ with the following parameters:
9190
</Authentication>
9291
```
9392

94-
### C based security agent
93+
### C-based security agent
9594

9695
Edit _LocalConfiguration.json_ with the following parameters:
9796

articles/asc-for-iot/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ Choose the service scenario that best meets your IoT device and environment requ
2929
### Built-in deployment
3030
Using the seamless, built-in deployment option, Azure Security Center for IoT can be quickly integrated into your IoT Hub and provide security analysis of the IoT hub configuration, device identity and management, and hub-device communication patterns.
3131

32-
* Start a [Built-in deployment](iot-hub-integration.md) featuring IoT Hub monitoring and recommendations.
32+
Start a [Built-in deployment](iot-hub-integration.md) featuring IoT Hub monitoring and recommendations.
3333
<br>
3434

3535
### Enhanced deployment
3636
For enhanced security capabilities, deploying Azure Security Center for IoT agents in addition to enabling IoT Hub security provides agent-based event collection, analysis and threat detection of key security data from your IoT devices as well as comprehensive security posture management capabilities.
3737

38-
* Start an [Enhanced deployment](security-agents.md) featuring an agent-based comprehensive threat protection and security posture management solution.
38+
Start an [Enhanced deployment](security-agents.md) featuring an agent-based comprehensive threat protection and security posture management solution.
3939

4040

4141
## Next steps

articles/asc-for-iot/how-to-deploy-agent.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ms.author: mlottner
2424
Azure Security Center for IoT provides reference architectures for security agents that monitor and collect data from IoT devices.
2525
To learn more, see [Security agent reference architecture](security-agent-architecture.md).
2626

27-
Agents are developed as open source projects, and are available in two flavors: <br> [C](https://aka.ms/iot-security-github-c), and [C#](https://aka.ms/iot-security-github-cs).
27+
Agents are developed as open-source projects, and are available in two flavors: <br> [C](https://aka.ms/iot-security-github-c), and [C#](https://aka.ms/iot-security-github-cs).
2828

2929
In this article, you learn how to:
3030
> [!div class="checklist"]
@@ -40,18 +40,27 @@ The C-based security agent has a lower memory footprint, and is the ideal choice
4040

4141
| | C-based security agent | C#-based security agent |
4242
| --- | ----------- | --------- |
43-
| Open source | Available under [MIT license](https://en.wikipedia.org/wiki/MIT_License) in [Github](https://aka.ms/iot-security-github-cs) | Available under [MIT license](https://en.wikipedia.org/wiki/MIT_License) in [Github](https://aka.ms/iot-security-github-c) |
43+
| Open-source | Available under [MIT license](https://en.wikipedia.org/wiki/MIT_License) in [GitHub](https://aka.ms/iot-security-github-cs) | Available under [MIT license](https://en.wikipedia.org/wiki/MIT_License) in [GitHub](https://aka.ms/iot-security-github-c) |
4444
| Development language | C | C# |
4545
| Supported Windows platforms? | No | Yes |
4646
| Windows prerequisites | --- | [WMI](https://docs.microsoft.com/windows/desktop/wmisdk/) |
4747
| Supported Linux platforms? | Yes, x64 and x86 | Yes, x64 only |
4848
| Linux prerequisites | libunwind8, libcurl3, uuid-runtime, auditd, audispd-plugins | libunwind8, libcurl3, uuid-runtime, auditd, audispd-plugins, sudo, netstat, iptables |
49-
| Disk footprint | 10.5MB | 90MB |
50-
| Memory footprint (on average) | 5.5MB | 33MB |
49+
| Disk footprint | 10.5 MB | 90 MB |
50+
| Memory footprint (on average) | 5.5 MB | 33 MB |
5151
| [Authentication](concept-security-agent-authentication-methods.md) to IoT Hub | Yes | Yes |
5252
| Security data [collection](how-to-agent-configuration.md#supported-security-events) | Yes | Yes |
5353
| Event aggregation | Yes | Yes |
5454
| Remote configuration through [security module twin](concept-security-module.md) | Yes | Yes |
55+
|
56+
57+
## Security agent installation guidelines
58+
59+
For **Windows**:
60+
The Install SecurityAgent.ps1 script must be executed from an Administrator PowerShell window.
61+
62+
For **Linux**:
63+
The InstallSecurityAgent.sh must be run as superuser. We recommend prefixing the installation command with “sudo”.
5564

5665

5766
## Choose an agent flavor

articles/asc-for-iot/how-to-deploy-edge.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ There are three steps to create an IoT Edge deployment for Azure Security Center
132132

133133
#### Step 2: Specify Routes
134134

135-
1. In the **Specify Routes** tab, make sure you have a route (explicit or implicit) that will forward messages from the **azureiotsecurity** module to **$upstream**, then click Next.
135+
1. In the **Specify Routes** tab, make sure you have a route (explicit or implicit) that will forward messages from the **azureiotsecurity** module to **$upstream**.
136+
1. Click **Next**.
136137

137138
~~~Default implicit route
138139
"route": "FROM /messages/* INTO $upstream
@@ -144,7 +145,7 @@ There are three steps to create an IoT Edge deployment for Azure Security Center
144145

145146
#### Step 3: Review Deployment
146147

147-
1. In the **Review Deployment** tab, review your deployment information, then select **Submit** to complete the deployment.
148+
- In the **Review Deployment** tab, review your deployment information, then select **Submit** to complete the deployment.
148149

149150
## Diagnostic steps
150151

articles/asc-for-iot/how-to-deploy-linux-c.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ For other platforms and agent flavors, see [Choose the right security agent](how
3939

4040
## Installation
4141

42-
To install and deploy the security agent, do the following:
42+
To install and deploy the security agent, use the following workflow:
4343

4444

45-
1. Download the most recent version to your machine from [Github](https://aka.ms/iot-security-github-c).
45+
1. Download the most recent version to your machine from [GitHub](https://aka.ms/iot-security-github-c).
4646

4747
1. Extract the contents of the package and navigate to the _/Install_ folder.
4848

49-
1. Add running permissions to the **InstallSecurityAgent script** by running the following:
49+
1. Add running permissions to the **InstallSecurityAgent script** by running the following command:
5050

5151
```
5252
chmod +x InstallSecurityAgent.sh
@@ -60,11 +60,11 @@ To install and deploy the security agent, do the following:
6060

6161
See [How to configure authentication](concept-security-agent-authentication-methods.md) for more information about authentication parameters.
6262

63-
This script does the following:
63+
This script performs the following function:
6464

6565
1. Installs prerequisites.
6666

67-
2. Adds a service user (with interactive login disabled).
67+
2. Adds a service user (with interactive sign in disabled).
6868

6969
3. Installs the agent as a **Daemon** - assumes the device uses **systemd** for service management.
7070

articles/asc-for-iot/how-to-deploy-linux-cs.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ For other platforms and agent flavors, see [Choose the right security agent](how
4040

4141
## Installation
4242

43-
To deploy the security agent, do the following:
43+
To deploy the security agent, use the following steps:
4444

45-
1. Download the most recent version to your machine from [Github](https://aka.ms/iot-security-github-cs).
45+
1. Download the most recent version to your machine from [GitHub](https://aka.ms/iot-security-github-cs).
4646

4747
1. Extract the contents of the package and navigate to the _/Install_ folder.
4848

@@ -54,17 +54,17 @@ To deploy the security agent, do the following:
5454
./InstallSecurityAgent.sh -i -aui <authentication identity> -aum <authentication method> -f <file path> -hn <host name> -di <device id> -cl <certificate location kind>
5555
```
5656

57-
See [How to configure authentication](concept-security-agent-authentication-methods.md) for more information about authentication parameters.
57+
for more information about authentication parameters, see [How to configure authentication](concept-security-agent-authentication-methods.md).
5858

59-
This script does the following:
59+
This script performs the following actions:
6060

6161
- Installs prerequisites.
6262

63-
- Adds a service user (with interactive login disabled).
63+
- Adds a service user (with interactive sign in disabled).
6464

65-
- Installs the agent as a **Daemon** - this assumes the device uses **systemd** for service management.
65+
- Installs the agent as a **Daemon** - assumes the device uses **systemd** for classic deployment model.
6666

67-
- Configures **sudoers** to allow the agent to perform certain tasks as root.
67+
- Configures **sudoers** to allow the agent to do certain tasks as root.
6868

6969
- Configures the agent with the provided authentication parameters.
7070

articles/asc-for-iot/how-to-deploy-windows-cs.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,27 @@ In this guide, you learn how to:
3232
3333
## Prerequisites
3434

35-
For other platforms and agent flavours, see [Choose the right security agent](how-to-deploy-agent.md).
35+
For other platforms and agent flavors, see [Choose the right security agent](how-to-deploy-agent.md).
3636

3737
1. Local admin rights on the machine you wish to install on.
3838

3939
1. [Create a security module](quickstart-create-security-twin.md) for the device.
4040

4141
## Installation
4242

43-
To install the security agent, do the following:
43+
To install the security agent, use the following workflow:
4444

45-
1. To install the Azure Security Center for IoT Windows C# agent on the device, download the most recent version to your machine from the Azure Security Center for IoT [GitHub repository](https://github.com/Azure/Azure-IoT-Security-Agent-CS).
45+
1. Install the Azure Security Center for IoT Windows C# agent on the device. Download the most recent version to your machine from the Azure Security Center for IoT [GitHub repository](https://github.com/Azure/Azure-IoT-Security-Agent-CS).
4646

47-
2. Extract the contents of the package, and navigate to the /Install folder.
47+
1. Extract the contents of the package, and navigate to the /Install folder.
4848

49-
3. Open Windows PowerShell as Administrator.
50-
1. Add running permissions to the InstallSecurityAgent script by running
51-
```Unblock-File .\InstallSecurityAgent.ps1```
49+
1. Open Windows PowerShell as Administrator.
50+
1. Add running permissions to the InstallSecurityAgent script by running:<br>
51+
```
52+
Unblock-File .\InstallSecurityAgent.ps1
53+
```
5254
53-
and run:
55+
then run:
5456
5557
```
5658
.\InstallSecurityAgent.ps1 -Install -aui <authentication identity> -aum <authentication method> -f <file path> -hn <host name> -di <device id> -cl <certificate location kind>
@@ -62,13 +64,13 @@ To install the security agent, do the following:
6264
.\InstallSecurityAgent.ps1 -Install -aui Device -aum SymmetricKey -f c:\Temp\Key.txt -hn MyIotHub.azure-devices.net -di Mydevice1 -cl store
6365
```
6466
65-
See [How to configure authentication](concept-security-agent-authentication-methods.md) for more information about authentication parameters.
67+
For more information about authentication parameters, see [How to configure authentication](concept-security-agent-authentication-methods.md).
6668
67-
This script does the following:
69+
This script does the following actions:
6870
6971
- Installs prerequisites.
7072
71-
- Adds a service user (with interactive login disabled).
73+
- Adds a service user (with interactive sign in disabled).
7274
7375
- Installs the agent as a **System Service**.
7476

0 commit comments

Comments
 (0)