cas_server.response.inc in CAS 7

Response callbacks for the CAS Server module.

File

cas_server.response.inc

<?php

/**
 * @file
 * Response callbacks for the CAS Server module.
 */

/**
 * Returns a CAS 2.0 service response for a validation success.
 *
 * @param $variables
 *   An associative array containing the keys:
 *   - 'name': CAS username.
 *   - 'attributes': (optional) CAS attributes.
 */
function theme_cas_service_validate_success($variables) {
  $cas_name = $variables['name'];
  $output = "<cas:serviceResponse xmlns:cas='http://www.yale.edu/tp/cas'>\n";
  $output .= "<cas:authenticationSuccess>\n";
  $output .= "<cas:user>{$cas_name}</cas:user>\n";
  $output .= theme('cas_service_validate_attributes', $variables);
  $output .= "</cas:authenticationSuccess>\n";
  $output .= "</cas:serviceResponse>\n";
  return $output;
}

/**
 * Returns CAS attributes as part of a CAS 2.0 service response.
 *
 * @param $variables
 *   An associative array containing the keys 'attributes' and 'style', where
 *   the value of 'style' must be one of:
 *     - 'jasig' (default)
 *     - 'rubycas'
 *     - 'name-value'
 */
function theme_cas_service_validate_attributes($variables) {
  $attributes = $variables['attributes'];
  $style = $variables['style'];
  $output = '';
  switch ($style) {
    case 'jasig':
    default:
      $output .= "<cas:attributes>\n";
      $output .= "<cas:attraStyle>Jasig</cas:attraStyle>\n";
      foreach ($attributes as $name => $values) {
        foreach ((array) $values as $value) {
          $output .= strtr("<cas:!name>!value</cas:!name>\n", array(
            '!name' => $name,
            '!value' => $value,
          ));
        }
      }
      $output .= "</cas:attributes>\n";
      break;
    case 'rubycas':
      $output .= "<cas:attraStyle>RubyCAS</cas:attraStyle>\n";
      foreach ($attributes as $name => $values) {
        foreach ((array) $values as $value) {
          $output .= strtr("<cas:!name>!value</cas:!name>\n", array(
            '!name' => $name,
            '!value' => $value,
          ));
        }
      }
      break;
    case 'name-value':
      $output .= "<cas:attribute name='attraStyle' value='Name-Value' />\n";
      foreach ($attributes as $name => $values) {
        foreach ((array) $values as $value) {
          $output .= strtr("<cas:attribute name='!name' value='!value' />\n", array(
            '!name' => $name,
            '!value' => $value,
          ));
        }
      }
      break;
  }
  return $output;
}

/**
 * Returns a CAS 2.0 service response for a validation failure.
 *
 * @param $variables
 *  An associative array containing the keys 'ticket' and 'error_code'.
 */
function theme_cas_service_validate_failure($variables) {
  $ticket = $variables['ticket'];
  $error_code = $variables['error_code'];
  $output = "<cas:serviceResponse xmlns:cas='http://www.yale.edu/tp/cas'>\n";
  $output .= "<cas:authenticationFailure code=\"{$error_code}\">\n";
  $output .= "Ticket {$ticket} not recognized.\n";
  $output .= "</cas:authenticationFailure>\n";
  $output .= "</cas:serviceResponse>\n";
  return $output;
}

/**
 * Returns a CAS 2.0 service response for a service not on the whitelist.
 *
 * @param $variables
 *  An associative array containing the keys 'service' and 'error_code'.
 */
function theme_cas_service_validate_whitelist_failure($variables) {
  $service = $variables['service'];
  $error_code = $variables['error_code'];
  $output = "<cas:serviceReponse xmlns:cas='http://www.yale.edu/tp/cas'>\n" . "<cas:authenticationFailure code=\"{$error_code}\">\n" . "Service {$service} not recognized.\n" . "</cas:authenticationFailure>\n" . "</cas:serviceResponse>\n";
  return $output;
}

/**
 * Generate the Single Sign Out request.
 *
 * @param unknown_type $variables
 *   An associative array containing the key, date and logout id request
 */
function theme_cas_service_logout_request($variables) {
  $id = $variables['id'];
  $date = $variables['date'];
  $ticket = $variables['ticket'];
  $output = "<samlp:LogoutRequest xmlns:samlp='urn:oasis:names:tc:SAML:2.0:protocol' ID='{$id}' Version='2.0' IssueInstant='{$date}'>\n";
  $output .= "<saml:NameID xmlns:saml='urn:oasis:names:tc:SAML:2.0:assertion'>@NOT_USED@</saml:NameID>\n";
  $output .= "<samlp:SessionIndex>{$ticket}</samlp:SessionIndex>\n";
  $output .= "</samlp:LogoutRequest>\n";
  return $output;
}

Functions

Name	Description
theme_cas_service_logout_request	Generate the Single Sign Out request.
theme_cas_service_validate_attributes	Returns CAS attributes as part of a CAS 2.0 service response.
theme_cas_service_validate_failure	Returns a CAS 2.0 service response for a validation failure.
theme_cas_service_validate_success	Returns a CAS 2.0 service response for a validation success.
theme_cas_service_validate_whitelist_failure	Returns a CAS 2.0 service response for a service not on the whitelist.