SignXML: XML Signature in Python

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. Three versions of the standard exist (Version 1 “Second Edition”, 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 defusedxml.lxml to defend against common XML-based 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.5+ and PyPy)
Well-supported, portable, reliable dependencies: lxml, defusedxml, cryptography, eight, pyOpenSSL
Comprehensive testing (including the XMLDSig interoperability suite) and continuous integration
Simple interface with useful defaults
Compactness, readability, and extensibility

Installation

pip 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	Python	Command
Ubuntu 16.04	Python 2	apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev python-lxml python-cryptography python-openssl python-certifi python-defusedxml
Ubuntu 16.04	Python 3	apt-get install python3-dev python3-cffi libxml2-dev libxslt1-dev libssl-dev python3-lxml python3-cryptography python3-openssl python3-certifi python3-defusedxml
Ubuntu 14.04	Python 2	apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev
Ubuntu 14.04	Python 3	apt-get install python3-dev python3-cffi libxml2-dev libxslt1-dev libssl-dev
Ubuntu 12.04	Python 2	apt-get install python-dev libxml2-dev libxslt1-dev libssl-dev; pip install cffi
Red Hat	Python 2	yum install python-devel python-cffi libxml2-devel libxslt1-devel openssl-devel
Red Hat	Python 3	yum install python3-devel python3-cffi libxml2-devel libxslt1-devel openssl-devel
OS X/Homebrew		xcode-select --install; brew install openssl; export LDFLAGS="-L$(brew --prefix openssl)/lib" CFLAGS="-I$(brew --prefix openssl)/include"

Synopsis

SignXML uses the ElementTree API (also supported by lxml) to work with XML data.

from signxml import XMLSigner, XMLVerifier

cert = open("example.pem").read()
key = open("example.key").read()
root = ElementTree.fromstring(data_to_sign)
signed_root = XMLSigner().sign(root, key=key, cert=cert)
verified_data = XMLVerifier().verify(signed_root).signed_xml

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_xml

See what is signed

It is important to understand and follow the best practice rule of “See what is signed” when verifying XML signatures. The gist of this rule is: if your application neglects to verify that the information it trusts is what was actually signed, the attacker can supply a valid signature but point you to malicious data that wasn’t signed by that signature. Failure to follow this rule can lead to vulnerability against attacks like SAML signature wrapping.

In SignXML, you can ensure that the information signed is what you expect to be signed by only trusting the data returned by the verify() method. The signed_xml attribute of the return value is the XML node or string that was signed.

Example: Signing and verifying a SAML assertion

TODO

XML 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_xml

For 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=...).

Example: Signing and verifying a SOAP WS-Security envelope

TODO

See the API documentation for more.

Authors

Andrey Kislyuk

License

Licensed under the terms of the Apache License, Version 2.0.

https://img.shields.io/travis/XML-Security/signxml.svg

https://codecov.io/github/XML-Security/signxml/coverage.svg?branch=master

https://img.shields.io/pypi/v/signxml.svg

https://img.shields.io/pypi/l/signxml.svg

https://readthedocs.org/projects/signxml/badge/?version=latest

Metadata

Release files for signxml 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for signxml 2.3.0
File	Size	Uploaded
signxml-2.3.0.tar.gz	29.4 kB	Apr 24, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for signxml 2.3.0
File	Interpreter	ABI	Platform	Reset
signxml-2.3.0-py2.py3-none-any.whl 27.8 kB Apr 24, 2017	Python 2, Python 3	none	any	Details

Total release size: 57.2 kB

Release files / signxml-2.3.0.tar.gz

Download URL	signxml-2.3.0.tar.gz
Size	29.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`09efca5a966a3edf73cec77354200aae7b280aa736d4b3872c07388b69d396d9`
BLAKE2b-256 checksum How to use checksums	`cbdda677b6ff6186fca20c6cff792cfacddefedceae912183b22a938e1acf351`
Upload date	Apr 24, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / signxml-2.3.0-py2.py3-none-any.whl

Download URL	signxml-2.3.0-py2.py3-none-any.whl
Size	27.8 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`50685ee4dd58590c5b263eb8f45db3c95fe4fd0f846183540d8507252391ab11`
BLAKE2b-256 checksum How to use checksums	`fefdb9ad2e32b92cdeb81b6c57eb2785fb6713d3a11412af891d979de8cd7185`
Upload date	Apr 24, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release history Release notifications | RSS feed

5.1.0

Jul 5, 2026 2 release files

5.0.1

Jun 23, 2026 2 release files

5.0.0

Jun 21, 2026 2 release files

4.5.1

Jun 13, 2026 2 release files

4.4.0

Mar 1, 2026 2 release files

4.3.1

Feb 18, 2026 2 release files

4.3.0

Feb 14, 2026 2 release files

4.2.2

Jan 21, 2026 2 release files

4.2.1

Jan 19, 2026 2 release files

4.2.0

Aug 20, 2025 2 release files

4.1.0

Jun 28, 2025 2 release files

4.0.5

Jun 2, 2025 2 release files

4.0.4

Jun 1, 2025 2 release files

4.0.3

Nov 24, 2024 2 release files

4.0.2

Sep 11, 2024 2 release files

4.0.1

Aug 30, 2024 2 release files

4.0.0

Aug 22, 2024 2 release files

3.2.2

Jan 29, 2024 2 release files

3.2.1

Aug 6, 2023 2 release files

3.2.0

Apr 13, 2023 2 release files

3.1.1

Apr 8, 2023 2 release files

3.1.0

Jan 4, 2023 2 release files

3.0.2

Nov 29, 2022 2 release files

3.0.1

Nov 27, 2022 2 release files

3.0.0

Nov 14, 2022 2 release files

2.10.1

Sep 9, 2022 2 release files

2.10.0

Aug 21, 2022 2 release files

2.9.0

Oct 8, 2021 2 release files

2.8.2

May 14, 2021 2 release files

2.8.1

Oct 29, 2020 2 release files

2.8.0

Jun 21, 2020 2 release files

2.7.3

Jun 10, 2020 2 release files

2.7.2

Dec 2, 2019 2 release files

2.7.1

Nov 30, 2019 2 release files

2.7.0

Nov 30, 2019 2 release files

2.6.0

Jan 11, 2019 2 release files

2.5.2

Dec 7, 2017 2 release files

2.4.0

Jul 10, 2017 2 release files

This release

2.3.0 This release

Apr 24, 2017 2 release files

2.2.6

Apr 12, 2017 2 release files

2.2.4

Mar 19, 2017 2 release files

2.2.3

Dec 20, 2016 2 release files

2.2.2

Dec 20, 2016 2 release files

2.2.1

Sep 26, 2016 2 release files

2.2.0

Sep 25, 2016 2 release files

2.1.4

Sep 19, 2016 2 release files

2.0.0

Aug 5, 2016 2 release files

1.0.2

Aug 1, 2016 2 release files

1.0.1

Jul 15, 2016 2 release files

1.0.0

Apr 8, 2016 2 release files

0.6.0

Mar 24, 2016 2 release files

0.5.0

Mar 3, 2016 2 release files

0.4.6

Nov 28, 2015 2 release files

0.4.5

Nov 8, 2015 2 release files

0.4.4

Aug 7, 2015 2 release files

0.4.3

Jul 26, 2015 2 release files

0.4.2

May 24, 2015 2 release files

0.4.1

Apr 21, 2015 1 release file

0.4.0

Mar 8, 2015 1 release file

0.3.9

Feb 4, 2015 1 release file

0.3.8

Feb 4, 2015 1 release file

0.3.7

Feb 4, 2015 1 release file

0.3.6

Jan 10, 2015 1 release file

0.3.5

Dec 23, 2014 1 release file

0.3.4

Dec 15, 2014 1 release file

0.3.3

Dec 13, 2014 1 release file

0.3.2

Dec 12, 2014 1 release file

0.3.1

Oct 17, 2014 1 release file

0.3.0

Oct 17, 2014 1 release file

0.2.9

Oct 15, 2014 1 release file

0.2.8

Oct 14, 2014 1 release file

0.2.7

Oct 14, 2014 1 release file

0.2.6

Oct 13, 2014 1 release file

0.2.5

Oct 13, 2014 1 release file

0.2.4

Oct 13, 2014 1 release file

0.2.3

Oct 13, 2014 1 release file

0.2.2

Oct 4, 2014 1 release file

0.2.1

Oct 4, 2014 1 release file

0.2.0

Oct 3, 2014 1 release file

0.1.9

Sep 27, 2014 1 release file

0.1.8

Sep 26, 2014 1 release file

0.1.7

Sep 26, 2014 1 release file

0.1.6

Sep 26, 2014 1 release file

0.1.5

Sep 26, 2014 1 release file

0.1.4

Sep 26, 2014 1 release file

0.1.3

Sep 23, 2014 1 release file

0.1.2

Sep 22, 2014 1 release file

0.1.1

Sep 22, 2014 1 release file

0.1.0

Sep 22, 2014 1 release file

0.0.1

Sep 3, 2014 1 release file

signxml 2.3.0

SignXML: XML Signature in Python

Installation

Synopsis

Verifying SAML assertions

Example: Signing and verifying a SAML assertion

XML signature methods: enveloped, detached, enveloping

Example: Signing and verifying a SOAP WS-Security envelope

Authors

Links

Bugs

License

Project links

Key dates

1 maintainer

Credits

License

Classifiers

Metadata

Project links

Key dates

1 maintainer

Credits

License

Classifiers

Release files for signxml 2.3.0

Source distribution (sdist)

Built distribution (wheel)

Release files / signxml-2.3.0.tar.gz

Release files / signxml-2.3.0-py2.py3-none-any.whl

Release history Release notifications | RSS feed