You are here

function ldap_sso_user_login_sso in LDAP Single Sign On 7.2

Same name and namespace in other branches
  1. 7 ldap_sso.module \ldap_sso_user_login_sso()

A proxy function for the actual authentication routine.

This is in place so various implementations of grabbing NTLM credentials can be used and selected from an administration page. This is the real gatekeeper since this assumes that any NTLM authentication from the underlying web server is good enough, and only checks that there are values in place for the user name, and anything else that is set for a particular implementation. In the case that there are no credentials set by the underlying web server, the user is redirected to the normal user login form.

1 string reference to 'ldap_sso_user_login_sso'
ldap_sso_menu in ./ldap_sso.module
Implements hook_menu().

File

./ldap_sso.module, line 188
This module injects itself into Drupal's Authentication stack.

Code

function ldap_sso_user_login_sso() {
  $detailed_watchdog_log = variable_get('ldap_help_watchdog_detail', 0);
  $auth_conf = ldap_authentication_get_valid_conf();
  if ($detailed_watchdog_log) {
    $watchdog_tokens = array(
      '!implementation' => $auth_conf->ldapImplementation,
      '!enabled' => $auth_conf->ssoEnabled,
      '!server_remote_user' => @$_SERVER['REMOTE_USER'],
      '!server_redirect_remote_user' => @$_SERVER['REDIRECT_REMOTE_USER'],
      '!ssoRemoteUserStripDomainName' => $auth_conf->ssoRemoteUserStripDomainName,
      '!seamlessLogin' => $auth_conf->seamlessLogin,
    );
    watchdog('ldap_sso', 'ldap_sso_user_login_sso.step1: implementation: !implementation, enabled: !enabled, server_remote_user: !server_remote_user, server_redirect_remote_user: !server_redirect_remote_user, ssoRemoteUserStripDomainName: !ssoRemoteUserStripDomainName,seamlessLogin: !seamlessLogin', $watchdog_tokens, WATCHDOG_DEBUG);
  }

  // Step 1.  Derive $remote_user, $realm, and $domain from $_SERVER variable.
  $remote_user = NULL;
  $realm = NULL;
  $domain = NULL;
  switch ($auth_conf->ldapImplementation) {
    case 'mod_auth_sspi':
      $remote_user = FALSE;
      if ($remote_user = ldap_servers_get_globals('_SERVER', 'REMOTE_USER')) {
      }
      else {
        $remote_user = ldap_servers_get_globals('_SERVER', 'REDIRECT_REMOTE_USER');
      }
      break;
    case 'mod_auth_kerb':
      if ($remote_user = ldap_servers_get_globals('_SERVER', 'REMOTE_USER')) {
      }
      else {
        $remote_user = ldap_servers_get_globals('_SERVER', 'REDIRECT_REMOTE_USER');
      }
      if ($remote_user && preg_match('/^([A-Za-z0-9_\\-\\.]+)@([A-Za-z0-9_\\-.]+)$/', $remote_user, $matches)) {
        $remote_user = $matches[1];

        // This can be used later if realms is ever supported properly.
        $realm = $matches[2];
      }
      break;
  }
  if ($detailed_watchdog_log) {
    $watchdog_tokens['!remote_user'] = $remote_user;
    $watchdog_tokens['!realm'] = $realm;
    watchdog('ldap_authentication', 'ldap_sso_user_login_sso.implementation: username=!remote_user, (realm=!realm) found', $watchdog_tokens, WATCHDOG_DEBUG);
  }
  if ($remote_user) {
    if ($auth_conf->ssoRemoteUserStripDomainName) {

      // Might be in form <remote_user>@<domain> or <domain>\<remote_user>.
      $domain = NULL;
      $exploded = preg_split('/[\\@\\\\]/', $remote_user);
      if (count($exploded) == 2) {
        if (strpos($remote_user, '@') !== FALSE) {
          $remote_user = $exploded[0];
          $domain = $exploded[1];
        }
        else {
          $domain = $exploded[0];
          $remote_user = $exploded[1];
        }
        if ($detailed_watchdog_log) {
          $watchdog_tokens['!remote_user'] = $remote_user;
          $watchdog_tokens['!domain'] = $domain;
          watchdog('ldap_authentication', 'ldap_sso_user_login_sso.stripdomain: remote_user=!remote_user, domain=!domain', $watchdog_tokens, WATCHDOG_DEBUG);
        }
      }
    }
    if ($detailed_watchdog_log) {
      $watchdog_tokens['!remote_user'] = $remote_user;
      $watchdog_tokens['!realm'] = $realm;
      $watchdog_tokens['!domain'] = $domain;
      watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user: username=!remote_user, (realm=!realm, domain=!domain) found', $watchdog_tokens, WATCHDOG_DEBUG);
    }
    $fake_form_state = array(
      'values' => array(
        'name' => check_plain($remote_user),
        'pass' => user_password(20),
      ),
      'sso_login' => TRUE,
    );

    // Make sure we're populating the global user object so that we can log this
    // user in.
    global $user;
    $validated_user = ldap_authentication_user_login_authenticate_validate(array(), $fake_form_state, TRUE);
    if ($validated_user) {
      $user = $validated_user;
    }
    if ($detailed_watchdog_log) {
      $watchdog_tokens['!uid'] = is_object($user) ? $user->uid : NULL;
      watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user: uid of user=!uid', $watchdog_tokens, WATCHDOG_DEBUG);
    }
    if ($user && $user->uid > 0 && $user->status != 0) {

      // Reload the account to ensure we have a fully populated user object.
      $user = user_load($user->uid);
      if ($auth_conf->seamlessLogin == 1) {
        if ($detailed_watchdog_log) {
          watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user.user_success.seamlessLogin', $watchdog_tokens, WATCHDOG_DEBUG);
        }
        setcookie("seamless_login", 'auto login', time() + $auth_conf->cookieExpire, base_path(), "");
        ldap_servers_set_globals('_SESSION', 'seamless_login', 'auto login');
        setcookie("seamless_login_attempted", '', time() - 3600, base_path(), "");
        ldap_servers_delete_globals('_SESSION', 'seamless_login_attempted');

        // Make sure we tell Drupal to create the session cookie for this
        // authenticated user.
      }
      user_login_finalize();
      if ($auth_conf->ssoNotifyAuthentication) {
        drupal_set_message(theme('ldap_authentication_login_message', array(
          'message' => t('You have been successfully authenticated'),
        )));
      }
      if ($detailed_watchdog_log) {
        watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user.user_success.drupal_goto front', $watchdog_tokens, WATCHDOG_DEBUG);
      }
      drupal_goto('<front>');
    }
    elseif ($user->status == 0) {
      drupal_set_message(t('Your account is blocked.'), 'error');
      drupal_goto('user/login');
    }
    else {
      if ($auth_conf->seamlessLogin == 1) {
        if ($detailed_watchdog_log) {
          watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user.user_fail.seamlessLogin', $watchdog_tokens, WATCHDOG_DEBUG);
        }
        setcookie("seamless_login", 'do not auto login', time() + $auth_conf->cookieExpire, base_path(), "");
        ldap_servers_set_globals('_SESSION', 'seamless_login', 'do not auto login');
      }
      drupal_set_message(theme('ldap_authentication_message_not_found', array(
        'message' => t('Sorry, your LDAP credentials were not found, or the LDAP server is not available. You may log in with other credentials on the !user_login_form.', array(
          '!user_login_form' => l(t('user login form'), 'user/login'),
        )),
      )), 'error');
      if ($detailed_watchdog_log) {
        watchdog('ldap_authentication', 'ldap_sso_user_login_sso.remote_user.user_fail.drupal_goto user/logint', $watchdog_tokens, WATCHDOG_DEBUG);
      }
      drupal_goto('user/login');
    }
  }
  else {
    if ($detailed_watchdog_log) {
      watchdog('ldap_authentication', '$_SERVER[\'REMOTE_USER\'] not found', array(), WATCHDOG_DEBUG);
    }
    if ($auth_conf->seamlessLogin == 1) {
      setcookie("seamless_login", 'do not auto login', time() + $auth_conf->cookieExpire, base_path(), "");
      ldap_servers_set_globals('_SESSION', 'seamless_login', 'do not auto login');
      if ($detailed_watchdog_log) {
        watchdog('ldap_authentication', 'ldap_sso_user_login_sso.no_remote_user.seamlessLogin', $watchdog_tokens, WATCHDOG_DEBUG);
      }
    }
    drupal_set_message(theme('ldap_authentication_message_not_authenticated', array(
      'message' => t('You were not authenticated by the server. You may log in with your credentials below.'),
    )), 'error', FALSE);
    if ($detailed_watchdog_log) {
      watchdog('ldap_authentication', 'ldap_sso_user_login_sso.no_remote_user.drupal_goto user/login', $watchdog_tokens, WATCHDOG_DEBUG);
    }
    drupal_goto('user/login');
  }
}