Skip to content

Commit fe13b20

Browse files
authored
Doc updates: dependency versions, standard links
1 parent c121105 commit fe13b20

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ SignXML: XML Signature in Python
44
*SignXML* is an implementation of the W3C `XML Signature <http://en.wikipedia.org/wiki/XML_Signature>`_ standard in
55
Python. This standard (also known as XMLDSig and `RFC 3275 <http://www.ietf.org/rfc/rfc3275.txt>`_) is used to provide
66
payload security in `SAML 2.0 <http://en.wikipedia.org/wiki/SAML_2.0>`_ and
7-
`WS-Security <https://en.wikipedia.org/wiki/WS-Security>`_, among other uses. Three versions of the
8-
standard exist (`Version 1 "Second Edition" <http://www.w3.org/TR/xmldsig-core/>`_, `Version 1.1
9-
<http://www.w3.org/TR/xmldsig-core1/>`_, and `Version 2.0 <http://www.w3.org/TR/xmldsig-core2>`_). *SignXML* implements
10-
all of the required components of the standard, and most recommended ones. Its features are:
7+
`WS-Security <https://en.wikipedia.org/wiki/WS-Security>`_, among other uses. Two versions of the standard exist
8+
(`Version 1.1 <http://www.w3.org/TR/xmldsig-core1/>`_ and `Version 2.0 <http://www.w3.org/TR/xmldsig-core2>`_).
9+
*SignXML* implements all of the required components of the standard, and most recommended ones. Its features are:
1110

1211
* Use of `defusedxml.lxml <https://bitbucket.org/tiran/defusedxml>`_ to defend against common XML-based attacks when
1312
verifying signatures
1413
* Extensions to allow signing with and verifying X.509 certificate chains, including hostname/CN validation
1514
* Support for exclusive XML canonicalization with inclusive prefixes (`InclusiveNamespaces PrefixList
1615
<http://www.w3.org/TR/xml-exc-c14n/#def-InclusiveNamespaces-PrefixList>`_, required to verify signatures generated by
1716
some SAML implementations)
18-
* Modern Python compatibility (2.7-3.5+ and PyPy)
17+
* Modern Python compatibility (2.7-3.6+ and PyPy)
1918
* Well-supported, portable, reliable dependencies: `lxml <https://github.com/lxml/lxml>`_, `defusedxml
2019
<https://bitbucket.org/tiran/defusedxml>`_, `cryptography <https://github.com/pyca/cryptography>`_, `eight
2120
<https://github.com/kislyuk/eight>`_, `pyOpenSSL <https://github.com/pyca/pyopenssl>`_
@@ -37,11 +36,11 @@ Note: SignXML depends on `lxml <https://github.com/lxml/lxml>`_ and `cryptograph
3736
+--------------+---------+-------------------------------------------------------------------------------------------------+
3837
| OS | Python | Command |
3938
+==============+=========+=================================================================================================+
40-
| Ubuntu 16.04 | Python 2| ``apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev`` |
41-
| | | ``python-lxml python-cryptography python-openssl python-certifi python-defusedxml`` |
39+
| Ubuntu 16.04,| Python 2| ``apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev`` |
40+
| 18.04 | | ``python-lxml python-cryptography python-openssl python-certifi python-defusedxml`` |
4241
+--------------+---------+-------------------------------------------------------------------------------------------------+
43-
| Ubuntu 16.04 | Python 3| ``apt-get install python3-dev python3-cffi libxml2-dev libxslt1-dev libssl-dev`` |
44-
| | | ``python3-lxml python3-cryptography python3-openssl python3-certifi python3-defusedxml`` |
42+
| Ubuntu 16.04,| Python 3| ``apt-get install python3-dev python3-cffi libxml2-dev libxslt1-dev libssl-dev`` |
43+
| 18.04 | | ``python3-lxml python3-cryptography python3-openssl python3-certifi python3-defusedxml`` |
4544
+--------------+---------+-------------------------------------------------------------------------------------------------+
4645
| Ubuntu 14.04 | Python 2| ``apt-get install python-dev python-cffi libxml2-dev libxslt1-dev libssl-dev`` |
4746
+--------------+---------+-------------------------------------------------------------------------------------------------+
@@ -163,7 +162,6 @@ Links
163162
* `Package distribution (PyPI) <https://pypi.python.org/pypi/signxml>`_
164163
* `Change log <https://github.com/XML-Security/signxml/blob/master/Changes.rst>`_
165164
* `List of W3C XML Signature standards and drafts <http://www.w3.org/TR/#tr_XML_Signature>`_
166-
* `W3C Recommendation: XML Signature Syntax and Processing (Second Edition) <http://www.w3.org/TR/xmldsig-core/>`_
167165
* `W3C Recommendation: XML Signature Syntax and Processing Version 1.1 <http://www.w3.org/TR/xmldsig-core1>`_
168166
* `W3C Working Group Note: XML Signature Syntax and Processing Version 2.0 <http://www.w3.org/TR/xmldsig-core2>`_
169167
* `W3C Working Group Note: XML Security 2.0 Requirements and Design Considerations <https://www.w3.org/TR/2013/NOTE-xmlsec-reqs2-20130411/>`_

0 commit comments

Comments
 (0)