Skip to main content

Python XML Signature library

Project description

SignXML is an implementation of the W3C XML Signature standard in Python (both “Second Edition” and Version 1.1). This standard (also known as XMLDSig and RFC 3275) 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

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

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()

Verifying SAML assertions

Assuming metadata.xml contains SAML metadata for the assertion source:

from lxml import etree
from base64 import b64decode
from signxml import xmldsig

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

root = etree.parse(b64decode(assertion)).getroot()
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

Project details


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

signxml-0.3.4.tar.gz (41.7 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: signxml-0.3.4.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for signxml-0.3.4.tar.gz
Algorithm Hash digest
SHA256 33f3a7d2f8f234a21df59c22f535245f6d6ba541a1a0f3993e2f4daf5dd5b834
MD5 034b1f7a1f55c351ba68c2ee64f69279
BLAKE2b-256 76e9d8a5a0e2476dd26a8224f4c28d04f88c1de6b7627f4b2f2e889329a31244

See more details on using hashes here.

Supported by

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