From 750813d487d01e34910c6e53de4eea90515c821f Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Thu, 7 Nov 2024 19:32:58 +0200 Subject: [PATCH 1/9] Initial commit.Added Processing Chain factory.Moved TicketFactory to Factories directory. --- public/login.php | 45 +++++-- public/proxy.php | 2 +- public/utility/validateTicket.php | 2 +- public/validate.php | 2 +- src/Cas/AttributeExtractor.php | 125 +++++++++++++----- src/Cas/Factories/ProcessingChainFactory.php | 49 +++++++ .../{Ticket => Factories}/TicketFactory.php | 2 +- src/Cas/TicketValidator.php | 8 +- tests/src/AttributeExtractorTest.php | 52 +++++--- 9 files changed, 211 insertions(+), 76 deletions(-) create mode 100644 src/Cas/Factories/ProcessingChainFactory.php rename src/Cas/{Ticket => Factories}/TicketFactory.php (98%) diff --git a/public/login.php b/public/login.php index 94f664f6..87db9753 100644 --- a/public/login.php +++ b/public/login.php @@ -30,6 +30,7 @@ declare(strict_types=1); +use SimpleSAML\Auth\Simple; use SimpleSAML\Configuration; use SimpleSAML\Locale\Language; use SimpleSAML\Logger; @@ -44,8 +45,8 @@ $forceAuthn = isset($_GET['renew']) && $_GET['renew']; $isPassive = isset($_GET['gateway']) && $_GET['gateway']; -// Determine if client wants us to post or redirect the response. Default is redirect. -$redirect = !(isset($_GET['method']) && 'POST' === $_GET['method']); +// Determine if the client wants us to post or redirect the response. Default is redirect. +$redirect = !(isset($_GET['method']) && $_GET['method'] === 'POST'); $casconfig = Configuration::getConfig('module_casserver.php'); $serviceValidator = new ServiceValidator($casconfig); @@ -66,9 +67,6 @@ } } - -$as = new \SimpleSAML\Auth\Simple($casconfig->getValue('authsource')); - if (array_key_exists('scope', $_GET) && is_string($_GET['scope'])) { $scopes = $casconfig->getOptionalValue('scopes', []); @@ -87,16 +85,34 @@ Language::setLanguageCookie($_GET['language']); } +/** Initializations */ + +// AuthSource Simple +$as = new Simple($casconfig->getValue('authsource')); + +// Ticket Store $ticketStoreConfig = $casconfig->getOptionalValue('ticketstore', ['class' => 'casserver:FileSystemTicketStore']); $ticketStoreClass = Module::resolveClass($ticketStoreConfig['class'], 'Cas\Ticket'); /** @var $ticketStore TicketStore */ /** @psalm-suppress InvalidStringClass */ $ticketStore = new $ticketStoreClass($casconfig); -$ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Ticket'); +// Ticket Factory +$ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Factories'); /** @var $ticketFactory TicketFactory */ /** @psalm-suppress InvalidStringClass */ $ticketFactory = new $ticketFactoryClass($casconfig); + +// Processing Chain Factory +$processingChaingFactoryClass = Module::resolveClass('casserver:ProcessingChainFactory', 'Cas\Factories'); +/** @var $processingChainFactory ProcessingChainFactory */ +/** @psalm-suppress InvalidStringClass */ +$processingChainFactory = new $processingChaingFactoryClass($casconfig); + +// Attribute Extractor +$attributeExtractor = new AttributeExtractor($casconfig, $processingChainFactory); + +// HTTP Utils $httpUtils = new Utils\HTTP(); $session = Session::getSessionFromRequest(); @@ -177,10 +193,8 @@ if (isset($oldLanguagePreferred)) { $parameters['language'] = $oldLanguagePreferred; - } else { - if (is_string($_GET['language'])) { - $parameters['language'] = $_GET['language']; - } + } elseif (is_string($_GET['language'])) { + $parameters['language'] = $_GET['language']; } } @@ -188,8 +202,7 @@ $defaultTicketName = isset($_GET['service']) ? 'ticket' : 'SAMLart'; $ticketName = $casconfig->getOptionalValue('ticketName', $defaultTicketName); - $attributeExtractor = new AttributeExtractor(); - $mappedAttributes = $attributeExtractor->extractUserAndAttributes($as->getAttributes(), $casconfig); + $mappedAttributes = $attributeExtractor->extractUserAndAttributes($as->getAttributes()); $serviceTicket = $ticketFactory->createServiceTicket([ 'service' => $serviceUrl, @@ -207,7 +220,7 @@ $validDebugModes = ['true', 'samlValidate']; if ( array_key_exists('debugMode', $_GET) && - in_array($_GET['debugMode'], $validDebugModes) && + in_array($_GET['debugMode'], $validDebugModes, true) && $casconfig->getOptionalBoolean('debugMode', false) ) { if ($_GET['debugMode'] === 'samlValidate') { @@ -229,7 +242,11 @@ } elseif ($redirect) { $httpUtils->redirectTrustedURL($httpUtils->addURLParameters($serviceUrl, $parameters)); } else { - $httpUtils->submitPOSTData($serviceUrl, $parameters); + try { + $httpUtils->submitPOSTData($serviceUrl, $parameters); + } catch (\SimpleSAML\Error\Exception $e) { + + } } } else { $httpUtils->redirectTrustedURL( diff --git a/public/proxy.php b/public/proxy.php index adb0e32e..ae4182f2 100644 --- a/public/proxy.php +++ b/public/proxy.php @@ -47,7 +47,7 @@ /** @psalm-suppress InvalidStringClass */ $ticketStore = new $ticketStoreClass($casconfig); - $ticketFactoryClass = \SimpleSAML\Module::resolveClass('casserver:TicketFactory', 'Cas\Ticket'); + $ticketFactoryClass = \SimpleSAML\Module::resolveClass('casserver:TicketFactory', 'Cas\Factories'); /** @psalm-suppress InvalidStringClass */ $ticketFactory = new $ticketFactoryClass($casconfig); diff --git a/public/utility/validateTicket.php b/public/utility/validateTicket.php index 4ab4d200..0d639d26 100644 --- a/public/utility/validateTicket.php +++ b/public/utility/validateTicket.php @@ -61,7 +61,7 @@ /** @psalm-suppress InvalidStringClass */ $ticketStore = new $ticketStoreClass($casconfig); - $ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Ticket'); + $ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Factories'); /** @var TicketFactory $ticketFactory */ /** @psalm-suppress InvalidStringClass */ $ticketFactory = new $ticketFactoryClass($casconfig); diff --git a/public/validate.php b/public/validate.php index 3f28be59..cb073253 100644 --- a/public/validate.php +++ b/public/validate.php @@ -51,7 +51,7 @@ /** @psalm-suppress InvalidStringClass */ $ticketStore = new $ticketStoreClass($casconfig); - $ticketFactoryClass = \SimpleSAML\Module::resolveClass('casserver:TicketFactory', 'Cas\Ticket'); + $ticketFactoryClass = \SimpleSAML\Module::resolveClass('casserver:TicketFactory', 'Cas\Factories'); /** @psalm-suppress InvalidStringClass */ $ticketFactory = new $ticketFactoryClass($casconfig); diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index 2883b874..48976e5f 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -5,14 +5,32 @@ namespace SimpleSAML\Module\casserver\Cas; use SimpleSAML\Auth; +use SimpleSAML\Auth\ProcessingChain; use SimpleSAML\Configuration; +use SimpleSAML\Error\Exception; +use SimpleSAML\Error\NoState; use SimpleSAML\Module; +use SimpleSAML\Module\casserver\Cas\Factories\ProcessingChainFactory; /** * Extract the user and any mapped attributes from the AuthSource attributes */ class AttributeExtractor { + /** @var Configuration */ + private readonly Configuration $casconfig; + + /** @var ProcessingChainFactory */ + private readonly ProcessingChainFactory $processingChainFactory; + + public function __construct( + Configuration $casconfig, + ProcessingChainFactory $processingChainFactory + ) { + $this->casconfig = $casconfig; + $this->processingChainFactory = $processingChainFactory; + } + /** * Determine the user and any CAS attributes based on the attributes from the * authsource and the CAS configuration. @@ -24,32 +42,34 @@ class AttributeExtractor * // any attributes * ] * - * If no CAS attributes are configured then the attributes array is empty - * @param array $attributes - * @param \SimpleSAML\Configuration $casconfig + * If no CAS attributes are configured, then the attributes' array is empty + * + * @param array $attributes + * * @return array + * @throws \Exception */ - public function extractUserAndAttributes(array $attributes, Configuration $casconfig): array + public function extractUserAndAttributes(array $attributes): array { - if ($casconfig->hasValue('authproc')) { - $attributes = $this->invokeAuthProc($attributes, $casconfig); + if ($this->casconfig->hasValue('authproc')) { + $attributes = $this->runAuthProcs($attributes); } - $casUsernameAttribute = $casconfig->getOptionalValue('attrname', 'eduPersonPrincipalName'); + $casUsernameAttribute = $this->casconfig->getOptionalValue('attrname', 'eduPersonPrincipalName'); $userName = $attributes[$casUsernameAttribute][0]; if (empty($userName)) { throw new \Exception("No cas user defined for attribute $casUsernameAttribute"); } - if ($casconfig->getOptionalValue('attributes', true)) { - $attributesToTransfer = $casconfig->getOptionalValue('attributes_to_transfer', []); + if ($this->casconfig->getOptionalValue('attributes', true)) { + $attributesToTransfer = $this->casconfig->getOptionalValue('attributes_to_transfer', []); if (sizeof($attributesToTransfer) > 0) { $casAttributes = []; foreach ($attributesToTransfer as $key) { - if (array_key_exists($key, $attributes)) { + if (\array_key_exists($key, $attributes)) { $casAttributes[$key] = $attributes[$key]; } } @@ -66,35 +86,74 @@ public function extractUserAndAttributes(array $attributes, Configuration $casco ]; } + /** + * Run authproc filters with the processing chain + * Creating the ProcessingChain require metadata. + * - For the idp metadata use the OIDC issuer as the entityId (and the authprocs from the main config file) + * - For the sp metadata use the client id as the entityId (and don’t set authprocs). + * + * @param array $state + * + * @return void + * @throws Exception + * @throws Error\UnserializableException + * @throws \Exception + */ + protected function runAuthProcs(array &$state): void + { + $filters = $this->casconfig->getOptionalArray('authproc', []); + $idpMetadata = [ + 'entityid' => $state['Source']['entityid'] ?? '', + // ProcessChain needs to know the list of authproc filters we defined in module_oidc configuration + 'authproc' => $filters, + ]; + $spMetadata = [ + 'entityid' => $state['Destination']['entityid'] ?? '', + ]; + + $state['ReturnURL'] = Module::getModuleURL('casserver/login.php'); + $state['Destination'] = $spMetadata; + $state['Source'] = $idpMetadata; + + $this->processingChainFactory->build($state)->processState($state); + } /** - * Process any authproc filters defined in the configuration. The Authproc filters must only - * rely on 'Attributes' being available and not on additional SAML state. - * @see \SimpleSAML_Auth_ProcessingChain::parseFilter() For the original, SAML side implementation - * @param array $attributes The current attributes - * @param \SimpleSAML\Configuration $casconfig The cas configuration - * @return array The attributes post processing. + * This is a wrapper around Auth/State::loadState that facilitates testing by + * hiding the static method + * + * @param array $queryParameters + * + * @return array|null + * @throws NoState */ - private function invokeAuthProc(array $attributes, Configuration $casconfig): array + public function manageState(array $queryParameters): ?array { - $filters = $casconfig->getOptionalArray('authproc', []); + if (empty($queryParameters[ProcessingChain::AUTHPARAM])) { + throw new NoState(); + } - $state = [ - 'Attributes' => $attributes, - ]; - foreach ($filters as $config) { - $className = Module::resolveClass( - $config['class'], - 'Auth\Process', - Auth\ProcessingFilter::class, - ); - // Unset 'class' to prevent the filter from interpreting it as an option - unset($config['class']); - /** @psalm-suppress InvalidStringClass */ - $filter = new $className($config, null); - $filter->process($state); + $stateId = (string)$queryParameters[ProcessingChain::AUTHPARAM]; + $state = $this->loadState($stateId, ProcessingChain::COMPLETED_STAGE); + + if (!empty($state['authSourceId'])) { + $this->authSourceId = (string)$state['authSourceId']; + unset($state['authSourceId']); } - return $state['Attributes']; + return $state; + } + + /** + * @param string $id + * @param string $stage + * @param bool $allowMissing + * + * @return array|null + * @throws \SimpleSAML\Error\NoState + */ + public function loadState(string $id, string $stage, bool $allowMissing = false): ?array + { + return $this->authState::loadState($id, $stage, $allowMissing); } } diff --git a/src/Cas/Factories/ProcessingChainFactory.php b/src/Cas/Factories/ProcessingChainFactory.php new file mode 100644 index 00000000..11f48918 --- /dev/null +++ b/src/Cas/Factories/ProcessingChainFactory.php @@ -0,0 +1,49 @@ +casconfig = $casconfig; + } + + /** + * @codeCoverageIgnore + * @throws \Exception + */ + public function build(array $state): ProcessingChain + { + $idpMetadata = [ + 'entityid' => $state['Source']['entityid'] ?? '', + // ProcessChain needs to know the list of authproc filters we defined in casserver configuration + 'authproc' => $this->casconfig->getOptionalArray('authproc', []), + ]; + $spMetadata = [ + 'entityid' => $state['Destination']['entityid'] ?? '', + ]; + + return new ProcessingChain( + $idpMetadata, + $spMetadata, + 'casserver', + ); + } +} \ No newline at end of file diff --git a/src/Cas/Ticket/TicketFactory.php b/src/Cas/Factories/TicketFactory.php similarity index 98% rename from src/Cas/Ticket/TicketFactory.php rename to src/Cas/Factories/TicketFactory.php index 4a1f4f2b..f40cbeb5 100644 --- a/src/Cas/Ticket/TicketFactory.php +++ b/src/Cas/Factories/TicketFactory.php @@ -23,7 +23,7 @@ declare(strict_types=1); -namespace SimpleSAML\Module\casserver\Cas\Ticket; +namespace SimpleSAML\Module\casserver\Cas\Factories; use SimpleSAML\Configuration; use SimpleSAML\XML\Utils\Random; diff --git a/src/Cas/TicketValidator.php b/src/Cas/TicketValidator.php index d854d267..11101845 100644 --- a/src/Cas/TicketValidator.php +++ b/src/Cas/TicketValidator.php @@ -10,7 +10,7 @@ use SimpleSAML\Logger; use SimpleSAML\Module; use SimpleSAML\Module\casserver\Cas\CasException; -use SimpleSAML\Module\casserver\Cas\Ticket\TicketFactory; +use SimpleSAML\Module\casserver\Cas\Factories\TicketFactory; use SimpleSAML\Module\casserver\Cas\Ticket\TicketStore; class TicketValidator @@ -21,7 +21,7 @@ class TicketValidator /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore */ private TicketStore $ticketStore; - /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketFactory */ + /** @var \SimpleSAML\Module\casserver\Cas\Factories\TicketFactory */ private TicketFactory $ticketFactory; @@ -42,10 +42,10 @@ public function __construct(Configuration $casconfig) * @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore */ $this->ticketStore = new $ticketStoreClass($casconfig); - $ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Ticket'); + $ticketFactoryClass = Module::resolveClass('casserver:TicketFactory', 'Cas\Factories'); /** * @psalm-suppress InvalidStringClass - * @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketFactory + * @var \SimpleSAML\Module\casserver\Cas\Factories\TicketFactory */ $this->ticketFactory = new $ticketFactoryClass($casconfig); } diff --git a/tests/src/AttributeExtractorTest.php b/tests/src/AttributeExtractorTest.php index 0ae8d659..0ea60690 100644 --- a/tests/src/AttributeExtractorTest.php +++ b/tests/src/AttributeExtractorTest.php @@ -7,6 +7,7 @@ use PHPUnit\Framework\TestCase; use SimpleSAML\Configuration; use SimpleSAML\Module\casserver\Cas\AttributeExtractor; +use SimpleSAML\Module\casserver\Cas\Factories\ProcessingChainFactory; class AttributeExtractorTest extends TestCase { @@ -23,12 +24,14 @@ public function testNoCasConfig(): void 'eduPersonPrincipalName' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; - $attributeExtractor = new AttributeExtractor(); - $result = $attributeExtractor->extractUserAndAttributes( - $attributes, - Configuration::loadFromArray($casConfig), + $loadedConfig = Configuration::loadFromArray($casConfig); + $attributeExtractor = new AttributeExtractor( + $loadedConfig, + new ProcessingChainFactory($loadedConfig) ); + $result = $attributeExtractor->extractUserAndAttributes($attributes); + $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals($attributes, $result['attributes']); } @@ -47,12 +50,14 @@ public function testNoAttributeCopying(): void 'eduPersonPrincipalName' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; - $attributeExtractor = new AttributeExtractor(); - $result = $attributeExtractor->extractUserAndAttributes( - $attributes, - Configuration::loadFromArray($casConfig), + $loadedConfig = Configuration::loadFromArray($casConfig); + $attributeExtractor = new AttributeExtractor( + $loadedConfig, + new ProcessingChainFactory($loadedConfig) ); + $result = $attributeExtractor->extractUserAndAttributes($attributes); + $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals([], $result['attributes']); } @@ -75,12 +80,14 @@ public function testCustomAttributeCopy(): void 'userNameAttribute' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; - $attributeExtractor = new AttributeExtractor(); - $result = $attributeExtractor->extractUserAndAttributes( - $attributes, - Configuration::loadFromArray($casConfig), + $loadedConfig = Configuration::loadFromArray($casConfig); + $attributeExtractor = new AttributeExtractor( + $loadedConfig, + new ProcessingChainFactory($loadedConfig) ); + $result = $attributeExtractor->extractUserAndAttributes($attributes); + $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals(['additionalAttribute' => ['Taco Club']], $result['attributes']); } @@ -100,12 +107,14 @@ public function testEmptyAuthproc(): void 'additionalAttribute' => ['Taco Club'], 'authproc' => [], ]; - $attributeExtractor = new AttributeExtractor(); - $result = $attributeExtractor->extractUserAndAttributes( - $attributes, - Configuration::loadFromArray($casConfig), + $loadedConfig = Configuration::loadFromArray($casConfig); + $attributeExtractor = new AttributeExtractor( + $loadedConfig, + new ProcessingChainFactory($loadedConfig) ); + $result = $attributeExtractor->extractUserAndAttributes($attributes); + $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals($attributes, $result['attributes']); } @@ -138,12 +147,13 @@ public function testAuthprocConfig(): void 'urn:example' => ['Taco Club'], 'not-affected-by-authproc' => ['Value'], ]; - $attributeExtractor = new AttributeExtractor(); - // The authproc filters will remap the attributes prior to mapping them to CAS attributes - $result = $attributeExtractor->extractUserAndAttributes( - $attributes, - Configuration::loadFromArray($casConfig), + $loadedConfig = Configuration::loadFromArray($casConfig); + $attributeExtractor = new AttributeExtractor( + $loadedConfig, + new ProcessingChainFactory($loadedConfig) ); + // The authproc filters will remap the attributes prior to mapping them to CAS attributes + $result = $attributeExtractor->extractUserAndAttributes($attributes); $expectedAttributes = [ 'additionalAttribute' => ['Taco Club'], From b1152c6d6c0be76302ab1d9805a23dcb93c92e86 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Fri, 8 Nov 2024 13:00:20 +0200 Subject: [PATCH 2/9] Get state from authsource and pass it to extract user attributes --- public/login.php | 114 ++++++++++++++++++--------------- src/Cas/AttributeExtractor.php | 11 ++-- 2 files changed, 68 insertions(+), 57 deletions(-) diff --git a/public/login.php b/public/login.php index 87db9753..e62c7ebe 100644 --- a/public/login.php +++ b/public/login.php @@ -47,12 +47,11 @@ $isPassive = isset($_GET['gateway']) && $_GET['gateway']; // Determine if the client wants us to post or redirect the response. Default is redirect. $redirect = !(isset($_GET['method']) && $_GET['method'] === 'POST'); +$serviceUrl = $_GET['service'] ?? $_GET['TARGET'] ?? null; $casconfig = Configuration::getConfig('module_casserver.php'); $serviceValidator = new ServiceValidator($casconfig); -$serviceUrl = $_GET['service'] ?? $_GET['TARGET'] ?? null; - if (isset($serviceUrl)) { $serviceCasConfig = $serviceValidator->checkServiceURL(sanitize($serviceUrl)); if (isset($serviceCasConfig)) { @@ -198,58 +197,67 @@ } } -if (isset($serviceUrl)) { - $defaultTicketName = isset($_GET['service']) ? 'ticket' : 'SAMLart'; - $ticketName = $casconfig->getOptionalValue('ticketName', $defaultTicketName); - - $mappedAttributes = $attributeExtractor->extractUserAndAttributes($as->getAttributes()); - - $serviceTicket = $ticketFactory->createServiceTicket([ - 'service' => $serviceUrl, - 'forceAuthn' => $forceAuthn, - 'userName' => $mappedAttributes['user'], - 'attributes' => $mappedAttributes['attributes'], - 'proxies' => [], - 'sessionId' => $sessionTicket['id'], - ]); - - $ticketStore->addTicket($serviceTicket); - - $parameters[$ticketName] = $serviceTicket['id']; - - $validDebugModes = ['true', 'samlValidate']; - if ( - array_key_exists('debugMode', $_GET) && - in_array($_GET['debugMode'], $validDebugModes, true) && - $casconfig->getOptionalBoolean('debugMode', false) - ) { - if ($_GET['debugMode'] === 'samlValidate') { - $samlValidate = new SamlValidateResponder(); - $samlResponse = $samlValidate->convertToSaml($serviceTicket); - $soap = $samlValidate->wrapInSoap($samlResponse); - echo '
' . htmlspecialchars(strval($soap)) . '
'; - } else { - $method = 'serviceValidate'; - // Fake some options for validateTicket - $_GET[$ticketName] = $serviceTicket['id']; - // We want to capture the output from echo used in validateTicket - ob_start(); - require_once 'utility/validateTicket.php'; - $casResponse = ob_get_contents(); - ob_end_clean(); - echo '
' . htmlspecialchars($casResponse) . '
'; - } - } elseif ($redirect) { - $httpUtils->redirectTrustedURL($httpUtils->addURLParameters($serviceUrl, $parameters)); - } else { - try { - $httpUtils->submitPOSTData($serviceUrl, $parameters); - } catch (\SimpleSAML\Error\Exception $e) { - - } - } -} else { +// I am already logged in. Redirect to the logged in endpoint +if(!isset($serviceUrl)) { + // LOGGED IN $httpUtils->redirectTrustedURL( $httpUtils->addURLParameters(Module::getModuleURL('casserver/loggedIn.php'), $parameters), ); } + + + +$defaultTicketName = isset($_GET['service']) ? 'ticket' : 'SAMLart'; +$ticketName = $casconfig->getOptionalValue('ticketName', $defaultTicketName); + +$mappedAttributes = $attributeExtractor->extractUserAndAttributes($as->getAuthDataArray()); + +$serviceTicket = $ticketFactory->createServiceTicket([ + 'service' => $serviceUrl, + 'forceAuthn' => $forceAuthn, + 'userName' => $mappedAttributes['user'], + 'attributes' => $mappedAttributes['attributes'], + 'proxies' => [], + 'sessionId' => $sessionTicket['id'], + ]); + +$ticketStore->addTicket($serviceTicket); + +$parameters[$ticketName] = $serviceTicket['id']; + +$validDebugModes = ['true', 'samlValidate']; + +// DEBUG MODE +if ( + array_key_exists('debugMode', $_GET) && + in_array($_GET['debugMode'], $validDebugModes, true) && + $casconfig->getOptionalBoolean('debugMode', false) +) { + if ($_GET['debugMode'] === 'samlValidate') { + $samlValidate = new SamlValidateResponder(); + $samlResponse = $samlValidate->convertToSaml($serviceTicket); + $soap = $samlValidate->wrapInSoap($samlResponse); + echo '
' . htmlspecialchars(strval($soap)) . '
'; + } else { + $method = 'serviceValidate'; + // Fake some options for validateTicket + $_GET[$ticketName] = $serviceTicket['id']; + // We want to capture the output from echo used in validateTicket + ob_start(); + require_once 'utility/validateTicket.php'; + $casResponse = ob_get_contents(); + ob_end_clean(); + echo '
' . htmlspecialchars($casResponse) . '
'; + } +} elseif ($redirect) { + // GET + $httpUtils->redirectTrustedURL($httpUtils->addURLParameters($serviceUrl, $parameters)); +} else { + // POST + try { + $httpUtils->submitPOSTData($serviceUrl, $parameters); + } catch (\SimpleSAML\Error\Exception $e) { + // somehting happened + var_export($e, true); + } +} diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index 48976e5f..74000920 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -44,17 +44,20 @@ public function __construct( * * If no CAS attributes are configured, then the attributes' array is empty * - * @param array $attributes + * @param array|null $state * * @return array - * @throws \Exception + * @throws Exception */ - public function extractUserAndAttributes(array $attributes): array + public function extractUserAndAttributes(?array $state): array { if ($this->casconfig->hasValue('authproc')) { - $attributes = $this->runAuthProcs($attributes); + $this->runAuthProcs($state); } + // Get the attributes from the state + $attributes = $state['Attributes']; + $casUsernameAttribute = $this->casconfig->getOptionalValue('attrname', 'eduPersonPrincipalName'); $userName = $attributes[$casUsernameAttribute][0]; From 9d49f92d3770b39e29635cf97701185a8dd87ae3 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Fri, 8 Nov 2024 18:30:38 +0200 Subject: [PATCH 3/9] Add processing chain query parameter handling. --- public/login.php | 17 +++++++++++++++-- src/Cas/AttributeExtractor.php | 14 +++++++++----- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/public/login.php b/public/login.php index e62c7ebe..f29a1ae2 100644 --- a/public/login.php +++ b/public/login.php @@ -30,6 +30,7 @@ declare(strict_types=1); +use SimpleSAML\Auth\ProcessingChain; use SimpleSAML\Auth\Simple; use SimpleSAML\Configuration; use SimpleSAML\Locale\Language; @@ -45,6 +46,7 @@ $forceAuthn = isset($_GET['renew']) && $_GET['renew']; $isPassive = isset($_GET['gateway']) && $_GET['gateway']; +$authProcId = $_GET[ProcessingChain::AUTHPARAM] ?? null; // Determine if the client wants us to post or redirect the response. Default is redirect. $redirect = !(isset($_GET['method']) && $_GET['method'] === 'POST'); $serviceUrl = $_GET['service'] ?? $_GET['TARGET'] ?? null; @@ -210,7 +212,18 @@ $defaultTicketName = isset($_GET['service']) ? 'ticket' : 'SAMLart'; $ticketName = $casconfig->getOptionalValue('ticketName', $defaultTicketName); -$mappedAttributes = $attributeExtractor->extractUserAndAttributes($as->getAuthDataArray()); +// Get the state. If we come from an authproc filter we will load the state from +// the stateId. If not we will get the state from the AuthSource Data +try { + $state = $authProcId !== null ? + $attributeExtractor->manageState($authProcId) : + $as->getAuthDataArray(); +} catch (\SimpleSAML\Error\NoState $e) { + var_export($e, true); + die(); +} +// Attribute Handler +$mappedAttributes = $attributeExtractor->extractUserAndAttributes($state); $serviceTicket = $ticketFactory->createServiceTicket([ 'service' => $serviceUrl, @@ -257,7 +270,7 @@ try { $httpUtils->submitPOSTData($serviceUrl, $parameters); } catch (\SimpleSAML\Error\Exception $e) { - // somehting happened var_export($e, true); + die(); } } diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index 74000920..328338c7 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -23,6 +23,11 @@ class AttributeExtractor /** @var ProcessingChainFactory */ private readonly ProcessingChainFactory $processingChainFactory; + /** + * ID of the Authentication Source used during authn. + */ + private ?string $authSourceId = null; + public function __construct( Configuration $casconfig, ProcessingChainFactory $processingChainFactory @@ -125,18 +130,17 @@ protected function runAuthProcs(array &$state): void * This is a wrapper around Auth/State::loadState that facilitates testing by * hiding the static method * - * @param array $queryParameters + * @param string $stateId * * @return array|null * @throws NoState */ - public function manageState(array $queryParameters): ?array + public function manageState(string $stateId): ?array { - if (empty($queryParameters[ProcessingChain::AUTHPARAM])) { + if (empty($stateId)) { throw new NoState(); } - $stateId = (string)$queryParameters[ProcessingChain::AUTHPARAM]; $state = $this->loadState($stateId, ProcessingChain::COMPLETED_STAGE); if (!empty($state['authSourceId'])) { @@ -155,7 +159,7 @@ public function manageState(array $queryParameters): ?array * @return array|null * @throws \SimpleSAML\Error\NoState */ - public function loadState(string $id, string $stage, bool $allowMissing = false): ?array + protected function loadState(string $id, string $stage, bool $allowMissing = false): ?array { return $this->authState::loadState($id, $stage, $allowMissing); } From a0c558d903f2ee24f4da45595cae10dd872961c9 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Sat, 9 Nov 2024 20:59:47 +0200 Subject: [PATCH 4/9] Fix ProcessingChaing redirect request handling. --- public/login.php | 68 ++++++++++++---------------------- public/utility/urlUtils.php | 50 +++++++++++++++++++++++++ src/Cas/AttributeExtractor.php | 14 +++++-- 3 files changed, 84 insertions(+), 48 deletions(-) diff --git a/public/login.php b/public/login.php index f29a1ae2..c62f62d5 100644 --- a/public/login.php +++ b/public/login.php @@ -119,45 +119,16 @@ $sessionTicket = $ticketStore->getTicket($session->getSessionId()); $sessionRenewId = $sessionTicket ? $sessionTicket['renewId'] : null; -$requestRenewId = isset($_REQUEST['renewId']) ? $_REQUEST['renewId'] : null; - -if (!$as->isAuthenticated() || ($forceAuthn && $sessionRenewId != $requestRenewId)) { - $query = []; - - if ($sessionRenewId && $forceAuthn) { - $query['renewId'] = $sessionRenewId; - } - - if (isset($_REQUEST['service'])) { - $query['service'] = $_REQUEST['service']; - } - - if (isset($_REQUEST['TARGET'])) { - $query['TARGET'] = $_REQUEST['TARGET']; - } - - if (isset($_REQUEST['method'])) { - $query['method'] = $_REQUEST['method']; - } - - if (isset($_REQUEST['renew'])) { - $query['renew'] = $_REQUEST['renew']; - } - - if (isset($_REQUEST['gateway'])) { - $query['gateway'] = $_REQUEST['gateway']; - } - - if (array_key_exists('language', $_GET)) { - $query['language'] = is_string($_GET['language']) ? $_GET['language'] : null; - } - - if (isset($_REQUEST['debugMode'])) { - $query['debugMode'] = $_REQUEST['debugMode']; - } - - $returnUrl = $httpUtils->getSelfURLNoQuery() . '?' . http_build_query($query); +$requestRenewId = $_REQUEST['renewId'] ?? null; +// Parse the query parameters and return them in an array +$query = parseQueryParameters($sessionTicket); +// Construct the ReturnTo URL +$returnUrl = $httpUtils->getSelfURLNoQuery() . '?' . http_build_query($query); +// Authenticate +if ( + !$as->isAuthenticated() || ($forceAuthn && $sessionRenewId != $requestRenewId) +) { $params = [ 'ForceAuthn' => $forceAuthn, 'isPassive' => $isPassive, @@ -183,7 +154,6 @@ if (!is_array($sessionTicket) || $forceAuthn) { $sessionTicket = $ticketFactory->createSessionTicket($session->getSessionId(), $sessionExpiry); - $ticketStore->addTicket($sessionTicket); } @@ -200,20 +170,19 @@ } // I am already logged in. Redirect to the logged in endpoint -if(!isset($serviceUrl)) { +if(!isset($serviceUrl) && $authProcId === null) { // LOGGED IN $httpUtils->redirectTrustedURL( $httpUtils->addURLParameters(Module::getModuleURL('casserver/loggedIn.php'), $parameters), ); } - - $defaultTicketName = isset($_GET['service']) ? 'ticket' : 'SAMLart'; $ticketName = $casconfig->getOptionalValue('ticketName', $defaultTicketName); -// Get the state. If we come from an authproc filter we will load the state from -// the stateId. If not we will get the state from the AuthSource Data +// Get the state. +// If we come from an authproc filter, we will load the state from the stateId. +// If not, we will get the state from the AuthSource Data try { $state = $authProcId !== null ? $attributeExtractor->manageState($authProcId) : @@ -223,7 +192,16 @@ die(); } // Attribute Handler -$mappedAttributes = $attributeExtractor->extractUserAndAttributes($state); +$state['ReturnTo'] = $returnUrl; +if($authProcId !== null) { + $state[ProcessingChain::AUTHPARAM] = $authProcId; +} +try { + $mappedAttributes = $attributeExtractor->extractUserAndAttributes($state); +} catch (\SimpleSAML\Error\Exception $e) { + var_export($e, true); + die(); +} $serviceTicket = $ticketFactory->createServiceTicket([ 'service' => $serviceUrl, diff --git a/public/utility/urlUtils.php b/public/utility/urlUtils.php index 4ffe54fa..0ed7c992 100644 --- a/public/utility/urlUtils.php +++ b/public/utility/urlUtils.php @@ -51,3 +51,53 @@ function sanitize(string $parameter): string { return TicketValidator::sanitize($parameter); } + + +/** + * Parse the query Parameters from $_GET global and return them in an array. + * + * @param array|null $sessionTicket + * + * @return array + */ +function parseQueryParameters(?array $sessionTicket): array +{ + $forceAuthn = isset($_GET['renew']) && $_GET['renew']; + $sessionRenewId = $sessionTicket ? $sessionTicket['renewId'] : null; + + $query = []; + + if ($sessionRenewId && $forceAuthn) { + $query['renewId'] = $sessionRenewId; + } + + if (isset($_REQUEST['service'])) { + $query['service'] = $_REQUEST['service']; + } + + if (isset($_REQUEST['TARGET'])) { + $query['TARGET'] = $_REQUEST['TARGET']; + } + + if (isset($_REQUEST['method'])) { + $query['method'] = $_REQUEST['method']; + } + + if (isset($_REQUEST['renew'])) { + $query['renew'] = $_REQUEST['renew']; + } + + if (isset($_REQUEST['gateway'])) { + $query['gateway'] = $_REQUEST['gateway']; + } + + if (array_key_exists('language', $_GET)) { + $query['language'] = is_string($_GET['language']) ? $_GET['language'] : null; + } + + if (isset($_REQUEST['debugMode'])) { + $query['debugMode'] = $_REQUEST['debugMode']; + } + + return $query; +} diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index 328338c7..bed9d96b 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -4,8 +4,8 @@ namespace SimpleSAML\Module\casserver\Cas; -use SimpleSAML\Auth; use SimpleSAML\Auth\ProcessingChain; +use SimpleSAML\Auth\State; use SimpleSAML\Configuration; use SimpleSAML\Error\Exception; use SimpleSAML\Error\NoState; @@ -23,6 +23,9 @@ class AttributeExtractor /** @var ProcessingChainFactory */ private readonly ProcessingChainFactory $processingChainFactory; + /** @var State */ + private State $authState; + /** * ID of the Authentication Source used during authn. */ @@ -34,6 +37,7 @@ public function __construct( ) { $this->casconfig = $casconfig; $this->processingChainFactory = $processingChainFactory; + $this->authState = new State(); } /** @@ -56,7 +60,10 @@ public function __construct( */ public function extractUserAndAttributes(?array $state): array { - if ($this->casconfig->hasValue('authproc')) { + if ( + !isset($state[ProcessingChain::AUTHPARAM]) + && $this->casconfig->hasValue('authproc') + ) { $this->runAuthProcs($state); } @@ -119,7 +126,8 @@ protected function runAuthProcs(array &$state): void 'entityid' => $state['Destination']['entityid'] ?? '', ]; - $state['ReturnURL'] = Module::getModuleURL('casserver/login.php'); + // Get the ReturnTo from the state or fallback to the login page + $state['ReturnURL'] = $state['ReturnTo'] ?? Module::getModuleURL('casserver/login.php'); $state['Destination'] = $spMetadata; $state['Source'] = $idpMetadata; From 4e03081d8841e1a7fb91e30b694425d3d247ba15 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Thu, 14 Nov 2024 21:33:55 +0200 Subject: [PATCH 5/9] Fixed unit tests and phpcs --- composer.json | 15 +- phpcs.xml | 3 + phpunit.xml | 7 +- public/login.php | 4 +- src/Cas/AttributeExtractor.php | 1 - src/Cas/Factories/ProcessingChainFactory.php | 2 +- src/Cas/Protocol/SamlValidateResponder.php | 8 +- tests/config/config.php | 11 + tests/config/jwks-cert.pem | 12 + tests/config/jwks-key.pem | 10 + tests/config/ssp2_3-config.php | 1301 ++++++++++++++++++ tests/public/LoginIntegrationTest.php | 26 +- tests/resources/xml/testValidServiceUrl.xml | 5 +- tests/src/AttributeExtractorTest.php | 34 +- tests/src/Cas/Protocol/Cas20Test.php | 14 +- tests/src/Cas/Protocol/SamlValidateTest.php | 48 +- 16 files changed, 1446 insertions(+), 55 deletions(-) create mode 100644 tests/config/config.php create mode 100644 tests/config/jwks-cert.pem create mode 100644 tests/config/jwks-key.pem create mode 100644 tests/config/ssp2_3-config.php diff --git a/composer.json b/composer.json index c87a0179..6c769fe4 100644 --- a/composer.json +++ b/composer.json @@ -14,7 +14,8 @@ "composer/package-versions-deprecated": true, "simplesamlphp/composer-module-installer": true, "dealerdirect/phpcodesniffer-composer-installer": true, - "phpstan/extension-installer": true + "phpstan/extension-installer": true, + "simplesamlphp/composer-xmlprovider-installer": true } }, "autoload": { @@ -34,16 +35,18 @@ "ext-filter": "*", "ext-libxml": "*", "ext-SimpleXML": "*", - "simplesamlphp/assert": "^1.1", "simplesamlphp/composer-module-installer": "^1.3", "simplesamlphp/simplesamlphp": "^2.2", - "simplesamlphp/xml-cas": "^1.2", - "simplesamlphp/xml-common": "^1.16", - "simplesamlphp/xml-soap": "^1.4" + "simplesamlphp/xml-cas": "^v1.3", + "simplesamlphp/xml-common": "^v1.18", + "simplesamlphp/xml-soap": "^v1.5" }, "require-dev": { - "simplesamlphp/simplesamlphp-test-framework": "^1.7" + "simplesamlphp/simplesamlphp-test-framework": "^1.7", + "phpunit/phpunit": "^10", + "psalm/plugin-phpunit": "^0.19.0", + "squizlabs/php_codesniffer": "^3.7" }, "support": { "issues": "https://github.com/simplesamlphp/simplesamlphp-module-casserver/issues", diff --git a/phpcs.xml b/phpcs.xml index 4b5e79ac..86466c0d 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -19,6 +19,9 @@ tests/www/UtilsTest.php + + tests/config/* + diff --git a/phpunit.xml b/phpunit.xml index 5caff29c..9163c388 100644 --- a/phpunit.xml +++ b/phpunit.xml @@ -1,5 +1,10 @@ - + diff --git a/public/login.php b/public/login.php index c62f62d5..8cda8c8f 100644 --- a/public/login.php +++ b/public/login.php @@ -170,7 +170,7 @@ } // I am already logged in. Redirect to the logged in endpoint -if(!isset($serviceUrl) && $authProcId === null) { +if (!isset($serviceUrl) && $authProcId === null) { // LOGGED IN $httpUtils->redirectTrustedURL( $httpUtils->addURLParameters(Module::getModuleURL('casserver/loggedIn.php'), $parameters), @@ -193,7 +193,7 @@ } // Attribute Handler $state['ReturnTo'] = $returnUrl; -if($authProcId !== null) { +if ($authProcId !== null) { $state[ProcessingChain::AUTHPARAM] = $authProcId; } try { diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index bed9d96b..6db73d72 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -7,7 +7,6 @@ use SimpleSAML\Auth\ProcessingChain; use SimpleSAML\Auth\State; use SimpleSAML\Configuration; -use SimpleSAML\Error\Exception; use SimpleSAML\Error\NoState; use SimpleSAML\Module; use SimpleSAML\Module\casserver\Cas\Factories\ProcessingChainFactory; diff --git a/src/Cas/Factories/ProcessingChainFactory.php b/src/Cas/Factories/ProcessingChainFactory.php index 11f48918..90820a55 100644 --- a/src/Cas/Factories/ProcessingChainFactory.php +++ b/src/Cas/Factories/ProcessingChainFactory.php @@ -46,4 +46,4 @@ public function build(array $state): ProcessingChain 'casserver', ); } -} \ No newline at end of file +} diff --git a/src/Cas/Protocol/SamlValidateResponder.php b/src/Cas/Protocol/SamlValidateResponder.php index 86b3f59a..dcc82b42 100644 --- a/src/Cas/Protocol/SamlValidateResponder.php +++ b/src/Cas/Protocol/SamlValidateResponder.php @@ -6,8 +6,8 @@ use SimpleSAML\Configuration; use SimpleSAML\Module\casserver\Shib13\AuthnResponse; -use SimpleSAML\SOAP11\XML\env\Body; -use SimpleSAML\SOAP11\XML\env\Envelope; +use SimpleSAML\SOAP\XML\env_200305\Body; +use SimpleSAML\SOAP\XML\env_200305\Envelope; use SimpleSAML\XML\Chunk; use SimpleSAML\XML\DOMDocumentFactory; use SimpleSAML\XML\SerializableElementInterface; @@ -64,11 +64,11 @@ public function convertToSaml(array $ticket): Chunk /** * @param \SimpleSAML\XML\SerializableElementInterface $samlResponse - * @return \SimpleSAML\SOAP11\XML\env\Envelope + * @return \SimpleSAML\SOAP\XML\env\Envelope */ public function wrapInSoap(SerializableElementInterface $samlResponse): Envelope { - $body = new Body([$samlResponse]); + $body = new Body(null, [$samlResponse]); return new Envelope($body); } } diff --git a/tests/config/config.php b/tests/config/config.php new file mode 100644 index 00000000..4b4af1b1 --- /dev/null +++ b/tests/config/config.php @@ -0,0 +1,11 @@ + 'simplesaml/', + + /* + * The 'application' configuration array groups a set configuration options + * relative to an application protected by SimpleSAMLphp. + */ + 'application' => [ + /* + * The 'baseURL' configuration option allows you to specify a protocol, + * host and optionally a port that serves as the canonical base for all + * your application's URLs. This is useful when the environment + * observed in the server differs from the one observed by end users, + * for example, when using a load balancer to offload TLS. + * + * Note that this configuration option does not allow setting a path as + * part of the URL. If your setup involves URL rewriting or any other + * tricks that would result in SimpleSAMLphp observing a URL for your + * application's scripts different than the canonical one, you will + * need to compute the right URLs yourself and pass them dynamically + * to SimpleSAMLphp's API. + */ + //'baseURL' => 'https://example.com', + ], + + /* + * The following settings are *filesystem paths* which define where + * SimpleSAMLphp can find or write the following things: + * - 'cachedir': Where SimpleSAMLphp can write its cache. + * - 'loggingdir': Where to write logs. MUST be set to NULL when using a logging + * handler other than `file`. + * - 'datadir': Storage of general data. + * - 'tempdir': Saving temporary files. SimpleSAMLphp will attempt to create + * this directory if it doesn't exist. DEPRECATED - replaced by cachedir. + * When specified as a relative path, this is relative to the SimpleSAMLphp + * root directory. + */ + 'cachedir' => '/var/cache/simplesamlphp', + //'loggingdir' => '/var/log/', + //'datadir' => '/var/data/', + //'tempdir' => '/tmp/simplesamlphp', + + /* + * Certificate and key material can be loaded from different possible + * locations. Currently two locations are supported, the local filesystem + * and the database via pdo using the global database configuration. Locations + * are specified by a URL-link prefix before the file name/path or database + * identifier. + */ + + /* To load a certificate or key from the filesystem, it should be specified + * as 'file://' where is either a relative filename or a fully + * qualified path to a file containing the certificate or key in PEM + * format, such as 'cert.pem' or '/path/to/cert.pem'. If the path is + * relative, it will be searched for in the directory defined by the + * 'certdir' parameter below. When 'certdir' is specified as a relative + * path, it will be interpreted as relative to the SimpleSAMLphp root + * directory. Note that locations with no prefix included will be treated + * as file locations. + */ + 'certdir' => 'cert/', + + /* To load a certificate or key from the database, it should be specified + * as 'pdo://' where is the identifier in the database table that + * should be matched. While the certificate and key tables are expected to + * be in the simplesaml database, they are not created or managed by + * simplesaml. The following parameters control how the pdo location + * attempts to retrieve certificates and keys from the database: + * + * - 'cert.pdo.table': name of table where certificates are stored + * - 'cert.pdo.keytable': name of table where keys are stored + * - 'cert.pdo.apply_prefix': whether or not to prepend the database.prefix + * parameter to the table names; if you are using + * database.prefix to separate multiple SSP instances + * in the same database but want to share certificate/key + * data between them, set this to false + * - 'cert.pdo.id_column': name of column to use as identifier + * - 'cert.pdo.data_column': name of column where PEM data is stored + * + * Basically, the query executed will be: + * + * SELECT cert.pdo.data_column FROM cert.pdo.table WHERE cert.pdo.id_column = :id + * + * Defaults are shown below, to change them, uncomment the line and update as + * needed + */ + //'cert.pdo.table' => 'certificates', + //'cert.pdo.keytable' => 'private_keys', + //'cert.pdo.apply_prefix' => true, + //'cert.pdo.id_column' => 'id', + //'cert.pdo.data_column' => 'data', + + /* + * Some information about the technical persons running this installation. + * The email address will be used as the recipient address for error reports, and + * also as the technical contact in generated metadata. + */ + 'technicalcontact_name' => 'Administrator', + 'technicalcontact_email' => 'na@example.org', + + /* + * (Optional) The method by which email is delivered. Defaults to mail which utilizes the + * PHP mail() function. + * + * Valid options are: mail, sendmail and smtp. + */ + //'mail.transport.method' => 'smtp', + + /* + * Set the transport options for the transport method specified. The valid settings are relative to the + * selected transport method. + */ + /* + 'mail.transport.options' => [ + 'host' => 'mail.example.org', // required + 'port' => 25, // optional + 'username' => 'user@example.org', // optional: if set, enables smtp authentication + 'password' => 'password', // optional: if set, enables smtp authentication + 'security' => 'tls', // optional: defaults to no smtp security + 'smtpOptions' => [], // optional: passed to stream_context_create when connecting via SMTP + ], + + // sendmail mail transport options + /* + 'mail.transport.options' => [ + 'path' => '/usr/sbin/sendmail' // optional: defaults to php.ini path + ], + */ + + /* + * The envelope from address for outgoing emails. + * This should be in a domain that has your application's IP addresses in its SPF record + * to prevent it from being rejected by mail filters. + */ + //'sendmail_from' => 'no-reply@example.org', + + /* + * The timezone of the server. This option should be set to the timezone you want + * SimpleSAMLphp to report the time in. The default is to guess the timezone based + * on your system timezone. + * + * See this page for a list of valid timezones: http://php.net/manual/en/timezones.php + */ + 'timezone' => null, + + + + /********************************** + | SECURITY CONFIGURATION OPTIONS | + **********************************/ + + /* + * This is a secret salt used by SimpleSAMLphp when it needs to generate a secure hash + * of a value. It must be changed from its default value to a secret value. The value of + * 'secretsalt' can be any valid string of any length. + * + * A possible way to generate a random salt is by running the following command from a unix shell: + * LC_ALL=C tr -c -d '0123456789abcdefghijklmnopqrstuvwxyz' /dev/null;echo + */ + 'secretsalt' => 'defaultsecretsalt', + + /* + * This password must be kept secret, and modified from the default value 123. + * This password will give access to the installation page of SimpleSAMLphp with + * metadata listing and diagnostics pages. + * You can also put a hash here; run "bin/pwgen.php" to generate one. + */ + 'auth.adminpassword' => '123', + + /* + * Set this option to true if you want to require administrator password to access the metadata. + */ + 'admin.protectmetadata' => false, + + /* + * Set this option to false if you don't want SimpleSAMLphp to check for new stable releases when + * visiting the configuration tab in the web interface. + */ + 'admin.checkforupdates' => true, + + /* + * Array of domains that are allowed when generating links or redirects + * to URLs. SimpleSAMLphp will use this option to determine whether to + * to consider a given URL valid or not, but you should always validate + * URLs obtained from the input on your own (i.e. ReturnTo or RelayState + * parameters obtained from the $_REQUEST array). + * + * SimpleSAMLphp will automatically add your own domain (either by checking + * it dynamically, or by using the domain defined in the 'baseurlpath' + * directive, the latter having precedence) to the list of trusted domains, + * in case this option is NOT set to NULL. In that case, you are explicitly + * telling SimpleSAMLphp to verify URLs. + * + * Set to an empty array to disallow ALL redirects or links pointing to + * an external URL other than your own domain. This is the default behaviour. + * + * Set to NULL to disable checking of URLs. DO NOT DO THIS UNLESS YOU KNOW + * WHAT YOU ARE DOING! + * + * Example: + * 'trusted.url.domains' => ['sp.example.com', 'app.example.com'], + */ + 'trusted.url.domains' => [], + + /* + * Enable regular expression matching of trusted.url.domains. + * + * Set to true to treat the values in trusted.url.domains as regular + * expressions. Set to false to do exact string matching. + * + * If enabled, the start and end delimiters ('^' and '$') will be added to + * all regular expressions in trusted.url.domains. + */ + 'trusted.url.regex' => false, + + /* + * Enable secure POST from HTTPS to HTTP. + * + * If you have some SP's on HTTP and IdP is normally on HTTPS, this option + * enables secure POSTing to HTTP endpoint without warning from browser. + * + * For this to work, module.php/core/postredirect.php must be accessible + * also via HTTP on IdP, e.g. if your IdP is on + * https://idp.example.org/ssp/, then + * http://idp.example.org/ssp/module.php/core/postredirect.php must be accessible. + */ + 'enable.http_post' => false, + + /* + * Set the allowed clock skew between encrypting/decrypting assertions + * + * If you have a server that is constantly out of sync, this option + * allows you to adjust the allowed clock-skew. + * + * Allowed range: 180 - 300 + * Defaults to 180. + */ + 'assertion.allowed_clock_skew' => 180, + + /* + * Set custom security headers. The defaults can be found in \SimpleSAML\Configuration::DEFAULT_SECURITY_HEADERS + * + * NOTE: When a header is already set on the response we will NOT overrule it and leave it untouched. + * + * Whenever you change any of these headers, make sure to validate your config by running your + * hostname through a security-test like https://en.internet.nl + 'headers.security' => [ + 'Content-Security-Policy' => "default-src 'none'; frame-ancestors 'self'; object-src 'none'; script-src 'self'; style-src 'self'; font-src 'self'; connect-src 'self'; img-src 'self' data:; base-uri 'none'", + 'X-Frame-Options' => 'SAMEORIGIN', + 'X-Content-Type-Options' => 'nosniff', + 'Referrer-Policy' => 'origin-when-cross-origin', + ], + */ + + + /************************ + | ERRORS AND DEBUGGING | + ************************/ + + /* + * The 'debug' option allows you to control how SimpleSAMLphp behaves in certain + * situations where further action may be taken + * + * It can be left unset, in which case, debugging is switched off for all actions. + * If set, it MUST be an array containing the actions that you want to enable, or + * alternatively a hashed array where the keys are the actions and their + * corresponding values are booleans enabling or disabling each particular action. + * + * SimpleSAMLphp provides some pre-defined actions, though modules could add new + * actions here. Refer to the documentation of every module to learn if they + * allow you to set any more debugging actions. + * + * The pre-defined actions are: + * + * - 'saml': this action controls the logging of SAML messages exchanged with other + * entities. When enabled ('saml' is present in this option, or set to true), all + * SAML messages will be logged, including plaintext versions of encrypted + * messages. + * + * - 'backtraces': this action controls the logging of error backtraces so you + * can debug any possible errors happening in SimpleSAMLphp. + * + * - 'validatexml': this action allows you to validate SAML documents against all + * the relevant XML schemas. SAML 1.1 messages or SAML metadata parsed with + * the XML to SimpleSAMLphp metadata converter or the metaedit module will + * validate the SAML documents if this option is enabled. + * + * If you want to disable debugging completely, unset this option or set it to an + * empty array. + */ + 'debug' => [ + 'saml' => false, + 'backtraces' => true, + 'validatexml' => false, + ], + + /* + * When 'showerrors' is enabled, all error messages and stack traces will be output + * to the browser. + * + * When 'errorreporting' is enabled, a form will be presented for the user to report + * the error to 'technicalcontact_email'. + */ + 'showerrors' => true, + 'errorreporting' => true, + + /* + * Custom error show function called from SimpleSAML\Error\Error::show. + * See docs/simplesamlphp-errorhandling.md for function code example. + * + * Example: + * 'errors.show_function' => ['SimpleSAML\Module\example\Error', 'show'], + */ + + + /************************** + | LOGGING AND STATISTICS | + **************************/ + + /* + * Define the minimum log level to log. Available levels: + * - SimpleSAML\Logger::ERR No statistics, only errors + * - SimpleSAML\Logger::WARNING No statistics, only warnings/errors + * - SimpleSAML\Logger::NOTICE Statistics and errors + * - SimpleSAML\Logger::INFO Verbose logs + * - SimpleSAML\Logger::DEBUG Full debug logs - not recommended for production + * + * Choose logging handler. + * + * Options: [syslog,file,errorlog,stderr] + * + * If you set the handler to 'file', the directory specified in loggingdir above + * must exist and be writable for SimpleSAMLphp. If set to something else, set + * loggingdir above to 'null'. + */ + 'logging.level' => SimpleSAML\Logger::NOTICE, + 'logging.handler' => 'syslog', + + /* + * Specify the format of the logs. Its use varies depending on the log handler used (for instance, you cannot + * control here how dates are displayed when using the syslog or errorlog handlers), but in general the options + * are: + * + * - %date{}: the date and time, with its format specified inside the brackets. See the PHP documentation + * of the date() function for more information on the format. If the brackets are omitted, the standard + * format is applied. This can be useful if you just want to control the placement of the date, but don't care + * about the format. + * + * - %process: the name of the SimpleSAMLphp process. Remember you can configure this in the 'logging.processname' + * option below. + * + * - %level: the log level (name or number depending on the handler used). + * + * - %stat: if the log entry is intended for statistical purposes, it will print the string 'STAT ' (bear in mind + * the trailing space). + * + * - %trackid: the track ID, an identifier that allows you to track a single session. + * + * - %srcip: the IP address of the client. If you are behind a proxy, make sure to modify the + * $_SERVER['REMOTE_ADDR'] variable on your code accordingly to the X-Forwarded-For header. + * + * - %msg: the message to be logged. + * + */ + //'logging.format' => '%date{M j H:i:s} %process %level %stat[%trackid] %msg', + + /* + * Choose which facility should be used when logging with syslog. + * + * These can be used for filtering the syslog output from SimpleSAMLphp into its + * own file by configuring the syslog daemon. + * + * See the documentation for openlog (http://php.net/manual/en/function.openlog.php) for available + * facilities. Note that only LOG_USER is valid on windows. + * + * The default is to use LOG_LOCAL5 if available, and fall back to LOG_USER if not. + */ + 'logging.facility' => defined('LOG_LOCAL5') ? constant('LOG_LOCAL5') : LOG_USER, + + /* + * The process name that should be used when logging to syslog. + * The value is also written out by the other logging handlers. + */ + 'logging.processname' => 'simplesamlphp', + + /* + * Logging: file - Logfilename in the loggingdir from above. + */ + 'logging.logfile' => 'simplesamlphp.log', + + /* + * This is an array of outputs. Each output has at least a 'class' option, which + * selects the output. + */ + 'statistics.out' => [ + // Log statistics to the normal log. + /* + [ + 'class' => 'core:Log', + 'level' => 'notice', + ], + */ + // Log statistics to files in a directory. One file per day. + /* + [ + 'class' => 'core:File', + 'directory' => '/var/log/stats', + ], + */ + ], + + + + /*********************** + | PROXY CONFIGURATION | + ***********************/ + + /* + * Proxy to use for retrieving URLs. + * + * Example: + * 'proxy' => 'http://proxy.example.com:5100' + */ + 'proxy' => null, + + /* + * Username/password authentication to proxy (Proxy-Authorization: Basic) + * Example: + * 'proxy.auth' = 'myuser:password' + */ + //'proxy.auth' => 'myuser:password', + + + + /************************** + | DATABASE CONFIGURATION | + **************************/ + + /* + * This database configuration is optional. If you are not using + * core functionality or modules that require a database, you can + * skip this configuration. + */ + + /* + * Database connection string. + * Ensure that you have the required PDO database driver installed + * for your connection string. + */ + 'database.dsn' => 'mysql:host=localhost;dbname=saml', + + /* + * SQL database credentials + */ + 'database.username' => 'simplesamlphp', + 'database.password' => 'secret', + 'database.options' => [], + + /* + * (Optional) Table prefix + */ + 'database.prefix' => '', + + /* + * (Optional) Driver options + */ + 'database.driver_options' => [], + + /* + * True or false if you would like a persistent database connection + */ + 'database.persistent' => false, + + /* + * Database secondary configuration is optional as well. If you are only + * running a single database server, leave this blank. If you have + * a primary/secondary configuration, you can define as many secondary servers + * as you want here. Secondaries will be picked at random to be queried from. + * + * Configuration options in the secondary array are exactly the same as the + * options for the primary (shown above) with the exception of the table + * prefix and driver options. + */ + 'database.secondaries' => [ + /* + [ + 'dsn' => 'mysql:host=mysecondary;dbname=saml', + 'username' => 'simplesamlphp', + 'password' => 'secret', + 'persistent' => false, + ], + */ + ], + + + + /************* + | PROTOCOLS | + *************/ + + /* + * Which functionality in SimpleSAMLphp do you want to enable. Normally you would enable only + * one of the functionalities below, but in some cases you could run multiple functionalities. + * In example when you are setting up a federation bridge. + */ + 'enable.saml20-idp' => false, + 'enable.adfs-idp' => false, + + + + /*********** + | MODULES | + ***********/ + + /* + * Configuration for enabling/disabling modules. By default the 'core', 'admin' and 'saml' modules are enabled. + * + * Example: + * + * 'module.enable' => [ + * 'exampleauth' => true, // Setting to TRUE enables. + * 'consent' => false, // Setting to FALSE disables. + * 'core' => null, // Unset or NULL uses default. + * ], + */ + + 'module.enable' => [ + 'exampleauth' => false, + 'core' => true, + 'admin' => true, + 'saml' => true + ], + + + /************************* + | SESSION CONFIGURATION | + *************************/ + + /* + * This value is the duration of the session in seconds. Make sure that the time duration of + * cookies both at the SP and the IdP exceeds this duration. + */ + 'session.duration' => 8 * (60 * 60), // 8 hours. + + /* + * Sets the duration, in seconds, data should be stored in the datastore. As the data store is used for + * login and logout requests, this option will control the maximum time these operations can take. + * The default is 4 hours (4*60*60) seconds, which should be more than enough for these operations. + */ + 'session.datastore.timeout' => (4 * 60 * 60), // 4 hours + + /* + * Sets the duration, in seconds, auth state should be stored. + */ + 'session.state.timeout' => (60 * 60), // 1 hour + + /* + * Option to override the default settings for the session cookie name + */ + 'session.cookie.name' => 'SimpleSAMLSessionID', + + /* + * Expiration time for the session cookie, in seconds. + * + * Defaults to 0, which means that the cookie expires when the browser is closed. + * + * Example: + * 'session.cookie.lifetime' => 30*60, + */ + 'session.cookie.lifetime' => 0, + + /* + * Limit the path of the cookies. + * + * Can be used to limit the path of the cookies to a specific subdirectory. + * + * Example: + * 'session.cookie.path' => '/simplesaml/', + */ + 'session.cookie.path' => '/', + + /* + * Cookie domain. + * + * Can be used to make the session cookie available to several domains. + * + * Example: + * 'session.cookie.domain' => '.example.org', + */ + 'session.cookie.domain' => '', + + /* + * Set the secure flag in the cookie. + * + * Set this to TRUE if the user only accesses your service + * through https. If the user can access the service through + * both http and https, this must be set to FALSE. + * + * If unset, SimpleSAMLphp will try to automatically determine the right value + */ + //'session.cookie.secure' => true, + + /* + * Set the SameSite attribute in the cookie. + * + * You can set this to the strings 'None', 'Lax', or 'Strict' to support + * the RFC6265bis SameSite cookie attribute. If set to null, no SameSite + * attribute will be sent. + * + * A value of "None" is required to properly support cross-domain POST + * requests which are used by different SAML bindings. Because some older + * browsers do not support this value, the canSetSameSiteNone function + * can be called to only set it for compatible browsers. + * + * You must also set the 'session.cookie.secure' value above to true. + * + * Example: + * 'session.cookie.samesite' => 'None', + */ + 'session.cookie.samesite' => $httpUtils->canSetSameSiteNone() ? 'None' : null, + + /* + * Options to override the default settings for php sessions. + */ + 'session.phpsession.cookiename' => 'SimpleSAML', + 'session.phpsession.savepath' => null, + 'session.phpsession.httponly' => true, + + /* + * Option to override the default settings for the auth token cookie + */ + 'session.authtoken.cookiename' => 'SimpleSAMLAuthToken', + + /* + * Options for remember me feature for IdP sessions. Remember me feature + * has to be also implemented in authentication source used. + * + * Option 'session.cookie.lifetime' should be set to zero (0), i.e. cookie + * expires on browser session if remember me is not checked. + * + * Session duration ('session.duration' option) should be set according to + * 'session.rememberme.lifetime' option. + * + * It's advised to use remember me feature with session checking function + * defined with 'session.check_function' option. + */ + 'session.rememberme.enable' => false, + 'session.rememberme.checked' => false, + 'session.rememberme.lifetime' => (14 * 86400), + + /* + * Custom function for session checking called on session init and loading. + * See docs/simplesamlphp-advancedfeatures.md for function code example. + * + * Example: + * 'session.check_function' => ['\SimpleSAML\Module\example\Util', 'checkSession'], + */ + + + + /************************** + | MEMCACHE CONFIGURATION | + **************************/ + + /* + * Configuration for the 'memcache' session store. This allows you to store + * multiple redundant copies of sessions on different memcache servers. + * + * 'memcache_store.servers' is an array of server groups. Every data + * item will be mirrored in every server group. + * + * Each server group is an array of servers. The data items will be + * load-balanced between all servers in each server group. + * + * Each server is an array of parameters for the server. The following + * options are available: + * - 'hostname': This is the hostname or ip address where the + * memcache server runs. This is the only required option. + * - 'port': This is the port number of the memcache server. If this + * option isn't set, then we will use the 'memcache.default_port' + * ini setting. This is 11211 by default. + * + * When using the "memcache" extension, the following options are also + * supported: + * - 'weight': This sets the weight of this server in this server + * group. http://php.net/manual/en/function.Memcache-addServer.php + * contains more information about the weight option. + * - 'timeout': The timeout for this server. By default, the timeout + * is 3 seconds. + * + * Example of redundant configuration with load balancing: + * This configuration makes it possible to lose both servers in the + * a-group or both servers in the b-group without losing any sessions. + * Note that sessions will be lost if one server is lost from both the + * a-group and the b-group. + * + * 'memcache_store.servers' => [ + * [ + * ['hostname' => 'mc_a1'], + * ['hostname' => 'mc_a2'], + * ], + * [ + * ['hostname' => 'mc_b1'], + * ['hostname' => 'mc_b2'], + * ], + * ], + * + * Example of simple configuration with only one memcache server, + * running on the same computer as the web server: + * Note that all sessions will be lost if the memcache server crashes. + * + * 'memcache_store.servers' => [ + * [ + * ['hostname' => 'localhost'], + * ], + * ], + * + * Additionally, when using the "memcached" extension, unique keys must + * be provided for each group of servers if persistent connections are + * desired. Each server group can also have an "options" indexed array + * with the options desired for the given group: + * + * 'memcache_store.servers' => [ + * 'memcache_group_1' => [ + * 'options' => [ + * \Memcached::OPT_BINARY_PROTOCOL => true, + * \Memcached::OPT_NO_BLOCK => true, + * \Memcached::OPT_TCP_NODELAY => true, + * \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, + * ], + * ['hostname' => '127.0.0.1', 'port' => 11211], + * ['hostname' => '127.0.0.2', 'port' => 11211], + * ], + * + * 'memcache_group_2' => [ + * 'options' => [ + * \Memcached::OPT_BINARY_PROTOCOL => true, + * \Memcached::OPT_NO_BLOCK => true, + * \Memcached::OPT_TCP_NODELAY => true, + * \Memcached::OPT_LIBKETAMA_COMPATIBLE => true, + * ], + * ['hostname' => '127.0.0.3', 'port' => 11211], + * ['hostname' => '127.0.0.4', 'port' => 11211], + * ], + * ], + * + */ + 'memcache_store.servers' => [ + [ + ['hostname' => 'localhost'], + ], + ], + + /* + * This value allows you to set a prefix for memcache-keys. The default + * for this value is 'simpleSAMLphp', which is fine in most cases. + * + * When running multiple instances of SSP on the same host, and more + * than one instance is using memcache, you probably want to assign + * a unique value per instance to this setting to avoid data collision. + */ + 'memcache_store.prefix' => '', + + /* + * This value is the duration data should be stored in memcache. Data + * will be dropped from the memcache servers when this time expires. + * The time will be reset every time the data is written to the + * memcache servers. + * + * This value should always be larger than the 'session.duration' + * option. Not doing this may result in the session being deleted from + * the memcache servers while it is still in use. + * + * Set this value to 0 if you don't want data to expire. + * + * Note: The oldest data will always be deleted if the memcache server + * runs out of storage space. + */ + 'memcache_store.expires' => 36 * (60 * 60), // 36 hours. + + + + /************************************* + | LANGUAGE AND INTERNATIONALIZATION | + *************************************/ + + /* + * Languages available, RTL languages, and what language is the default. + */ + 'language.available' => [ + 'en', 'no', 'nn', 'se', 'da', 'de', 'sv', 'fi', 'es', 'ca', 'fr', 'it', 'nl', 'lb', + 'cs', 'sk', 'sl', 'lt', 'hr', 'hu', 'pl', 'pt', 'pt_BR', 'tr', 'ja', 'zh', 'zh_TW', + 'ru', 'et', 'he', 'id', 'sr', 'lv', 'ro', 'eu', 'el', 'af', 'zu', 'xh', 'st', + ], + 'language.rtl' => ['ar', 'dv', 'fa', 'ur', 'he'], + 'language.default' => 'en', + + /* + * Options to override the default settings for the language parameter + */ + 'language.parameter.name' => 'language', + 'language.parameter.setcookie' => true, + + /* + * Options to override the default settings for the language cookie + */ + 'language.cookie.name' => 'language', + 'language.cookie.domain' => '', + 'language.cookie.path' => '/', + 'language.cookie.secure' => true, + 'language.cookie.httponly' => false, + 'language.cookie.lifetime' => (60 * 60 * 24 * 900), + 'language.cookie.samesite' => $httpUtils->canSetSameSiteNone() ? 'None' : null, + + /** + * Custom getLanguage function called from SimpleSAML\Locale\Language::getLanguage(). + * Function should return language code of one of the available languages or NULL. + * See SimpleSAML\Locale\Language::getLanguage() source code for more info. + * + * This option can be used to implement a custom function for determining + * the default language for the user. + * + * Example: + * 'language.get_language_function' => ['\SimpleSAML\Module\example\Template', 'getLanguage'], + */ + + /************** + | APPEARANCE | + **************/ + + /* + * Which theme directory should be used? + */ + 'theme.use' => 'default', + + /* + * Set this option to the text you would like to appear at the header of each page. Set to false if you don't want + * any text to appear in the header. + */ + //'theme.header' => 'SimpleSAMLphp', + + /** + * A template controller, if any. + * + * Used to intercept certain parts of the template handling, while keeping away unwanted/unexpected hooks. Set + * the 'theme.controller' configuration option to a class that implements the + * \SimpleSAML\XHTML\TemplateControllerInterface interface to use it. + */ + //'theme.controller' => '', + + /* + * Templating options + * + * By default, twig templates are not cached. To turn on template caching: + * Set 'template.cache' to an absolute path pointing to a directory that + * SimpleSAMLphp has read and write permissions to. + */ + //'template.cache' => '', + + /* + * Set the 'template.auto_reload' to true if you would like SimpleSAMLphp to + * recompile the templates (when using the template cache) if the templates + * change. If you don't want to check the source templates for every request, + * set it to false. + */ + 'template.auto_reload' => false, + + /* + * Set this option to true to indicate that your installation of SimpleSAMLphp + * is running in a production environment. This will affect the way resources + * are used, offering an optimized version when running in production, and an + * easy-to-debug one when not. Set it to false when you are testing or + * developing the software, in which case a banner will be displayed to remind + * users that they're dealing with a non-production instance. + * + * Defaults to true. + */ + 'production' => true, + + /* + * SimpleSAMLphp modules can host static resources which are served through PHP. + * The serving of the resources can be configured through these settings. + */ + 'assets' => [ + /* + * These settings adjust the caching headers that are sent + * when serving static resources. + */ + 'caching' => [ + /* + * Amount of seconds before the resource should be fetched again + */ + 'max_age' => 86400, + /* + * Calculate a checksum of every file and send it to the browser + * This allows the browser to avoid downloading assets again in situations + * where the Last-Modified header cannot be trusted, + * for example in cluster setups + * + * Defaults false + */ + 'etag' => false, + ], + ], + + /** + * Set to a full URL if you want to redirect users that land on SimpleSAMLphp's + * front page to somewhere more useful. If left unset, a basic welcome message + * is shown. + */ + //'frontpage.redirect' => 'https://example.com/', + + /********************* + | DISCOVERY SERVICE | + *********************/ + + /* + * Whether the discovery service should allow the user to save his choice of IdP. + */ + 'idpdisco.enableremember' => true, + 'idpdisco.rememberchecked' => true, + + /* + * The disco service only accepts entities it knows. + */ + 'idpdisco.validate' => true, + + 'idpdisco.extDiscoveryStorage' => null, + + /* + * IdP Discovery service look configuration. + * Whether to display a list of idp or to display a dropdown box. For many IdP' a dropdown box + * gives the best use experience. + * + * When using dropdown box a cookie is used to highlight the previously chosen IdP in the dropdown. + * This makes it easier for the user to choose the IdP + * + * Options: [links,dropdown] + */ + 'idpdisco.layout' => 'dropdown', + + + + /************************************* + | AUTHENTICATION PROCESSING FILTERS | + *************************************/ + + /* + * Authentication processing filters that will be executed for all IdPs + */ + 'authproc.idp' => [ + /* Enable the authproc filter below to add URN prefixes to all attributes + 10 => [ + 'class' => 'core:AttributeMap', 'addurnprefix' + ], + */ + /* Enable the authproc filter below to automatically generated eduPersonTargetedID. + 20 => 'core:TargetedID', + */ + + // Adopts language from attribute to use in UI + 30 => 'core:LanguageAdaptor', + + /* When called without parameters, it will fallback to filter attributes 'the old way' + * by checking the 'attributes' parameter in metadata on IdP hosted and SP remote. + */ + 50 => 'core:AttributeLimit', + + /* + * Search attribute "distinguishedName" for pattern and replaces if found + */ + /* + 60 => [ + 'class' => 'core:AttributeAlter', + 'pattern' => '/OU=studerende/', + 'replacement' => 'Student', + 'subject' => 'distinguishedName', + '%replace', + ], + */ + + /* + * Consent module is enabled (with no permanent storage, using cookies). + */ + /* + 90 => [ + 'class' => 'consent:Consent', + 'store' => 'consent:Cookie', + 'focus' => 'yes', + 'checked' => true + ], + */ + // If language is set in Consent module it will be added as an attribute. + 99 => 'core:LanguageAdaptor', + ], + + /* + * Authentication processing filters that will be executed for all SPs + */ + 'authproc.sp' => [ + /* + 10 => [ + 'class' => 'core:AttributeMap', 'removeurnprefix' + ], + */ + + /* + * Generate the 'group' attribute populated from other variables, including eduPersonAffiliation. + 60 => [ + 'class' => 'core:GenerateGroups', 'eduPersonAffiliation' + ], + */ + /* + * All users will be members of 'users' and 'members' + */ + /* + 61 => [ + 'class' => 'core:AttributeAdd', 'groups' => ['users', 'members'] + ], + */ + + // Adopts language from attribute to use in UI + 90 => 'core:LanguageAdaptor', + ], + + + + /************************** + | METADATA CONFIGURATION | + **************************/ + + /* + * This option allows you to specify a directory for your metadata outside of the standard metadata directory + * included in the standard distribution of the software. + */ + 'metadatadir' => 'metadata', + + /* + * This option configures the metadata sources. The metadata sources is given as an array with + * different metadata sources. When searching for metadata, SimpleSAMLphp will search through + * the array from start to end. + * + * Each element in the array is an associative array which configures the metadata source. + * The type of the metadata source is given by the 'type' element. For each type we have + * different configuration options. + * + * Flat file metadata handler: + * - 'type': This is always 'flatfile'. + * - 'directory': The directory we will load the metadata files from. The default value for + * this option is the value of the 'metadatadir' configuration option, or + * 'metadata/' if that option is unset. + * + * XML metadata handler: + * This metadata handler parses an XML file with either an EntityDescriptor element or an + * EntitiesDescriptor element. The XML file may be stored locally, or (for debugging) on a remote + * web server. + * The XML metadata handler defines the following options: + * - 'type': This is always 'xml'. + * - 'file': Path to the XML file with the metadata. + * - 'url': The URL to fetch metadata from. THIS IS ONLY FOR DEBUGGING - THERE IS NO CACHING OF THE RESPONSE. + * + * MDQ metadata handler: + * This metadata handler looks up for the metadata of an entity at the given MDQ server. + * The MDQ metadata handler defines the following options: + * - 'type': This is always 'mdq'. + * - 'server': Base URL of the MDQ server. Mandatory. + * - 'validateCertificate': The certificates file that may be used to sign the metadata. You don't need this + * option if you don't want to validate the signature on the metadata. Optional. + * - 'cachedir': Directory where metadata can be cached. Optional. + * - 'cachelength': Maximum time metadata can be cached, in seconds. Defaults to 24 + * hours (86400 seconds). Optional. + * + * PDO metadata handler: + * This metadata handler looks up metadata of an entity stored in a database. + * + * Note: If you are using the PDO metadata handler, you must configure the database + * options in this configuration file. + * + * The PDO metadata handler defines the following options: + * - 'type': This is always 'pdo'. + * + * Examples: + * + * This example defines two flatfile sources. One is the default metadata directory, the other + * is a metadata directory with auto-generated metadata files. + * + * 'metadata.sources' => [ + * ['type' => 'flatfile'], + * ['type' => 'flatfile', 'directory' => 'metadata-generated'], + * ], + * + * This example defines a flatfile source and an XML source. + * 'metadata.sources' => [ + * ['type' => 'flatfile'], + * ['type' => 'xml', 'file' => 'idp.example.org-idpMeta.xml'], + * ], + * + * This example defines an mdq source. + * 'metadata.sources' => [ + * [ + * 'type' => 'mdq', + * 'server' => 'http://mdq.server.com:8080', + * 'validateCertificate' => [ + * '/var/simplesamlphp/cert/metadata-key.new.crt', + * '/var/simplesamlphp/cert/metadata-key.old.crt' + * ], + * 'cachedir' => '/var/simplesamlphp/mdq-cache', + * 'cachelength' => 86400 + * ] + * ], + * + * This example defines an pdo source. + * 'metadata.sources' => [ + * ['type' => 'pdo'] + * ], + * + * Default: + * 'metadata.sources' => [ + * ['type' => 'flatfile'] + * ], + */ + 'metadata.sources' => [ + ['type' => 'flatfile'], + ], + + /* + * Should signing of generated metadata be enabled by default. + * + * Metadata signing can also be enabled for a individual SP or IdP by setting the + * same option in the metadata for the SP or IdP. + */ + 'metadata.sign.enable' => false, + + /* + * The default key & certificate which should be used to sign generated metadata. These + * are files stored in the cert dir. + * These values can be overridden by the options with the same names in the SP or + * IdP metadata. + * + * If these aren't specified here or in the metadata for the SP or IdP, then + * the 'certificate' and 'privatekey' option in the metadata will be used. + * if those aren't set, signing of metadata will fail. + */ + 'metadata.sign.privatekey' => null, + 'metadata.sign.privatekey_pass' => null, + 'metadata.sign.certificate' => null, + 'metadata.sign.algorithm' => 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256', + + + /**************************** + | DATA STORE CONFIGURATION | + ****************************/ + + /* + * Configure the data store for SimpleSAMLphp. + * + * - 'phpsession': Limited datastore, which uses the PHP session. + * - 'memcache': Key-value datastore, based on memcache. + * - 'sql': SQL datastore, using PDO. + * - 'redis': Key-value datastore, based on redis. + * + * The default datastore is 'phpsession'. + */ + 'store.type' => 'phpsession', + + /* + * The DSN the sql datastore should connect to. + * + * See http://www.php.net/manual/en/pdo.drivers.php for the various + * syntaxes. + */ + 'store.sql.dsn' => 'sqlite:/path/to/sqlitedatabase.sq3', + + /* + * The username and password to use when connecting to the database. + */ + 'store.sql.username' => null, + 'store.sql.password' => null, + + /* + * The prefix we should use on our tables. + */ + 'store.sql.prefix' => 'SimpleSAMLphp', + + /* + * The driver-options we should pass to the PDO-constructor. + */ + 'store.sql.options' => [], + + /* + * The hostname and port of the Redis datastore instance. + */ + 'store.redis.host' => 'localhost', + 'store.redis.port' => 6379, + + /* + * The credentials to use when connecting to Redis. + * + * If your Redis server is using the legacy password protection (config + * directive "requirepass" in redis.conf) then you should only provide + * a password. + * + * If your Redis server is using ACL's (which are recommended as of + * Redis 6+) then you should provide both a username and a password. + * See https://redis.io/docs/manual/security/acl/ + */ + 'store.redis.username' => '', + 'store.redis.password' => '', + + /* + * Communicate with Redis over a secure connection instead of plain TCP. + * + * This setting affects both single host connections as + * well as Sentinel mode. + */ + 'store.redis.tls' => false, + + /* + * Verify the Redis server certificate. + */ + 'store.redis.insecure' => false, + + /* + * Files related to secure communication with Redis. + * + * Files are searched in the 'certdir' when using relative paths. + */ + 'store.redis.ca_certificate' => null, + 'store.redis.certificate' => null, + 'store.redis.privatekey' => null, + + /* + * The prefix we should use on our Redis datastore. + */ + 'store.redis.prefix' => 'SimpleSAMLphp', + + /* + * The master group to use for Redis Sentinel. + */ + 'store.redis.mastergroup' => 'mymaster', + + /* + * The Redis Sentinel hosts. + * Example: + * 'store.redis.sentinels' => [ + * 'tcp://[yoursentinel1]:[port]', + * 'tcp://[yoursentinel2]:[port]', + * 'tcp://[yoursentinel3]:[port] + * ], + * + * Use 'tls' instead of 'tcp' in order to make use of the additional + * TLS settings. + */ + 'store.redis.sentinels' => [], + + /********************* + | IdP/SP PROXY MODE | + *********************/ + + /* + * If the IdP in front of SimpleSAMLphp in IdP/SP proxy mode sends + * AuthnContextClassRef, decide whether the AuthnContextClassRef will be + * processed by the IdP/SP proxy or if it will be passed to the SP behind + * the IdP/SP proxy. + */ + 'proxymode.passAuthnContextClassRef' => false, +]; diff --git a/tests/public/LoginIntegrationTest.php b/tests/public/LoginIntegrationTest.php index 0ef563d8..a431e985 100644 --- a/tests/public/LoginIntegrationTest.php +++ b/tests/public/LoginIntegrationTest.php @@ -10,7 +10,6 @@ use PHPUnit\Framework\TestCase; use SimpleSAML\Configuration; use SimpleSAML\TestUtils\BuiltInServer; -use SimpleSAML\XML\DOMDocumentFactory; /** * @@ -206,12 +205,23 @@ public function testValidServiceUrl(string $serviceParam, string $ticketParam): ], ); - $expectedResponse = DOMDocumentFactory::fromFile( - dirname(__FILE__, 2) . '/resources/xml/testValidServiceUrl.xml', - )->saveXML(); + $expectedXml = simplexml_load_string( + file_get_contents(\dirname(__FILE__, 2) . '/resources/xml/testValidServiceUrl.xml'), + ); + + $actualXml = simplexml_load_string($resp['body']); + + // We will remove the cas:authenticationDate element since we know that it will fail. The dates will not match + $authenticationNodeToDeleteExpected = $expectedXml->xpath('//cas:authenticationDate')[0]; + $authenticationNodeToDeleteActual = $actualXml->xpath('//cas:authenticationDate')[0]; + unset($authenticationNodeToDeleteExpected[0], $authenticationNodeToDeleteActual[0]); $this->assertEquals(200, $resp['code']); - $this->assertEquals($expectedResponse, $resp['body']); + + $this->assertEquals( + $expectedXml->xpath('//cas:serviceResponse')[0]->asXML(), + $actualXml->xpath('//cas:serviceResponse')[0]->asXML(), + ); } public static function validServiceUrlProvider(): array @@ -414,7 +424,11 @@ public function testSamlValidate(): void - + $ticket diff --git a/tests/resources/xml/testValidServiceUrl.xml b/tests/resources/xml/testValidServiceUrl.xml index 61c6d5db..bbcf187c 100644 --- a/tests/resources/xml/testValidServiceUrl.xml +++ b/tests/resources/xml/testValidServiceUrl.xml @@ -2,8 +2,11 @@ testuser@example.com + 2024-11-14T14:44:21Z + true + true testuser@example.com false - + \ No newline at end of file diff --git a/tests/src/AttributeExtractorTest.php b/tests/src/AttributeExtractorTest.php index 0ea60690..315feff6 100644 --- a/tests/src/AttributeExtractorTest.php +++ b/tests/src/AttributeExtractorTest.php @@ -20,20 +20,20 @@ public function testNoCasConfig(): void // Default is to use eppn and copy all attributes ]; - $attributes = [ + $state['Attributes'] = [ 'eduPersonPrincipalName' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; $loadedConfig = Configuration::loadFromArray($casConfig); $attributeExtractor = new AttributeExtractor( $loadedConfig, - new ProcessingChainFactory($loadedConfig) + new ProcessingChainFactory($loadedConfig), ); - $result = $attributeExtractor->extractUserAndAttributes($attributes); + $result = $attributeExtractor->extractUserAndAttributes($state); $this->assertEquals('testuser@example.com', $result['user']); - $this->assertEquals($attributes, $result['attributes']); + $this->assertEquals($state['Attributes'], $result['attributes']); } @@ -46,17 +46,17 @@ public function testNoAttributeCopying(): void 'attributes' => false, ]; - $attributes = [ + $state['Attributes'] = [ 'eduPersonPrincipalName' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; $loadedConfig = Configuration::loadFromArray($casConfig); $attributeExtractor = new AttributeExtractor( $loadedConfig, - new ProcessingChainFactory($loadedConfig) + new ProcessingChainFactory($loadedConfig), ); - $result = $attributeExtractor->extractUserAndAttributes($attributes); + $result = $attributeExtractor->extractUserAndAttributes($state); $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals([], $result['attributes']); @@ -76,17 +76,17 @@ public function testCustomAttributeCopy(): void ], ]; - $attributes = [ + $state['Attributes'] = [ 'userNameAttribute' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], ]; $loadedConfig = Configuration::loadFromArray($casConfig); $attributeExtractor = new AttributeExtractor( $loadedConfig, - new ProcessingChainFactory($loadedConfig) + new ProcessingChainFactory($loadedConfig), ); - $result = $attributeExtractor->extractUserAndAttributes($attributes); + $result = $attributeExtractor->extractUserAndAttributes($state); $this->assertEquals('testuser@example.com', $result['user']); $this->assertEquals(['additionalAttribute' => ['Taco Club']], $result['attributes']); @@ -102,7 +102,7 @@ public function testEmptyAuthproc(): void // Default is to use eppn and copy all attributes ]; - $attributes = [ + $state['Attributes'] = [ 'eduPersonPrincipalName' => ['testuser@example.com'], 'additionalAttribute' => ['Taco Club'], 'authproc' => [], @@ -110,13 +110,13 @@ public function testEmptyAuthproc(): void $loadedConfig = Configuration::loadFromArray($casConfig); $attributeExtractor = new AttributeExtractor( $loadedConfig, - new ProcessingChainFactory($loadedConfig) + new ProcessingChainFactory($loadedConfig), ); - $result = $attributeExtractor->extractUserAndAttributes($attributes); + $result = $attributeExtractor->extractUserAndAttributes($state); $this->assertEquals('testuser@example.com', $result['user']); - $this->assertEquals($attributes, $result['attributes']); + $this->assertEquals($state['Attributes'], $result['attributes']); } @@ -142,7 +142,7 @@ public function testAuthprocConfig(): void ], ]; - $attributes = [ + $state['Attributes'] = [ 'urn:oid:1.3.6.1.4.1.5923.1.1.1.6' => ['testuser@example.com'], 'urn:example' => ['Taco Club'], 'not-affected-by-authproc' => ['Value'], @@ -150,10 +150,10 @@ public function testAuthprocConfig(): void $loadedConfig = Configuration::loadFromArray($casConfig); $attributeExtractor = new AttributeExtractor( $loadedConfig, - new ProcessingChainFactory($loadedConfig) + new ProcessingChainFactory($loadedConfig), ); // The authproc filters will remap the attributes prior to mapping them to CAS attributes - $result = $attributeExtractor->extractUserAndAttributes($attributes); + $result = $attributeExtractor->extractUserAndAttributes($state); $expectedAttributes = [ 'additionalAttribute' => ['Taco Club'], diff --git a/tests/src/Cas/Protocol/Cas20Test.php b/tests/src/Cas/Protocol/Cas20Test.php index bf6d23cf..b85828e2 100644 --- a/tests/src/Cas/Protocol/Cas20Test.php +++ b/tests/src/Cas/Protocol/Cas20Test.php @@ -52,8 +52,20 @@ public function testAttributeToXmlConversion(): void $casProtocol = new Cas20($casConfig); $casProtocol->setAttributes($userAttributes); + // We will remove the cas:authenticationDate element since we know that it will fail. The dates will not match $xml = $casProtocol->getValidateSuccessResponse('myUser'); + $actualXml = simplexml_load_string((string)$xml); - $this->assertEquals($this->document->saveXML($this->document->documentElement), strval($xml)); + $expectedXml = simplexml_load_string($this->document->saveXML($this->document->documentElement)); + + // We will remove the cas:authenticationDate element since we know that it will fail. The dates will not match + $authenticationNodeToDeleteExpected = $expectedXml->xpath('//cas:authenticationDate')[0]; + $authenticationNodeToDeleteActual = $actualXml->xpath('//cas:authenticationDate')[0]; + unset($authenticationNodeToDeleteExpected[0], $authenticationNodeToDeleteActual[0]); + + $this->assertEquals( + $expectedXml->asXML(), + $actualXml->asXML(), + ); } } diff --git a/tests/src/Cas/Protocol/SamlValidateTest.php b/tests/src/Cas/Protocol/SamlValidateTest.php index ee89a814..0b51ec5e 100644 --- a/tests/src/Cas/Protocol/SamlValidateTest.php +++ b/tests/src/Cas/Protocol/SamlValidateTest.php @@ -6,14 +6,13 @@ use PHPUnit\Framework\TestCase; use SimpleSAML\Module\casserver\Cas\Protocol\SamlValidateResponder; -use SimpleSAML\SOAP11\XML\env\Envelope; -use SimpleXMLElement; +use SimpleSAML\SOAP\XML\env_200305\Envelope; class SamlValidateTest extends TestCase { /** */ - public function testSamlValidatXmlGeneration(): void + public function testSamlValidateXmlGeneration(): void { $serviceUrl = 'http://jellyfish.greatvalleyu.com:7777/ssomanager/c/SSB'; $udcValue = '2F10C881AC7D55942329E149405DC2F5'; @@ -27,24 +26,43 @@ public function testSamlValidatXmlGeneration(): void $samlValidate = new SamlValidateResponder(); $xmlString = $samlValidate->convertToSaml($ticket); - $response = new SimpleXMLElement(strval($xmlString)); + + $p = xml_parser_create(); + xml_parse_into_struct($p, \strval($xmlString), $vals, $index); + xml_parser_free($p); /** @psalm-suppress PossiblyNullPropertyFetch */ - $this->assertEquals($serviceUrl, $response->attributes()->Recipient); - $this->assertEquals('samlp:Success', $response->Status->StatusCode->attributes()->Value); - $this->assertEquals('localhost', $response->Assertion->attributes()->Issuer); - $this->assertEquals($serviceUrl, $response->Assertion->Conditions->AudienceRestrictionCondition->Audience); - $attributeStatement = $response->Assertion->AttributeStatement; - $this->assertEquals('saisusr', $attributeStatement->Subject->NameIdentifier); + $this->assertEquals( + $serviceUrl, + $vals[$index['RESPONSE'][0]]['attributes']['RECIPIENT'], + ); + $this->assertEquals( + 'samlp:Success', + $vals[$index['STATUSCODE'][0]]['attributes']['VALUE'], + ); + + $this->assertEquals( + 'localhost', + $vals[$index['SAML:ASSERTION'][0]]['attributes']['ISSUER'], + ); + + $this->assertEquals($serviceUrl, $vals[$index['SAML:AUDIENCE'][0]]['value']); + + $this->assertEquals('saisusr', $vals[$index['SAML:NAMEIDENTIFIER'][0]]['value']); $this->assertEquals( 'urn:oasis:names:tc:SAML:1.0:cm:artifact', - $attributeStatement->Subject->SubjectConfirmation->ConfirmationMethod, + $vals[$index['SAML:CONFIRMATIONMETHOD'][0]]['value'], ); - $attribute = $attributeStatement->Attribute; - $this->assertEquals('UDC_IDENTIFIER', $attribute->attributes()->AttributeName); - $this->assertEquals('http://www.ja-sig.org/products/cas/', $attribute->attributes()->AttributeNamespace); - $this->assertEquals($udcValue, $attribute->AttributeValue); + $this->assertEquals( + 'UDC_IDENTIFIER', + $vals[$index['SAML:ATTRIBUTE'][0]]['attributes']['ATTRIBUTENAME'], + ); + $this->assertEquals( + 'http://www.ja-sig.org/products/cas/', + $vals[$index['SAML:ATTRIBUTE'][0]]['attributes']['ATTRIBUTENAMESPACE'], + ); + $this->assertEquals($udcValue, $vals[$index['SAML:ATTRIBUTEVALUE'][0]]['value']); $asSoap = $samlValidate->wrapInSoap($xmlString); From 6a52c3b60a52687f3ce3a9e695f7bae0d4c0e2dc Mon Sep 17 00:00:00 2001 From: Patrick Radtke Date: Thu, 14 Nov 2024 16:44:23 -0800 Subject: [PATCH 6/9] Add testing steps with docker image to README --- README.md | 24 ++++++ docker/apache-override.cf | 14 ++++ docker/ssp/authsources.php | 62 ++++++++++++++++ docker/ssp/config-override.php | 12 +++ docker/ssp/module_casserver.php | 126 ++++++++++++++++++++++++++++++++ 5 files changed, 238 insertions(+) create mode 100644 docker/apache-override.cf create mode 100644 docker/ssp/authsources.php create mode 100644 docker/ssp/config-override.php create mode 100644 docker/ssp/module_casserver.php diff --git a/README.md b/README.md index 1e559865..406ef057 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,30 @@ chance it will just mess up your code. phpcbf --ignore=somefile.php --standard=PSR12 lib/ tests/ www/ templates/ ``` +### Local testing with docker + +To explore the module using docker run the below command. This will run an SSP image, with the current git checkout +of the `casserver` module mounted in the container, along with some configuration files. Any code changes you make to your git checkout are +"live" in the container, allowing you to test and iterate different things. + +``` +# Note: this currently errors on this module requiring a newer version of `simplesamlphp/xml-common` than what is in the base image +docker run --name ssp-casserver-dev \ + --mount type=bind,source="$(pwd)",target=/var/simplesamlphp/staging-modules/casserver,readonly \ + -e STAGINGCOMPOSERREPOS=casserver \ + -e COMPOSER_REQUIRE="simplesamlphp/simplesamlphp-module-casserver:@dev simplesamlphp/simplesamlphp-module-preprodwarning" + -e SSP_ADMIN_PASSWORD=secret1 \ + --mount type=bind,source="$(pwd)/docker/ssp/module_casserver.php",target=/var/simplesamlphp/config/module_casserver.php,readonly \ + --mount type=bind,source="$(pwd)/docker/ssp/authsources.php",target=/var/simplesamlphp/config/authsources.php,readonly \ + --mount type=bind,source="$(pwd)/docker/ssp/config-override.php",target=/var/simplesamlphp/config/config-override.php,readonly \ + --mount type=bind,source="$(pwd)/docker/apache-override.cf",target=/etc/apache2/sites-enabled/ssp-override.cf,readonly \ + -p 443:443 cirrusid/simplesamlphp:v2.3.2 +``` + +Visit https://localhost/simplesaml/ and confirm you get the default page. +Then navigate to [casserver debug](https://localhost/cas/login?service=http://host1.domain:1234/path1&debugMode=true), authenticate and confirm +use see what a ticket would look like. To see what a CAS v1 saml response looks like set [debugMode=samlValidate](https://localhost/cas/login?service=http://host1.domain:1234/path1&debugMode=samlValidate) + ## History CAS 1.0 and 2.0 compliant CAS server module for simpleSAMLphp diff --git a/docker/apache-override.cf b/docker/apache-override.cf new file mode 100644 index 00000000..867ebaa5 --- /dev/null +++ b/docker/apache-override.cf @@ -0,0 +1,14 @@ +RewriteEngine On +RewriteRule ^/.well-known/openid-configuration(.*) /${SSP_APACHE_ALIAS}module.php/oidc/.well-known/openid-configuration$1 [PT] +RewriteRule ^/.well-known/openid-federation(.*) /${SSP_APACHE_ALIAS}module.php/oidc/.well-known/openid-federation$1 [PT] + +# Some CAS clients expect you to run under /cas/ so you use some rewrite rules + +RewriteRule ^/cas/login(.*) /${SSP_APACHE_ALIAS}module.php/casserver/login.php$1 [PT] +RewriteRule ^/cas/serviceValidate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/serviceValidate.php$1 [PT] +RewriteRule ^/cas/p3/serviceValidate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/serviceValidate.php$1 [PT] +RewriteRule ^/cas/proxyValidate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/serviceValidate.php$1 [PT] +RewriteRule ^/cas/p3/proxyValidate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/serviceValidate.php$1 [PT] +RewriteRule ^/cas/validate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/validate.php$1 [PT] +RewriteRule ^/cas/logout(.*) /${SSP_APACHE_ALIAS}module.php/casserver/logout.php$1 [PT] +RewriteRule ^/cas/samlValidate(.*) /${SSP_APACHE_ALIAS}module.php/casserver/samlValidate.php$1 [PT] \ No newline at end of file diff --git a/docker/ssp/authsources.php b/docker/ssp/authsources.php new file mode 100644 index 00000000..134815f8 --- /dev/null +++ b/docker/ssp/authsources.php @@ -0,0 +1,62 @@ + array( + 'core:AdminPassword', + ), + + 'example-userpass' => [ + 'exampleauth:UserPass', + 'users' => [ + 'student:studentpass' => [ + 'uid' => ['student'], + 'eduPersonAffiliation' => ['member', 'student'], + 'eduPersonNickname' => 'Sir_Nickname', + 'displayName' => 'Some User', + 'givenName' => 'Firsty', + 'middle_name' => 'Mid', + 'sn' => 'Lasty', + 'labeledURI' => 'https://example.com/student', + 'jpegURL' => 'https://example.com/student.jpg', + 'mail' => 'something@example.com', + 'email_verified' => 'yes', + 'zoneinfo' => 'Europe/Paris', + 'updated_at' => '1621374126', + 'preferredLanguage' => 'fr-CA', + 'website' => 'https://example.com/student-blog', + 'gender' => 'female', + 'birthdate' => '1945-03-21', + 'eduPersonUniqueId' => '13579', + 'phone_number_verified' => 'yes', + 'mobile' => '+1 (604) 555-1234;ext=5678', + 'postalAddress' => ["Place Charles de Gaulle, Paris"], + 'street_address' => ['Place Charles de Gaulle'], + 'locality' => ['Paris'], + 'region' => ['Île-de-France'], + 'postal_code' => ['75008'], + 'country' => ['France'], + // Confirm that an attribute containing xml stuff is handled + 'attributeContainingXml' => ['', 'test < "'] + ], + 'employee:employeepass' => [ + 'uid' => ['employee'], + 'eduPersonAffiliation' => ['member', 'employee'], + 'eduPersonEntitlement' => ['urn:example:oidc:manage:client'] + ], + 'member:memberpass' => [ + 'uid' => ['member'], + 'eduPersonAffiliation' => ['member'], + 'eduPersonEntitlement' => ['urn:example:oidc:manage:client'] + ], + 'minimal:minimalpass' => [ + 'uid' => ['minimal'], + ], + ], + ], + + +); diff --git a/docker/ssp/config-override.php b/docker/ssp/config-override.php new file mode 100644 index 00000000..09d2846b --- /dev/null +++ b/docker/ssp/config-override.php @@ -0,0 +1,12 @@ + 'testsalt', + 'logging.level' => 7, + ] + $config; \ No newline at end of file diff --git a/docker/ssp/module_casserver.php b/docker/ssp/module_casserver.php new file mode 100644 index 00000000..4f5867d5 --- /dev/null +++ b/docker/ssp/module_casserver.php @@ -0,0 +1,126 @@ + 'example-userpass', + + /* Scopes are named sets of entityIDs to be used for scoping. If a named scope is provided during login, then the + IdPs listed by the disco service will be restricted to entityIDs in the specified set. */ + 'scopes' => [ + 'mobile' => [ + 'https://idp1.domain:1234/saml2/idp/metadata.php', + 'https://idp2.domain:5678/saml2/idp/metadata.php' + ], + 'desktop' => [ + 'https://idp3.domain:1234/saml2/idp/metadata.php', + 'https://idp4.domain:5678/saml2/idp/metadata.php' + ] + ], + 'legal_service_urls' => [ + //Any service url string matching any of the following prefixes is accepted + 'http://host1.domain:1234/path1', + 'http://host1.domain:1234/noattributes' => [ + 'attributes' => false, + ], + 'https://host2.domain:5678/path2/path3', + // So is regex + '|^https://.*\.domain.com/|', + // Some configuration options can be overridden + 'https://override.example.com' => [ + 'attrname' => 'uid', + 'attributes_to_transfer' => ['cn'], + ], + ], + + 'legal_target_service_urls' => [ + //Any target service url string matching any of the following prefixes is accepted + 'http://host3.domain:4321/path4', + 'https://host4.domain:8765/path5/path6', + ], + + 'ticketstore' => [ + //defaults to filesystem ticket store using the directory 'ticketcache' + 'class' => 'casserver:FileSystemTicketStore', //Not intended for production + 'directory' => 'ticketcache', + + //'class' => 'casserver:MemCacheTicketStore', + //'prefix' => 'some_prefix', + + //'class' => 'casserver:SQLTicketStore', + //'dsn' => 'pgsql:host=localhost;port=5432;dbname=casserver', + //'username' => 'username', + //'password' => 'password', + //'prefix' => 'some_prefix', + //'options' => [ + // \PDO::ATTR_TIMEOUT => 4, + // ] + + //'class' => 'casserver:RedisTicketStore', + //'prefix' => 'some_prefix', + + // Store tickets in multiple ticket stores for redundancy or to allow + // transitions between data stores without downtime. + /* + 'class' => 'casserver:DelegatingTicketStore', + 'delegateTo' => 'all', + 'ticketStores' => [ + 'oldStore' => [ + 'class' => 'casserver:RedisTicketStore', + 'prefix' => 'cas', + ], + 'newStore' => [ + 'class' => 'casserver:FileSystemTicketStore', + 'prefix' => 'cas' + ] + ]*/ + ], + + 'attrname' => 'uid', // 'eduPersonPrincipalName', + 'attributes' => true, // enable transfer of attributes, defaults to true + 'attributes_to_transfer' => ['cn', 'eduPersonAffiliation', 'attributeContainingXml'], // set of attributes to transfer, defaults to all + + /** + * Optional authproc filter. Only authproc filters that solely rely on attributes + * (such as core:AttributeMap and AttributeAlter) + * may be used. If your authsource supports authproc filters you are better off doing it there. + */ + 'authproc' => [ + [ + 'class' => 'core:AttributeMap', + 'oid2name', + 'urn:example' => 'example', + ], + [ + 'class' => 'preprodwarning:Warning', + ], + // Additional authproc filter + ], + + 'base64attributes' => false, // base64 encode transferred attributes, defaults to false + + /** + * add an attribute with the value of the base64attributes + * configuration parameter to the set of transferred attributes. + * Defaults to not adding an indicator attribute. + */ + 'base64_attributes_indicator_attribute' => 'base64Attributes', + + 'enable_logout' => true, // enable CAS logout, defaults to false + 'skip_logout_page' => true, /*perform a redirect instead of showing a logout page with a link to the location + given in the url parameter, defaults to false. Skipping the logout page makes the + url query parameter to CAS logout mandatory for obvious reasons.*/ + + // how many seconds service tickets are valid for, defaults to 5 + 'service_ticket_expire_time' => 5, + // how many seconds proxy granting tickets are valid for at most, defaults to 3600 + 'proxy_granting_ticket_expire_time' => 600, + //how many seconds proxy tickets are valid for, defaults to 5 + 'proxy_ticket_expire_time' => 5, + + // If query param debugMode=true is sent to the login endpoint then print cas ticket xml. Default false + 'debugMode' => true, +]; From a911fa7e618e5f68bd9c1789848b50f3b53e8950 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Fri, 15 Nov 2024 13:29:25 +0200 Subject: [PATCH 7/9] Review changes. --- composer.json | 11 ++++++++- public/login.php | 26 +++++--------------- src/Cas/AttributeExtractor.php | 2 +- src/Cas/Factories/ProcessingChainFactory.php | 13 ++-------- src/Cas/Protocol/SamlValidateResponder.php | 8 +++--- tests/config/jwks-cert.pem | 12 --------- tests/config/jwks-key.pem | 10 -------- tests/src/Cas/Protocol/SamlValidateTest.php | 2 +- 8 files changed, 24 insertions(+), 60 deletions(-) delete mode 100644 tests/config/jwks-cert.pem delete mode 100644 tests/config/jwks-key.pem diff --git a/composer.json b/composer.json index 6c769fe4..6d347e2a 100644 --- a/composer.json +++ b/composer.json @@ -39,7 +39,7 @@ "simplesamlphp/composer-module-installer": "^1.3", "simplesamlphp/simplesamlphp": "^2.2", "simplesamlphp/xml-cas": "^v1.3", - "simplesamlphp/xml-common": "^v1.18", + "simplesamlphp/xml-common": "^v1.17", "simplesamlphp/xml-soap": "^v1.5" }, "require-dev": { @@ -54,5 +54,14 @@ }, "suggest": { "ext-pdo": "*" + }, + "scripts": { + "validate": [ + "vendor/bin/phpunit --no-coverage --testdox", + "vendor/bin/phpcs -p" + ], + "tests": [ + "vendor/bin/phpunit --no-coverage" + ] } } diff --git a/public/login.php b/public/login.php index 8cda8c8f..5b9798ab 100644 --- a/public/login.php +++ b/public/login.php @@ -183,25 +183,16 @@ // Get the state. // If we come from an authproc filter, we will load the state from the stateId. // If not, we will get the state from the AuthSource Data -try { - $state = $authProcId !== null ? - $attributeExtractor->manageState($authProcId) : - $as->getAuthDataArray(); -} catch (\SimpleSAML\Error\NoState $e) { - var_export($e, true); - die(); -} +$state = $authProcId !== null ? + $attributeExtractor->manageState($authProcId) : + $as->getAuthDataArray(); + // Attribute Handler $state['ReturnTo'] = $returnUrl; if ($authProcId !== null) { $state[ProcessingChain::AUTHPARAM] = $authProcId; } -try { - $mappedAttributes = $attributeExtractor->extractUserAndAttributes($state); -} catch (\SimpleSAML\Error\Exception $e) { - var_export($e, true); - die(); -} +$mappedAttributes = $attributeExtractor->extractUserAndAttributes($state); $serviceTicket = $ticketFactory->createServiceTicket([ 'service' => $serviceUrl, @@ -245,10 +236,5 @@ $httpUtils->redirectTrustedURL($httpUtils->addURLParameters($serviceUrl, $parameters)); } else { // POST - try { - $httpUtils->submitPOSTData($serviceUrl, $parameters); - } catch (\SimpleSAML\Error\Exception $e) { - var_export($e, true); - die(); - } + $httpUtils->submitPOSTData($serviceUrl, $parameters); } diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index 6db73d72..bee5fd4a 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -32,7 +32,7 @@ class AttributeExtractor public function __construct( Configuration $casconfig, - ProcessingChainFactory $processingChainFactory + ProcessingChainFactory $processingChainFactory, ) { $this->casconfig = $casconfig; $this->processingChainFactory = $processingChainFactory; diff --git a/src/Cas/Factories/ProcessingChainFactory.php b/src/Cas/Factories/ProcessingChainFactory.php index 90820a55..6b92e5a0 100644 --- a/src/Cas/Factories/ProcessingChainFactory.php +++ b/src/Cas/Factories/ProcessingChainFactory.php @@ -31,18 +31,9 @@ public function __construct( */ public function build(array $state): ProcessingChain { - $idpMetadata = [ - 'entityid' => $state['Source']['entityid'] ?? '', - // ProcessChain needs to know the list of authproc filters we defined in casserver configuration - 'authproc' => $this->casconfig->getOptionalArray('authproc', []), - ]; - $spMetadata = [ - 'entityid' => $state['Destination']['entityid'] ?? '', - ]; - return new ProcessingChain( - $idpMetadata, - $spMetadata, + $state['Source'], + $state['Destination'], 'casserver', ); } diff --git a/src/Cas/Protocol/SamlValidateResponder.php b/src/Cas/Protocol/SamlValidateResponder.php index dcc82b42..0ce7115e 100644 --- a/src/Cas/Protocol/SamlValidateResponder.php +++ b/src/Cas/Protocol/SamlValidateResponder.php @@ -6,8 +6,8 @@ use SimpleSAML\Configuration; use SimpleSAML\Module\casserver\Shib13\AuthnResponse; -use SimpleSAML\SOAP\XML\env_200305\Body; -use SimpleSAML\SOAP\XML\env_200305\Envelope; +use SimpleSAML\SOAP\XML\env_200106\Body; +use SimpleSAML\SOAP\XML\env_200106\Envelope; use SimpleSAML\XML\Chunk; use SimpleSAML\XML\DOMDocumentFactory; use SimpleSAML\XML\SerializableElementInterface; @@ -64,11 +64,11 @@ public function convertToSaml(array $ticket): Chunk /** * @param \SimpleSAML\XML\SerializableElementInterface $samlResponse - * @return \SimpleSAML\SOAP\XML\env\Envelope + * @return \SimpleSAML\SOAP\XML\env_200106\Envelope */ public function wrapInSoap(SerializableElementInterface $samlResponse): Envelope { - $body = new Body(null, [$samlResponse]); + $body = new Body([$samlResponse]); return new Envelope($body); } } diff --git a/tests/config/jwks-cert.pem b/tests/config/jwks-cert.pem deleted file mode 100644 index 1d37f735..00000000 --- a/tests/config/jwks-cert.pem +++ /dev/null @@ -1,12 +0,0 @@ ------BEGIN CERTIFICATE----- -MIIBxTCCAW+gAwIBAgIUF6cgHno1ftvK5NSTMgKzb+N/9cUwDQYJKoZIhvcNAQEL -BQAwNzELMAkGA1UEBhMCTk8xEzARBgNVBAgMClNvbWUtU3RhdGUxEzARBgNVBAoM -ClNpbXBsZVNBTUwwHhcNMTkwODIzMTMxODAzWhcNMjkwODIwMTMxODAzWjA3MQsw -CQYDVQQGEwJOTzETMBEGA1UECAwKU29tZS1TdGF0ZTETMBEGA1UECgwKU2ltcGxl -U0FNTDBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQDDblC3zTyaroUJr2vVcxsXRrI4 -X1KWpOewfI8qdVCK1efXcjJO/lStq0l3rPHzX2g6VIFKS897E4thBdqbRYHPAgMB -AAGjUzBRMB0GA1UdDgQWBBSle2ndlvLV99q5YZGROsv+MEIjATAfBgNVHSMEGDAW -gBSle2ndlvLV99q5YZGROsv+MEIjATAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3 -DQEBCwUAA0EACx6Z1TGX74wL65mvOEqz3BurPqQlPp7q4bywm3GtMZY7xU/vpyiD -ldRq83U+KnyEmQ9IrrzYXs8ReQ3GSY7q/g== ------END CERTIFICATE----- diff --git a/tests/config/jwks-key.pem b/tests/config/jwks-key.pem deleted file mode 100644 index 304d6aa5..00000000 --- a/tests/config/jwks-key.pem +++ /dev/null @@ -1,10 +0,0 @@ ------BEGIN PRIVATE KEY----- -MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEAw25Qt808mq6FCa9r -1XMbF0ayOF9SlqTnsHyPKnVQitXn13IyTv5UratJd6zx819oOlSBSkvPexOLYQXa -m0WBzwIDAQABAkBwaAAXZ/3mvmCY7IQqlnVLkwcpM3KuYRU+RraV5jo4T8Nq+Nm8 -Cs9ywc3aurepFf72XySwmx6C8/8s63H0WZRhAiEA+y8Noq39K6k1N9j5tSleMH1H -5VHv1zNtbGBL3MfwJjECIQDHLZi4eskwei5Hs98njAyx3WcMnPugfo9xo/yFO54n -/wIhAMkGdWE24iFpQGA71Ez6mJkyCrIrC0otrGtJ/izqDvZhAiAXrNXQZ9fuSTej -EkBeRQllQvnyx94pD6IhUeq8M3/zJQIhAJep7ljBTshymiQleAinU/R5w2y08T63 -QtCUAe5Q1aDW ------END PRIVATE KEY----- diff --git a/tests/src/Cas/Protocol/SamlValidateTest.php b/tests/src/Cas/Protocol/SamlValidateTest.php index 0b51ec5e..217dc201 100644 --- a/tests/src/Cas/Protocol/SamlValidateTest.php +++ b/tests/src/Cas/Protocol/SamlValidateTest.php @@ -6,7 +6,7 @@ use PHPUnit\Framework\TestCase; use SimpleSAML\Module\casserver\Cas\Protocol\SamlValidateResponder; -use SimpleSAML\SOAP\XML\env_200305\Envelope; +use SimpleSAML\SOAP\XML\env_200106\Envelope; class SamlValidateTest extends TestCase { From 7ded7999e9cc0e0121c715241382af3776f334b0 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Fri, 15 Nov 2024 19:38:26 +0200 Subject: [PATCH 8/9] Fix markdown errors --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 406ef057..1c26f5f0 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ To explore the module using docker run the below command. This will run an SSP i of the `casserver` module mounted in the container, along with some configuration files. Any code changes you make to your git checkout are "live" in the container, allowing you to test and iterate different things. -``` +```bash # Note: this currently errors on this module requiring a newer version of `simplesamlphp/xml-common` than what is in the base image docker run --name ssp-casserver-dev \ --mount type=bind,source="$(pwd)",target=/var/simplesamlphp/staging-modules/casserver,readonly \ @@ -102,7 +102,7 @@ docker run --name ssp-casserver-dev \ -p 443:443 cirrusid/simplesamlphp:v2.3.2 ``` -Visit https://localhost/simplesaml/ and confirm you get the default page. +Visit [https://localhost/simplesaml/](https://localhost/simplesaml/) and confirm you get the default page. Then navigate to [casserver debug](https://localhost/cas/login?service=http://host1.domain:1234/path1&debugMode=true), authenticate and confirm use see what a ticket would look like. To see what a CAS v1 saml response looks like set [debugMode=samlValidate](https://localhost/cas/login?service=http://host1.domain:1234/path1&debugMode=samlValidate) @@ -125,4 +125,3 @@ See Google Groups discussion in [this thread][1]. This work is licensed under a Creative Commons GNU Lesser General Public License License. - From f2c07c08b8dc2b2cf0c7285a88c904e971877d37 Mon Sep 17 00:00:00 2001 From: Ioannis Igoumenos Date: Mon, 18 Nov 2024 12:15:02 +0200 Subject: [PATCH 9/9] Fix scrutinizer reported issues --- src/Cas/AttributeExtractor.php | 4 ++-- src/Cas/Factories/ProcessingChainFactory.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Cas/AttributeExtractor.php b/src/Cas/AttributeExtractor.php index bee5fd4a..275f38d8 100644 --- a/src/Cas/AttributeExtractor.php +++ b/src/Cas/AttributeExtractor.php @@ -17,10 +17,10 @@ class AttributeExtractor { /** @var Configuration */ - private readonly Configuration $casconfig; + private Configuration $casconfig; /** @var ProcessingChainFactory */ - private readonly ProcessingChainFactory $processingChainFactory; + private ProcessingChainFactory $processingChainFactory; /** @var State */ private State $authState; diff --git a/src/Cas/Factories/ProcessingChainFactory.php b/src/Cas/Factories/ProcessingChainFactory.php index 6b92e5a0..beaeb85c 100644 --- a/src/Cas/Factories/ProcessingChainFactory.php +++ b/src/Cas/Factories/ProcessingChainFactory.php @@ -17,7 +17,7 @@ class ProcessingChainFactory { /** @var Configuration */ - private readonly Configuration $casconfig; + private Configuration $casconfig; public function __construct( Configuration $casconfig,