signxml

Python XML Signature library

These details have not been verified by PyPI

Project links

Homepage

Project description

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	Python	Command
Ubuntu	Python 2	apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev libffi-dev python-lxml python-cryptography python-openssl python-certifi build-essential
Ubuntu	Python 3	apt-get install python3-dev python3-cffi libxml2-dev libxslt1-dev libssl-dev libffi-dev python3-lxml python3-cryptography python3-openssl python3-certifi build-essential
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
Mac OS	Homebrew Python	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_xml

To 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.
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 software 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_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.

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

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 trusted 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:

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

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

4.0.2

Sep 11, 2024

4.0.1

Aug 30, 2024

4.0.0

Aug 22, 2024

3.2.2

Jan 29, 2024

3.2.1

Aug 6, 2023

3.2.0

Apr 13, 2023

3.1.1

Apr 8, 2023

3.1.0

Jan 4, 2023

3.0.2

Nov 29, 2022

3.0.1

Nov 27, 2022

3.0.0

Nov 14, 2022

2.10.1

Sep 9, 2022

2.10.0

Aug 21, 2022

2.9.0

Oct 8, 2021

2.8.2

May 14, 2021

2.8.1

Oct 29, 2020

2.8.0

Jun 21, 2020

2.7.3

Jun 10, 2020

2.7.2

Dec 2, 2019

This version

2.7.1

Nov 30, 2019

2.7.0

Nov 30, 2019

2.6.0

Jan 11, 2019

2.5.2

Dec 7, 2017

2.4.0

Jul 10, 2017

2.3.0

Apr 24, 2017

2.2.6

Apr 12, 2017

2.2.4

Mar 19, 2017

2.2.3

Dec 20, 2016

2.2.2

Dec 20, 2016

2.2.1

Sep 26, 2016

2.2.0

Sep 25, 2016

2.1.4

Sep 19, 2016

2.0.0

Aug 5, 2016

1.0.2

Aug 1, 2016

1.0.1

Jul 15, 2016

1.0.0

Apr 8, 2016

0.6.0

Mar 24, 2016

0.5.0

Mar 3, 2016

0.4.6

Nov 28, 2015

0.4.5

Nov 8, 2015

0.4.4

Aug 7, 2015

0.4.3

Jul 26, 2015

0.4.2

May 24, 2015

0.4.1

Apr 21, 2015

0.4.0

Mar 8, 2015

0.3.9

Feb 4, 2015

0.3.8

Feb 4, 2015

0.3.7

Feb 4, 2015

0.3.6

Jan 10, 2015

0.3.5

Dec 23, 2014

0.3.4

Dec 15, 2014

0.3.3

Dec 13, 2014

0.3.2

Dec 12, 2014

0.3.1

Oct 17, 2014

0.3.0

Oct 17, 2014

0.2.9

Oct 15, 2014

0.2.8

Oct 14, 2014

0.2.7

Oct 14, 2014

0.2.6

Oct 13, 2014

0.2.5

Oct 13, 2014

0.2.4

Oct 13, 2014

0.2.3

Oct 13, 2014

0.2.2

Oct 4, 2014

0.2.1

Oct 4, 2014

0.2.0

Oct 3, 2014

0.1.9

Sep 27, 2014

0.1.8

Sep 26, 2014

0.1.7

Sep 26, 2014

0.1.6

Sep 26, 2014

0.1.5

Sep 26, 2014

0.1.4

Sep 26, 2014

0.1.3

Sep 23, 2014

0.1.2

Sep 22, 2014

0.1.1

Sep 22, 2014

0.1.0

Sep 22, 2014

0.0.1

Sep 3, 2014

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signxml-2.7.1.tar.gz (31.0 kB view details)

Uploaded Nov 30, 2019 Source

Built Distribution

signxml-2.7.1-py2.py3-none-any.whl (28.1 kB view details)

Uploaded Nov 30, 2019 Python 2 Python 3

File details

Details for the file signxml-2.7.1.tar.gz.

File metadata

Download URL: signxml-2.7.1.tar.gz
Upload date: Nov 30, 2019
Size: 31.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for signxml-2.7.1.tar.gz
Algorithm	Hash digest
SHA256	`01e115dd6a6b773b572f7898807e6f7d0de947a08d6234216d3d8bf8af3163df`
MD5	`ac2f5f1c4a471d37840744c79f5e8ffa`
BLAKE2b-256	`6c30bed5a5854095764c57c8ba3a249e7eaa84a9db73d9fb908a566d9dcf5647`

See more details on using hashes here.

File details

Details for the file signxml-2.7.1-py2.py3-none-any.whl.

File metadata

Download URL: signxml-2.7.1-py2.py3-none-any.whl
Upload date: Nov 30, 2019
Size: 28.1 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for signxml-2.7.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`917515c2b23f3334c8628092ef9fed9fe08af6c502dea9a31a31caf875889e42`
MD5	`bf4700bcf6c53cff3388deae76a354a0`
BLAKE2b-256	`f60002e1a6c81581d1d970f7fa01e799b89e39f9a65dbc68f42cf806d776feef`

See more details on using hashes here.

signxml 2.7.1

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Installation

Synopsis

Verifying SAML assertions

XML signature methods: enveloped, detached, enveloping

XML parsing security and compatibility with xml.etree.ElementTree

Authors

Links

Bugs

License

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes