From feba98b584f0b05d3bb36a5e873ce6110eed7840 Mon Sep 17 00:00:00 2001
From: Jaime Perez Crespo <jaime.perez@uninett.no>
Date: Fri, 24 Jul 2015 11:56:41 +0200
Subject: [PATCH] Document the new feature in metarefresh to specify the entity
types to load.
---
docs/simplesamlphp-automated_metadata.txt | 16 +++++++++++
.../config-templates/config-metarefresh.php | 27 +++++++++++++++++++
2 files changed, 43 insertions(+)
diff --git a/docs/simplesamlphp-automated_metadata.txt b/docs/simplesamlphp-automated_metadata.txt
index bd8833deb..8c3a5c40d 100644
--- a/docs/simplesamlphp-automated_metadata.txt
+++ b/docs/simplesamlphp-automated_metadata.txt
@@ -132,6 +132,18 @@ The metarefresh module supports the following configuration options:
: The format of the generated metadata files. This must match the
metadata source added in `config.php`.
+`types`
+: The sets of entities to load. An array containing strings identifying the different types of entities that will be
+ loaded. Valid types are:
+
+ * saml20-idp-remote
+ * saml20-sp-remote
+ * shib13-idp-remote
+ * shib13-sp-remote
+ * attributeauthority-remote
+
+ All entity types will be loaded by default.
+
Each metadata source has the following options:
`src`
@@ -154,6 +166,10 @@ Each metadata source has the following options:
: This is an array which will be combined with the metadata fetched to
generate the final metadata array.
+`types`
+: Same as the option with the same name at the metadata set level. This option has precedence when both are specified,
+ allowing a more fine grained configuration for every metadata source.
+
After you have configured the metadata sources, you need to give the
web-server write access to the output directories. Following the previous example:
diff --git a/modules/metarefresh/config-templates/config-metarefresh.php b/modules/metarefresh/config-templates/config-metarefresh.php
index 8da56ebcc..377c514d4 100644
--- a/modules/metarefresh/config-templates/config-metarefresh.php
+++ b/modules/metarefresh/config-templates/config-metarefresh.php
@@ -51,6 +51,20 @@ $config = array(
51 => array('class' => 'core:AttributeMap', 'oid2name'),
),
),
+
+ /*
+ * The sets of entities to load, any combination of:
+ * - 'saml20-idp-remote'
+ * - 'saml20-sp-remote'
+ * - 'shib13-idp-remote'
+ * - 'shib13-sp-remote'
+ * - 'attributeauthority-remote'
+ *
+ * All of them will be used by default.
+ *
+ * This option takes precedence over the same option per metadata set.
+ */
+ //'types' => array(),
),
),
'expireAfter' => 60*60*24*4, // Maximum 4 days cache time.
@@ -61,6 +75,19 @@ $config = array(
* Can be 'flatfile' or 'serialize'. 'flatfile' is the default.
*/
'outputFormat' => 'flatfile',
+
+
+ /*
+ * The sets of entities to load, any combination of:
+ * - 'saml20-idp-remote'
+ * - 'saml20-sp-remote'
+ * - 'shib13-idp-remote'
+ * - 'shib13-sp-remote'
+ * - 'attributeauthority-remote'
+ *
+ * All of them will be used by default.
+ */
+ //'types' => array(),
),
),
);
--
GitLab