Duo can be integrated with almost any device or system that supports using LDAP for authentication. In this type of configuration, users will receive an automatic push or phone callback during login. Users who need to use a passcode have the option to append it to their existing password when logging in.
To integrate Duo with your application using LDAP authentication, you will need to install a local proxy service on a machine within your network. This Duo proxy will accept incoming ldap connections from the downstream application, perform primary authentication against an upstream LDAP directory server, and then add Duo secondary authentication.
If you are already running a Duo Authentication Proxy server in your environment, you can generally use that existing host for additional applications, appending the new configuration sections to the current config.
Once configured, Duo sends your users an automatic authentication request via Duo Push notification to a mobile device or phone call after successful primary login.
This configuration doesn't support inline self-service enrollment. You'll need to create your users in Duo ahead of time using one of our other enrollment methods, like directory sync or CSV import. Read the enrollment documentation to learn more.
Duo can be integrated with most devices and systems that support LDAP for authentication.
LDAP authentication does not pass client IP information to Duo. Therefore policy settings based on available IP address information, like authorized networks or user location have no effect on LDAP logins to Duo-protected applications.
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.
You should already have a working primary LDAP authentication configuration for your LDAP device users before you begin to deploy Duo.
To integrate Duo with your LDAP device, you will need to install a local Duo proxy service on a machine within your network. This Duo proxy server will receive incoming LDAP requests from your LDAP device, contact your existing local LDAP/AD server to perform primary authentication, and then contact Duo's cloud service for secondary authentication.
If you are already running a Duo Authentication Proxy server in your environment, you can use that existing host for additional applications, appending the new configuration sections to the current config. You don't have to set up a new Authentication Proxy server for each application you create. However, there are some cases where it might make sense for you to deploy a new proxy server for a new application, like if you want to co-locate the Duo proxy with the application it will protect in the same data center.
If you will set up a new Duo server, locate (or set up) a system to host the Duo Authentication Proxy installation. The proxy supports these operating systems:
Then 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!
If you will reuse an existing Duo Authentication Proxy server for this new application, you can skip the install steps and go to Configure the Proxy.
The Duo Authentication Proxy can be installed on a physical or virtual host. We recommend a system with at least 1 CPU, 200 MB disk space, and 4 GB RAM (although 1 GB RAM is usually sufficient). See additional Authentication Proxy performance recommendations in the Duo Authentication Proxy Reference.
When installing, you can choose whether or not you want to install the Proxy Manager. The Proxy Manager is a Windows utility that helps you edit the Duo Authentication Proxy configuration, determine the proxy's status, and start or stop the proxy service. Learn more about using the Proxy Manager. Installing the Proxy Manager adds about 100 MB to the installed size.
If you do not want to install the Proxy Manager, you may deselect it on the "Choose Components" installer screen before clicking Install.
To perform a silent install on Windows, issue the following from an elevated command prompt after downloading the installer (replacing version with the actual version you downloaded):
/exclude-auth-proxy-manager to install silently without the Proxy Manager:
duoauthproxy-version.exe /S /exclude-auth-proxy-manager
Ensure that Perl and a compiler toolchain are installed. On most recent RPM-based distributions — like Fedora, RedHat Enterprise, and CentOS — you can install these by running (as root):
$ yum install gcc make libffi-devel perl zlib-devel diffutils
On Debian-derived systems, install these dependencies by running (as root):
$ apt-get install build-essential libffi-dev perl zlib1g-dev
If SELinux is present on your system and you want the Authentication Proxy installer to build and install its SELinux module, include
selinux-policy-devel in the dependencies:
$ yum install gcc make libffi-devel perl zlib-devel diffutils selinux-policy-devel
$ apt-get install build-essential libffi-dev perl zlib1g-dev selinux-policy-devel
Download the most recent Authentication Proxy for Unix from https://dl.duosecurity.com/duoauthproxy-latest-src.tgz. From the command line you can use
wget to download the file, like
$ wget --content-disposition https://dl.duosecurity.com/duoauthproxy-latest-src.tgz. Depending on your download method, the actual filename may reflect the version e.g. duoauthproxy-5.7.1-src.tgz. View checksums for Duo downloads here.
Extract the Authentication Proxy files and build it as follows:
$ tar xzf duoauthproxy-5.7.1-src.tgz $ cd duoauthproxy-version-src $ make
Install the authentication proxy (as root):
$ cd duoauthproxy-build $ ./install
Follow the prompts to complete the installation. The installer creates a user to run the proxy service and a group to own the log directory and files. You can accept the default user and group names or enter your own.
If SELinux is present on the target server, the Duo installer will ask you if you want to install the Authentication Proxy SELinux module. Your selection affects whether systemd can start the Authentication Proxy after installation.
|SELinux Mode||Default Response||Result|
|Enforcing||Yes||Choose 'yes' to install the Authentication Proxy's SELinux module. This permits start of the Authentication Proxy service by systemd. If you choose 'no' then the SELinux module is not installed, and systemd cannot start the Authentication Proxy service.|
|Permissive||No||Choose 'no' to decline install of the Authentication Proxy's SELinux module. The Authentication Proxy service can be started by systemd. However, if you change SELinux from permissive to enforcing mode after installing the Duo proxy, systemd can no longer start the Authentication Proxy service. If you plan to enable SELinux enforcing mode later, you should choose 'yes' to install the Authentication Proxy SELinux module now.|
The proxy listens for LDAP connections on ports 389 and 636 by default. Privileged ports below 1024 are reserved for the root user. Therefore, the proxy will not start if you choose any user account other than "root" to run under during installation.
To install the Duo proxy silently with the default options, use the following command:
sudo ./duoauthproxy-build/install --install-dir /opt/duoauthproxy --service-user duo_authproxy_svc --log-group duo_authproxy_grp --create-init-script yes
--enable-selinux=yes|no to the install command to choose whether to install the Authentication Proxy SELinux module.
After the installation completes, you will need to configure the proxy.
The Duo Authentication Proxy configuration file is named authproxy.cfg, and is located in the conf subdirectory of the proxy installation. With default installation paths, the proxy configuration file will be located at:
|Windows||v5.0.0 and later||
|Windows||v4.0.2 and earlier||
Note that as of v4.0.0, the default file access on Windows for the
conf directory is restricted to the built-in Administrators group during installation.
The configuration file is formatted as a simple INI file. Section headings appear as:
Individual properties beneath a section appear as:
The Authentication Proxy may include an existing authproxy.cfg with some example content. For the purposes of these instructions, however, you should delete the existing content and start with a blank text file.
The Duo Authentication Proxy Manager is a Windows utility for managing the Authentication Proxy installation on the Windows server where you install the Authentication Proxy. The Proxy Manager comes with Duo Authentication Proxy for Windows version 5.6.0 and later.
The Proxy Manager cannot manage remote Duo Authentication Proxy servers, nor can you install the Proxy Manager as a stand-alone application. There is no Proxy Manager available for Linux. The Proxy Manager only functions as part of a local Duo Authentication Proxy installation on Windows servers.
Learn more about using the Proxy Manager in the Duo Authentication Proxy Reference before you continue.
To launch the Proxy Manager utility:
%ProgramFiles%\Duo Security Authentication Proxy\conf\authproxy.cfgfile for editing.
Use the Proxy Manager editor on the left to make the
authproxy.cfg changes in these instructions. As you type into the editor, the Proxy Manager will automatically suggest configuration options. Accepting these suggestions helps make sure you use the correct option syntax.
As you follow the instructions on this page to edit the Authentication Proxy configuration, you can click Validate to verify your changes (output shown on the right).
When you complete the Authentication Proxy configuration steps in this document, you can use the Save button to write your updates to
authproxy.cfg, and then use the
authproxy.cfg button to start the Authentication Proxy service before continuing on to the next configuration steps.
If you do not use the Proxy Manager to edit your configuration then we recommend using WordPad or another text editor instead of Notepad when editing the config file on Windows.
In this step, you'll set up the Proxy's primary authenticator — the system which will validate users' existing passwords. The primary authentication source for Duo LDAP must be another LDAP directory. In most cases, this means configuring the Proxy to communicate with Active Directory.
To use Active Directory/LDAP as your primary authenticator, add an
[ad_client] section to the top of your config file. Add the following properties to the section:
The hostname or IP address of your domain controller.
The username of a domain account that has permission to bind to your directory and perform searches. We recommend creating a service account that has read-only access.
The password corresponding to
The LDAP distinguished name (DN) of an Active Directory container or organizational unit (OU) containing all of the users you wish to permit to log in. For example:
The hostname or IP address of a secondary/fallback domain controller. You can add additional domain controllers as
To further restrict access, specify the LDAP distinguished name (DN) of a security group that contains the users who should be able to log in as direct group members. Nested groups are not supported. Users who are not direct members of the specified group will not pass primary authentication. Example:
Starting with Authentication Proxy v3.2.0, the
LDAP attribute found on a user entry which will contain the submitted username. In most Active Directory configurations, it should not be necessary to change this option from the default value. OpenLDAP directories may use "uid" or another attribute for the username, which should be specified with this option.
[ad_client] host=18.104.22.168 host_2=22.214.171.124 service_account_username=duoservice service_account_password=password1 search_dn=DC=example,DC=com security_group_dn=CN=DuoVPNUsers,OU=Groups,DC=example,DC=com
For advanced Active Directory configuration, see the full Authentication Proxy documentation.
Next, you need to set up the Authentication Proxy to handle LDAP authentication requests. Create an
[ldap_server_auto] section and add the properties listed below. If you've already set up the Duo Authentication Proxy for a different LDAP application, append a number to the section header to make it unique, like
Your integration key.
Your secret key.
Your API hostname (i.e. api-XXXXXXXX.duosecurity.com)
The mechanism that the Authentication Proxy should use to perform primary authentication. This should correspond with a "client" section elsewhere in the config file.
This parameter is optional if you only have one "ad_client" section. If you have multiple, each "server" section should specify which "client" to use.
Either "safe" or "secure":
Path to PEM-formatted SSL/TLS server certificate. Both
Path to PEM-formatted SSL/TLS private key. Both
If set to "true" (the default) then multi-factor authentication will not be performed for the first successful LDAP authentication in each connection. Use this if the device using the Authentication Proxy first connects as a service user and then authenticates the user who is logging in.
Specify either the DN of a single user or an OU. Multi-factor authentication will not be required for these users. Set this option if the device using the Authentication Proxy first connects as a service user, disconnects, and then authenticates the user who is logging in with a separate LDAP connection. The exemptions should cover those service user(s).
A completed config file, using Active Directory as the primary authenticator, should look something like:
[ad_client] host=126.96.36.199 service_account_username=duoservice service_account_password=password1 search_dn=cn=Users,dc=example,dc=com [ldap_server_auto] client=ad_client ikey=DIXXXXXXXXXXXXXXXXXX skey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX api_host=api-XXXXXXXX.duosecurity.com failmode=safe ssl_key_path=ldap_server.key ssl_cert_path=ldap_server.pem
Make sure to save your configuration file in your text editor — or validate and save in the Proxy Manager for Windows — when you're finished making changes.
See the Duo Authentication Proxy Reference for additional Authentication Proxy LDAP configuration options.
If you installed the Duo Authentication Proxy Manager utility (available with 5.6.0 and later), click the Start Service button at the top of the Proxy Manager window to start the service.
To start the service from the command line, open an Administrator command prompt and run:
net start DuoAuthProxy
Alternatively, open the Windows Services console (
services.msc), locate "Duo Security Authentication Proxy Service" in the list of services, and click the Start Service button.
Authentication Proxy v5.1.0 and later includes the
authproxyctl executable, which shows the connectivity tool output when starting the service. The installer adds the Authentication Proxy
C:\Program Files\Duo Security Authentication Proxy\bin to your system path automatically, so you should not need to specify the full path to
authproxyctl to run it.
From an administrator command prompt run:
If the service starts successfully, Authentication Proxy service output is written to the authproxy.log file, which can be found in the
If you see an error saying that the "service could not be started", open the Application Event Viewer and look for an Error from the source "DuoAuthProxy". The traceback may include a "ConfigError" that can help you find the source of the issue.
Stop and restart the Authentication Proxy service by either clicking the Restart Service button in the Duo Authentication Proxy Manager or the Windows Services console or issuing these commands from an Administrator command prompt:
net stop DuoAuthProxy & net start DuoAuthProxy
To stop and restart the Authentication Proxy using authproxyctl, from an administrator command prompt run:
Open a root shell and run:
# /opt/duoauthproxy/bin/authproxyctl start
To ensure the proxy started successfully, run:
# /opt/duoauthproxy/bin/authproxyctl status
Authentication Proxy service output is written to the authproxy.log file, which can be found in the
To stop and restart the Authentication Proxy, open a root shell and run:
# /opt/duoauthproxy/bin/authproxyctl restart
If you modify your
authproxy.cfg configuration after initial setup, you'll need to stop and restart the Duo Authentication Proxy service or process for your change to take effect.
Once the proxy is up and running, you need to configure your LDAP clients to use it for authentication.
In your clients' settings, set the LDAP server to the IP address or host name of your Duo Authentication Proxy. Set the LDAP server port to 636 to secure the connection with SSL.
The service user name and service password configured on the LDAP client(s) should be the same as it would be if you were configured to connect directly to the AD or LDAP server.
If your clients allow you to configure the LDAP timeout, set them to values such that the clients will not give up for at least 60 seconds. This is necessary if your users choose to use Duo's out-of-band factors (phone callback, push) to log in, as the Authentication Proxy will not be able to respond to a LDAP authentication request until the user responds to the authentication challenge. If your clients do not allow you to configure the LDAP timeout behavior, then your users may be unable to authenticate with Duo's out-of-band factors.
To test your setup, attempt to log in to your newly-configured system as a user enrolled in Duo with an authentication device.
When you enter your username and password, you will receive an automatic push or phone callback.
Alternatively you may add a comma (",") to the end of your password and append a Duo factor option:
|push||Perform Duo Push authentication. You can use Duo Push if you've installed and activated Duo Mobile on your device.|
|phone||Perform phone callback authentication.|
|sms||Send a new batch of SMS passcodes. Your authentication attempt will be denied. You can then authenticate with one of the newly-delivered passcodes.|
|A numeric passcode||Log in using a passcode, either generated with Duo Mobile, sent via SMS, generated by your hardware token, or provided by an administrator. Examples: "123456" or "2345678".|
For example, if you wanted to use a passcode to authenticate instead of Duo Push or a phone call, you would enter:
username: bob password: hunter2,123456
If you wanted to use specify use of phone callback to authenticate instead of an automatic Duo Push request, you would enter:
username: bob password: hunter2,phone
You can also specify a number after the factor name if you have more than one device enrolled (as the automatic push or phone call goes to the first capable device attached to a user). So you can enter phone2 or push2 if you have two phones enrolled and you want the authentication request to go to the second phone.
Need some help? Review troubleshooting tips for the Authentication Proxy and try the connectivity tool included with Duo Authentication Proxy 2.9.0 and later to discover and troubleshoot general connectivity issues.