Python XML Signature library
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 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.6+ 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 |
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 python-defusedxml 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 python3-defusedxml 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 |
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_xmlVerifying 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_xmlExample: Signing and verifying a SAML assertion
TODOXML 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=...).
Example: Signing and verifying a SOAP WS-Security envelope
TODOSee the API documentation for more.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file signxml-2.6.0.tar.gz.
File metadata
- Download URL: signxml-2.6.0.tar.gz
- Upload date:
- Size: 29.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 70e3edbb07b89bec94d39db2cdced724c540f9258366474177c746b9f903d9c4 |
|
| MD5 | 9b1863be0481573022e8d2793957c4f1 |
|
| BLAKE2b-256 | c83261a8193985fcc4d8aada6157928aa628278a0cb0a8294c0489bf749a0008 |
File details
Details for the file signxml-2.6.0-py2.py3-none-any.whl.
File metadata
- Download URL: signxml-2.6.0-py2.py3-none-any.whl
- Upload date:
- Size: 23.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9540efcddd94e45399fa26ee2d24af43d162d55cbe3a2b36fddb394741993dd5 |
|
| MD5 | 5a4ca51d5540bcc87f8bd63dbebf4ce2 |
|
| BLAKE2b-256 | 3d7113250d8a9eacdd84129551e57ed25d08deb1d37c91adeb020e35e3cec2fc |
