DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Active Directory Authentication Plugin ======

---- plugin ----
description: Provides authentication against a Microsoft Active Directory
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : Auth
lastupdate : 2014-04-03
compatible : (bundled)
depends    : 
conflicts  : 
similar    : 
tags       : !bundled, authentication

downloadurl: 
bugtracker : # eg. https://github.com/splitbrain/dokuwiki/issues
sourcerepo : https://github.com/splitbrain/dokuwiki/tree/master/lib/plugins/authad
donationurl: 
----

===== Description =====

This auth backend allows DokuWiki to authenticate against an Active Directory Server.

While Active Directory authentication can be set up with the bundled [[authLDAP]] plugin, it should be easier to do with this dedicated AD auth plugin. It makes use of the excellent [[http://adldap.sourceforge.net/|adLDAP library]] and is based on the work by James Van Lommel. You do not need to download the adLDAP library yourself, it is included with DokuWiki.

In addition it allows the use of NTLM and Kerberos based Single-Sign-On .

===== Usage =====
Before this plugin can be used, you need to setup some settings:
  - Prepare your AD server, see also [[#server configuration]] below.
  - Activate the authad plugin in the [[plugin|Plugin Manager]].
  - Define connection details in the [[config|Configuration Manager]]
  - Switch on this Auth plugin via the configuration option [[config:authtype]] by selecting ''authad''.

Save the configuration settings to the ''conf/local.protected.php'' file to [[plugin:config#protecting_settings|protect the settings]] against changes via Config Manager.

Modification of users and its groups can be done in the [[Usermanager|User manager]]. Only modifications are possible, adding new users is not possible with authAD. Also self registration by users is disabled by the authAD  plugin. At the moment the wiki cannot check Active Directory password policy, so better you disable the [[config:disableactions|action password reset]] ''resendpwd'' or if possible modify your AD password policy.

===== Server Configuration =====
Your server configuration must meet the requirements of the [[http://adldap.sourceforge.net/|adLDAP]] PHP library.

===Apache===
If you're using Apache on Ubuntu or Debian, just install the ''php5-ldap'' package. If you're using Apache on another distro, follow [[http://adldap.sourceforge.net/wiki/doku.php?id=apache|this guide]]. Installing ''php5-ldap'' also works on SLES. If you're using Arch Linux, install the php-ldap package with pacman.

===MS IIS7===
For MS IIS7 server ''php-ldap'' and ''php-openssl'' extensions needs to be installed (the second one only when SSL support required). For ''php-openssl'' dependency dlls ''ssleay32.dll'' and ''libeay32.dll'' needs to be available in your system too, you will need to make sure they are in a folder that is in the system path or just drop them off in the windows\system32 folder. When accessing AD using SSL, you must create file ''ldap.conf'' in ''C:\OpenLDAP\sysconf'' with line ''TLS_REQCERT never''. which disables AD certificate checking when making LDAP call.\\ **WARNING!** This could lead to Man-In-The-Middle attacks, so probably better solution is configure valid certificate using this file (more on [[http://linux.die.net/man/5/ldap.conf]]).

===lighttpd===
If you're using Debian, just install the ''php5-ldap'' package.

===Nginx===
Installing under Nginx on Ubuntu 14 requires php5-ldap.  Follow the Nginx php setup instructions here: [[install:nginx|Dokuwiki Nginx Config]].  The user needs only to set account_suffix, base_dn, and domain_controllers.  For domain controller, ldaps://<server> and ldap://<server> work.  These modifications were made in local.php than moved to local.protected.php
ex:
<code php>
  $conf['plugin']['authad']['account_suffix'] = '@ad.something.edu';
  $conf['plugin']['authad']['base_dn'] = 'dc=ad,dc=something,dc=edu';
  $conf['plugin']['authad']['domain_controllers'] = 'ldaps://ad.something.edu';
</code>

===Other===
If you're using a web server other than Apache or IIS7, you have to figure it out yourself. :( Please update this article if you succeed.
===== Configuration=====

The backend will be enabled with the [[config:authtype]] configuration option by selecting ''authad'' which is part of "Authentication Settings" in the Configuration Manager, or you could add a corresponding line to the ''conf/local.protected.php'' file to save the setting protected for changes.

In the "Plugin Settings" are settings for the authAD plugin. Here you define your AD server and connection details.

There are more general [[:config#available_options|authentication related settings]] available too.

=== Example config ===

You can use the Configuration Manager to configure the plugin. However to avoid having them overridden by the config manager it is recommended to place the configuration in ''conf/local.protected.php''.

You probably want to set at least these options:

<code php conf/local.protected.php>
  <?php
  // general DokuWiki options
  $conf['useacl']         = 1;
  $conf['authtype']       = 'authad';

// configure your Active Directory data here
  $conf['plugin']['authad']['account_suffix']     = '@my.domain.org';
  $conf['plugin']['authad']['base_dn']            = 'DC=my,DC=domain,DC=org';
  $conf['plugin']['authad']['domain_controllers'] = 'srv1.domain.org, srv2.domain.org'; //multiple can be given
</code>

Optionally the following parameters can be given:

<code php>
  $conf['plugin']['authad']['admin_username']        = 'root';
  $conf['plugin']['authad']['admin_password']        = 'pass';
  $conf['plugin']['authad']['sso']                = 1;
  $conf['plugin']['authad']['real_primarygroup']  = 1;
  $conf['plugin']['authad']['use_ssl']            = 1; // Don't have ssl/tls options enabled at the same time. 
  $conf['plugin']['authad']['use_tls']            = 1; // Only one of them.
  $conf['plugin']['authad']['debug']              = 1;
  $conf['plugin']['authad']['recursive_groups']   = 1; // If number of groups in AD is large switching to 0 will improve performance, but indirect membership will not work
  $conf['plugin']['authad']['additional']         = 'department,office'; // additional attributes to fetch
  // warn user about expiring password this many days in advance (in version 2012-03-10 and higher):
  $conf['plugin']['authad']['expirywarn']         = 5;
</code>

''admin_username'' and ''admin_password'' are e.g. required to enable user [[:subscription|email subscriptions]]. This account binds to the AD for querying user details.

==Manager and superuser==
Use this code snippet in local.protected.php to set superuser rights:

<code php>
$conf['manager']   = '@LDAPGROUPNAME';
$conf['superuser'] = '@LDAPGROUPNAME';
</code>

AD group names should be preceded with "@" and all spaces should be replaced with underscores.  For example, if my AD group is called "Internal DokuWiki Admins", it should be "@Internal_DokuWiki_Admins" in DokuWiki.  Any additional LDAP syntax is unneeded (e.g. all "CN=", "DN=", etc.).  Only the name of the group is needed.

==Other options==
Any other options given in ''$conf['plugin']['authad']'' are directly passed to the adldap library. Please refer to the [[http://adldap.sourceforge.net/wiki/doku.php?id=api|adLDAP documentation]] for a detailed description of what other options might be available.

In combination with Single-Sign-On, you can also add Windows domain specific setups. E.g. to authenticate against different Active Directory Servers depending on the NTLM or Kerberos Domain of a given user. The (lowercased) Domain just has to be used as a subkey to the ''$conf['plugin']['authad']'' setting. E.g. to identify all users coming from the ''Foobar'' Windows Domain using a non-default AD Server and user just put the following additional lines into your config:

<code php>
  $conf['plugin']['authad']['foobar']['account_suffix']     = '@foobar.domain.org';
  $conf['plugin']['authad']['foobar']['base_dn']            = 'DC=foobar,DC=domain,DC=org';
  $conf['plugin']['authad']['foobar']['domain_controllers'] = 'otherad.domain.org';
  $conf['plugin']['authad']['foobar']['admin_username']        = 'otherroot';
  $conf['plugin']['authad']['foobar']['admin_password']        = 'otherpass';
</code>

Please note that the subkey is only needed for the second and following domains. The first domain needs to be specified without a subkey. Otherwise the domain selector won't show up.

You can set a default domain as option, used as fallback when no domain is given:
<code php>
  $conf['plugin']['authad']['domain'] = 'foobar';
</code>

When you configure more than one domain, a domain selection is shown in the login form.

If you have an organisation with multiple DCs under a single parent, you may need to connect to **port 3268**, rather than the default port 389. Otherwise, users from the remote DC may not show up as members of any groups. The easiest way to do this is to add the following parameter to your local.protected.php

<code php conf/local.protected.php>
$conf['plugin']['authad']['ad_port'] = 3268;
</code>

===== User Profile and Password Changes =====

Users can change their user details (name, email and passwords) using the profile button. This may require to set up a privileged user through the ''admin_username'' and ''admin_password'' options. Password changing is only supported via SSL or TLS. See [[http://adldap.sourceforge.net/wiki/doku.php?id=ldap_over_ssl|LDAP over SSL]] in the adLDAP documentation.

Please note that DokuWiki's auto generated passwords do not match with the Active Directory default [[http://technet.microsoft.com/en-us/library/cc875814.aspx|password policy]]. Either adjust your AD password policy or disable the "Forget Password" option using the [[config:disableactions]] config option.

===== Group and User Names =====

Group and user names are cleaned up internally so they might differ from what is configured in your Active Directory server. Spaces are replaced with underscore and backslashes and hash symbols are removed.

Example: ''Domain Users'' becomes ''Domain_Users'' in DokuWiki.  When you edit your ACLs manually, remember the correct encoding: ''Domain%5fUsers''.  The "%5f" represents an underscore.

Keep this in mind when specifying users and groups in [[:ACL]] setup or configuration.

===== Enabling SSO =====

Single Sign On (SSO) means that DokuWiki will use your Windows login name to identify you without the need for you to log in. This relies on the server setting the ''REMOTE_USER'' environment variable. The ad backend then will use this username to fetch additional data like your group membership.

To make this work you need to enable the ''sso'' setting in ''local.protected.php'' and most probably also need to setup a management account with enough permissions to fetch the user info:

<code php>
$conf['plugin']['authad']['sso'] = 1;
$conf['plugin']['authad']['admin_username'] = 'MyManager';
$conf['plugin']['authad']['admin_password'] = 'ManagerPass';
</code>

Additonally some settings have to be made for your server and the used Browser.

==== Web Server ====

=== NTLM on IIS 7.5 ===

- Open the IIS configuration console (Start -> Internet Information Services (IIS) Manager)
  - Click on the site or virtual directory
  - Double-click on IIS -> Authentication
  - Click "Anonymous Authentication" and disable it
  - Click "Windows Authentication" and enable it (Note: If you do not see Windows Authentication, you need to [[http://www.iis.net/configreference/system.webserver/security/authentication/windowsauthentication|install it]] via "Turn Windows features on or off" in Control Panel )

{{:plugin:iisconfig.png?200 }} Note: Once Windows Authentication is enabled, all write and read access is done as the authenticated users which requires either very permissive permissions on the filesystem or another setting in IIS. The latter is recommended. Simpley switch ''system.webServer/serverRuntime/authenticatedUserOverride'' to ''UseWorkerProcessUser'' in the IIS Configuration Editor as oulined as Option #4 in this [[https://weblogs.asp.net/owscott/iis-using-windows-authentication-with-minimal-permissions-granted-to-disk|Blog Post]].

=== NTLM on IIS 6 ===

First configure IIS to use the Windows Logon for authentication (see screenshots):

- Open the IIS configuration console using "Start" -> "Run" -> ''inetmgr''
  - Right click on the "Default Web Site" entry and choose "Properties" 
  - Switch to the "Directory Security" tab
  - Click the "Edit" button on "Anonymous access and authentication control".
  - Disable "Anonymous access"
  - Enable "Integrated Windows Authentication"

Then make sure NTLM is used as authentication protocol. This has to be done on the commandline:

- Open a command line: "Start" -> "Run" -> ''cmd''
  - Change to the admin script directory: ''cd \Inetpub\Adminscripts''
  - Check the current protocol: ''cscript adsutil.vbs get w3svc/NTAuthenticationProviders''
  - if it doesn't say NTLM, set it: ''cscript adsutil.vbs set w3svc/NTAuthenticationProviders "NTLM"''
  - Now restart IIS.

=== NTLM on Apache 2.x (Windows) ===

- Download [[http://sourceforge.net/projects/mod-auth-sspi/]]
  - Copy the mod_auth_sspi.so file into your apache modules directory.
  - Add into httpd.conf:<code>
LoadModule sspi_auth_module modules/mod_auth_sspi.so

<Directory "c:/wamp/www/">
    AuthName "My Intranet"
    AuthType SSPI
    SSPIAuth On
    SSPIAuthoritative On

require valid-user

</Directory>
</code>
  - Now restart Apache

=== NTLM on Apache 2.4 (Windows) ===

- Download [[https://www.apachehaus.net/modules/mod_authnz_sspi/]]
  - Copy the mod_authnz_sspi.so file into your apache modules directory.
  - Add into httpd.conf:<code>
LoadModule sspi_auth_module modules/mod_auth_sspi.so

<Directory "c:/wamp/www/">
    AuthName "My Intranet"
    AuthType SSPI
    SSPIAuth On
    SSPIAuthoritative On

require valid-sspi-user
</Directory>
</code>
  - Now restart Apache

=== NTLM on Apache < 2.4 (Linux) ===
  - Install mod_python, ''sudo apt-get install libapache2-mod-python''
  - Get PyAuthenNTLM2, ''wget https://github.com/Legrandin/PyAuthenNTLM2/zipball/master''
  - Rename to PyAuthenNTLM2.zip
  - Unzip
  - cd to new dir
  - Install, ''sudo python setup.py install''
  - Add config to Apache2:<code>
<Directory /var/lib/some_directory>
AuthType NTLM
AuthName !!DOMAIN!!
require valid-user
PythonAuthenHandler pyntlm
PythonOption Domain !!DOMAIN!!
PythonOption PDC !!PRIMARY_DOMAIN_CONTROLLER!!
PythonOption BDC !!BACKUP_DOMAIN_CONTROLLER!!
</Directory>
</code>

[[http://codebreaker.dk/2012/09/18/ntlm2-auth-pa-en-linux-boks/|Reference NTLM2 on Linux]]

Note: ap_requires is deprecated in Apache 2.4, this NTLM method no longer works as described.

=== Kerberos on Apache (Linux) ===

This setup enables an Apache Server on Linux to verify Kerberos Tickets against an Active Directory server.

Good references for Apache/Kerberos can be found at
  * http://www.grolmsnet.de/kerbtut/
  * http://www.itefix.no/i2/node/11683

Microsoft has a good (albeit somewhat outdated) article series [[https://msdn.microsoft.com/en-us/library/ms995329.aspx|here]].

The following examples assume your wiki to be running on ''dokuwiki.yourdomain.com'', with your Active Directory server running at ''dc1.yourdomain.com'';

**Note: Kerberos is case sensitive, if it is all caps - it should be!**

- Install Kerberos client((Redhat: yum install krb5-workstation, Debian: krb5-user))
  - Install [[http://modauthkerb.sourceforge.net|mod_auth_kerb]]((Redhat: yum install mod_auth_kerb, Debian: libapache2-mod-auth-kerb))
  - Configure Kerberos if necessary, sample ''/etc/krb5.conf'':<code>
[logging]
 default = FILE:/var/log/krb5libs.log
 kdc = FILE:/var/log/krb5kdc.log
 admin_server = FILE:/var/log/kadmind.log

[libdefaults]
 default_realm = YOURDOMAIN.COM
 ticket_lifetime = 24h
 forwardable = yes

[realms]
 YOURDOMAIN.COM = {
  kdc = dc1.yourdomain.com
  admin_server = dc1.yourdomain.com
  default_domain = yourdomain.com
 }

[domain_realm]
 dokuwiki.yourdomain.com = YOURDOMAIN.COM
 .yourdomain.com = YOURDOMAIN.COM
 yourdomain.com = YOURDOMAIN.COM

[appdefaults]
 pam = {
  debug = false
   ticket_lifetime = 36000
   renew_lifetime = 36000
   forwardable = true
   krb4_convert = false
 }
</code>
  - Verify that the time on the DokuWiki server is within 5 minutes of the Active Directory server. Otherwise Kerberos will not authenticate.
  - Verify that the Kerberos environment is working by running:<code>
kinit username@YOURDOMAIN.COM
klist
kdestroy
(If you get any errors here, make sure your DNS setup is working and you wrote all marked as "YOURDOMAIN.COM" hosts in uppercase in your krb5.conf. Try resolve every hostname manually.</code>
  - Create a keytab file for your DokuWiki server. Make sure you have created a non-admin user in Active Directory with no password expiration. Run this as a Domain Admin on a Windows server with Support Tools installed:<code>ktpass -princ HTTP/dokuwiki.yourdomain.com@YOURDOMAIN.COM -mapuser name_of_ad_user_you_have_created -crypto DES-CBC-MD5 -ptype KRB5_NT_PRINCIPAL -mapop set +desonly -pass the_ad_users_password -out dokuwiki.HTTP.keytab</code> Use the following if you're running Windows 7/Server 2008 R2 clients because [[http://technet.microsoft.com/en-us/library/dd560670(WS.10).aspx|des is disabled by default]] on these operating systems: <code>ktpass -princ HTTP/dokuwiki.yourdomain.com@YOURDOMAIN.COM -mapuser name_of_ad_user_you_have_created@yourdomain.com -crypto RC4-HMAC-NT -ptype KRB5_NT_PRINCIPAL -pass the_ad_users_password -out dokuwiki.HTTP.keytab </code> RC4-HMAC is supported on Windows 2000 and higher.
  - If no errors occurred, copy the keytab file to /etc/httpd/conf/.
  - Create /etc/httpd/conf.d/dokuwiki.conf:<code apache>
<Directory "/var/www/html/dokuwiki">
        # Kerberos Auth
        AuthType Kerberos
        KrbAuthRealms YOURDOMAIN.COM
        KrbServiceName HTTP/dokuwiki.yourdomain.com
        Krb5Keytab /etc/httpd/conf/dokuwiki.HTTP.keytab
        KrbMethodNegotiate on
        KrbMethodK5Passwd on
        require valid-user
</Directory>
</code>
  - (Re)start Apache: service httpd restart.

== Troubleshooting ==

* Restart Apache. Web server config changes won't apply until restarted.
  * Try using the FQDN of the DokuWiki server, i.e. <nowiki>http://dokuwiki.yourdomain.com/dokuwiki</nowiki>.
  * If you are presented with a login window, do not enter domain/realm info, just user name and password.
  * Verify that the time on the DokuWiki server is within 5 minutes of the Active Directory server. Otherwise Kerberos will not authenticate.
  * If your web browser tries to send NTLM authentication, verify that the browser is correctly configured (see [[#browser|below]]) and verify that there aren't duplicate SPN:s registered for the Dokuwiki server. Run this command:<code dos>setspn -X</code>Remove any duplicates found.
  * Check all Kerberos files for case inconsistencies.
  * Review this instruction from start to end. See reference links where possible.

==== Browser ====

Your browser needs to be setup to forward authentication info to the Webserver.

=== Setup MS Internet Explorer for SPNEGO ===

Activate SPNEGO in Internet Explorer by:

- Adding dokuwiki server to the Local Intranet zone. It might be a good idea to add both host name and FQDN. See https://msdn.microsoft.com/en-us/library/ms995329.aspx.
  - Enabling authentication forwarding (Windows Integrated Authentication). Restart your browser to complete the change. IE 8 shown here:
{{http://img97.imageshack.us/img97/9099/ieenableintegratedwindo.jpg|}}

=== Setup Firefox ===

- Open Firefox and type //about:config// in the address bar.
  - In the ‘Filter’ field type one of the following (depending if you're using NTLM or Kerberos) //network.automatic-ntlm-auth.trusted-uris// or //network.negotiate-auth.trusted-uris//
  - Double click the name of the preference that we just searched for
  - Enter the URLs of the sites you wish to pass NTLM auth info to in the form of:
<code>
    http://intranet.company.com,http://email.company.lan
</code>
Notice that you can use a comma separated list in this field.

===== Effect on Plug-Ins =====

Some plug-ins may not gracefully work once you've switched over to the ad auth backend. Specifically, pulling the user's display name will not work if you don't provide valid authentication information. One such plugin is WikiStatistics, where a simple workaround to only display the username can be employed.

Due to [[http://adldap.sourceforge.net/wiki/doku.php?id=api_pagingsupport|missing support for paged queries in PHP's LDAP extension]], plugins that try to get all users from the auth backend will fail if you use authAD plugin and have more than 1000 objects in Active Directory. One example is the [[:plugin:issuetracker#faq|IssueTracker]] plugin.

Please fill all the letters into the box to prove you're human. V W J D G Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International