Skip to content

Correct documentation for digest_algorithm and signing_algorithm #994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −11
Open

Correct documentation for digest_algorithm and signing_algorithm #994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
29 changes: 18 additions & 11 deletions docs/howto/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1369,27 +1369,34 @@ 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
"""""""""""""""""

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
"""""""""""""""""""""""

Expand Down