Debian Codegraph @

signxml/xades/__init__.py

raw
1 """
2 `XAdES ("XML Advanced Electronic Signatures") <https://en.wikipedia.org/wiki/XAdES>`_ is a standard for attaching
3 metadata to XML Signature objects. This standard is endorsed by the European Union as the implementation for its
4 `eSignature <https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/eSignature+Overview>`_ regulations.
5 While a `W3C publication from 2003 <https://www.w3.org/TR/XAdES/>`_ exists on the standard, that page is out of date
6 and further development was undertaken by `ETSI <https://www.etsi.org>`_. ETSI's approach to standards document
7 publication and versioning is best described as idiosyncratic, with many documents produced over time with confusing
8 terminology and naming. Documents are only available as PDFs, and there is no apparent way to track all publications on
9 a given standard. The most recent and straighforward description of the standard appears to be in the following two
10 documents:
11
12 * `ETSI EN 319 132-1 V1.1.1 (2016-04)
13 <https://www.etsi.org/deliver/etsi_en/319100_319199/31913201/01.01.01_60/en_31913201v010101p.pdf>`_,
14 "Part 1: Building blocks and XAdES baseline signatures"
15 * `ETSI EN 319 132-2 V1.1.1 (2016-04)
16 <https://www.etsi.org/deliver/etsi_en/319100_319199/31913202/01.01.01_60/en_31913202v010101p.pdf>`_,
17 "Part 2: Extended XAdES signatures"
18
19 XAdES metadata is attached to the XML Signature object as sub-elements under the ``ds:Signature/ds:Object`` path. The
20 elements required by each XAdES "level" (profile) are summarized in section 6.3 of the first document above, on
21 pages 50-56.
22
23 In SignXML, use :class:`signxml.xades.XAdESSigner` and :class:`signxml.xades.XAdESVerifier` to sign and verify XAdES
24 signatures, respectively. See `XAdES Signatures <#xades-signatures>`_ for examples.
25 """
26
27 from .xades import (
28 XAdESSigner,
29 XAdESDataObjectFormat,
30 XAdESSignaturePolicy,
31 XAdESVerifier,
32 XAdESVerifyResult,
33 XAdESSignatureConfiguration,
34 )