Add possibility to provide connection context to XML storage-handler (#2332)

tvdijen · monkeyiq · commit 394520dbc18e · 2024-11-27T09:33:24.000+10:00
* Add possibility to pass a connection context to the MetaDataStorageHandlerXML

* Add configuration example
diff --git a/config/config.php.dist b/config/config.php.dist
@@ -1134,6 +1134,21 @@ $config = [
      *     ['type' => 'xml', 'file' => 'idp.example.org-idpMeta.xml'],
      * ],
      *
+     * This example defines a remote xml-file with optional connection context.
+     * See PHP documentation for possible context options: https://www.php.net/manual/en/context.php
+     *
+     * 'metadata.sources' => [
+     *     [
+     *         'type' => 'xml',
+     *         'url' => 'https://example.org/idp.example.org-idpMeta.xml',
+     *         'context' => [
+     *             'ssl' => [
+     *                 'verify_peer' => true,
+     *             ],
+     *         ],
+     *     ],
+     * ],
+     *
      * This example defines an mdq source.
      * 'metadata.sources' => [
      *      [
diff --git a/src/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php b/src/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php
@@ -43,11 +43,16 @@ protected function __construct(Configuration $globalConfig, array $config)
         parent::__construct();
 
         $src = $srcXml = null;
+        $context = [];
         if (array_key_exists('file', $config)) {
             // get the configuration
             $src = $globalConfig->resolvePath($config['file']);
         } elseif (array_key_exists('url', $config)) {
             $src = $config['url'];
+            if (array_key_exists('context', $config)) {
+                Assert::isArray($config['context']);
+                $context = $config['context'];
+            }
         } elseif (array_key_exists('xml', $config)) {
             $srcXml = $config['xml'];
         } else {
@@ -60,7 +65,7 @@ protected function __construct(Configuration $globalConfig, array $config)
         $AAD = [];
 
         if (isset($src)) {
-            $entities = SAMLParser::parseDescriptorsFile($src);
+            $entities = SAMLParser::parseDescriptorsFile($src, $context);
         } elseif (isset($srcXml)) {
             $entities = SAMLParser::parseDescriptorsString($srcXml);
         } else {
diff --git a/src/SimpleSAML/Metadata/SAMLParser.php b/src/SimpleSAML/Metadata/SAMLParser.php
@@ -289,19 +289,20 @@ public static function parseElement(EntityDescriptor $entityElement): SAMLParser
      * instance.
      *
      * @param string $file The path to the file which contains the EntityDescriptor or EntitiesDescriptor element.
+     * @param array $context The connection context to pass to file_get_contents()
      *
      * @return SAMLParser[] An array of SAMLParser instances.
      * @throws \Exception If the file does not parse as XML.
      */
-    public static function parseDescriptorsFile(string $file): array
+    public static function parseDescriptorsFile(string $file, array $context = []): array
     {
         if (empty($file)) {
             throw new Exception('Cannot open file; file name not specified.');
         }
 
         /** @var string $data */
         $httpUtils = new Utils\HTTP();
-        $data = $httpUtils->fetch($file);
+        $data = $httpUtils->fetch($file, $context);
 
         try {
             $doc = DOMDocumentFactory::fromString($data);

Original file line number	Diff line number	Diff line change
`@@ -289,19 +289,20 @@ public static function parseElement(EntityDescriptor $entityElement): SAMLParser`
`289`	`289`	`* instance.`
`290`	`290`	`*`
`291`	`291`	`* @param string $file The path to the file which contains the EntityDescriptor or EntitiesDescriptor element.`
	`292`	`+ * @param array $context The connection context to pass to file_get_contents()`
`292`	`293`	`*`
`293`	`294`	`* @return SAMLParser[] An array of SAMLParser instances.`
`294`	`295`	`* @throws \Exception If the file does not parse as XML.`
`295`	`296`	`*/`
`296`		`- public static function parseDescriptorsFile(string $file): array`
	`297`	`+ public static function parseDescriptorsFile(string $file, array $context = []): array`
`297`	`298`	`{`
`298`	`299`	`if (empty($file)) {`
`299`	`300`	`throw new Exception('Cannot open file; file name not specified.');`
`300`	`301`	`}`
`301`	`302`
`302`	`303`	`/** @var string $data */`
`303`	`304`	`$httpUtils = new Utils\HTTP();`
`304`		`- $data = $httpUtils->fetch($file);`
	`305`	`+ $data = $httpUtils->fetch($file, $context);`
`305`	`306`
`306`	`307`	`try {`
`307`	`308`	`$doc = DOMDocumentFactory::fromString($data);`