Skip to main content

Python XML Signature library

Project description

SignXML is an implementation of the W3C XML Signature standard (RFC 3275) in Python (both “Second Edition” and Version 1.1). This standard (also known as XMLDSig) is used to provide payload security in SAML 2.0, among other uses. 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

  • Modern Python compatibility (2.7-3.4+ and PyPy)

  • Well-supported and 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

Synopsis

from signxml import xmldsig

cert = open("example.pem").read()
key = open("example.key").read()
root = ElementTree.fromstring(signature_data)
xmldsig(root).sign(key=key, cert=cert)
xmldsig(root).verify()

Using a SAML metadata file:

from signxml import xmldsig

with open("metadata.xml", "rb") as fh:
    cert = etree.parse(fh).find("//ds:X509Certificate").text

root = ElementTree.fromstring(signature_data)
xmldsig(root).verify(x509_cert=cert)

See the API documentation for more.

Authors

  • Andrey Kislyuk

License

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

https://travis-ci.org/kislyuk/signxml.png https://coveralls.io/repos/kislyuk/signxml/badge.png?branch=master https://pypip.in/v/signxml/badge.png https://pypip.in/d/signxml/badge.png https://readthedocs.org/projects/signxml/badge/?version=latest

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page