class CasServerConfig in CAS 8

Class CasServerConfig.

A value object that represents server configuration for the CAS server.

This object can is passed around in various CAS events, allowing modules to modify details about the default CAS server config if needed.

Hierarchy

• class \Drupal\cas\CasServerConfig

7 files declare their use of CasServerConfig

CasPreRedirectEvent.php in src/Event/CasPreRedirectEvent.php

CasPreValidateServerConfigEvent.php in src/Event/CasPreValidateServerConfigEvent.php

CasProxyHelper.php in src/Service/CasProxyHelper.php

CasRedirector.php in src/Service/CasRedirector.php

CasServerConfigTest.php in tests/src/Unit/CasServerConfigTest.php

... See full list

File

src/CasServerConfig.php, line 16

Namespace

Drupal\cas

class CasServerConfig {

  /**
   * The CAS protocol version to use when interacting with the CAS server.
   *
   * @var string
   */
  protected $protocolVersion;

  /**
   * The HTTP scheme to use for the CAS server.
   *
   * @var string
   */
  protected $httpScheme;

  /**
   * The HTTP hostname to use for the CAS server.
   *
   * @var string
   */
  protected $hostname;

  /**
   * The port number to use for the CAS server.
   *
   * @var int
   */
  protected $port;

  /**
   * The path where CAS can be interacted with on the CAS server.
   *
   * @var string
   */
  protected $path;

  /**
   * The cert verfication method to use when interacting with the CAS server.
   *
   * @var int
   */
  protected $verify;

  /**
   * The path to the CA root cert bundle to use when validating server SSL cert.
   *
   * @var string
   */
  protected $customRootCertBundlePath;

  /**
   * Number of seconds to wait on CAS server response during requests.
   *
   * @var int
   */
  protected $connectionTimeout;

  /**
   * Initialize an object from the CAS module config.
   *
   * @param \Drupal\Core\Config\Config $config
   *   The config object for the CAS module.
   *
   * @return \Drupal\cas\CasServerConfig
   *   The initialized value object.
   */
  public static function createFromModuleConfig(Config $config) {
    $obj = new self();
    $obj
      ->setProtocolVersion($config
      ->get('server.version'));
    $obj
      ->setHttpScheme($config
      ->get('server.protocol'));
    $obj
      ->setHostname($config
      ->get('server.hostname'));
    $obj
      ->setPort($config
      ->get('server.port'));
    $obj
      ->setPath($config
      ->get('server.path'));
    $obj
      ->setVerify($config
      ->get('server.verify'));
    $obj
      ->setCustomRootCertBundlePath($config
      ->get('server.cert'));
    $obj
      ->setConnectionTimeout($config
      ->get('advanced.connection_timeout'));
    return $obj;
  }

  /**
   * Set the protocol version.
   *
   * @param string $version
   *   The version.
   */
  public function setProtocolVersion($version) {
    $this->protocolVersion = $version;
  }

  /**
   * Get the protocol version.
   *
   * @return string
   *   The protocol version.
   */
  public function getProtocolVerison() {
    return $this->protocolVersion;
  }

  /**
   * Set the HTTP scheme.
   *
   * @param string $scheme
   *   The scheme.
   */
  public function setHttpScheme($scheme) {
    $this->httpScheme = $scheme;
  }

  /**
   * Get HTTP scheme.
   *
   * @return string
   *   The HTTP scheme.
   */
  public function getHttpScheme() {
    return $this->httpScheme;
  }

  /**
   * Set hostname.
   *
   * @param string $hostname
   *   The hostname.
   */
  public function setHostname($hostname) {
    $this->hostname = $hostname;
  }

  /**
   * Get hostname.
   *
   * @return string
   *   The hostname.
   */
  public function getHostname() {
    return $this->hostname;
  }

  /**
   * Set port.
   *
   * @param int $port
   *   The port.
   */
  public function setPort($port) {
    $this->port = $port;
  }

  /**
   * Get port.
   *
   * @return int
   *   The port.
   */
  public function getPort() {
    return $this->port;
  }

  /**
   * Set path.
   *
   * @param string $path
   *   The path.
   */
  public function setPath($path) {
    $this->path = $path;
  }

  /**
   * Get path.
   *
   * @return string
   *   The path.
   */
  public function getPath() {
    return $this->path;
  }

  /**
   * Set SSL cert verification method.
   *
   * @param int $verify
   *   The verification method.
   */
  public function setVerify($verify) {
    $this->verify = $verify;
  }

  /**
   * Get SSL cert verification method.
   *
   * @return int
   *   The SSL cert verification method.
   */
  public function getVerify() {
    return $this->verify;
  }

  /**
   * Set custom CA root cert bundle path.
   *
   * @param string $path
   *   The path.
   */
  public function setCustomRootCertBundlePath($path) {
    $this->customRootCertBundlePath = $path;
  }

  /**
   * Get custom CA root cert bundle path.
   *
   * @return string
   *   The path.
   */
  public function getCustomRootCertBundlePath() {
    return $this->customRootCertBundlePath;
  }

  /**
   * Set connection timeout.
   *
   * @param int $timeout
   *   The timeout.
   */
  public function setConnectionTimeout($timeout) {
    $this->connectionTimeout = $timeout;
  }

  /**
   * Get connection timeout.
   *
   * @return int
   *   The timeout.
   */
  public function getDirectConnectionTimeout() {
    return $this->connectionTimeout;
  }

  /**
   * Construct the base URL to the CAS server.
   *
   * @return string
   *   The base URL.
   */
  public function getServerBaseUrl() {
    $httpScheme = $this
      ->getHttpScheme();
    $url = $httpScheme . '://' . $this
      ->getHostname();

    // Only append port if it's non standard.
    $port = $this
      ->getPort();
    if ($httpScheme === 'http' && $port !== 80 || $httpScheme === 'https' && $port !== 443) {
      $url .= ':' . $port;
    }
    $url .= $this
      ->getPath();
    $url = rtrim($url, '/') . '/';
    return $url;
  }

  /**
   * Gets config data for guzzle communications with the CAS server.
   *
   * @return array
   *   The guzzle connection options.
   */
  public function getCasServerGuzzleConnectionOptions() {
    $options = [];
    $verify = $this
      ->getVerify();
    switch ($verify) {
      case CasHelper::CA_CUSTOM:
        $cert = $this
          ->getCustomRootCertBundlePath();
        $options['verify'] = $cert;
        break;
      case CasHelper::CA_NONE:
        $options['verify'] = FALSE;
        break;
      case CasHelper::CA_DEFAULT:
      default:
        $options['verify'] = TRUE;
    }
    $options['timeout'] = $this
      ->getDirectConnectionTimeout();
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CasServerConfig::$connectionTimeout	protected	property	Number of seconds to wait on CAS server response during requests.
CasServerConfig::$customRootCertBundlePath	protected	property	The path to the CA root cert bundle to use when validating server SSL cert.
CasServerConfig::$hostname	protected	property	The HTTP hostname to use for the CAS server.
CasServerConfig::$httpScheme	protected	property	The HTTP scheme to use for the CAS server.
CasServerConfig::$path	protected	property	The path where CAS can be interacted with on the CAS server.
CasServerConfig::$port	protected	property	The port number to use for the CAS server.
CasServerConfig::$protocolVersion	protected	property	The CAS protocol version to use when interacting with the CAS server.
CasServerConfig::$verify	protected	property	The cert verfication method to use when interacting with the CAS server.
CasServerConfig::createFromModuleConfig	public static	function	Initialize an object from the CAS module config.
CasServerConfig::getCasServerGuzzleConnectionOptions	public	function	Gets config data for guzzle communications with the CAS server.
CasServerConfig::getCustomRootCertBundlePath	public	function	Get custom CA root cert bundle path.
CasServerConfig::getDirectConnectionTimeout	public	function	Get connection timeout.
CasServerConfig::getHostname	public	function	Get hostname.
CasServerConfig::getHttpScheme	public	function	Get HTTP scheme.
CasServerConfig::getPath	public	function	Get path.
CasServerConfig::getPort	public	function	Get port.
CasServerConfig::getProtocolVerison	public	function	Get the protocol version.
CasServerConfig::getServerBaseUrl	public	function	Construct the base URL to the CAS server.
CasServerConfig::getVerify	public	function	Get SSL cert verification method.
CasServerConfig::setConnectionTimeout	public	function	Set connection timeout.
CasServerConfig::setCustomRootCertBundlePath	public	function	Set custom CA root cert bundle path.
CasServerConfig::setHostname	public	function	Set hostname.
CasServerConfig::setHttpScheme	public	function	Set the HTTP scheme.
CasServerConfig::setPath	public	function	Set path.
CasServerConfig::setPort	public	function	Set port.
CasServerConfig::setProtocolVersion	public	function	Set the protocol version.
CasServerConfig::setVerify	public	function	Set SSL cert verification method.