Skip to content

Commit 6f1e610

Browse files
pitbulkpitbulk
authored
Merge pull request #409 from onelogin/custom_scheme_path
Ability to set custom schema path.
2 parents fdc3ed0 + 1c35e4f commit 6f1e610

6 files changed

Lines changed: 55 additions & 20 deletions

File tree

‎src/Saml2/LogoutRequest.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public function __construct(\OneLogin\Saml2\Settings $settings, $request = null,
104104
$nameIdFormat = Constants::NAMEID_ENTITY;
105105
}
106106

107-
/* From saml-core-2.0-os 8.3.6, when the entity Format is used:
107+
/* From saml-core-2.0-os 8.3.6, when the entity Format is used:
108108
"The NameQualifier, SPNameQualifier, and SPProvidedID attributes MUST be omitted.
109109
*/
110110
if (!empty($nameIdFormat) && $nameIdFormat == Constants::NAMEID_ENTITY) {
@@ -278,7 +278,7 @@ public static function getNameIdData($request, $key = null)
278278
* @param string|null $key The SP key
279279
*
280280
* @return string Name ID Value
281-
*
281+
*
282282
* @throws Error
283283
* @throws Exception
284284
* @throws ValidationError
@@ -295,7 +295,7 @@ public static function getNameId($request, $key = null)
295295
* @param string|DOMDocument $request Logout Request Message
296296
*
297297
* @return string|null $issuer The Issuer
298-
*
298+
*
299299
* @throws Exception
300300
*/
301301
public static function getIssuer($request)
@@ -324,7 +324,7 @@ public static function getIssuer($request)
324324
* @param string|DOMDocument $request Logout Request Message
325325
*
326326
* @return array The SessionIndex value
327-
*
327+
*
328328
* @throws Exception
329329
*/
330330
public static function getSessionIndexes($request)
@@ -350,7 +350,7 @@ public static function getSessionIndexes($request)
350350
* @param bool $retrieveParametersFromServer True if we want to use parameters from $_SERVER to validate the signature
351351
*
352352
* @return bool If the Logout Request is or not valid
353-
*
353+
*
354354
* @throws Exception
355355
* @throws ValidationError
356356
*/
@@ -368,7 +368,7 @@ public function isValid($retrieveParametersFromServer = false)
368368
$security = $this->_settings->getSecurityData();
369369

370370
if ($security['wantXMLValidation']) {
371-
$res = Utils::validateXML($dom, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive());
371+
$res = Utils::validateXML($dom, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive(), $this->_settings->getSchemasPath());
372372
if (!$res instanceof DOMDocument) {
373373
throw new ValidationError(
374374
"Invalid SAML Logout Request. Not match the saml-schema-protocol-2.0.xsd",

‎src/Saml2/LogoutResponse.php‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,9 @@ class LogoutResponse
6565
*
6666
* @param Settings $settings Settings.
6767
* @param string|null $response An UUEncoded SAML Logout response from the IdP.
68-
*
68+
*
6969
* @throws Error
7070
* @throws Exception
71-
*
7271
*/
7372
public function __construct(\OneLogin\Saml2\Settings $settings, $response = null)
7473
{
@@ -140,7 +139,7 @@ public function getStatus()
140139
* @param bool $retrieveParametersFromServer True if we want to use parameters from $_SERVER to validate the signature
141140
*
142141
* @return bool Returns if the SAML LogoutResponse is or not valid
143-
*
142+
*
144143
* @throws ValidationError
145144
*/
146145
public function isValid($requestId = null, $retrieveParametersFromServer = false)
@@ -154,7 +153,7 @@ public function isValid($requestId = null, $retrieveParametersFromServer = false
154153
$security = $this->_settings->getSecurityData();
155154

156155
if ($security['wantXMLValidation']) {
157-
$res = Utils::validateXML($this->document, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive());
156+
$res = Utils::validateXML($this->document, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive(), $this->_settings->getSchemasPath());
158157
if (!$res instanceof DOMDocument) {
159158
throw new ValidationError(
160159
"Invalid SAML Logout Response. Not match the saml-schema-protocol-2.0.xsd",

‎src/Saml2/Response.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public function isValid($requestId = null)
172172

173173
if ($security['wantXMLValidation']) {
174174
$errorXmlMsg = "Invalid SAML Response. Not match the saml-schema-protocol-2.0.xsd";
175-
$res = Utils::validateXML($this->document, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive());
175+
$res = Utils::validateXML($this->document, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive(), $this->_settings->getSchemasPath());
176176
if (!$res instanceof DOMDocument) {
177177
throw new ValidationError(
178178
$errorXmlMsg,
@@ -182,7 +182,7 @@ public function isValid($requestId = null)
182182

183183
// If encrypted, check also the decrypted document
184184
if ($this->encrypted) {
185-
$res = Utils::validateXML($this->decryptedDocument, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive());
185+
$res = Utils::validateXML($this->decryptedDocument, 'saml-schema-protocol-2.0.xsd', $this->_settings->isDebugActive(), $this->_settings->getSchemasPath());
186186
if (!$res instanceof DOMDocument) {
187187
throw new ValidationError(
188188
$errorXmlMsg,

‎src/Saml2/Settings.php‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ private function _loadPaths()
164164
'base' => $basePath,
165165
'config' => $basePath,
166166
'cert' => $basePath.'certs/',
167-
'lib' => $basePath.'src/'
167+
'lib' => $basePath.'src/Saml2/'
168168
);
169169

170170
if (defined('ONELOGIN_CUSTOMPATH')) {
@@ -220,9 +220,23 @@ public function getLibPath()
220220
*/
221221
public function getSchemasPath()
222222
{
223+
if (isset($this->_paths['schemas'])) {
224+
return $this->_paths['schemas'];
225+
}
223226
return $this->_paths['lib'].'schemas/';
224227
}
225228

229+
/**
230+
* Set schemas path
231+
*
232+
* @param string $path
233+
* @return $this
234+
*/
235+
public function setSchemasPath($path)
236+
{
237+
$this->_paths['schemas'] = $path;
238+
}
239+
226240
/**
227241
* Loads settings info from a settings Array
228242
*
@@ -929,7 +943,7 @@ public function validateMetadata($xml)
929943
assert(is_string($xml));
930944

931945
$errors = array();
932-
$res = Utils::validateXML($xml, 'saml-schema-metadata-2.0.xsd', $this->_debug);
946+
$res = Utils::validateXML($xml, 'saml-schema-metadata-2.0.xsd', $this->_debug, $this->getSchemasPath());
933947
if (!$res instanceof DOMDocument) {
934948
$errors[] = $res;
935949
} else {

‎src/Saml2/Utils.php‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,13 @@ public static function loadXML(DOMDocument $dom, $xml)
111111
* @param string|DOMDocument $xml The XML string or document which should be validated.
112112
* @param string $schema The schema filename which should be used.
113113
* @param bool $debug To disable/enable the debug mode
114+
* @param string $schemaPath Change schema path
114115
*
115116
* @return string|DOMDocument $dom string that explains the problem or the DOMDocument
116117
*
117118
* @throws Exception
118119
*/
119-
public static function validateXML($xml, $schema, $debug = false)
120+
public static function validateXML($xml, $schema, $debug = false, $schemaPath = null)
120121
{
121122
assert(is_string($xml) || $xml instanceof DOMDocument);
122123
assert(is_string($schema));
@@ -134,7 +135,12 @@ public static function validateXML($xml, $schema, $debug = false)
134135
}
135136
}
136137

137-
$schemaFile = __DIR__ . '/schemas/' . $schema;
138+
if (isset($schemaPath)) {
139+
$schemaFile = $schemaPath . $schema;
140+
} else {
141+
$schemaFile = __DIR__ . '/schemas/' . $schema;
142+
}
143+
138144
$oldEntityLoader = libxml_disable_entity_loader(false);
139145
$res = $dom->schemaValidate($schemaFile);
140146
libxml_disable_entity_loader($oldEntityLoader);
@@ -622,7 +628,7 @@ public static function getSelfRoutedURLNoQuery()
622628
if (!empty($_SERVER['REQUEST_URI'])) {
623629
$route = $_SERVER['REQUEST_URI'];
624630
if (!empty($_SERVER['QUERY_STRING'])) {
625-
$route = self::str_lreplace($_SERVER['QUERY_STRING'], '', $route);
631+
$route = self::strLreplace($_SERVER['QUERY_STRING'], '', $route);
626632
if (substr($route, -1) == '?') {
627633
$route = substr($route, 0, -1);
628634
}
@@ -644,7 +650,7 @@ public static function getSelfRoutedURLNoQuery()
644650
return $selfRoutedURLNoQuery;
645651
}
646652

647-
public static function str_lreplace($search, $replace, $subject)
653+
public static function strLreplace($search, $replace, $subject)
648654
{
649655
$pos = strrpos($subject, $search);
650656

‎tests/src/OneLogin/Saml2/SettingsTest.php‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public function testGetLibPath()
8787
$settings = new Settings();
8888
$base = $settings->getBasePath();
8989

90-
$this->assertEquals($base.'src/', $settings->getLibPath());
90+
$this->assertEquals($base.'src/Saml2/', $settings->getLibPath());
9191
}
9292

9393
/**
@@ -100,10 +100,26 @@ public function testGetSchemasPath()
100100
$settings = new Settings();
101101
$base = $settings->getBasePath();
102102

103-
$this->assertEquals($base.'src/schemas/', $settings->getSchemasPath());
103+
$this->assertEquals($base.'src/Saml2/schemas/', $settings->getSchemasPath());
104104

105105
}
106106

107+
/**
108+
* Tests getSchemasPath method of the Settings
109+
*
110+
* @covers OneLogin\Saml2\Settings::setSchemasPath
111+
*/
112+
public function testSetSchemasPath()
113+
{
114+
$settings = new Settings();
115+
$base = $settings->getBasePath();
116+
117+
$this->assertEquals($base.'src/Saml2/schemas/', $settings->getSchemasPath());
118+
119+
$settings->setSchemasPath('custompath/');
120+
$this->assertEquals('custompath/', $settings->getSchemasPath());
121+
}
122+
107123
/**
108124
* Tests shouldCompressRequests method of Settings.
109125
*

0 commit comments

Comments
 (0)