README

This package is no longer being maintained.

Consider using alternatives like silverstripe/ldap instead.

SilverStripe Active Directory module

Introduction

This SilverStripe module provides Active Directory integration. It comes with three major components:

Single sign-on authentication with SAML
Synchronisation of Active Directory users and group memberships via LDAP
Active Directory authentication via LDAP binding

These components may be used in any combination, also alongside the default SilverStripe authentication scheme.

Requirements

PHP 5.4+ with extensions: ldap, openssl, dom, and mcrypt
SilverStripe 3.1
Active Directory on Windows Server 2008 R2 or greater (AD)
Active Directory Federation Services 2.0 or greater (ADFS)
HTTPS endpoint on SilverStripe site
HTTPS endpoint on ADFS
SSL/StartTLS encrypted LDAP endpoint on Active Directory

This module has been tested on the following configurations:

Windows Server 2008 R2 with ADFS 2.0
Windows Server 2012 R2 with ADFS 3.0

This module has not been tested on non-Microsoft directory products, such as OpenLDAP.

Note: This module will not be supported on SilverStripe 4. Please use either silverstripe/ldap or silverstripe/saml for SilverStripe 4 compatibility.

Overview

(Image) Typical authentication and authorisation flow for this module

Security Assertion Markup Language (SAML) is an XML-based, open-standard data format for exchanging authentication and authorization data between parties. The single most important requirement that SAML addresses is web browser single sign-on (SSO).

With this module, SilverStripe site is able to act as a SAML Service Provider (SP) entity, and thus allows users to perform a single sign-on against a centralised user directory (an Identity Provider - IdP).

The intended counterparty for this module is the Active Directory Federation Services (ADFS). ADFS is a software component developed by Microsoft that can be installed on Windows Server operating systems to provide users with single sign-on access to systems and applications located across organizational boundaries.

ADFS uses a claims-based access control authorization model to maintain application security and implement federated identity. We rely on this mechanism for authentication, and for automated synchronisation of some basic personal details into SilverStripe.

To synchronise further personal details, LDAP synchronisation feature can be used, also included in this module. This allows arbitrary fields to be synchronised - including binary fields such as photos. If relevant mappings have been configured in the CMS the module will also automatically maintain SilverStripe group memberships, which opens the way for an AD-centric authorisation.

If SAML authentication cannot be used, this module also provides an LDAP authenticator as an alternative.

Security

With appropriate configuration, this module provides a secure means of authentication and authorisation.

For secure communication over the internet during the SAML authentication process, users must communicate with SilverStripe and ADFS using HTTPS. Similarly, for AD authentication to be secure users must access the SilverStripe site using HTTPS.

SilverStripe trusts ADFS responses based on pre-shared x509 certificates. These certificates are exchanged between the Identity Provider (ADFS) and the Service Provider (SilverStripe site) during the initial configuration phase.

AD user synchronisation and authentication is hidden behind the backend (server to server communication), but must still use encrypted LDAP communication to prevent eavesdropping (either StartTLS or SSL - this is configurable). If the webserver and the AD server are hosted in different locations, a VPN could also be used to further encapsulate the traffic going over the public internet.

In-depth guides

Developer guide - configure your SilverStripe site
ADFS administrator guide - prepare the Identity Provider
CMS usage guide - manage LDAP group mappings
Troubleshooting - common problems

Changelog

The changelog can be found at CHANGELOG.MD.

silverstripe / activedirectory

Maintainers

Details