Page tree
Skip to end of metadata
Go to start of metadata

Overview

The mod_authnz_ldap Apache module provides the functionality for Apache to use an LDAP directory to authenticate and authorize users. This module works in conjunction with a front-end Apache authentication module.

Usage

To authenticate or authorize users with an LDAP directory, install the mod_authnz_ldap Apache module. For information on how to use the mod_authnz_ldap Apache module, read the Related documentation section.

Requirements

Front-end Apache authentication module

The mod_authnz_ldap Apache module requires a front-end Apache authentication module. EasyApache includes the mod_auth_basic front-end Apache module by default.

For information on the mod_auth_basic Apache module, click the following links:

For information on how to enable the alternative Apache front-end authentication module mod_auth_digest, read our Apache Module: AuthDigest documentation.

mod_ldap

You can install the mod_authnz_ldap Apache module before you configure an LDAP directory. However, you must configure an LDAP directory to use the module.

Compatibility

This module has no known compatibility issues.

How to install or uninstall mod_authnz_ldap

The EasyApache profiles do not provide the mod_authnz_ldap Apache module by default.

To install or uninstall the mod_authnz_ldap Apache module, perform the following steps:

  1. Run EasyApache in WHM's EasyApache 3 interface (Home >> Software >> EasyApache 3).

    Notes:

    • To access EasyApache from the command line interface, run the /scripts/easyapache script as the root user.
    • For more information on EasyApache, read our EasyApache documentation.
  2. Select the profile that you wish to modify.

  3. Click the  icon that corresponds to your selection.

  4. Click Next Step in the Apache Version stage.
  5. Click Next Step in the PHP Version stage.
  6. Click Exhaustive Options List in the Short Options List stage.
  7. Perform one of the following actions in the Exhaustive Options List stage: 
    • To install the mod_authnz_ldap Apache module, select the AuthnzLDAP option.

      Note:

      If you select this option, EasyApache will perform the following tasks:

      • Add --enable-authnz-ldap to Apache's build options.
      • Enable the LDAP option.
    • To uninstall the mod_authnz_ldap Apache module, deselect the AuthnzLDAP option.
  8. Click Save and Build.

How to enable or disable the module in a custom EasyApache profile file

The following table provides information about how EasyApache refers to the mod_authnz_ldap Apache module: 

EasyApache module namemod_authnz_ldap
EasyApache Profile EntryApache::optmods::AuthnzLDAP

To enable or disable the mod_authnz_ldap Apache module in a custom EasyApache profile file, set the Apache::optmods::AuthnzLDAP profile entry to one of the following values:

  • 1 - This value enables the module.
  • 0 - This value disables the module.

History

The following table provides information on changes to the mod_authnz_ldap Apache module within EasyApache, and content changes to this document:

DateEasyApache versionActionDetails
2/11/20143.24.11Doc updateImplemented case 73225: Remove Apache 1.3 and 2.0
1/31/20133.18.0Doc updateImplemented case 51105: Update for Apache 2.4

Related documentation

Apache authentication and authorization

For more information on Apache authentication and authorization, click the following links:

Apache authorization modules

The following table includes the Apache authorization modules that are available in EasyApache:

EasyApache optionEasyApache's documentationApache's documentation
AuthzDBMApache Module: AuthzDBM
AuthzOwner 
AuthnzLDAPApache Module: AuthnzLDAP

Apache authentication modules

The following table includes the Apache authentication modules that are available in EasyApache:

EasyApache optionEasyApache's documentationApache's documentation
AuthnDBDApache Module: AuthnDBD
AuthnAnonApache Module: AuthnAnon

AuthnAlias

Apache Module: AuthnAlias

Note:

The mod_authn_alias Apache module does not provide authentication. It allows you to configure aliases to refer to authentication provider modules.

AuthnDBMApache Module: AuthnDBM
AuthnDefaultApache Module: AuthnDefault
AuthnzLDAPApache Module: AuthnzLDAP