You are here

Home » API reference » SAML Authentication 8 » SamlController.php

class SamlController in SAML Authentication 8

Same name and namespace in other branches
  1. 8.3 src/Controller/SamlController.php \Drupal\samlauth\Controller\SamlController
  2. 8.2 src/Controller/SamlController.php \Drupal\samlauth\Controller\SamlController
  3. 4.x src/Controller/SamlController.php \Drupal\samlauth\Controller\SamlController

Class SamlController.

@package Drupal\samlauth\Controller

Hierarchy

Expanded class hierarchy of SamlController

File

src/Controller/SamlController.php, line 24
Contains Drupal\samlauth\Controller\SamlController.

Namespace

Drupal\samlauth\Controller
View source 
class SamlController extends ControllerBase {

  /**
   * @var Drupal\samlauth\SamlService
   */
  protected $saml;

  /**
   * @var Drupal\samlauth\SamlUserService
   */
  protected $saml_user;

  /**
   * Constructor for Drupal\samlauth\Controller\SamlController.
   *
   * @param \Drupal\samlauth\Controller\SamlService $samlauth_saml
   */
  public function __construct(SamlService $saml, SamlUserService $saml_user) {
    $this->saml = $saml;
    $this->saml_user = $saml_user;
  }

  /**
   * Factory method for dependency injection container.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   * @return static
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('samlauth.saml'), $container
      ->get('samlauth.saml_user'));
  }

  /**
   * Redirect to the Login service on the IDP.
   */
  public function login() {
    $config = samlauth_get_config();
    $this->saml
      ->login($config['sp']['assertionConsumerService']['url']);
  }

  /**
   * Redirect to the SLS service on the IDP.
   */
  public function logout() {
    $config = samlauth_get_config();
    $this->saml
      ->logout($config['sp']['singleLogoutService']['url']);
  }

  /**
   * Displays service provider metadata XML for iDP autoconfiguration.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   */
  public function metadata() {
    $metadata = $this->saml
      ->getMetadata();
    $response = new Response($metadata, 200);
    $response->headers
      ->set('Content-Type', 'text/xml');
    return $response;
  }

  /**
   * Attribute Consumer Service
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   */
  public function acs() {
    $errors = $this->saml
      ->acs();
    if (!empty($errors)) {
      drupal_set_message($this
        ->t('An error occured.'), 'error');
      return new RedirectResponse('/');
    }
    try {
      $saml_data = $this->saml
        ->getData();
      $this->saml_user
        ->handleSamlData($saml_data);
    } catch (Exception $e) {
      drupal_set_message($e
        ->getMessage(), 'error');
    }
    $route = $this->saml_user
      ->getPostLoginDestination();
    $url = \Drupal::urlGenerator()
      ->generateFromRoute($route);
    return new RedirectResponse($url);
  }

  /**
   * Single Logout Service
   *
   * Return URL for the sls service on the identity provider.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   */
  public function sls() {
    $this->saml_user
      ->logout();
    $route = $this->saml_user
      ->getPostLogoutDestination();
    $url = \Drupal::urlGenerator()
      ->generateFromRoute($route);
    return new RedirectResponse($url);
  }

  /**
   * Change password redirector.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   */
  public function changepw() {
    $url = \Drupal::config('samlauth.samlauthconfigure_config')
      ->get('idp_change_password_service');
    return new RedirectResponse($url);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SamlController::$saml protected property
SamlController::$saml_user protected property
SamlController::acs public function Attribute Consumer Service
SamlController::changepw public function Change password redirector.
SamlController::create public static function Factory method for dependency injection container. Overrides ControllerBase::create
SamlController::login public function Redirect to the Login service on the IDP.
SamlController::logout public function Redirect to the SLS service on the IDP.
SamlController::metadata public function Displays service provider metadata XML for iDP autoconfiguration.
SamlController::sls public function Single Logout Service
SamlController::__construct public function Constructor for Drupal\samlauth\Controller\SamlController.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.