Skip to content

Commit b1e0e4b

Browse files
authored
Merge pull request #293786 from cherylmc/p2s-openvpn
OpenVPN articles for VWAN
2 parents 25dcab5 + 30eda81 commit b1e0e4b

7 files changed

+286
-88
lines changed

articles/virtual-wan/TOC.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,17 @@
231231
- name: Certificate authentication clients
232232
items:
233233
- name: Windows clients
234-
href: vpn-client-certificate-windows.md
234+
items:
235+
- name: Native VPN client
236+
href: vpn-client-certificate-windows.md
237+
- name: Azure VPN client
238+
href: vpn-client-certificate-windows.md
239+
- name: OpenVPN client
240+
items:
241+
- name: Version 2.x
242+
href: point-to-site-vpn-client-certificate-windows-openvpn-client-version-2.md
243+
- name: Version 3.x
244+
href: point-to-site-vpn-client-certificate-windows-openvpn-client-version-3.md
235245
- name: macOS and iOS clients
236246
href: point-to-site-vpn-client-cert-mac.md
237247
- name: Install client certificates
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: 'Configure User VPN P2S clients: certificate authentication: OpenVPN Client 2.x - Windows'
3+
titleSuffix: Azure Virtual WAN
4+
description: Learn how to configure User VPN clients for P2S configurations that use certificate authentication. This article applies to Windows and the OpenVPN Client 2.x series.
5+
author: cherylmc
6+
ms.service: azure-virtual-wan
7+
ms.topic: how-to
8+
ms.date: 01/29/2025
9+
ms.author: cherylmc
10+
---
11+
12+
# Configure OpenVPN 2.x client for P2S User VPN certificate authentication connections - Windows
13+
14+
If your point-to-site (P2S) VPN gateway is configured to use OpenVPN and certificate authentication, you can connect to your virtual network using the OpenVPN Client. This article walks you through the steps to configure the **OpenVPN client 2.4 and higher** and connect to your virtual network. For OpenVPN Connect 3.x clients, see [Configure OpenVPN 3.x client for P2S User VPN certificate authentication connections - Windows](point-to-site-vpn-client-certificate-windows-openvpn-client-version-3.md).
15+
16+
> [!NOTE]
17+
> The OpenVPN client is independently managed and not under Microsoft's control. This means Microsoft doesn't oversee its code, builds, roadmap, or legal aspects. Should customers encounter any bugs or issues with the OpenVPN client, they should directly contact OpenVPN Inc. support. The guidelines in this article are provided 'as is' and haven't been validated by OpenVPN Inc. They are intended to assist customers who are already familiar with the client and wish to use it to connect to the Azure VPN Gateway in a Point-to-Site VPN setup.
18+
19+
## Before you begin
20+
21+
Before beginning, make sure you've configured a virtual WAN according to the steps in the [Create User VPN point-to-site connections](virtual-wan-point-to-site-portal.md) article. Your User VPN configuration must use certificate authentication.
22+
23+
### Prerequisites
24+
25+
This article assumes that you've already performed the following prerequisites:
26+
27+
* You configured a virtual WAN according to the steps in the [Create User VPN point-to-site connections](virtual-wan-point-to-site-portal.md) article. Your User VPN configuration must use certificate authentication.
28+
* You generated and downloaded the VPN client configuration files. For steps to generate a VPN client profile configuration package, see [Generate VPN client configuration files](virtual-wan-point-to-site-portal.md#p2sconfig).
29+
* You can either generate client certificates, or acquire the appropriate client certificates necessary for authentication.
30+
31+
### Connection requirements
32+
33+
To connect to Azure using the OpenVPN client using certificate authentication, each connecting client computer requires the following items:
34+
35+
* The Open VPN Client software must be installed and configured on each client computer.
36+
* The client computer must have a client certificate that's installed locally.
37+
38+
### Workflow
39+
40+
The workflow for this article is:
41+
42+
1. Generate and install client certificates if you haven't done so already.
43+
1. View the VPN client profile configuration files contained in the VPN client profile configuration package that you generated.
44+
1. Configure the OpenVPN client.
45+
1. Connect to Azure.
46+
47+
## Generate and install client certificates
48+
49+
For certificate authentication, a client certificate must be installed on each client computer. The client certificate you want to use must be exported with the private key, and must contain all certificates in the certification path. Additionally, for some configurations, you'll also need to install root certificate information.
50+
51+
In many cases, you can install the client certificate directly on the client computer by double-clicking. However, for certain OpenVPN client configurations, you might need to extract information from the client certificate in order to complete the configuration.
52+
53+
* For steps to generate a client certificate, see [Generate and export certificates](certificates-point-to-site.md#clientcert).
54+
* To view an installed client certificate, open **Manage User Certificates**. The client certificate is installed in **Current User\Personal\Certificates**.
55+
56+
### Install the client certificate
57+
58+
Each computer needs a client certificate in order to authenticate. If the client certificate isn't already installed on the local computer, you can install it using the following steps:
59+
60+
1. Locate the client certificate. For more information about client certificates, see [Install client certificates](install-client-certificates.md).
61+
1. Install the client certificate. Typically, you can install a certificate by double-clicking the certificate file and providing a password (if required).
62+
1. You'll also use the client certificate later in this exercise to configure the OpenVPN Connect client profile settings.
63+
64+
## View client profile configuration files
65+
66+
The [VPN client profile configuration package](virtual-wan-point-to-site-portal.md#p2sconfig) contains specific folders. The files within the folders contain the settings needed to configure the VPN client profile on the client computer. The files and the settings they contain are specific to the VPN gateway and the type of authentication and tunnel your VPN gateway is configured to use.
67+
68+
Locate and unzip the VPN client profile configuration package you generated. For Certificate authentication and OpenVPN, you should see the **OpenVPN** folder. If you don't see the folder, verify the following items:
69+
70+
* Verify that your VPN gateway is configured to use the OpenVPN tunnel type.
71+
* If you're using Microsoft Entra ID authentication, you might not have an OpenVPN folder. See the [Microsoft Entra ID](openvpn-azure-ad-client.md) configuration article instead.
72+
73+
## Configure the client
74+
75+
[!INCLUDE [Configuration steps](../../includes/vpn-gateway-vwan-config-openvpn-windows.md)]
76+
77+
## Next steps
78+
79+
To modify additional P2S User VPN connection settings, see [Tutorial: Create a P2S User VPN connection](virtual-wan-point-to-site-portal.md).
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: 'Configure P2S VPN clients: certificate authentication: OpenVPN Client 3.x series - Windows'
3+
titleSuffix: Azure Virtual WAN
4+
description: Learn how to configure VPN clients for P2S User VPN configurations that use certificate authentication. This article applies to Windows and the OpenVPN Client 3.x series.
5+
author: cherylmc
6+
ms.service: azure-virtual-wan
7+
ms.topic: how-to
8+
ms.date: 01/28/2025
9+
ms.author: cherylmc
10+
---
11+
12+
# Configure OpenVPN Connect 3.x clients for P2S User VPN certificate authentication connections - Windows
13+
14+
If your point-to-site (P2S) VPN gateway is configured to use OpenVPN and certificate authentication, you can connect to your virtual network using the OpenVPN Client. This article walks you through the steps to configure the **OpenVPN Connect client 3.x** and connect to your virtual network. There are some configuration differences between the [OpenVPN 2.x](point-to-site-vpn-client-certificate-windows-openvpn-client-version-2.md) client and the OpenVPN Connect 3.x client. This article focuses on the OpenVPN Connect 3.x client.
15+
16+
> [!NOTE]
17+
> The OpenVPN client is independently managed and not under Microsoft's control. This means Microsoft doesn't oversee its code, builds, roadmap, or legal aspects. Should customers encounter any bugs or issues with the OpenVPN client, they should directly contact OpenVPN Inc. support. The guidelines in this article are provided 'as is' and haven't been validated by OpenVPN Inc. They're intended to assist customers who are already familiar with the client and wish to use it to connect to the Azure VPN gateway in a User VPN point-to-site VPN setup.
18+
19+
## Before you begin
20+
21+
Before beginning, make sure you've configured a virtual WAN according to the steps in the [Create User VPN point-to-site connections](virtual-wan-point-to-site-portal.md) article. Your User VPN configuration must use certificate authentication.
22+
23+
### Prerequisites
24+
25+
This article assumes that you've already performed the following prerequisites:
26+
27+
* You configured a virtual WAN according to the steps in the [Create User VPN point-to-site connections](virtual-wan-point-to-site-portal.md) article. Your User VPN configuration must use certificate authentication.
28+
* You generated and downloaded the VPN client configuration files. For steps to generate a VPN client profile configuration package, see [Generate VPN client configuration files](virtual-wan-point-to-site-portal.md#p2sconfig).
29+
* You can either generate client certificates, or acquire the appropriate client certificates necessary for authentication.
30+
31+
### Connection requirements
32+
33+
To connect to Azure using the OpenVPN Connect 3.x client using certificate authentication, each connecting client computer requires the following items:
34+
35+
* The OpenVPN Connect client software must be installed and configured on each client computer.
36+
* The client computer must have a client certificate that's installed locally.
37+
* If your certificate chain includes an intermediate certificate, see the [Intermediate certificates](#intermediate) section first to verify that your P2S VPN gateway configuration is set up to support this certificate chain. The certificate authentication behavior for 3.x clients is different than previous versions, where you could specify the intermediate certificate in the client profile.
38+
39+
### Workflow
40+
41+
The workflow for this article is:
42+
43+
1. Generate and install client certificates, if you haven't already done so.
44+
1. View the VPN client profile configuration files contained in the VPN client profile configuration package that you generated.
45+
1. Configure the OpenVPN Connect client.
46+
1. Connect to Azure.
47+
48+
## Generate and install client certificates
49+
50+
For certificate authentication, a client certificate must be installed on each client computer. The client certificate you want to use must be exported with the private key, and must contain all certificates in the certification path. Additionally, for some configurations, you'll also need to install root certificate information.
51+
52+
In many cases, you can install the client certificate directly on the client computer by double-clicking. However, for some OpenVPN client configurations, you might need to extract information from the client certificate in order to complete the configuration.
53+
54+
* For information about working with certificates, see [Generate and export certificates](certificates-point-to-site.md#clientcert).
55+
* To view an installed client certificate, open **Manage User Certificates**. The client certificate is installed in **Current User\Personal\Certificates**.
56+
57+
### Install the client certificate
58+
59+
Each computer needs a client certificate in order to authenticate. If the client certificate isn't already installed on the local computer, you can install it using the following steps:
60+
61+
1. Locate the client certificate. For more information about client certificates, see [Install client certificates](install-client-certificates.md).
62+
1. Install the client certificate. Typically, you can install a certificate by double-clicking the certificate file and providing a password (if required).
63+
1. You'll also use the client certificate later in this exercise to configure the OpenVPN Connect client profile settings.
64+
65+
## View client profile configuration files
66+
67+
The VPN client profile configuration package contains specific folders. The files within the folders contain the settings needed to configure the VPN client profile on the client computer. The files and the settings they contain are specific to the VPN gateway and the type of authentication and tunnel your VPN gateway is configured to use.
68+
69+
Locate and unzip the VPN client profile configuration package you generated. For Certificate authentication and OpenVPN, you should see the **OpenVPN** folder. If you don't see the folder, verify the following items:
70+
71+
* Verify that your VPN gateway is configured to use the OpenVPN tunnel type.
72+
* If you're using Microsoft Entra ID authentication, you might not have an OpenVPN folder. See the [Microsoft Entra ID](openvpn-azure-ad-client.md) configuration article instead.
73+
74+
## Configure the client
75+
76+
[!INCLUDE [Configuration steps](../../includes/vpn-gateway-vwan-config-openvpn-3-series-windows.md)]
77+
78+
### <a name="example"></a>User profile example
79+
80+
[!INCLUDE [User profile example](../../includes/vpn-gateway-vwan-config-openvpn-user-profile.md)]
81+
82+
## <a name="intermediate"></a>Intermediate certificates
83+
84+
If your certificate chain includes intermediate certificates, you must upload the intermediate certificates to the Azure VPN gateway.
85+
This is the preferred method to use, regardless of the VPN client you choose to connect from. In previous versions, you could specify intermediate certificates in the user profile. This is no longer supported in OpenVPN Connect client version 3.x.
86+
87+
When you're working with intermediate certificates, the intermediate certificate must be uploaded after the root certificate.
88+
89+
## Reconnects
90+
91+
If you experience periodic reconnects due to no traffic being sent to client, you can add the "ping-restart 0" option to the profile to prevent disconnections from causing reconnects. This is described in the OpenVPN Connect documentation as follows: " --ping-restart n Similar to --ping-exit, but trigger a SIGUSR1 restart after n seconds pass without reception of a ping or other packet from remote."
92+
93+
See the [User profile example](#example) for an example of how to add this option.
94+
95+
## Next steps
96+
97+
Follow up with any additional server or connection settings. See [Tutorial: Create a P2S User VPN connection](virtual-wan-point-to-site-portal.md).

articles/vpn-gateway/point-to-site-vpn-client-certificate-windows-openvpn-client-version-3.md

Lines changed: 7 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to configure VPN clients for P2S configurations that use
55
author: cherylmc
66
ms.service: azure-vpn-gateway
77
ms.topic: how-to
8-
ms.date: 10/08/2024
8+
ms.date: 01/29/2025
99
ms.author: cherylmc
1010
---
1111

@@ -20,7 +20,7 @@ Before beginning client configuration steps, verify that you're on the correct V
2020
[!INCLUDE [All client articles](../../includes/vpn-gateway-vpn-client-install-articles.md)]
2121

2222
> [!NOTE]
23-
> The OpenVPN client is independently managed and not under Microsoft's control. This means Microsoft does not oversee its code, builds, roadmap, or legal aspects. Should customers encounter any bugs or issues with the OpenVPN client, they should directly contact OpenVPN Inc. support. The guidelines in this article are provided 'as is' and have not been validated by OpenVPN Inc. They are intended to assist customers who are already familiar with the client and wish to use it to connect to the Azure VPN Gateway in a Point-to-Site VPN setup.
23+
> The OpenVPN client is independently managed and not under Microsoft's control. This means Microsoft doesn't oversee its code, builds, roadmap, or legal aspects. Should customers encounter any bugs or issues with the OpenVPN client, they should directly contact OpenVPN Inc. support. The guidelines in this article are provided 'as is' and haven't been validated by OpenVPN Inc. They're intended to assist customers who are already familiar with the client and wish to use it to connect to the Azure VPN Gateway in a Point-to-Site VPN setup.
2424
2525
### Prerequisites
2626

@@ -42,7 +42,7 @@ To connect to Azure using the OpenVPN Connect 3.x client using certificate authe
4242

4343
The workflow for this article is:
4444

45-
1. Generate and install client certificates if you haven't already done so.
45+
1. Generate and install client certificates, if you haven't already done so.
4646
1. View the VPN client profile configuration files contained in the VPN client profile configuration package that you generated.
4747
1. Configure the OpenVPN Connect client.
4848
1. Connect to Azure.
@@ -61,7 +61,8 @@ In many cases, you can install the client certificate directly on the client com
6161
Each computer needs a client certificate in order to authenticate. If the client certificate isn't already installed on the local computer, you can install it using the following steps:
6262

6363
1. Locate the client certificate. For more information about client certificates, see [Install client certificates](point-to-site-how-to-vpn-client-install-azure-cert.md).
64-
1. Install the client certificate. Typically, you can do this by double-clicking the certificate file and providing a password (if required).
64+
1. Install the client certificate. Typically, you can install a certificate by double-clicking the certificate file and providing a password (if required).
65+
1. You'll also use the client certificate later in this exercise to configure the OpenVPN Connect client profile settings.
6566

6667
## View configuration files
6768

@@ -78,76 +79,7 @@ Locate and unzip the VPN client profile configuration package you generated. For
7879

7980
### <a name="example"></a>User profile example
8081

81-
The following example shows a user profile configuration file for 3.x OpenVPN Connect clients. This example shows the log file commented out and the "ping-restart 0" option added to prevent periodic reconnects due to no traffic being sent to the client.
82-
83-
```
84-
client
85-
remote <vpnGatewayname>.ln.vpn.azure.com 443
86-
verify-x509-name <IdGateway>.ln.vpn.azure.com name
87-
remote-cert-tls server
88-
89-
dev tun
90-
proto tcp
91-
resolv-retry infinite
92-
nobind
93-
94-
auth SHA256
95-
cipher AES-256-GCM
96-
persist-key
97-
persist-tun
98-
99-
tls-timeout 30
100-
tls-version-min 1.2
101-
key-direction 1
102-
103-
#log openvpn.log
104-
#inactive 0
105-
ping-restart 0
106-
verb 3
107-
108-
# P2S CA root certificate
109-
<ca>
110-
-----BEGIN CERTIFICATE-----
111-
……
112-
……..
113-
……..
114-
……..
115-
116-
-----END CERTIFICATE-----
117-
</ca>
118-
119-
# Pre Shared Key
120-
<tls-auth>
121-
-----BEGIN OpenVPN Static key V1-----
122-
……..
123-
……..
124-
……..
125-
126-
-----END OpenVPN Static key V1-----
127-
</tls-auth>
128-
129-
# P2S client certificate
130-
# Please fill this field with a PEM formatted client certificate
131-
# Alternatively, configure 'cert PATH_TO_CLIENT_CERT' to use input from a PEM certificate file.
132-
<cert>
133-
-----BEGIN CERTIFICATE-----
134-
……..
135-
……..
136-
……..
137-
-----END CERTIFICATE-----
138-
</cert>
139-
140-
# P2S client certificate private key
141-
# Please fill this field with a PEM formatted private key of the client certificate.
142-
# Alternatively, configure 'key PATH_TO_CLIENT_KEY' to use input from a PEM key file.
143-
<key>
144-
-----BEGIN PRIVATE KEY-----
145-
……..
146-
……..
147-
……..
148-
-----END PRIVATE KEY-----
149-
</key>
150-
```
82+
[!INCLUDE [User profile example](../../includes/vpn-gateway-vwan-config-openvpn-user-profile.md)]
15183

15284
## <a name="intermediate"></a>Intermediate certificates
15385

@@ -160,7 +92,7 @@ When you're working with intermediate certificates, the intermediate certificate
16092

16193
## Reconnects
16294

163-
If you experience periodic reconnects due to no traffic being sent to client, you can add the "ping-restart 0" option to the profile to prevent disconnections from causing reconnects. This is described in the OpenVPN Connect documentation as follows: " --ping-restart n Similar to --ping-exit, but trigger a SIGUSR1 restart after n seconds pass without reception of a ping or other packet from remote."
95+
If you experience periodic reconnects due to no traffic being sent to client, you can add the "ping-restart 0" option to the profile to prevent disconnections from causing reconnects. This is described in the OpenVPN Connect documentation as follows: ` --ping-restart n Similar to --ping-exit, but trigger a SIGUSR1 restart after n seconds pass without reception of a ping or other packet from remote.`
16496

16597
See the [User profile example](#example) for an example of how to add this option.
16698

0 commit comments

Comments
 (0)