public function saml_sp_Auth::login in SAML Service Provider 7.2

Same name and namespace in other branches

1. 7.8 includes/saml_sp.Auth.inc \saml_sp_Auth::login()
2. 7.3 includes/saml_sp.Auth.inc \saml_sp_Auth::login()

Initiates the SSO process.

Parameters

string $returnTo The target URL the user should be returned to after login.:

array $parameters Extra parameters to be added to the GET:

File

includes/saml_sp.Auth.inc, line 19

Class

saml_sp_Auth

Code

public function login($returnTo = null, $parameters = array(), $forceAuthn = false, $isPassive = false, $stay = false, $setNameIdPolicy = true) {
  assert('is_array($parameters)');
  $settings = $this
    ->getSettings();
  $authnRequest = new saml_sp_AuthnRequest($settings);
  $samlRequest = $authnRequest
    ->getRequest();
  $parameters['SAMLRequest'] = $samlRequest;
  if (!empty($returnTo)) {
    $parameters['RelayState'] = $returnTo;
  }
  else {
    $parameters['RelayState'] = OneLogin_Saml2_Utils::getSelfRoutedURLNoQuery();
  }
  $security = $settings
    ->getSecurityData();
  if (isset($security['authnRequestsSigned']) && $security['authnRequestsSigned']) {
    $signature = $this
      ->buildRequestSignature($samlRequest, $parameters['RelayState']);
    $parameters['SigAlg'] = XMLSecurityKey::RSA_SHA1;
    $parameters['Signature'] = $signature;
  }

  // get this necessary information for this IdP
  $idp = (object) $settings
    ->getIdPData();
  $all_idps = saml_sp__load_all_idps();
  if (variable_get('saml_sp__debug', FALSE)) {
    watchdog('saml_sp', 'saml_sp_Auth::login $all_idps => <pre>@idps</pre>', array(
      '@idps' => print_r($all_idps, TRUE),
    ), WATCHDOG_DEBUG);
  }
  foreach ($all_idps as $this_idp) {
    if ($this_idp->entity_id == $idp->entityId || $this_idp->app_name == $idp->entityId) {
      $idp->machine_name = $this_idp->machine_name;
    }
  }
  if (!isset($idp->machine_name) || empty($idp->machine_name)) {

    // ensure there is an $idp->machine_name as it won't function otherwise
    $idp->machine_name = variable_get('saml_sp_drupal_login__idp', '');
  }
  if (variable_get('saml_sp__debug', FALSE)) {
    watchdog('saml_sp', 'saml_sp_Auth::login $idp => <pre>@idp</pre>', array(
      '@idp' => print_r($idp, TRUE),
    ), WATCHDOG_DEBUG);
  }

  // record the outbound Id of the request
  $id = $authnRequest
    ->getId();
  saml_sp__track_request($id, $idp, $this->auth_callback);
  if (variable_get('saml_sp__debug', FALSE) && module_exists('devel')) {
    return t('This is a debug page, <a href="!url">you can proceed by clicking this link.</a> (this might not work, because "/" chars are encoded differently when the link is made by Drupal as opposed to redirected, as it is when debugging is turned off)', array(
      '!url' => url($this
        ->getSSOurl(), array(
        'query' => $parameters,
      )),
    ));
  }
  if (variable_get('saml_sp__debug', FALSE)) {
    watchdog('saml_sp', 'Using $parameters => <pre>@parameters</pre>', array(
      '@parameters' => print_r($parameters, TRUE),
    ), WATCHDOG_DEBUG);
  }
  $this
    ->redirectTo($this
    ->getSSOurl(), $parameters);
}