summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Kanakarakis <ivan.kanak@gmail.com>2020-10-25 19:52:23 +0200
committerIvan Kanakarakis <ivan.kanak@gmail.com>2020-10-30 17:24:04 +0200
commit915add35f4ae41c513534bdc5e159872cf2f1ff6 (patch)
tree34a1c5ea352060b199757b4ac411770fb49c518d
parent3fd7839770bf7e1fff0879a3ccfb4bb2bb5a1c9e (diff)
downloadpysaml2-915add35f4ae41c513534bdc5e159872cf2f1ff6.tar.gz
Update docs
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
-rw-r--r--docs/howto/config.rst53
1 files changed, 31 insertions, 22 deletions
diff --git a/docs/howto/config.rst b/docs/howto/config.rst
index 50be1de7..88b0f6fa 100644
--- a/docs/howto/config.rst
+++ b/docs/howto/config.rst
@@ -517,22 +517,23 @@ policy
""""""
If the server is an IdP and/or an AA, then there might be reasons to do things
-differently depending on who is asking; this is where that is specified.
-The keys are 'default' and SP entity identifiers. Default is used whenever
-there is no entry for a specific SP. The reasoning is also that if there is
-no default and only SP entity identifiers as keys, then the server will only
-accept connections from the specified SPs.
+differently depending on who is asking (which is the requesting service); the
+policy is where this behaviour is specified.
+
+The keys are SP entity identifiers, Registration Authority names, or 'default'.
+First, the policy for the requesting service is looked up using the SP entityID.
+If no such policy is found, and if the SP metadata includes a Registration
+Authority then a policy for the registration authority is looked up using the
+Registration Authority name. If no policy is found, then the 'default' is looked
+up. If there is no default and only SP entity identifiers as keys, then the
+server will only accept connections from the specified SPs.
+
An example might be::
"service": {
"idp": {
"policy": {
- "default": {
- "lifetime": {"minutes":15},
- "attribute_restrictions": None, # means all I have
- "name_form": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri",
- "entity_categories": ["edugain"]
- },
+ # a policy for a service
"urn:mace:example.com:saml:roland:sp": {
"lifetime": {"minutes": 5},
"attribute_restrictions": {
@@ -540,16 +541,23 @@ An example might be::
"surName": None,
},
},
- "registration_authorities": {
- "default" {
- "attribute_restrictions": None
+
+ # a policy for a registration authority
+ "http://www.swamid.se/": {
+ "attribute_restrictions": {
+ "givenName": None,
},
- "http://www.swamid.se/": {
- "attribute_restrictions": {
- "givenName": None,
- }
- }
- }
+ },
+
+ # the policy for all other services
+ "default": {
+ "lifetime": {"minutes":15},
+ "attribute_restrictions": None, # means all I have
+ "name_form": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri",
+ "entity_categories": [
+ "edugain",
+ ],
+ },
}
}
}
@@ -573,11 +581,12 @@ An example might be::
the friendly name, and the saml attribute name will be taken from the uri/oid
defined in the attribute map.
*nameid_format*
- Which nameid format that should be used. Defaults to urn:oasis:names:tc:SAML:2.0:nameid-format:transient.
+ Which nameid format that should be used. Defaults to
+ `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`.
*entity_categories*
Entity categories to apply.
*sign*
- Possible choices: "sign": ["response", "assertion", "on_demand"]
+ Possible choices: "response", "assertion", "on_demand"
If restrictions on values are deemed necessary, those are represented by
regular expressions.::