Skip to content

Commit 4674c66

Browse files
authored
Merge pull request #222362 from yoninalmsft/deploy-certificates-updates
Deploy certificates updates
2 parents f77944a + 91f6e0c commit 4674c66

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

articles/defender-for-iot/organizations/how-to-deploy-certificates.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ This article provides information needed when creating and deploying certificate
1111

1212
Defender for IoT uses SSL/TLS certificates to secure communication between the following system components:
1313

14-
- Between users and the web console of the appliance.
15-
- Between the sensors and an on-premises management console.
14+
- Between users and the web console of the appliance.
15+
- Between the sensors and an on-premises management console.
1616
- Between a management console and a High Availability management console.
17-
- To the REST API on the sensor and on-premises management console.
17+
- To the REST API on the sensor and on-premises management console.
1818

1919
Defender for IoT Admin users can upload a certificate to sensor consoles and their on-premises management console from the SSL/TLS Certificates dialog box.
2020

21-
:::image type="content" source="media/how-to-activate-and-set-up-your-sensor/wizard-upload-activation-certificates-1.png" alt-text="Screenshot of an initial sensor sign in certificate page.":::
21+
:::image type="content" source="media/how-to-activate-and-set-up-your-sensor/wizard-upload-activation-certificates-1.png" alt-text="Screenshot of an initial sensor sign-in certificate page.":::
2222

2323
## About certificate generation methods
2424

2525
All certificate generation methods are supported using:
2626

27-
- Private and Enterprise Key Infrastructures (Private PKI)
28-
- Public Key Infrastructures (Public PKI)
27+
- Private and Enterprise Key Infrastructures (Private PKI).
28+
- Public Key Infrastructures (Public PKI).
2929
- Certificates locally generated on the appliance (locally self-signed).
3030

3131
> [!Important]
@@ -52,58 +52,58 @@ Validation is carried out twice:
5252

5353
If validation fails, communication between the relevant components is halted and a validation error is presented in the console.
5454

55-
## About certificate upload to Defender for IoT
55+
## About certificate upload to Defender for IoT appliances
5656

5757
Following sensor and on-premises management console installation, a local self-signed certificate is generated and used to access the sensor and on-premises management console web application.
5858

5959
When signing into the sensor and on-premises management console for the first time, Admin users are prompted to upload an SSL/TLS certificate. Using SSL/TLS certificates is highly recommended.
6060

6161
If the certificate isn't created properly by the certificate lead or there are connection issues to it, the certificate can't be uploaded and users will be forced to work with a locally signed certificate.
6262

63-
The option to validate the uploaded certificate and third-party certificates is automatically enabled, but can be disabled. When disabled, encrypted communications between components continues, even if a certificate is invalid.
63+
The option to validate the uploaded certificate and third-party certificates is automatically enabled, but can be disabled. When disabled, encrypted communications between components continue, even if a certificate is invalid.
6464

65-
## Certificate deployment tasks
65+
## Certificate deployment
6666

6767
This section describes the steps you need to take to ensure that certificate deployment runs smoothly.
6868

6969
**To deploy certificates, verify that:**
7070

7171
- A security, PKI or certificate specialist is creating or overseeing certificate creation.
7272
- You create a unique certificate for each sensor, management console and HA machine.
73-
- You meet certificate creation requirements. See [Certificate creation requirements](#certificate-creation-requirements).
73+
- You meet[certificate creation requirements](#supported-ssl-certificates).
7474
- Admin users logging in to each Defender for IoT sensor, and on-premises management console and HA machine have access to the certificate.
7575

76-
## Certificate creation requirements
76+
## Supported SSL certificates
7777

78-
This section covers certificate creation requirement, including:
78+
This section covers requirements for successful certificate deployment, including:
7979

80-
- [Port access requirements for certificate validation](#port-access-requirements-for-certificate-validation)
80+
- [CRL server access for certificate validation](#crl-server-access-for-certificate-validation)
8181

82-
- [File type requirements](#file-type-requirements)
82+
- [Supported certificate file types](#supported-certificate-file-types)
8383

8484
- [Key file requirements](#key-file-requirements)
8585

86-
- [Certificate chain file requirements (if .pem is used)](#certificate-chain-file-requirements-if-pem-is-used)
86+
- [Using a certificate chain (optional)](#using-a-certificate-chain-optional)
8787

88-
### Port access requirements for certificate validation
88+
### CRL server access for certificate validation
8989

9090
If you are working with certificate validation, verify access to port 80 is available.
9191

92-
Certificate validation is evaluated against a Certificate Revocation List, and the certificate expiration date. This means appliance should be able to establish connection to the CRL server defined by the certificate. By default, the certificate will reference the CRL URL on HTTP port 80.
92+
Certificate validation is evaluated against a Certificate Revocation List, and the certificate expiration date. This means the appliance should be able to establish connection to the CRL server defined by the certificate. By default, the certificate will reference the CRL URL on HTTP port 80.
9393

9494
Some organizational security policies may block access to this port. If your organization doesn't have access to port 80, you can:
9595

9696
1. Define another URL and a specific port in the certificate.
9797

98-
- The URL should be defined as http: // rather than https: // .
98+
- The URL should be defined as `http: //` rather than `https: //`.
9999

100100
- Verify that the destination CRL server can listen on the port you defined.
101101

102102
1. Use a proxy server that will access the CRL on port 80.
103103

104-
### File type requirements
104+
### Supported certificate file types
105105

106-
Defender for IoT requires that each CA-signed certificate contains a .key file and a .crt file. These files are uploaded to the sensor and On-premises management console after login. Some organizations may require .pem file. Defender for IoT doesn't require this file type.
106+
Defender for IoT requires that each CA-signed certificate contains a .key file and a .crt file. These files are uploaded to the sensor and On-premises management console after login. Some organizations may require a .pem file. Defender for IoT doesn't require this file type.
107107

108108
**.crt – certificate container file**
109109

@@ -125,7 +125,7 @@ Verify that you've met the following parameter requirements before creating a ce
125125

126126
- [CRT file requirements](#crt-file-requirements)
127127
- [Key file requirements](#key-file-requirements)
128-
- [Certificate chain file requirements (if .pem is used)](#certificate-chain-file-requirements-if-pem-is-used)
128+
- [Using a certificate chain (optional)](#using-a-certificate-chain-optional)
129129

130130
### CRT file requirements
131131

@@ -142,41 +142,43 @@ This section covers .crt field requirements.
142142
- Subject (OU) Org Unit = defined, for example, Contoso Labs
143143
- Subject (O)rganization = defined, for example, Contoso Inc.
144144

145-
Certificates with other parameters might work, but Microsoft doesn't support them. 
145+
> [!IMPORTANT]
146+
> Certificates with other parameters might work, but Microsoft doesn't support them.
147+
> Wildcard SSL certificates (public key certificates that can be used on multiple subdomains such as *.contoso.com) are not supported and insecure. Each appliance should use a unique CN.
146148
147149
### Key file requirements
148150

149151
Use either RSA 2048 bits or 4096 bits.
150152

151-
When using a key length of 4096 bits, the SSL handshake at the start of each connection will be slower. in addition, there is an increase in CPU usage during handshakes.
153+
When using a key length of 4096 bits, the SSL handshake at the start of each connection will be slower. In addition, there's an increase in CPU usage during handshakes.
152154

153-
### Certificate chain file requirements (if .pem is used)
155+
### Using a certificate chain (optional)
154156

155157
A .pem file containing the certificates of all the certificate authorities in the chain of trust that led to your certificate.
156158

157159
Bag attributes are supported in the certificate chain file.
158160

159-
## Create certificates
161+
## Create SSL certificates
160162

161-
Use a certificate management platform to create a certificate, for example, an automated PKI management platform. Verify that the certificates meet certificate file requirements. See Test certificates for information on testing the files you create.
163+
Use a certificate management platform to create a certificate, for example, an automated PKI management platform. Verify that the certificates meet certificate file requirements. For more information on testing the files you create, see [Test certificates you create](#test-certificates-you-create).
162164

163165
If you are not carrying out certificate validation, remove the CRL URL reference in the certificate. See [CRT file requirements](#crt-file-requirements) for information about this parameter.
164166

165-
Consult a security, PKI, or other qualified certificate lead if you do not have an application that can automatically create certificates.
167+
Consult a security, PKI, or other qualified certificate lead if you don't have an application that can automatically create certificates.
166168

167169
You can [Test certificates you create](#test-certificates-you-create).
168170

169-
You can also convert existing certificate files if you do not want to create new ones. See [Convert existing files to supported files](#convert-existing-files-to-supported-files) for details.
171+
You can also convert existing certificate files if you don't want to create new ones. See [Convert existing files to supported files](#convert-existing-files-to-supported-files) for details.
170172

171173
### Sample Certificate
172174

173-
You can compare your certificate to the sample certificate below. Verify that the same fields exits and that the order of the fields is the same.
175+
Compare your certificate to the following sample certificate. Verify that the same fields exits and that the order of the fields is the same:
174176

175177
:::image type="content" source="media/how-to-deploy-certificates/sample-certificate.png" alt-text="Screenshot of a sample certificate.":::
176178

177179
## Test certificates you create
178180

179-
You can test certificates before deploying them to your sensors and on-premises management consoles. If you want to check the information within the certificate .csr file or private key file, use these commands:
181+
Test certificates before deploying them to your sensors and on-premises management consoles. If you want to check the information within the certificate .csr file or private key file, use these commands:
180182

181183
| **Test** | **CLI command** |
182184
|--|--|
@@ -203,15 +205,15 @@ This section covers various issues that may occur during certificate upload and
203205

204206
### Troubleshoot CA-Certificate Upload
205207

206-
Admin users attempting to log in to the sensor or on-premises management console for the first time will not be able to upload the CA-signed certificate if the certificate is not created properly or is invalid. If certificate upload fails, one or several of the error messages will display:
208+
Admin users attempting to log in to the sensor or on-premises management console for the first time will not be able to upload the CA-signed certificate if the certificate isn't created properly or is invalid. If certificate upload fails, one or several of the error messages will display:
207209

208210
| **Certificate validation error** | **Recommendation** |
209211
|--|--|
210212
| Passphrase does not match to the key | Validate that you typed the correct passphrase. If the problem continues, try recreating the certificate using the correct passphrase. |
211-
| Cannot validate chain of trust. The provided Certificate and Root CA do not match. | Make sure the .pem file correlates to the .crt file. If the problem continues, try recreating the certificate using the correct chain of trust (defined by the .pem file). |
212-
| This SSL certificate has expired and is not considered valid. | Create a new certificate with valid dates.|
213-
| This SSL certificate has expired and is not considered valid. | Create a new certificate with valid dates.|
214-
|This certificate has been revoked by the CRL and cannot be trusted for a secure connection | Create a new unrevoked certificate. |
213+
| Cannot validate chain of trust. The provided Certificate and Root CA don't match. | Make sure the .pem file correlates to the .crt file. If the problem continues, try recreating the certificate using the correct chain of trust (defined by the .pem file). |
214+
| This SSL certificate has expired and isn't considered valid. | Create a new certificate with valid dates.|
215+
| This SSL certificate has expired and isn't considered valid. | Create a new certificate with valid dates.|
216+
|This certificate has been revoked by the CRL and can't be trusted for a secure connection | Create a new unrevoked certificate. |
215217
|The CRL (Certificate Revocation List) location is not reachable. Verify the URL can be accessed from this appliance | Make sure that your network configuration allows the appliance to reach the CRL Server defined in the certificate. You can use a proxy server if there are limitations in establishing a direct connection.
216218
|Certificate validation failed | This indicates a general error in the appliance. Contact [Microsoft Support](https://support.microsoft.com/supportforbusiness/productselection?sapId=82c8f35-1b8e-f274-ec11-c6efdd6dd099).|
217219

@@ -222,7 +224,7 @@ Your file conversion may not create a valid certificate. For example, the file s
222224
If the conversion fails:
223225

224226
- Use the conversion commands described in [Convert existing files to supported files](#convert-existing-files-to-supported-files).
225-
- Make sure the file parameters are accurate. See, [File type requirements](#file-type-requirements) and [Certificate File Parameter Requirements](#certificate-file-parameter-requirements) for details.
227+
- Make sure the file parameters are accurate. See [Supported certificate file types](#supported-certificate-file-types) and [Certificate File Parameter Requirements](#certificate-file-parameter-requirements) for details.
226228
- Consult your certificate lead.
227229

228230
## Next steps

0 commit comments

Comments
 (0)