Duo helps secure your CyberArk Privileged Account Security Solution with two-factor authentication for Password Vault logins. In this type of configuration, users receive an automatic push or phone callback during login. Users who need to use a passcode may append it to their password when logging in.
These instructions assume that you already have Active Directory authentication working with CyberArk Privileged Account Security Solution. Use Duo's LDAP proxy with CyberArk instead of RADIUS when you want to continue using LDAP group lookup to assign privileges in CyberArk Privileged Account Security.
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 CyberArk Privileged Account Security Solution environment users before you begin to deploy Duo.
To integrate Duo with your CyberArk Privileged Account Security Solution environment, 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 CyberArk Privileged Account Security Solution environment, contact your existing local LDAP/AD server to perform primary authentication, and then contact Duo's cloud service for secondary authentication.
Locate (or set up) a system on which you will install the Duo Authentication Proxy. 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!
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).
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):
duoauthproxy-version.exe /S
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
Download the most recent Authentication Proxy for Unix from https://dl.duosecurity.com/duoauthproxy-latest-src.tgz. Depending on your download method, the actual filename may reflect the version e.g. duoauthproxy-5.2.2-src.tgz. View checksums for Duo downloads here.
Extract the Authentication Proxy files and build it as follows:
$ tar xzf duoauthproxy-latest-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.
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.
If you ever need to uninstall the proxy, run /opt/duoauthproxy/uninstall
.
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:
Operating System | Authentication Proxy Version |
Path |
---|---|---|
Windows | v5.0.0 and later | C:\Program Files\Duo Security Authentication Proxy\conf\authproxy.cfg |
Windows | v4.0.2 and earlier | C:\Program Files (x86)\Duo Security Authentication Proxy\conf\authproxy.cfg |
Linux | All | /opt/duoauthproxy/conf/authproxy.cfg |
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:
[section]
Individual properties beneath a section appear as:
name=value
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. 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:
Required
host
|
The hostname or IP address of your domain controller. |
service_account_username
|
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. |
service_account_password
|
The password corresponding to |
search_dn
|
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:
|
Optional
host_2
|
The hostname or IP address of a secondary/fallback domain controller. You can add additional domain controllers as |
security_group_dn
|
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 |
username_attribute
|
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. Default: "sAMAccountName" |
For example:
[ad_client]
host=1.2.3.4
host_2=1.2.3.5
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 [ldap_server_auto2]
.
Required
api_host
|
Your API hostname (i.e. api-XXXXXXXX.duosecurity.com) | ||||||
ikey
|
Your integration key | ||||||
skey
|
Your secret key | ||||||
client
|
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. |
||||||
failmode
|
Either safe or secure:
|
||||||
ssl_cert_path
|
(Optional) Path to PEM-formatted SSL/TLS server certificate. Both ssl_key_path and ssl_cert_path must be specified to listen for STARTTLS or LDAPS requests. |
||||||
ssl_key_path
|
(Optional) Path to PEM-formatted SSL/TLS private key. Both ssl_key_path and ssl_cert_path must be specified to listen for STARTTLS or LDAPS requests. |
||||||
exempt_ou_1
|
Specify the DN of the service account used to authenticate from CyberArk Privileged Account Security Solution to the Authentication Proxy (the account configured as the BindUserName for the LDAP directory in CyberArk). Multi-factor authentication is not required for this user. This setting is needed because CyberArk Privileged Account Security Solution first connects to the Authentication Proxy as the service account user, disconnects, and then authenticates the user who is logging in with a separate LDAP connection. All other accounts will require Duo authentication. |
||||||
exempt_primary_bind
|
Set this value to 'false'. This setting, when combined with the exempt_ou_1 setting above, ensures that the CyberArk Privileged Account Security Solution service account's initial bind to the Authentication Proxy does not require two-factor authentication, but all other account logins via LDAP do. |
A completed config file, using Active Directory as the primary authenticator, should look something like:
[ad_client]
host=1.2.3.4
service_account_username=ServiceAcct
service_account_password=Password1
search_dn=cn=Users,dc=example,dc=com
[ldap_server_auto]
ikey=DIXXXXXXXXXXXXXXXXXX
skey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
api_host=api-XXXXXXXX.duosecurity.com
failmode=safe
ssl_key_path=ldap_server.key
ssl_cert_path=ldap_server.pem
exempt_primary_bind=false
exempt_ou_1=CN=ServiceAcct,CN=users,DC=example,DC=com
Make sure to save your configuration file when done.
View video guides for proxy deployment at the Authentication Proxy Overview or see the Authentication Proxy Reference Guide for additional configuration options.
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:
authproxyctl start
If the service starts successfully, Authentication Proxy service output is written to the authproxy.log file, which can be found in the log
subdirectory.
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 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:
authproxyctl restart
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 log
subdirectory.
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.
Log on to Password Vault Web Access via your browser as the predefined Administrator user. This is typically accessed at https://yourvaultserver/PasswordVault.
Click on ADMINISTRATION at the top to navigate to the "System Configuration" page. Then, click on LDAP Integration in the "Component Settings" table.
Go to LDAP → Directories → the AD directory currently used for Privileged Account Security access. Verify that the BindUserName is set to the full DN of the service account user (e.g. CN=ServiceAcct,CN=users,DC=example,DC=com
) and that it matches the exempt_ou_1
value you configured in the ldap_server_auto
section of your Duo proxy server's authproxy.cfg
file earlier .
Go to LDAP → Directories → the AD directory currently used for Privileged Account Security access → Hosts. Right-click Hosts and select Add Host.
In the Properties table, the required information about the Duo LDAP proxy host (example shows adding Duo Authentication Proxy host to the "Duo LDAP" existing directory with the IP 10.1.10.101 using LDAP/389):
ServerName |
The IP address or fully-qualified DNS host name of your Duo Authentication Proxy server. |
ServerPort |
Duo Authentication Proxy server port for incoming LDAP requests. Default port is '389' for CLEAR and STARTTLS and '636' for LDAPS. If using STARTTLS or LDAPS then the ssl_cert_path and ssl_key_path options must be configured in the Authentication Proxy LDAP configuration above. |
SSLConnect |
Select No for LDAP or Yes for LDAPS and STARTTLS. |
Right-click the new Duo LDAP Proxy host in the "Hosts" tree and select Move Up. Repeat until the Duo host is the first one in the list.
Click Apply in the upper left, and then click OK.
For additional information please refer to the "LDAP Authentication" section in the "CyberArk Privileged Account Security Installation Guide".
Navigate to the Privileged Account Security web login page and click the LDAP directory option to which you added the Duo LDAP proxy host.
Enter your Active Directory username and password. When you enter your username and password, you will receive an automatic push or phone callback. Alternatively you can add a comma (",") to the end of your password, followed by a Duo passcode.
For example, given a username 'bob', with password 'password123' and a Duo passcode '123456', you would enter:
username: bob
password: password123,123456
In addition, you may also enter the name of an out-of-band factor in lieu of a passcode. You may choose from the following factor names:
push |
Perform Duo Push authentication You can use Duo Push if you've installed Duo Mobile and added your account to it |
phone | Perform phone callback authentication |
sms |
Send a new batch of SMS passcodes Your initial authentication attempt is rejected and you'll receive a text message with Duo passcodes. You can then try to log on again, authenticating with one of the newly-delivered passcodes. |
Returning to the previous example, if you wanted to use Duo Push (rather than a passcode) to authenticate, you would enter:
username: bob
password: password123,push
You can also specify a number after the factor name if you have more than one device enrolled. So you can enter phone2 or push2 if you have two phones enrolled and you want the Duo Push or phone call request to go to your second phone instead.
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.
Also take a look at our CyberArk Knowledge Base articles or Community discussions. For further assistance, contact Support.
To further secure access to the CyberArk Privileged Account Security Solution, you can remove any LDAP hosts that aren't Duo LDAP proxy hosts or disable alternate authentication methods. See the "Authenticating to the Privileged Account Security Solution" section in the "CyberArk Privileged Account Security Installation Guide" for guidance.