Skip to content

Commit

Permalink
Fix formatting for docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Kanakarakis <[email protected]>
  • Loading branch information
c00kiemon5ter committed Jul 10, 2020
1 parent 0c1873d commit 5d1d035
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions docs/howto/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ General directives
additional_cert_files
^^^^^^^^^^^^^^^^^^^^^

Format::
Example::

additional_cert_files: ["other-cert.pem", "another-cert.pem"]

Expand All @@ -79,29 +79,30 @@ Each entry in *additional_cert_files* must be a PEM formatted file with a single
assurance_certification
^^^^^^^^^^^^^^^^^^^^^^^

Format::
Example::

"assurance_specification": [
"https://refeds.org/sirtfi",
]

Generates an `Attribute` element with name-format
`urn:oasis:names:tc:SAML:2.0:attrname-format:uri` and name
`urn:oasis:names:tc:SAML:attribute:assurance-certification` that contains
`AttributeValue` elements with the given values from the list.
The element is added under the generated metadata `EntityDescriptor` as an
`Extension` element under the `EntityAttributes` element.
Generates an ``Attribute`` element with name-format
``urn:oasis:names:tc:SAML:2.0:attrname-format:uri`` and name
``urn:oasis:names:tc:SAML:attribute:assurance-certification`` that contains
``AttributeValue`` elements with the given values from the list.
The element is added under the generated metadata ``EntityDescriptor`` as an
``Extension`` element under the ``EntityAttributes`` element.

Read more about `representing assurance information at the specification <https://wiki.oasis-open.org/security/SAML2IDAssuranceProfile>`_.

attribute_map_dir
^^^^^^^^^^^^^^^^^

Format::
Points to a directory which has the attribute maps in Python modules.

Example::

"attribute_map_dir": "attribute-maps"

Points to a directory which has the attribute maps in Python modules.
A typical map file will look like this::

MAP = {
Expand Down Expand Up @@ -138,7 +139,7 @@ automatically create the other.
cert_file
^^^^^^^^^

Format::
Example::

cert_file: "cert.pem"

Expand Down Expand Up @@ -175,7 +176,7 @@ and **other**.::
debug
^^^^^

Format::
Example::

debug: 1

Expand All @@ -184,7 +185,7 @@ Whether debug information should be sent to the log file.
entityid
^^^^^^^^

Format::
Example::

entityid: "http://saml.example.com/sp"

Expand All @@ -196,7 +197,7 @@ The globally unique identifier of the entity.
key_file
^^^^^^^^

Format::
Example::

key_file: "key.pem"

Expand Down

0 comments on commit 5d1d035

Please sign in to comment.