modules/Users/authentication/SAMLAuthenticate/settings.php

   1 <?php
   2 /*********************************************************************************
   3 Copyright (c) 2010, OneLogin, Inc.
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8     * Redistributions of source code must retain the above copyright
   9       notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11       notice, this list of conditions and the following disclaimer in the
  12       documentation and/or other materials provided with the distribution.
  13     * Neither the name of the <organization> nor the
  14       names of its contributors may be used to endorse or promote products
  15       derived from this software without specific prior written permission.
  16
  17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  18 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20 DISCLAIMED. IN NO EVENT SHALL ONELOGIN, INC. BE LIABLE FOR ANY
  21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  ********************************************************************************/
  28
  29 /**
  30  * Return a SamlSettings object with user settings.
  31  *
  32  * @return SamlSettings object
  33  */
  34 function get_saml_settings()
  35 {
  36     // this function should be modified to return the SAML settings for the current user
  37
  38     $settings                           = new SamlSettings();
  39     // when using Service Provider Initiated SSO (starting at index.php), this URL asks the IdP to authenticate the user.
  40     $settings->idp_sso_target_url       = $GLOBALS['sugar_config']['SAML_loginurl'];
  41
  42     // the certificate for the users account in the IdP
  43     $settings->x509certificate          = $GLOBALS['sugar_config']['SAML_X509Cert'];
  44
  45     // The URL where to the SAML Response/SAML Assertion will be posted
  46     $settings->assertion_consumer_service_url = $GLOBALS['sugar_config']['site_url']. "/index.php?module=Users&action=Authenticate";
  47
  48     // Name of this application
  49     $settings->issuer                         = "php-saml";
  50
  51     // Tells the IdP to return the email address of the current user
  52     $settings->name_identifier_format         = "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress";
  53
  54     return $settings;
  55 }