class CasLogout in CAS 8

Class CasLogout.

Hierarchy

• class \Drupal\cas\Service\CasLogout

1 file declares its use of CasLogout

ServiceController.php in src/Controller/ServiceController.php

1 string reference to 'CasLogout'

cas.services.yml in ./cas.services.yml

cas.services.yml

1 service uses CasLogout

cas.logout in ./cas.services.yml

Drupal\cas\Service\CasLogout

File

src/Service/CasLogout.php, line 13

Namespace

Drupal\cas\Service

class CasLogout {

  /**
   * The CAS helper.
   *
   * @var CasHelper
   */
  protected $casHelper;

  /**
   * The database connection used to find the user's session ID.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Stores settings object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $settings;

  /**
   * CasLogout constructor.
   *
   * @param \Drupal\cas\Service\CasHelper $cas_helper
   *   The CAS helper.
   * @param \Drupal\Core\Database\Connection $database_connection
   *   The database connection.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(CasHelper $cas_helper, Connection $database_connection, ConfigFactoryInterface $config_factory) {
    $this->casHelper = $cas_helper;
    $this->connection = $database_connection;
    $this->settings = $config_factory
      ->get('cas.settings');
  }

  /**
   * Handles a single-log-out request from a CAS server.
   *
   * @param string $data
   *   The raw data posted to us from the CAS server.
   *
   * @throws \Drupal\cas\Exception\CasSloException
   *   If the logout data could not be parsed.
   */
  public function handleSlo($data) {
    $this->casHelper
      ->log(LogLevel::DEBUG, "Attempting to handle single-log-out request.");

    // Only look up tickets if they were stored to begin with.
    if (!$this->settings
      ->get('logout.enable_single_logout')) {
      $this->casHelper
        ->log(LogLevel::DEBUG, "Aborting single-log-out handling; it's not enabled in the CAS settings.");
      return;
    }
    $service_ticket = $this
      ->getServiceTicketFromData($data);
    $this->casHelper
      ->log(LogLevel::DEBUG, 'Service ticket %ticket extracted from single-log-out request.', [
      '%ticket' => $service_ticket,
    ]);

    // Look up the session ID by the service ticket, then load up that
    // session and destroy it.
    $sid = $this
      ->lookupSessionIdByServiceTicket($service_ticket);
    if (!$sid) {
      $this->casHelper
        ->log(LogLevel::DEBUG, 'No matching session found for %ticket', [
        '%ticket' => $service_ticket,
      ]);
      return;
    }
    $this
      ->destroySession($sid);
    $this
      ->removeSessionMapping($sid);
    $this->casHelper
      ->log(LogLevel::DEBUG, "Single-log-out request completed successfully.");
  }

  /**
   * Load up the session and destroy it.
   *
   * @param string $sid
   *   The ticket id to destroy.
   *
   * @codeCoverageIgnore
   */
  protected function destroySession($sid) {
    session_id($sid);
    session_start();
    session_destroy();
    session_write_close();
  }

  /**
   * Parse the SLO SAML and return the service ticket.
   *
   * @param string $data
   *   The raw data posted to us from the CAS server.
   *
   * @return string
   *   The service ticket to log out.
   *
   * @throws \Drupal\cas\Exception\CasSloException
   *   If the logout data could not be parsed.
   */
  private function getServiceTicketFromData($data) {
    $dom = new \DOMDocument();
    $dom->preserveWhiteSpace = FALSE;
    $dom->encoding = "utf-8";
    if ($dom
      ->loadXML($data) === FALSE) {
      throw new CasSloException("SLO data from CAS server is not valid.");
    }
    $session_elements = $dom
      ->getElementsByTagName('SessionIndex');
    if ($session_elements->length == 0) {
      throw new CasSloException("SLO data from CAS server is not valid.");
    }
    $session_element = $session_elements
      ->item(0);
    return $session_element->nodeValue;
  }

  /**
   * Lookup Session ID by CAS service ticket.
   *
   * @param string $ticket
   *   A service ticket value from CAS to lookup in the database.
   *
   * @return string
   *   The session ID corresponding to the session ticket.
   *
   * @codeCoverageIgnore
   */
  private function lookupSessionIdByServiceTicket($ticket) {
    $result = $this->connection
      ->select('cas_login_data', 'c')
      ->fields('c', [
      'plainsid',
    ])
      ->condition('ticket', $ticket)
      ->execute()
      ->fetch();
    if (!empty($result)) {
      return $result->plainsid;
    }
    else {
      return NULL;
    }
  }

  /**
   * Remove the SLO session mapping data for the passed in session ID.
   *
   * @param string $sid
   *   The user's session ID.
   */
  private function removeSessionMapping($sid) {
    $this->connection
      ->delete('cas_login_data')
      ->condition('plainsid', $sid)
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CasLogout::$casHelper	protected	property	The CAS helper.
CasLogout::$connection	protected	property	The database connection used to find the user's session ID.
CasLogout::$settings	protected	property	Stores settings object.
CasLogout::destroySession	protected	function	Load up the session and destroy it.
CasLogout::getServiceTicketFromData	private	function	Parse the SLO SAML and return the service ticket.
CasLogout::handleSlo	public	function	Handles a single-log-out request from a CAS server.
CasLogout::lookupSessionIdByServiceTicket	private	function	Lookup Session ID by CAS service ticket.
CasLogout::removeSessionMapping	private	function	Remove the SLO session mapping data for the passed in session ID.
CasLogout::__construct	public	function	CasLogout constructor.