You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/defender-for-iot/organizations/how-to-deploy-certificates.md
+83-75Lines changed: 83 additions & 75 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,59 +29,37 @@ To perform the procedures described in this article, make sure that:
29
29
30
30
For more information, see [On-premises users and roles for OT monitoring with Defender for IoT](roles-on-premises.md).
31
31
32
-
## Create CA-signed SSL/TLS certificates
33
-
34
-
Use a certificate management platform, such as an automated PKI management platform, to create a certificate. Verify that the certificate meets [certificate file requirements](#verify-certificate-file-parameter-requirements), and then [test the certificate](#test-your-ssltls-certificates) file you created when you're done.
35
-
36
-
If you are not carrying out certificate validation, remove the CRL URL reference in the certificate. For more information, see [certificate file requirements](#verify-certificate-file-parameter-requirements).
37
-
38
-
Consult a security, PKI, or other qualified certificate lead if you don't have an application that can automatically create certificates.
39
-
40
-
You can also convert existing certificate files if you don't want to create new ones.
41
-
42
-
## Create self-signed SSL/TLS certificates
43
-
44
-
Create self-signed SSL/TLS certificates by first downloading a security certificate from the OT sensor or on-premises management console and then exporting it to the required file types.
45
-
46
-
> [!NOTE]
47
-
> While you can use a locally-generated and self-signed certificate, we do not recommend this option.
32
+
## Deploy an SSL/TLS certificate
48
33
49
-
### Download a security certificate
34
+
After you've created your SSL/TLS certificate as required and have it installed on a trusted storage, deploy it to your OT sensor or on-premises management console.
50
35
51
-
1. After [installing your OT sensor software](ot-deploy/install-software-ot-sensor.md) or [on-premises management console](ot-deploy/install-software-on-premises-management-console.md), go to the sensor's or on-premises management console's IP address in a browser.
36
+
### Import the SSL/TLS certificate
52
37
53
-
1. Select the :::image type="icon" source="media/how-to-deploy-certificates/warning-icon.png" border="false"::: **Not secure** alert in the address bar of your web browser, then select the **>** icon next to the warning message **"Your connection to this site isn't secure"**. For example:
54
-
55
-
:::image type="content" source="media/how-to-deploy-certificates/connection-is-not-secure.png" alt-text="Screenshot of web page with a Not secure warning in the address bar." lightbox="media/how-to-deploy-certificates/connection-is-not-secure.png":::
38
+
**To deploy a certificate on an OT sensor**:
56
39
57
-
1.Select the :::image type="icon" source="media/how-to-deploy-certificates/show-certificate-icon.png" border="false"::: **Show certificate**icon to view the security certificate for this website.
40
+
1.Sign into your OT sensor and select **System settings**> **Basic** > **SSL/TLS certificate**
58
41
59
-
1. In the **Certificate viewer** pane, select the **Details** tab, then select **Export** to save the file on your local machine.
42
+
1. In the **SSL/TLS certificate** pane, enter your certificate name and passphrase, and then upload the files you'd created earlier.
60
43
61
-
### Export an SSL/TLS certificate
44
+
Select **Enable certificate validation** to validate the certificate against a [CRL server](#verify-crl-server-access).
62
45
63
-
Use a certificate management platform to create the following types of SSL/TLS certificate files:
46
+
1. Select **Save**to save your certificate settings.
64
47
65
-
| File type | Description |
66
-
|---------|---------|
67
-
|**.crt – certificate container file**| A `.pem`, or `.der` file, with a different extension for support in Windows Explorer.|
68
-
|**.key – Private key file**| A key file is in the same format as a `.pem` file, with a different extension for support in Windows Explorer.|
69
-
|**.pem – certificate container file (optional)**| Optional. A text file with a Base64-encoding of the certificate text, and a plain-text header and footer to mark the beginning and end of the certificate. |
48
+
**To deploy a certificate on an on-premises management console sensor**:
70
49
71
-
For example:
50
+
1. Sign into your OT sensor and select **System settings** > **SSL/TLS certificates**.
72
51
73
-
1.Open the downloaded certificate file and select the **Details** tab > **Copy to file** to run the **Certificate Export Wizard**.
52
+
1.In the **SSL/TLS Certificates** dialog, select **Add Certificate**.
74
53
75
-
1. In the **Certificate Export Wizard**, select **Next** > **DER encoded binary X.509 (.CER)** > and then select **Next** again.
54
+
1. In the **Import a trusted CA-signed certificate** area, enter a certificate name and optional passphrase, and then upload the files you'd created earlier.
76
55
77
-
1.In the **File to Export**screen, select **Browse**, choose a location to store the certificate, and then select **Next**.
56
+
1.Select the **Enable certificate validation**option to validate the certificate against a [CRL server](#verify-crl-server-access).
78
57
79
-
1. Select **Finish** to export the certificate.
58
+
1. Select **Save** to save your certificate settings.
80
59
81
-
> [!NOTE]
82
-
> You may need to convert existing files types to supported types.
60
+
You can also [import the certificate to your OT sensor using CLI commands](references-work-with-defender-for-iot-cli-commands.md#tlsssl-certificate-commands).
83
61
84
-
## Verify certificate file parameter requirements
62
+
###Verify certificate file parameter requirements
85
63
86
64
Verify that the certificates meet the following requirements:
87
65
@@ -106,9 +84,9 @@ Verify that the certificates meet the following requirements:
106
84
107
85
-**Key file requirements**: Use either RSA 2048 bits or 4096 bits. Using a key length of 4096 bits will slow down the SSL handshake at the start of each connection, and increase the CPU usage during handshakes.
108
86
109
-
- (Optional) Create a certificate chain, which is a `.pem` file that contains the certificates of all the certificate authorities in the chain of trust that led to your certificate. Certificate chain files support bag attributes.<!--what is this and why do we care?-->
87
+
- (Optional) Create a certificate chain, which is a `.pem` file that contains the certificates of all the certificate authorities in the chain of trust that led to your certificate. Certificate chain files support bag attributes.
110
88
111
-
## Verify CRL server access
89
+
###Verify CRL server access
112
90
113
91
If your organization validates certificates, your OT sensors and on-premises management console must be able to access the CRL server defined by the certificate. By default, certificates access the CRL server URL via HTTP port 80. However, some organizational security policies block access to this port.
114
92
@@ -125,27 +103,49 @@ If your OT sensors and on-premises management consoles can't access your CRL ser
125
103
126
104
If validation fails, communication between the relevant components is halted and a validation error is presented in the console.
127
105
128
-
## Import the SSL/TLS certificate
106
+
## Create a certificate
129
107
130
-
After creating your certificate, [import it to your OT sensor](references-work-with-defender-for-iot-cli-commands.md#tlsssl-certificate-commands) or to a trusted storage location. For example:
108
+
Add description.
131
109
132
-
1. Open the security certificate file and, in the **General** tab, select **Install Certificate** to start the **Certificate Import Wizard**.
110
+
### Create CA-signed SSL/TLS certificates
133
111
134
-
1. In **Store Location**, select **Local Machine**, then select **Next**.
112
+
Use a certificate management platform, such as an automated PKI management platform, to create a certificate. Verify that the certificate meets [certificate file requirements](#verify-certificate-file-parameter-requirements), and then [test the certificate](#test-your-ssltls-certificates) file you created when you're done.
135
113
136
-
1.If a **User Allow Control** prompt appears, select **Yes** to allow the app to make changes to your device.
114
+
If you aren't carrying out certificate validation, remove the CRL URL reference in the certificate. For more information, see [certificate file requirements](#verify-certificate-file-parameter-requirements).
137
115
138
-
1. In the **Certificate Store** screen, select **Automatically select the certificate store based on the type of certificate**, then select **Next**.
116
+
Consult a security, PKI, or other qualified certificate lead if you don't have an application that can automatically create certificates.
139
117
140
-
1. Select **Place all certificates in the following store**, then **Browse**, and then select the **Trusted Root Certification Authorities** store. When you're done, select **Next**. For example:
118
+
You can also convert existing certificate files if you don't want to create new ones.
141
119
142
-
:::image type="content" source="media/how-to-deploy-certificates/certificate-store-trusted-root.png" alt-text="Screenshot of the certificate store screen where you can browse to the trusted root folder." lightbox="media/how-to-deploy-certificates/certificate-store-trusted-root.png":::
120
+
### Create self-signed SSL/TLS certificates
143
121
144
-
1. Select **Finish** to complete the import.
122
+
Create self-signed SSL/TLS certificates by first [downloading a security certificate](#import-a-downloaded-security-certificate-to-a-trusted-store) from the OT sensor or on-premises management console and then exporting it to the required file types.
123
+
124
+
> [!NOTE]
125
+
> While you can use a locally-generated and self-signed certificate, we do not recommend this option.
126
+
127
+
**Export as a certificate file:**
128
+
129
+
Use a certificate management platform to create the following types of SSL/TLS certificate files:
130
+
131
+
| File type | Description |
132
+
|---------|---------|
133
+
|**.crt – certificate container file**| A `.pem`, or `.der` file, with a different extension for support in Windows Explorer.|
134
+
|**.key – Private key file**| A key file is in the same format as a `.pem` file, with a different extension for support in Windows Explorer.|
135
+
|**.pem – certificate container file (optional)**| Optional. A text file with a Base64-encoding of the certificate text, and a plain-text header and footer to mark the beginning and end of the certificate. |
136
+
137
+
For example:
138
+
139
+
1. Open the downloaded certificate file and select the **Details** tab > **Copy to file** to run the **Certificate Export Wizard**.
145
140
146
-
## Test your SSL/TLS certificates
141
+
1. In the **Certificate Export Wizard**, select **Next** > **DER encoded binary X.509 (.CER)** > and then select **Next** again.
142
+
143
+
1. In the **File to Export** screen, select **Browse**, choose a location to store the certificate, and then select **Next**.
144
+
145
+
1. Select **Finish** to export the certificate.
147
146
148
-
Use the following procedures to test certificates before deploying them to your OT sensors and on-premises management consoles.
147
+
> [!NOTE]
148
+
> You may need to convert existing files types to supported types.
### Test certificates without a `.csr` or private key file
187
+
### Test your SSL/TLS certificates
188
188
189
189
If you want to check the information within the certificate `.csr` file or private key file, use the following CLI commands:
190
190
@@ -194,51 +194,59 @@ If you want to check the information within the certificate `.csr` file or priva
194
194
195
195
If these tests fail, review [certificate file parameter requirements](#verify-certificate-file-parameter-requirements) to verify that your file parameters are accurate, or consult your certificate specialist.
196
196
197
-
### Validate the certificate's common name
197
+
##Troubleshoot
198
198
199
-
1. To view the certificate's common name, open the certificate file and select the **Details** tab and then select the **Subject** field.
199
+
### Import a downloaded security certificate to a trusted store
200
200
201
-
The certificate's common name will then appear next to **CN**.
201
+
**Download a security certificate:**
202
202
203
-
1.Sign-in to your sensor console without a secure connection. In the **Your connection isn't private** warning screen, you might see a **NET::ERR_CERT_COMMON_NAME_INVALID** error message.
203
+
1.After [installing your OT sensor software](ot-deploy/install-software-ot-sensor.md) or [on-premises management console](ot-deploy/install-software-on-premises-management-console.md), go to the sensor's or on-premises management console's IP address in a browser.
204
204
205
-
1. Select the error message to expand it, and then copy the string next to **Subject**. For example:
205
+
1. Select the :::image type="icon" source="media/how-to-deploy-certificates/warning-icon.png" border="false"::: **Not secure** alert in the address bar of your web browser, then select the **>** icon next to the warning message **"Your connection to this site isn't secure"**. For example:
206
206
207
-
:::image type="content" source="media/how-to-deploy-certificates/connection-is-not-private-subject.png" alt-text="Screenshot of the connection isn't private screen with the details expanded." lightbox="media/how-to-deploy-certificates/connection-is-not-private-subject.png":::
207
+
:::image type="content" source="media/how-to-deploy-certificates/connection-is-not-secure.png" alt-text="Screenshot of web page with a Not secure warning in the address bar." lightbox="media/how-to-deploy-certificates/connection-is-not-secure.png":::
208
208
209
-
The subject string should match the **CN**string in the security certificate's details.
209
+
1. Select the :::image type="icon" source="media/how-to-deploy-certificates/show-certificate-icon.png" border="false"::: **Show certificate**icon to view the security certificate for this website.
210
210
211
-
1. In your local file explorer, browse to the hosts file, such as at **This PC > Local Disk (C:) > Windows > System32 > drivers > etc**, and open the **hosts**file.
211
+
1. In the **Certificate viewer** pane, select the **Details** tab, then select **Export** to save the file on your local machine.
212
212
213
-
1. In the hosts file, add in a line at the end of document with the sensor's IP address and the SSL certificate's common name that you copied in the previous steps. When you're done, save the changes. For example:
213
+
**Import the sensor's locally signed certificate to your certificate store:**
214
214
215
-
:::image type="content" source="media/how-to-deploy-certificates/hosts-file.png" alt-text="Screenshot of the hosts file." lightbox="media/how-to-deploy-certificates/hosts-file.png":::
215
+
After creating your locally signed certificate, import it to a trusted storage location. For example:
216
216
217
-
## Deploy an SSL/TLS certificate
217
+
1. Open the security certificate file and, in the **General** tab, select **Install Certificate** to start the **Certificate Import Wizard**.
218
218
219
-
After you've created your SSL/TLS certificate as required and have it installed on a trusted storage, deploy it to your OT sensor or on-premises management console.
219
+
1. In **Store Location**, select **Local Machine**, then select **Next**.
220
220
221
-
**To deploy a certificate on an OT sensor**:
221
+
1. If a **User Allow Control** prompt appears, select **Yes** to allow the app to make changes to your device.
222
222
223
-
1.Sign into your OT sensor and select **System settings** > **Basic** > **SSL/TLS certificate**
223
+
1.In the **Certificate Store** screen, select **Automatically select the certificate store based on the type of certificate**, then select **Next**.
224
224
225
-
1.In the **SSL/TLS certificate** pane, enter your certificate name and passphrase, and then upload the files you'd created earlier.
225
+
1.Select **Place all certificates in the following store**, then **Browse**, and then select the **Trusted Root Certification Authorities** store. When you're done, select **Next**. For example:
226
226
227
-
Select **Enable certificate validation** to validate the certificate against a [CRL server](#verify-crl-server-access).
227
+
:::image type="content" source="media/how-to-deploy-certificates/certificate-store-trusted-root.png" alt-text="Screenshot of the certificate store screen where you can browse to the trusted root folder." lightbox="media/how-to-deploy-certificates/certificate-store-trusted-root.png":::
228
228
229
-
1. Select **Save** to save your certificate settings.
229
+
1. Select **Finish** to complete the import.
230
230
231
-
**To deploy a certificate on an on-premises management console sensor**:
231
+
### Validate the certificate's common name
232
232
233
-
1.Sign into your OT sensor and select **System settings** > **SSL/TLS certificates**.
233
+
1.To view the certificate's common name, open the certificate file and select the Details tab, and then select the **Subject** field.
234
234
235
-
1. In the **SSL/TLS Certificates** dialog, select **Add Certificate**.
235
+
The certificate's common name will then appear next to **CN**.
236
236
237
-
1.In the **Import a trusted CA-signed certificate** area, enter a certificate name and optional passphrase, and then upload the files you'd created earlier.
237
+
1.Sign-in to your sensor console without a secure connection. In the **Your connection isn't private** warning screen, you might see a **NET::ERR_CERT_COMMON_NAME_INVALID** error message.
238
238
239
-
1. Select the **Enable certificate validation** option to validate the certificate against a [CRL server](#verify-crl-server-access).
239
+
1. Select the error message to expand it, and then copy the string next to **Subject**. For example:
240
240
241
-
1. Select **Save** to save your certificate settings.
241
+
:::image type="content" source="media/how-to-deploy-certificates/connection-is-not-private-subject.png" alt-text="Screenshot of the connection isn't private screen with the details expanded." lightbox="media/how-to-deploy-certificates/connection-is-not-private-subject.png":::
242
+
243
+
The subject string should match the **CN** string in the security certificate's details.
244
+
245
+
1. In your local file explorer, browse to the hosts file, such as at **This PC > Local Disk (C:) > Windows > System32 > drivers > etc**, and open the **hosts** file.
246
+
247
+
1. In the hosts file, add in a line at the end of document with the sensor's IP address and the SSL certificate's common name that you copied in the previous steps. When you're done, save the changes. For example:
248
+
249
+
:::image type="content" source="media/how-to-deploy-certificates/hosts-file.png" alt-text="Screenshot of the hosts file." lightbox="media/how-to-deploy-certificates/hosts-file.png":::
0 commit comments