diff --git a/CHANGELOG.md b/CHANGELOG.md index 87595fd08..49e79740e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ # Changelog +- Correct documentation for `signing_algorithm` and `digest_algorithm` configuration options. + ## 7.5.2 (2025-02-10) - Include the XSD of the XML Encryption Syntax and Processing Version 1.1 to the schema validator diff --git a/docs/howto/config.rst b/docs/howto/config.rst index b3e3cb5e1..59f8f001d 100644 --- a/docs/howto/config.rst +++ b/docs/howto/config.rst @@ -1369,12 +1369,7 @@ signing_algorithm Default algorithm to be used. Example:: - "service": { - "sp": { - "signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512", - "digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512", - } - } + "signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512", digest_algorithm @@ -1382,14 +1377,26 @@ digest_algorithm Default algorithm to be used. Example:: - "service": { - "idp": { - "signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512", - "digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512", - } + "digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512", + +Note that previously the documentation suggested `signing_algorithm` and +`digest_algorithm` configuration belong in the `service.idp` or `service.sp` section +which was not correct. + +There are constants for the identifiers of the algorithms in the `saml2.xmldsig` module. +For example:: + + + from saml2 import xmldsig + + { + "signing_algorithm": xmldsig.SIG_RSA_SHA256, + "digest_algorithm": xmldsig.DIGEST_SHA256, + ... } + logout_responses_signed """""""""""""""""""""""