SignXML is an implementation of the W3C XML Signature standard in Python. This standard (also known as XMLDSig and RFC 3275) is used to provide payload security in SAML 2.0 and WS-Security, among other uses. Two versions of the standard exist (Version 1.1 and Version 2.0). SignXML implements all of the required components of the standard, and most recommended ones. Its features are:
Use of a libxml2-based XML parser configured to defend against common XML attacks when verifying signatures
Extensions to allow signing with and verifying X.509 certificate chains, including hostname/CN validation
Support for exclusive XML canonicalization with inclusive prefixes (InclusiveNamespaces PrefixList, required to verify signatures generated by some SAML implementations)
Modern Python compatibility (2.7-3.8+ and PyPy)
Well-supported, portable, reliable dependencies: lxml, cryptography, eight, pyOpenSSL
Comprehensive testing (including the XMLDSig interoperability suite) and continuous integration
Simple interface with useful defaults
Compactness, readability, and extensibility
Installation
pip3 install signxml
Note: SignXML depends on lxml and cryptography, which in turn depend on OpenSSL, LibXML, and Python tools to interface with them. You can install those as follows:
OS |
Command |
|---|---|
Ubuntu |
apt-get install --no-install-recommends python3-pip python3-wheel python3-setuptools python3-openssl python3-lxml |
Red Hat, Amazon Linux, CentOS |
yum install python3-pip python3-pyOpenSSL python3-lxml |
Mac OS |
Install Homebrew, then run brew install python. |
Synopsis
SignXML uses the lxml ElementTree API to work with XML data.
from lxml import etree
from signxml import XMLSigner, XMLVerifier
data_to_sign = "<Test/>"
cert = open("example.pem").read()
key = open("example.key").read()
root = etree.fromstring(data_to_sign)
signed_root = XMLSigner().sign(root, key=key, cert=cert)
verified_data = XMLVerifier().verify(signed_root).signed_xmlTo make this example self-sufficient for test purposes:
Generate a test certificate and key using openssl req -x509 -sha256 -nodes -subj "/CN=test" -days 1 -newkey rsa:2048 -keyout example.key -out example.pem (run yum install openssl on Red Hat).
Pass the x509_cert=cert keyword argument to XMLVerifier.verify(). (In production, ensure this is replaced with the correct configuration for the trusted CA or certificate - this determines which signatures your application trusts.)
Verifying SAML assertions
Assuming metadata.xml contains SAML metadata for the assertion source:
from lxml import etree
from base64 import b64decode
from signxml import XMLVerifier
with open("metadata.xml", "rb") as fh:
cert = etree.parse(fh).find("//ds:X509Certificate").text
assertion_data = XMLVerifier().verify(b64decode(assertion_body), x509_cert=cert).signed_xmlXML signature methods: enveloped, detached, enveloping
The XML Signature specification defines three ways to compose a signature with the data being signed: enveloped, detached, and enveloping signature. Enveloped is the default method. To specify the type of signature that you want to generate, pass the method argument to sign():
signed_root = XMLSigner(method=signxml.methods.detached).sign(root, key=key, cert=cert)
verified_data = XMLVerifier().verify(signed_root).signed_xmlFor detached signatures, the code above will use the Id or ID attribute of root to generate a relative URI (<Reference URI="#value"). You can also override the value of URI by passing a reference_uri argument to sign(). To verify a detached signature that refers to an external entity, pass a callable resolver in XMLVerifier().verify(data, uri_resolver=...).
See the API documentation for more.
XML parsing security and compatibility with xml.etree.ElementTree
SignXML uses the lxml ElementTree library, not the ElementTree from Python’s standard library, to work with XML. lxml is used due to its superior resistance to XML attacks, as well as XML canonicalization and namespace organization features. It is recommended that you pass XML string input directly to signxml before further parsing, and use lxml to work with untrusted XML input in general. If you do pass xml.etree.ElementTree objects to SignXML, you should be aware of differences in XML namespace handling between the two libraries. See the following references for more information:
Links
W3C Recommendation: XML Signature Syntax and Processing Version 1.1
W3C Working Group Note: XML Signature Syntax and Processing Version 2.0
W3C Working Group Note: XML Security 2.0 Requirements and Design Considerations
W3C Working Group Note: Test Cases for C14N 1.1 and XMLDSig Interoperability
Bugs
Please report bugs, issues, feature requests, etc. on GitHub.
License
Licensed under the terms of the Apache License, Version 2.0.
1 maintainer
Metadata
1 maintainer
Release files for signxml-openadr 2.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| signxml-openadr-2.9.1.tar.gz | 34.6 kB | Without provenance | Details for signxml-openadr-2.9.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| signxml_openadr-2.9.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for signxml_openadr-2.9.1-py2.py3-none-any.whl |
Total release size: 64.8 kB
Release files / signxml-openadr-2.9.1.tar.gz
| Download URL | signxml-openadr-2.9.1.tar.gz |
|---|---|
| Size | 34.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
93bf41824247a36fa09d8ac23435f5675aaa9e1e58fcb3809a549fba9a905c23
|
|
BLAKE2b-256 checksum How to use checksums |
d364a4abf4f7cd12e9f98ea4f782f319782e8c6cf670407b61eac69a4e09b9b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
|
Release files / signxml_openadr-2.9.1-py2.py3-none-any.whl
| Download URL | signxml_openadr-2.9.1-py2.py3-none-any.whl |
|---|---|
| Size | 30.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
da393d73f2f9739b3dcc6b7cbf3c32e22406370ce714cc490ec303d1db822c48
|
|
BLAKE2b-256 checksum How to use checksums |
4f34ebd0664a76cd6daa4b45c06f024bca17686ee8c7b0da254649b390003b4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0
|
Security for signxml-openadr 2.9.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
