This application communicates with Duo's service on TCP port 443. Firewall configurations that restrict outbound access to Duo's service with rules using destination IP addresses or IP address ranges aren't recommended, since these may change over time to maintain our service's high availability. If your organization requires IP-based rules, please review this Duo KB article.
Before moving on to the deployment steps, it's a good idea to familiarize yourself with Duo administration concepts and features like options for applications, available methods for enrolling Duo users, and Duo policy settings and how to apply them. See all Duo Administrator documentation.
To get started with Duo for OpenVPN, you'll need to:
The security of your Duo application is tied to the security of your secret key (skey). Secure it as you would any sensitive credential. Don't share it with unauthorized individuals or email it to anyone under any circumstances!
To get started with the Duo OpenVPN plugin, download the Duo OpenVPN v2.3 package. Then simply extract, build, and install the plugin.
$ tar zxf duosecurity-duo_openvpn-2.3.tar.gz $ cd duosecurity-duo_openvpn-2.3 $ make && sudo make install
The duo_openvpn.so plugin and duo_openvpn.py Python helper script will be installed into /opt/duo.
Open your OpenVPN server configuration file (e.g.
/etc/openvpn/server.conf) and append the following line to it:
OpenVPN 2.4 and later:
plugin /opt/duo/duo_openvpn.so 'IKEY SKEY HOST'
OpenVPN 2.3 or earlier:
plugin /opt/duo/duo_openvpn.so IKEY SKEY HOST
Be sure to replace IKEY, SKEY, and HOST on the plugin line with the integration key, secret key, and API hostname from your OpenVPN application's properties page in the Duo Admin Panel.
We also recommend setting the reneg-sec option in the server configuration file. This option will determine how often OpenVPN forces a renegotiation, thereby requiring the user to re-authenticate with Duo. This setting defaults to 3600 seconds, which means your users must re-authenticate every hour. If your user's VPN client saves the password and automatically re-authenticates with it, this may cause issues with the user receiving unexpected push notifications or their client replaying a one-time passcode. Therefore, we recommend disabling reneg-sec by setting it to 0 in your server configuration file:
Old versions of OpenVPN may fail to connect with reneg-sec set to 0. If your OpenVPN version is below 2.2, then you should instead set reneg-sec to a very large value.
Save the configuration file and restart the OpenVPN server for the changes to take effect.
Ensure that the following line is present in the OpenVPN client configuration file of all of your users:
The auth-user-pass line in the client config will cause the OpenVPN client to prompt the user for an additional password (described in more detail below) to authenticate.
If you specified the reneg-sec option in the server configuration above, be sure to also include it in your client configuration file:
You may need to enable the dynamic challenge-response mechanism in your OpenVPN client. This mechanism is supported in the open-source client starting with version 2.2, but you usually must enable it explicitly.
First, make sure you’re running version 2.2 or later of the openvpn client:
$ openvpn --version OpenVPN 2.2.1 x86_64-linux-gnu [SSL] [LZO2] [EPOLL] [PKCS11] [eurephia] [MH] [PF_INET6] [IPv6 payload 20110424-2 (2.2RC2)] built on Mar 30 2012 Originally developed by James Yonan Copyright (C) 2002-2010 OpenVPN Technologies, Inc. <email@example.com>
Set the auth-retry option to a value of interact when running the client. For example:
$ openvpn --config client.ovpn --auth-retry interact
When OpenVPN is configured with certificate authentication as the primary authentication factor, Duo uses the OpenVPN password field as the input mechanism for the secondary authentication factor.
When you authenticate, your OpenVPN client to provide an additional username and password. The username field can usually be ignored since Duo will pull the real username from common name (CN) field of the provided certificate. Some OpenVPN clients won't let you submit a blank username. In that case, type something in that field.
In the password field, you can enter the name of a Duo authentication method. Choose from the following factors:
|phone||Perform phone callback. Press the specified key on your phone to approve.|
Perform Duo Push authentication.
Note that you can only use Duo Push if you have successfully activated the Duo Mobile app on your phone.
Send a new batch of SMS passcodes.
If you select this factor, then your authentication attempt will be denied, but you will also receive new SMS passcodes. You can then proceed to authenticate again with one of the newly-delivered passcodes.
Enter a passcode value from a hardware token, sent via SMS, generated by Duo Mobile, or a bypass code provided by your Duo administrator.
The number following the factor identifier identifies which enrolled device you wish to use to authentication. So, if you have two phones provisioned, you can also enter phone2, push2, etc.
So, if you wanted to use Duo Push to authenticate, you would enter:
username: <ignored> password: push
If you'd like to use a Duo passcode instead (eg. "124356"), enter:
username: <ignored> password: 123456
Need some help? Take a look at the OpenVPN Frequently Asked Questions (FAQ) page or try searching our OpenVPN Knowledge Base articles or Community discussions. For further assistance, contact Support.