Skip to content

Commit ead10a6

Browse files
committed
Correct documentation for digest_algorithm and signing_algorithm
1 parent 0252ec9 commit ead10a6

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Changelog
22

3+
- Correct documentation for `signing_algorithm` and `digest_algorithm` configuration options.
4+
35
## 7.5.2 (2025-02-10)
46

57
- Include the XSD of the XML Encryption Syntax and Processing Version 1.1 to the schema validator

docs/howto/config.rst

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1369,27 +1369,34 @@ signing_algorithm
13691369

13701370
Default algorithm to be used. Example::
13711371

1372-
"service": {
1373-
"sp": {
1374-
"signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512",
1375-
"digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512",
1376-
}
1377-
}
1372+
"signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512",
13781373

13791374

13801375
digest_algorithm
13811376
"""""""""""""""""
13821377

13831378
Default algorithm to be used. Example::
13841379

1385-
"service": {
1386-
"idp": {
1387-
"signing_algorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512",
1388-
"digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512",
1389-
}
1380+
"digest_algorithm": "http://www.w3.org/2001/04/xmlenc#sha512",
1381+
1382+
Note that previously the documentation suggested `signing_algorithm` and
1383+
`digest_algorithm` configuration belong in the `service.idp` or `service.sp` section
1384+
which was not correct.
1385+
1386+
There are constants for the identifiers of the algorithms in the `saml2.xmldsig` module.
1387+
For example::
1388+
1389+
1390+
from saml2 import xmldsig
1391+
1392+
{
1393+
"signing_algorithm": xmldsig.SIG_RSA_SHA256,
1394+
"digest_algorithm": xmldsig.DIGEST_SHA256,
1395+
...
13901396
}
13911397

13921398

1399+
13931400
logout_responses_signed
13941401
"""""""""""""""""""""""
13951402

0 commit comments

Comments
 (0)