Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 36baf5e

Browse files
committedApr 1, 2021
cleaned up docs
1 parent a63188b commit 36baf5e

File tree

5 files changed

+54
-47
lines changed

5 files changed

+54
-47
lines changed
 

‎articles/application-gateway/application-gateway-configure-listener-specific-ssl-policy.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ First create a new Application Gateway as you would usually through the portal -
2828

2929
To set up a listener-specific SSL policy, you'll need to first go to the **SSL settings (Preview)** tab in the Portal and create a new SSL profile. When you create an SSL profile, you'll see two tabs: **Client Authentication** and **SSL Policy**. The **SSL Policy** tab is to configure a listener-specific SSL policy. The **Client Authentication** tab is where to upload a client certificate(s) for mutual authentication - for more information, check out [Configuring a mutual authentication](./mutual-authentication-portal.md).
3030

31+
> [!NOTE]
32+
> We recommend using TLS 1.2 as TLS 1.2 will be mandated in the future.
33+
3134
1. Search for **Application Gateway** in portal, select **Application gateways**, and click on your existing Application Gateway.
3235

3336
2. Select **SSL settings (Preview)** from the left-side menu.

‎articles/application-gateway/mutual-authentication-portal.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,20 @@ Now that we've created an SSL profile with mutual authentication configured, we
7373

7474
![Associate SSL profile to new listener](./media/mutual-authentication-portal/mutual-authentication-listener-portal.png)
7575

76+
## Renew expired client CA certificates
77+
78+
In the case that your client CA certificate has expired, you can update the certificate on your gateway through the following steps:
79+
80+
1. Navigate to your Application Gateway and go to the **SSL settings (Preview)** tab in the left-hand menu.
81+
82+
1. Select the existing SSL profile(s) with the expired client certificate.
83+
84+
1. Select **Upload a new certificate** in the **Client Authentication** tab and upload your new client certificate.
85+
86+
1. Select the trash can icon next to the expired certificate. This will remove the association of that certificate from the SSL profile.
87+
88+
1. Repeat steps 2-4 with any other SSL profile that was using the same expired client certificate. You will be able to choose the new certificate you uploaded in step 3 from the dropdown menu in other SSL profiles.
89+
7690
## Next steps
7791

7892
> [!div class="nextstepaction"]

‎articles/application-gateway/mutual-authentication-powershell.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ $port = New-AzApplicationGatewayFrontendPort -Name $frontendPortName -Port 443
7474

7575
Configure client authentication on your Application Gateway. Make sure the trusted client CA certificate chain you upload, if you upload a chain, is complete and contains all intermediate certificates (if any).
7676

77+
> [!IMPORTANT]
78+
> Please ensure that you upload the entire client CA certificate chain in one file.
79+
80+
> [!NOTE]
81+
> We recommend using TLS 1.2 with mutual authentication as TLS 1.2 will be mandated in the future.
82+
7783
```azurepowershell
7884
$clientCertFilePath = $basedir + "/ScenarioTests/Data/TrustedClientCertificate.cer"
7985
$trustedClient01 = New-AzApplicationGatewayTrustedClientCertificate -Name $trustedClientCert01Name -CertificateFile $clientCertFilePath
@@ -121,6 +127,32 @@ When no longer needed, remove the resource group, application gateway, and all r
121127
Remove-AzResourceGroup -Name $rgname
122128
```
123129

130+
## Renew expired client CA certificates
131+
132+
In the case that your client CA certificate has expired, you can update the certificate on your gateway through the following steps:
133+
134+
1. Sign in to Azure
135+
```azurepowershell
136+
Connect-AzAccount
137+
Select-AzSubscription -Subscription "<sub name>"
138+
```
139+
2. Get your Application Gateway configuration
140+
```azurepowershell
141+
$gateway = Get-AzApplicationGateway -Name "<gateway-name>" -ResourceGroupName "<resource-group-name>"
142+
```
143+
3. Remove the trusted client certificate from the gateway
144+
```azurepowershell
145+
Remove-AzApplicationGatewayTrustedClientCertificate -Name "<name-of-client-certificate>" -ApplicationGateway $gateway
146+
```
147+
4. Add the new certificate onto the gateway
148+
```azurepowershell
149+
Add-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway $gateway -Name "<name-of-new-cert>" -CertificateFile "<path-to-certificate-file>"
150+
```
151+
5. Update the gateway with the new certificate
152+
```azurepowershell
153+
Set-AzApplicationGateway -ApplicationGateway $gateway
154+
```
155+
124156
## Next steps
125157

126158
> [!div class="nextstepaction"]

‎articles/application-gateway/mutual-authentication-troubleshooting.md

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -39,53 +39,9 @@ The client certificate you uploaded is a self-signed certificate and is resultin
3939

4040
Double check that the self-signed certificate that you're using has the extension *BasicConstraintsOid* = "2.5.29.19" which indicates the subject can act as a CA. This will ensure that the certificate used is a CA certificate. For more information about how to generate self-signed client certificates, check out [trusted client certificates](./mutual-authentication-certificate-management.md).
4141

42-
### Expired client CA certificate
43-
44-
#### Problem
45-
46-
The client CA certificate you uploaded onto your Application Gateway is now expired. You can validate that this is the problem by looking through the gateway's access logs and checking to see what the error message is.
47-
48-
#### Solution
49-
50-
You can update the client certificate on your gateway through portal or through PowerShell.
51-
52-
**Portal**
53-
1. Navigate to your Application Gateway and go to the **SSL settings (Preview)** tab in the left-hand menu.
54-
2. Select the existing SSL profile(s) with the expired client certificate.
55-
3. Select **Upload a new certificate** in the **Client Authentication** tab and upload your new client certificate.
56-
4. Select the trash can icon next to the expired certificate. This will remove the association of that certificate from the SSL profile.
57-
5. Repeat steps 2-4 with any other SSL profile that was using the same expired client certificate. You will be able to choose the new certificate you uploaded in step 3 from the dropdown menu in other SSL profiles.
58-
59-
**PowerShell**
60-
[!INCLUDE [updated-for-az](../../includes/updated-for-az.md)]
61-
62-
You must have Azure PowerShell module version 1.0.0 or later installed. Run `Get-Module -ListAvailable Az` to find the version. If you need to upgrade, see [Install Azure PowerShell module](/powershell/azure/install-az-ps). After you verify the PowerShell version, run `Connect-AzAccount` to create a connection with Azure.
63-
64-
1. Sign in to Azure
65-
```azurepowershell
66-
Connect-AzAccount
67-
Select-AzSubscription -Subscription "<sub name>"
68-
```
69-
2. Get your Application Gateway configuration
70-
```azurepowershell
71-
$gateway = Get-AzApplicationGateway -Name "<gateway-name>" -ResourceGroupName "<resource-group-name>"
72-
```
73-
3. Remove the trusted client certificate from the gateway
74-
```azurepowershell
75-
Remove-AzApplicationGatewayTrustedClientCertificate -Name "<name-of-client-certificate>" -ApplicationGateway $gateway
76-
```
77-
4. Add the new certificate onto the gateway
78-
```azurepowershell
79-
Add-AzApplicationGatewayTrustedClientCertificate -ApplicationGateway $gateway -Name "<name-of-new-cert>" -CertificateFile "<path-to-certificate-file>"
80-
```
81-
5. Update the gateway with the new certificate
82-
```azurepowershell
83-
Set-AzApplicationGateway -ApplicationGateway $gateway
84-
```
85-
8642
## Scenario troubleshooting - connectivity problems
8743

88-
You might have been able to configure mutual authentication without any problems but you're running into problems when sending requests to your Application Gateway. We address some common problems and solutions in the following section. You can find the sslClientVerify property in the access logs of your Application Gateway.
44+
You might have been able to configure mutual authentication without any problems but you're running into problems when sending requests to your Application Gateway. We address some common problems and solutions in the following section. You can find the *sslClientVerify* property in the access logs of your Application Gateway.
8945

9046
### SslClientVerify is NONE
9147

@@ -97,11 +53,13 @@ The property *sslClientVerify* is appearing as "NONE" in your access logs.
9753

9854
This is seen when the client doesn't send a client certificate when sending a request to the Application Gateway. This could happen if the client sending the request to the Application Gateway isn't configured correctly to use client certificates. One way to verify that the client authentication setup on Application Gateway is working as expected is through the following OpenSSL command:
9955

56+
```
10057
openssl s_client -connect <hostname:port> -cert <path-to-certificate> -key <client-private-key-file>
58+
```
10159

102-
The cert flag is the leaf certificate, the key flag is the client private key file.
60+
The `-cert` flag is the leaf certificate, the `-key` flag is the client private key file.
10361

104-
For more information on how to use the OpenSSL s_client command, check out their [manual page](https://www.openssl.org/docs/man1.0.2/man1/openssl-s_client.html).
62+
For more information on how to use the OpenSSL `s_client` command, check out their [manual page](https://www.openssl.org/docs/man1.0.2/man1/openssl-s_client.html).
10563

10664
### SslClientVerify is FAILED
10765

0 commit comments

Comments
 (0)
Please sign in to comment.