You are here

Home » API reference » SAML Authentication 7

README.txt in SAML Authentication 7

Same filename and directory in other branches
  1. 8.2 README.txt
This module provides integration between Drupal and OneLogin's SAML PHP Toolkit
(https://github.com/onelogin/php-saml/). The aim of this module is to provide an
easy to setup and simple solution to setting up a SAML Service Provider. All
configuration is handled inside Drupal and requires no editing or working with
the SAML library in order to function.

Features
--------------------------------------------------------------------------------

  * Account creation: when an unknown user logs in with the SAML system, a new
    Drupal account is automatically provisioned for them
  * Account synchronization: automatically update the username or email of a
    user based on the IdP information for the user
  * Restrict login: force SAML users to always login with SAML

Installation Notes
--------------------------------------------------------------------------------

  * The onelogin/php-saml PHP library must exist in your Drupal installation
  * Composer Manager is the recommended way to automatically handle dependencies
    for this module - see instructions below
  * The external library requires some PHP extensions to be enabled including
    php-mcrypt - Composer Manager will inform if the server does not meet the
    requirements set by the library
  * If a folder is used to store certs, place the folder outside of the Drupal
    root directory to ensure the certs are not accessible via the web server

OneLogin's SAML PHP Toolkit Library Installation
--------------------------------------------------------------------------------

  - Download Composer if you don't already have it installed:
    https://getcomposer.org/download/

  - Install Drush on your system if you haven't already:
    http://www.drush.org/en/master/

  - Download and install the Composer Manager module:
    drush en composer_manager

  - Run Composer Manager with Drush within your Drupal installation:
    drush composer-manager update --no-dev

Configuration
--------------------------------------------------------------------------------

  1. In your browser, open /admin/config/people/saml to configure the module.
  2. Configure information about the Service Provider, the IdP, user settings,
     and any additional security options.
  3. Open /saml/metadata to obtain the metadata needed to configure the IdP for
     this service provider.

File

README.txt
View source 
  1. This module provides integration between Drupal and OneLogin's SAML PHP Toolkit

  2. (https://github.com/onelogin/php-saml/). The aim of this module is to provide an

  3. easy to setup and simple solution to setting up a SAML Service Provider. All

  4. configuration is handled inside Drupal and requires no editing or working with

  5. the SAML library in order to function.

  6. 

  7. Features

  8. --------------------------------------------------------------------------------

  9. 

  10.   * Account creation: when an unknown user logs in with the SAML system, a new

  11.     Drupal account is automatically provisioned for them

  12.   * Account synchronization: automatically update the username or email of a

  13.     user based on the IdP information for the user

  14.   * Restrict login: force SAML users to always login with SAML

  15. 

  16. Installation Notes

  17. --------------------------------------------------------------------------------

  18. 

  19.   * The onelogin/php-saml PHP library must exist in your Drupal installation

  20.   * Composer Manager is the recommended way to automatically handle dependencies

  21.     for this module - see instructions below

  22.   * The external library requires some PHP extensions to be enabled including

  23.     php-mcrypt - Composer Manager will inform if the server does not meet the

  24.     requirements set by the library

  25.   * If a folder is used to store certs, place the folder outside of the Drupal

  26.     root directory to ensure the certs are not accessible via the web server

  27. 

  28. OneLogin's SAML PHP Toolkit Library Installation

  29. --------------------------------------------------------------------------------

  30. 

  31.   - Download Composer if you don't already have it installed:

  32.     https://getcomposer.org/download/

  33. 

  34.   - Install Drush on your system if you haven't already:

  35.     http://www.drush.org/en/master/

  36. 

  37.   - Download and install the Composer Manager module:

  38.     drush en composer_manager

  39. 

  40.   - Run Composer Manager with Drush within your Drupal installation:

  41.     drush composer-manager update --no-dev

  42. 

  43. Configuration

  44. --------------------------------------------------------------------------------

  45. 

  46.   1. In your browser, open /admin/config/people/saml to configure the module.

  47.   2. Configure information about the Service Provider, the IdP, user settings,

  48.      and any additional security options.

  49.   3. Open /saml/metadata to obtain the metadata needed to configure the IdP for

  50.      this service provider.