Skip to main content

Arculix LDAP Agent deployment guide

The Arculix LDAP Agent provides a means of integrating an enterprise's Active Directory service with Arculix and other services, such as single sign-on (SSO), that require authentication or user details.

The Arculix LDAP Agent can be deployed to a server on the customer's premises or a preferred cloud environment, as long as it can communicate with the enterprise's Active Directory server.

Requirements

Server requirements

Any virtualization platform that is capable of hosting Linux or Windows servers should be suitable, including on-premises solutions such as VMware ESXi and Microsoft Hyper-V, and cloud environments such as Amazon EC2 and Microsoft Azure.

Number of instances

We recommend you provision two or more instances to provide high availability. The LDAP Agent is a stateless service, so there is no limitation for horizontal scaling. However, the system can work with only one instance of the agent if high availability is not a hard requirement.

Operating system

You can install the Arculix LDAP Agent on the following operating systems:

  • Red Hat Enterprise Linux 7+

  • CentOS 7+

  • Amazon Linux 2

  • Ubuntu Server LTS 18.04+

  • Microsoft Windows Server 2012+

We recommend using the latest releases (for example, Red Hat Enterprise Linux 8, Ubuntu Server LTS 20.04, or Microsoft Windows Server 2022).

Hardware

The minimum hardware requirements for deploying the LDAP Agent are:

Linux

Windows

CPU

2 CPU cores

2 CPU cores

RAM

2 GB

4 GB

Storage

16 GB SSD

32 GB SSD

Network requirements

All communication with the LDAP Agent is over HTTPS. There is an additional layer of security that provides authenticity above and beyond the HTTPS certificates by signing all communication.

Outbound rules

The following external service should be reachable by the LDAP Agent:

Service

Protocol

Port Numbers

Host

Arculix

WSS (WebSocket Secure)

443

switchboard.arculix.com

Additionally, your operating system or deployment environment may require external services to be reachable to install components and receive software updates. Please consult your operating system vendor for details.

If you choose to use the Docker-based deployment method, the following outbound access will be needed to install and manage Docker:

Service

Protocol

Port Numbers

Host

Docker updates

TCP

80, 443

download.docker.com

Docker Compose download

TCP

80, 443

github.com

Internal network rules

The following internal services provided by the customer must be reachable by the agent:

Service

Protocol

Port Numbers

Service

LDAPS

TCP

636

Secure LDAP service

LDAP

TCP

389

Non-secure LDAP service

DNS

UDP

53

DNS server

Caution

Use of non-secure LDAP isn't recommended, but is available for rare situations where the customer can guarantee protection of the data in transit by other means (e.g. physical security controls)

User directory (AD) requirements

The Arculix LDAP Agent communicates with the user directory using the LDAP protocol. Before deployment, a user account must be provisioned which allows read-only access to the directory.

The following information needs to be prepared before the installation:

Name

Required

Description

URL

Yes

The LDAP URL to use when performing LDAP queries.

The URL must begin with ldap:// or ldaps:// and may include an optional port number to override the defaults of port 389 for ldap and 636 for ldaps.

Examples include ldaps://ldap.company.com/ and ldaps://ad1.example.org:5000/

Bind User

Yes

The user used when binding to the LDAP server.

This may be a DN such as CN=John Doe,CN=Users,DC=company,DC=com or, in the case of Active Directory, a name in user@domain format such as johndoe@company.com.

A new account with read-only access to the directory should be provisioned for the agent and used for binding.

Note

The Arculix integration will no longer function if this user account is disabled, its password is changed, or its privileges are lowered or revoked.

Bind password

Yes

The password of the user used to bind to the LDAP server.

Base DN

Yes

The Base DN used when performing LDAP queries.

All relevant users and groups must be descendants of this DN.

Example: DC=company,DC=com.

TLS Trusted CAs

No

A list of certificates in PEM format representing trusted certificate authorities (CAs) to be used when verifying the LDAP server's certificate.

These could include an enterprise CA used to issue certificates to LDAP servers, or even the certificate of the LDAP server itself.

Warning

If this option is used, the operating system's default list of trusted CAs will not be used.

Default: Use the operating system's list of trusted CAs.

Pre-installation checklist

Please use this checklist to prepare for the installation:

  • The required servers or virtual machines should be provisioned.

  • The required firewall rules are in place.

  • An Active Directory read-only account has been provisioned for the agent.

  • The Active Directory LDAP service is reachable from the LDAP Agent hosts within the network.

  • Optional. If secure LDAP (LDAPS, port 636) is used, a certificate or certificate chain is available which may be used to verify the connection to the server. (See TLS Trusted CAs, above.)

Installation methods

We support three different installation methods for the LDAP Agent, and provide a separate package for each. The installation method you choose depends on your choice of server platform:

  • Linux/RPM. An RPM package is available which may be installed on Red Hat Enterprise Linux 7 (and higher), CentOS 7 (and higher), and Amazon Linux 2.

  • Linux/Docker. A Docker image, packaged with supporting installation scripts, is available for installing the LDAP Agent on most Linux systems, including Ubuntu Server 18.04 (and higher).

  • Windows. A Windows package is distributed as a self-installing executable, and is available for Windows Server 2012 and higher in the Download Center.

The following sections describe each installation method in detail.

Linux / RPM package

The Arculix LDAP Agent RPM package is named arculix-ldap-agent-X.Y.Z-1.x86_64.rpm (where X.Y.Z, here and elsewhere in the installation instructions, is the version of this release), and may be installed on the following platforms:

  • Red Hat Enterprise Linux 7+

  • CentOS 7+

  • Amazon Linux 2

When installed via the RPM package, the agent is integrated with systemd to support life cycle management, launch at boot-time, and collection of log output via syslog. On a typical system, agent logs will be written to /var/log/messages and automatically rotated as needed. However, this may vary depending on the log infrastructure used by your organization.

Installing

The package may be installed using:

rpm -ivh arculix-ldap-agent-X.Y.Z-1.x86_64.rpm

After installation, the customer should configure the agent using the YAML configuration file in /etc/arculix/ldap-agent.conf. See the LDAP Agent configuration section below for full details on configuring the LDAP Agent.

Note

If an ldap-agent.env file is present in the /etc/arculix directory, it will be treated as an environment-based configuration file and used instead of the YAML ldap-agent.conf file. This is only meant to provide backwards compatibility when migrating from a Docker-based deployment to an RPM-based deployment. SecureAuth recommends using the YAML ldap-agent.conf configuration for RPM deployments whenever possible.

After configuration, you can test the agent's connectivity to the LDAP server using the following commands. If you've used the YAML configuration (ldap-agent.conf), run the following command to test your installation:

ldap-agent -config /etc/arculix/ldap-agent.conf -test

Note

If you have chosen to use the environment-based configuration (ldap-agent.env) instead of ldap-agent.conf, run the following command to test your installation:

( set -a && source /etc/arculix/ldap-agent.env && ldap-agent -test )

Parentheses are part of the above command -- make sure they are included.

You should see diagnostics output similar to the following:

Using configuration: Config(AgentID=ldap:v1:f6ac662c-0c4f-45b2-8721-13388db62f8e,SharedSecret=✓,
  SwitchboardURL=wss://switchboard.arculix.com,LogLevel=info,AuthenticationTimeout=5s,
  RequestTimeout=10s,RequestWorkers=500,LDAPURLs=[ldaps://ad1.arculix.local/],
  LDAPBindUser=abe.lincoln@arculix.local,LDAPBindPass=*****,LDAPBaseDN=dc=arculix,dc=local,
  LDAPTLSDisableVerification=false,LDAPTLSTrustedCAs=✓,LDAPTLSServerNames=[])
Healthy: true
LDAP query time: 22 ms

After a successful connectivity test, the agent should be enabled in systemd to arrange for its launch when the server boots:

systemctl enable arculix-ldap-agent

Then, start the agent:

systemctl start arculix-ldap-agent

Upgrading

The agent may be upgraded to a newer version by using the -U option of RPM instead of -i:

rpm -Uvh arculix-ldap-agent-X.Y.Z-1.x86_64.rpm

Removing

The package may be removed using:

rpm -e arculix-ldap-agent

Any running LDAP Agent instance will be shut down. Any modified configuration file will be renamed and preserved with a .rpmsave extension.

Linux / Docker package

The Docker installation method may be used to install the LDAP Agent on any Linux system that supports Docker. Installation scripts are provided in this package to assist with installing Docker and the LDAP Agent.

Note

We require Docker 19.3.0 or higher, and Docker Compose 1.26 or higher. The bundled install-docker.sh script may be used to install these on the server if not already present.

The Arculix LDAP Agent Docker package is distributed as an archive named ldap-agent-X.Y.Z.tar.xz (where X.Y.Z is the version of this release) containing the following assets:

  • docker-compose.yml - The Docker Compose configuration describing how to launch the LDAP Agent.

  • install-docker.sh - A helper script to install Docker on Linux hosts.

  • install.sh - The LDAP Agent installation script.

  • ldap-agent-image.tar - The LDAP Agent Docker image.

  • manifest.json - Metadata describing this release of the LDAP Agent. This is provided for informational purposes only, and is not actively used by the agent or the installation scripts.

SecureAuth will provide customers with this archive and a configuration file customized for the customer's site.

Installing

To install the Arculix LDAP Agent, first upload the provided ldap-agent-X.Y.Z.tar.xz archive to the server. (Where X.Y.Z, here and elsewhere in the installation instructions, is the version of this release.) On the server, find the archive and extract it using the following command:

tar -xvJ -f ldap-agent-X.Y.Z.tar.xz

Note that the extraction will create an ldap-agent-X.Y.Z directory containing the installation assets. Change to this directory:

cd ldap-agent-X.Y.Z

If this server does not have Docker and Docker Compose installed, they can be installed using the provided helper script:

sudo ./install-docker.sh

(Note the use of sudo, as this step requires root access.)

If this is a new installation, SecureAuth will provide an ldap-agent-config.env configuration file template pre-configured with any credentials needed to pair your agent with Arculix. You should edit this file using an editor of your choice (vi, vim, nano, or whatever editor may be available in your Linux system):

vi ldap-agent-config.env

This configuration file supplies settings in the form of environment variables. See the LDAP Agent configuration section below for full details on configuring the LDAP Agent.

Finally, to install the agent, run the install.sh script from a user account with sufficient privileges to manage Docker:

sudo ./install.sh

Note that sudo is used in the above example to run the script as root, which should always have Docker privileges.

The installation process needs a destination directory where it can store agent assets such as the configuration file. It will suggest a default path, but you can provide an alternate location if desired.

After the LDAP Agent is installed, you can test connectivity from the agent to Active Directory:

  1. Change to the installed directory as the root user.

  2. Execute the following command:

    docker-compose exec ldap-agent ./ldap-agent -test
    

You should see diagnostics output similar to the following:

Using configuration: Config(AgentID=ldap:v1:f6ac662c-0c4f-45b2-8721-13388db62f8e,SharedSecret=✓,
  SwitchboardURL=wss://switchboard.arculix.com,LogLevel=info,AuthenticationTimeout=5s,
  RequestTimeout=10s,RequestWorkers=500,LDAPURLs=[ldaps://ad1.arculix.local/],
  LDAPBindUser=abe.lincoln@arculix.local,LDAPBindPass=*****,LDAPBaseDN=dc=arculix,dc=local,
  LDAPTLSDisableVerification=false,LDAPTLSTrustedCAs=✓,LDAPTLSServerNames=[])
Healthy: true
LDAP query time: 22 ms

After installation, the extracted contents of the archive are no longer needed and may be removed:

cd ..
rm -rf ldap-agent-X.Y.Z

Upgrading

Upgrading to a newer version of the LDAP Agent works mostly the same as performing a fresh installation: extract the provided archive and run its install.sh script. Note the following minor differences:

  • If an LDAP Agent is currently present on the system, its installation directory will be suggested as the destination for installing the new agent.

  • If the destination directory has an existing configuration file, it will be preserved instead of overwritten.

  • Any currently running agent will be stopped before starting the new agent.

Removing

The LDAP agent may be removed by shutting down the Docker container, then removing the installed files from the system. First, change directory to the installed location, then use Docker Compose to shut down the agent:

cd /root/arculix/ldap-agent
docker-compose down

You will see output similar to the following:

Stopping ldap-agent ... done
Removing ldap-agent ... done
Removing network ldap-agent_default

After the container is shut down in this way, it will not restart when the system reboots. If the agent shutdown is meant to be temporary, you can run docker-compose up -d in the installation directory at a future time to restart the agent. To remove the agent permanently, simply remove the installation directory entirely.

Windows package

The Arculix LDAP Agent Windows package is named LDAP-Agent-X.Y.Z.exe (where X.Y.Z is the version of this release), and may be installed on the following platforms:

  • Microsoft Windows Server 2022

  • Microsoft Windows Server 2019

  • Microsoft Windows Server 2016

  • Microsoft Windows Server 2012

Installing

Download the latest version of the Arculix LDAP Agent to a Windows Server that is prepared for installation. This server can be a member server in your Active Directory domain or a domain controller.

  1. Login to Windows with a user account with administrative privileges, run the downloaded package, and click Next.

    ldap-agent-windows-installer.png
  2. Select your installation folder and click Next.

    ldap-agent-installation-folder.png
  3. Click on Install.

    begin-ldap-agent-install.png
  4. After installation is complete, click on Configure to configure communication parameters.

    ldap-agent-install-success.png
  5. In Arculix LDAP Agent Settings, there are four tabs which should be filled with the following structure:

    • General

      • User Name: A name in user@domain format such as johndoe@company.com. A new account with read-only access to the directory should be provisioned for the agent and used for binding.

      • Password: The password of the user used to connect to the LDAP server.

      • Base DN: The Base DN used when performing LDAP queries. All relevant users and groups must be descendants of this DN. Example: DC=company,DC=com

      • URL: An LDAP URL to use when performing LDAP queries. The URLs must begin with ldap:// or ldaps:// and may include an optional port number to override the defaults of port 389 for LDAP and 636 for LDAPS. Examples include ldaps://ldap.company.com/ and ldaps://ad1.example.org:3269/.

      • Agent ID: The agent's unique identifier. (This is provided by SecureAuth to customers.)

      • Shared Secret Key: The 256-bit (32 byte) shared secret used to sign messages sent between this agent and Arculix. This should be represented as a Base64 string. (This is provided by SecureAuth to customers.)

      • Log Level: Log events generated by the agent must be at least this severity before being sent to the event log. The supported severity thresholds, from most severe to least severe, are fatal, error, warning, info, and debug. The default value is info. SecureAuth recommends leaving the log level set to this default, unless you have a specific need to increase or decrease log output.

        ldap-agent-settings.png
    • LDAP Certificate

      • One or more certificates which should be considered as trustworthy when verifying the certificate of an LDAPS server. This may be the server's certificate itself, or (preferably) the certificate of an enterprise CA used to issue the server's certificate. (See TLS Trusted CAs, above.)

        Tip

        You can use an LDAPS connection without providing a trusted certificate if the LDAP Agent server is a domain member and you have an internal certificate authority configured in your network.

  6. After entering all communication parameters, click Save and then the OK button.

    ldap-agent-settings-success.png
  7. Click the Finish button to complete the setup process.

    ldap-agent-install-thank-you.png

Test connection

After the LDAP Agent is installed, you can test connectivity from the agent to your LDAP server:

  1. Open a command prompt window and navigate to the installation folder.

  2. Execute the following command at the command prompt:

    ldap-agent.exe -test
    
  3. You should see diagnostics output similar to the following:

    C:\Program Files\Arculix\LDAP Agent>ldap-agent.exe -test
    Using configuration: Config(AgentID=ldap:v1:f6ac662c-0c4f-45b2-8721-13388db62f8e,SharedSecret=✓,
      SwitchboardURL=wss://switchboard.arculix.com,LogLevel=info,AuthenticationTimeout=5s,
      RequestTimeout=10s,RequestWorkers=500,LDAPURLs=[ldaps://ad1.arculix.local/],
      LDAPBindUser=abe.lincoln@arculix.local,LDAPBindPass=*****,LDAPBaseDN=dc=arculix,dc=local,
      LDAPTLSDisableVerification=false,LDAPTLSTrustedCAs=✓,LDAPTLSServerNames=[])
    Healthy: true
    LDAP query time: 22 ms
    

Note

If you are installing the Arculix LDAP Agent on the same server as the Active Directory domain controller with which it will communicate, and IPv6 is enabled on this server, use the IPv4 localhost address (“127.0.0.1”) or the IPv4 address of the server when configuring the LDAP URL. (Using the hostname in this situation may result in the agent trying the IPv6 address before failing over to IPv4, adding needless latency to transactions.)

Tip

If you want to change the configuration of the Arculix LDAP Agent you can find the ConfigUI in the installation path or you can search for Arculix in the Windows Start menu to find the Arculix LDAP Agent Settings.

Upgrading

The LDAP Agent may be upgraded to a newer version using these steps:

  1. Run the new LDAP Agent package, and click Next:

    ldap-agent-windows-upgrade-welcome.png
  2. Allow the setup wizard to remove older versions of the LDAP Agent by clicking Upgrade:

    ldap-agent-windows-upgrade-search.png
  3. If an LDAP Agent is currently running, the wizard will offer to stop the existing agent so the new agent can be installed. Click OK to allow this:

    ldap-agent-windows-upgrade-close.png
  4. The new agent will be installed, and the installation process will continue as documented in the Installing section, above.

Removing

The LDAP Agent may be removed the same way as most Windows applications:

  1. In Windows Settings, select Apps, then select the LDAP Agent:

    ldap-agent-windows-removal.png
  2. Click the Uninstall button, and confirm.

  3. The LDAP Agent will be removed from the system.

The agent's configuration file (ldap-agent.conf) will remain in the installation directory, and will be used if another LDAP Agent is installed in the same directory in the future.

LDAP Agent configuration

The Arculix LDAP Agent may be configured using either a YAML-based configuration file (ldap-agent.conf) or environment variables. After making any configuration changes, the agent should be restarted for the changes to take effect.

You can obtain the AgentID and SharedSecret parameters in Arculix. Log in to Arculix and navigate to Connectors from the left side menu. (Admin access is required.)

Note

Use of environment variables to configure the LDAP Agent is primarily intended for Docker-based deployments. In the Docker world, using environment variables for configuration is a common convention, while mapping a YAML configuration into the container can require extra steps. For customers using the Linux/RPM and Windows deployment methods, we highly recommend use of the YAML configuration.

Tip

Windows administrators are encouraged to use the supplied configuration tool instead of editing the YAML configuration directly.

Configuration file templates

The following configuration files are templates for a minimal configuration setup. You may add more parameters as specified in the Configuration options section.

YAML configuration file

# Login to https://mfa.arculix.com and go to the "Connectors" page to get the
# "Agent ID" and "Shared Secret" parameters.
AgentID: CHANGE_ME
SharedSecret: CHANGE_ME

# The LDAP parameters used to reach Active Directory
LDAPURLs:
    - ldaps://arculix.local/
LDAPBindUser: administrator@arculix.local
LDAPBindPass: verysecret
LDAPBaseDN: dc=arculix,dc=local

# If using LDAPS and the LDAP server's certificate is not issued by a public
# certificate authority, a trusted root CA or the LDAPS certificate itself may
# provided here to establish trust.
#
# LDAPTLSTrustedCAs: |
#     -----BEGIN CERTIFICATE-----
#     MIIFdzCCA1+gAwIBAgIUPhmZ5ytNQDJ1gqIYtPWXsFSXbm8wDQYJKoZIhvcNAQEL
#     BQAwYzELMAkGA1UEBhMCVVMxDzANBgNVBAgMBk9yZWdvbjERMA8GA1UEBwwIUG9y
#     ...
#     nRFv5H77DMo15HfFgGsy7zCt7OrIHl/G/PVLce4/4T+cLjahHDbn5J6Cz9DWNYYq
#     jRgO45686HIchzfyTpPRbdt+S7TA+1ToUX5nlnCFhsgcCwBuPqCozNBvTbYN7xdq
#     fkATtpM5lE4Ip7Y=
#     -----END CERTIFICATE-----

Environment-based (.env) configuration file

######################################################################
# To use this configuration, source this script into your bash shell:
#   ( set -a && source /etc/arculix/ldap-agent.env && ldap-agent -test )
######################################################################

# Login to https://mfa.arculix.com and go to the "Connectors" page to get the
# "Agent ID" and "Shared Secret" parameters.
ALA_AGENT_ID=CHANGE_ME
ALA_SHARED_SECRET=CHANGE_ME

# The LDAP parameters used to reach Active Directory
ALA_LDAP_URLS='ldap://arculix.local/'
ALA_LDAP_BIND_USER='administrator@arculix.local'
ALA_LDAP_BIND_PASS='verysecret'
ALA_LDAP_BASE_DN='dc=arculix,dc=local'

# If using LDAPS and the LDAP server's certificate is not issued by a public
# certificate authority, a trusted root CA or the LDAPS certificate itself may
# provided here to establish trust.
#
# ALA_LDAP_TLS_TRUSTED_CAS='
# -----BEGIN CERTIFICATE-----
# MIIFdzCCA1+gAwIBAgIUPhmZ5ytNQDJ1gqIYtPWXsFSXbm8wDQYJKoZIhvcNAQEL
# BQAwYzELMAkGA1UEBhMCVVMxDzANBgNVBAgMBk9yZWdvbjERMA8GA1UEBwwIUG9y
# ...
# nRFv5H77DMo15HfFgGsy7zCt7OrIHl/G/PVLce4/4T+cLjahHDbn5J6Cz9DWNYYq
# jRgO45686HIchzfyTpPRbdt+S7TA+1ToUX5nlnCFhsgcCwBuPqCozNBvTbYN7xdq
# fkATtpM5lE4Ip7Y=
# -----END CERTIFICATE-----
# '

Configuration options

The following configuration items are required for the agent to start:

YAML Key(Environment variable)

Description

AgentID(ALA_AGENT_ID)

The unique identifier used to identify the agent.

It should be obtained from the Connectors page in Arculix.

SharedSecret(ALA_SHARED_SECRET)

The 256-bit (32 byte) shared secret, represented as a Base64 string, used to sign messages sent between this agent and Arculix.

It should be obtained from the Connectors page of the Arculix.

LDAPURLs(ALA_LDAP_URLS)

A list of LDAP URLs to use when performing LDAP queries.

The URLs must begin with ldap:// or ldaps:// and may include an optional port number to override the defaults of port 389 for ldap and 636 for ldaps.

Examples include ldaps://ldap.company.com/ and ldaps://ad1.example.org:5000/.

If provided via environment variable, multiple URLs may be separated by commas. Only the first URL is currently used. A future release may use additional LDAP URLs to round-robin outgoing connections or provide failover when one is not responding.

LDAPBindUser(ALA_LDAP_BIND_USER)

The user used when binding to the LDAP server.

This may be a DN such as CN=John Doe,CN=Users,DC=company,DC=com or, in the case of Active Directory, a name in user@domain format such as johndoe@company.com.

A new account with read-only access to the directory should be provisioned for the agent and used for binding.

LDAPBindPass(ALA_LDAP_BIND_PASS)

The password of the user used to bind to the LDAP server.

LDAPBaseDN(ALA_LDAP_BASE_DN)

The Base DN used when performing LDAP queries.

All relevant users and groups must be descendants of this DN.

Example: DC=company,DC=com.

The following configuration items are optional, and may be used to further guide the behavior of the agent:

YAML Key(Environment variable)

Description

LDAPTLSTrustedCAs(ALA_LDAP_TLS_TRUSTED_CAS)

A list of certificates in PEM format representing trusted certificate authorities (CAs) to be used when verifying the LDAP server's certificate.

These could include an enterprise CA used to issue certificates to LDAP servers, or even the certificate of the LDAP server itself.

Warning

If this option is used, the operating system's default list of trusted CAs will not be used.

Default: Use the operating system's list of trusted CAs.

LDAPTLSServerNames(ALA_LDAP_TLS_SERVER_NAMES)

If the hostname in an LDAP URL does not exactly match the hostname embedded in the certificate presented by the LDAP server, verification will fail.

This option may be used to specify the hostname we expect to find in the LDAP server's certificate.

If used, one such hostname should be provided for each configured LDAP URL, and in exactly the same order.

Default: Use the hostname as provided in the URL.

LDAPTLSDisableVerification(ALA_LDAP_TLS_DISABLE_VERIFICATION)

Disable verification of the server certificate provided by the LDAP server.

Warning

Use of this option leaves the agent vulnerable to machine-in-the-middle attacks, and is only provided for development and debugging purposes.

Default: false

LogLevel(ALA_LOG_LEVEL)

Specify the level of logging desired.

Must be one of panic, fatal, error, warn, info, debug, or trace.

Default: info

Accessing LDAPS servers via a load balancer

Some customers will provide a pool of LDAPS servers behind a load balancer. Thus, the agent will be configured with a single specific URL which points to the load balancer, but each backend LDAPS server may present a different certificate with a different hostname embedded. This can prevent certificate verification from working if we connect to the load balancer and expect a certificate that matches either the load balancer's address or a single item in LDAPTLSServerNames which corresponds to the single LDAPS URL.

Potential remedies include:

  • Terminate TLS at the load balancer, so the agent always sees a single certificate. This certificate's subject would need to match either the load balancer's address, or the configured entry in LDAPTLSServerNames.

  • Ensure that each pooled LDAPS server has a certificate with the same name (for example, by using the same certificate on each), and configure this name in LDAPTLSServerNames if it is not the load balancer address.

  • If the customer needs discrete certificates for each LDAPS server with different hostnames, perhaps a Subject Alternate Name (SAN) with the load balancer's address could be added to each certificate.

Agent status

You can check the status of your agents in Arculix provided that you have admin access. Log in to Arculix and from the left menu, go to Connectors.

Frequently asked questions (FAQs)

How many users can a single Arculix LDAP Agent serve?

Authentications are not compute intensive and a single Arculix LDAP Agent can generally serve thousands of users. We are able to provide more precise estimates after reviewing your specific needs.

Once the LDAP Agent requirements are met, what is the typical deployment and configuration effort to connect to Active Directory?

A typical remote or on-site deployment session takes our engineering team two hours start to finish. That is assuming all requirements are met and the team is ready to deploy and configure the agent.

Would we need dedicated VMs for development and staging as well?

Yes. While a single Arculix LDAP Agent instance can access development and staging directories stored in separate domains within an Active Directory forest (e.g. by using an Active Directory global catalog), we recommend using separate agent instances for development, staging, and production to maintain proper segregation between these deployments.

Does the Arculix LDAP Agent support multiple Active Directory domains and forests?

Yes. A single LDAP Agent may support multiple domains in a forest by using the Active Directory global catalog. Alternatively, multiple agents (or multiple load balanced agent groups) may be deployed -- each configured to serve users from specific domains. In this way, customers with multiple distinct forests may be easily accommodated.

What kind of information does the LDAP Agent send to Arculix?

The LDAP Agent acts as a worker waiting for commands from Arculix such as performing live user authentications, user lookups and checking the user group membership while enforcing Arculix group policies.