@@ -235,10 +235,12 @@ encryption_keypairs
235235Indicates which certificates will be used for encryption capabilities::
236236
237237 # Encryption
238- 'encryption_keypairs': [{
239- 'key_file': BASE_DIR + '/certificates/private.key',
240- 'cert_file': BASE_DIR + '/certificates/public.cert',
241- }],
238+ 'encryption_keypairs': [
239+ {
240+ 'key_file': BASE_DIR + '/certificates/private.key',
241+ 'cert_file': BASE_DIR + '/certificates/public.cert',
242+ },
243+ ],
242244
243245metadata
244246^^^^^^^^
@@ -273,7 +275,7 @@ For example::
273275 {
274276 "url": "https://mdq.thaturl.org/",
275277 "disable_ssl_certificate_validation": True,
276- "check_validity": False
278+ "check_validity": False,
277279 },
278280 ],
279281 },
@@ -286,9 +288,11 @@ metadata signing certificates should be used. These public keys must be
286288acquired by some secure out-of-band method before being placed on the local
287289file system.
288290
289- When using MDQ or remote, the paramenter *disable_ssl_certificate_validation *
290- prevents that the validity of ssl certificate involved in the https connection
291- will be verified. *check_validity * to False accept as valid the metadata that has expired.
291+ When the parameter *check_validity * is set to False metadata that have expired
292+ will be accepted as valid.
293+
294+ When the paramenter *disable_ssl_certificate_validation * is set to True the
295+ validity of ssl certificate will be skipped.
292296
293297When using MDQ, the `freshness_period ` option can be set to define a period for
294298which the metadata fetched from the the MDQ server are considered fresh. After
@@ -406,8 +410,8 @@ difference you are prepared to accept.
406410allow_unknown_attributes
407411""""""""""""""""""""""""
408412
409- Indicates that attributes not configured in attribute-mapping, with
410- unsupported attribute name format , will not be discarded.
413+ Indicates that attributes that are not recognized (they are not configured in
414+ attribute-mapping) , will not be discarded.
411415Default to False.
412416
413417xmlsec_binary
@@ -465,7 +469,9 @@ True or False. Default is False.
465469
466470want_authn_requests_only_with_valid_cert
467471""""""""""""""""""""""""""""""""""""""""
468- This option make mandatory the presence of the SP cert in a (signed) AuthnRequest.
472+
473+ When verifying a signed AuthnRequest ignore the signature and verify the
474+ certificate.
469475
470476policy
471477""""""
@@ -914,14 +920,14 @@ Example::
914920only_use_keys_in_metadata
915921"""""""""""""""""""""""""
916922
917- If True prevents that the certificate contained in a
918- SAML message, if present, will be used for signature verification.
923+ If set to False, the certificate contained in a SAML message will be used for
924+ signature verification.
919925Default True.
920926
921927validate_certificate
922928""""""""""""""""""""
923929
924- Indicates that the certificate used in signatures must be valid.
930+ Indicates that the certificate used in sign SAML messages must be valid.
925931Default to False.
926932
927933logout_requests_signed
@@ -1088,21 +1094,29 @@ Other considerations
10881094
10891095Entity Categories
10901096-----------------
1091- Entity categories and their attributes are defined in src/saml2/entity_category/<registrar of entcat>.py
1097+
1098+ Entity categories and their attributes are defined in
1099+ src/saml2/entity_category/<registrar-of-entity-category>.py.
10921100We can configure Entity Categories in pysaml2 in two ways:
10931101
1094- 1. As EntityAttributes, *entity_category_support * or *entity_category *.
1095- 2. As Policy, it acts like a filter.
1102+ 1. Using the configuration options *entity_category_support * or
1103+ *entity_category *, to generate the appropriate EntityAttribute metadata
1104+ elements.
1105+ 2. Using the configuration option *entity_categories * as part of the policy
1106+ configuration, to make the entity category work as a filter on the
1107+ attributes that will be released.
10961108
1097- Entity Category and Entity Category support can be configured as follow::
1109+ If the entity categories are configured as metadata, as follow::
10981110
10991111 'debug' : True,
11001112 'xmlsec_binary': get_xmlsec_binary([/usr/bin/xmlsec1']),
11011113 'entityid': '%s/metadata' % BASE_URL,
11021114
11031115 # or entity_category: [ ... ]
1104- 'entity_category_support': [edugain.COCO, # "http://www.geant.net/uri/dataprotection-code-of-conduct/v1"
1105- refeds.RESEARCH_AND_SCHOLARSHIP],
1116+ 'entity_category_support': [
1117+ edugain.COCO, # "http://www.geant.net/uri/dataprotection-code-of-conduct/v1"
1118+ refeds.RESEARCH_AND_SCHOLARSHIP,
1119+ ],
11061120
11071121 'attribute_map_dir': 'data/attribute-maps',
11081122 'description': 'SAML2 IDP',
@@ -1114,21 +1128,21 @@ Entity Category and Entity Category support can be configured as follow::
11141128In the metadata we'll then have::
11151129
11161130 <md:Extensions>
1117- <mdattr:EntityAttributes>
1131+ <mdattr:EntityAttributes>
11181132 <saml:Attribute Name="http://macedir.org/entity-category-support" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
1119- <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://www.geant.net/uri/dataprotection-code-of-conduct/v1</saml:AttributeValue>
1120- <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://refeds.org/category/research-and-scholarship</saml:AttributeValue>
1133+ <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://www.geant.net/uri/dataprotection-code-of-conduct/v1</saml:AttributeValue>
1134+ <saml:AttributeValue xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">http://refeds.org/category/research-and-scholarship</saml:AttributeValue>
11211135 </saml:Attribute>
1122- </mdattr:EntityAttributes>
1136+ </mdattr:EntityAttributes>
11231137
1124- If Entity Category would be configured instead in the policy section, as follow, it
1125- will acts like a filter on the released attributes.
1138+ If the entity categories are configurated in the policy section, they will act
1139+ as filters on the released attributes.
11261140
11271141Example::
11281142
11291143 "policy": {
1130- "default": {
1144+ "default": {
11311145 "lifetime": {"minutes": 15},
1132-
1133- # if the sp are not conform to entity_categories the attributes will not be released
1146+ # if the SP is not conform to entity_categories
1147+ # the attributes will not be released
11341148 "entity_categories": ["refeds",],
0 commit comments