Merge from develop

open-eid · May 20, 2022 · 45349db · 45349db
2 parents 4c59a05 + 426d20c
commit 45349db
Show file tree

Hide file tree

Showing 47 changed files with 736 additions and 128 deletions.
diff --git a/docs/documentation_deployment_instructions.txt b/docs/documentation_deployment_instructions.txt
@@ -1,44 +1,29 @@
-Our documentation is written using [MkDocs](http://www.mkdocs.org/) static documentation site generator and 
-language that we use to write documentation is [Markdown](https://daringfireball.net/projects/markdown/). 
+Our documentation is written using [MkDocs](http://www.mkdocs.org/) static documentation site generator with [Material theme](https://squidfunk.github.io/mkdocs-material/)  and [Markdown](https://daringfireball.net/projects/markdown/).
 
 System requirements
 -------------------
 
-* **Python 2** - All version above 2.6 should work
+* **Python 3** - currently used version is 3.10
 * **pip** - Python package manager
-* **MkDocs CLI** - to generate and deploy new version of documentation
 * **Text Editor** - to edit Markdown documents (i.e [Haroopad](http://pad.haroopress.com/#))
 
-Installing MkDocs
+Installing required software
 -----------------
 
 ### Ubuntu and Mac OS X
 
-Both Ubuntu and Mac OS X come `python` version 2 already installed You only need to install `pip`
+Both Ubuntu and Mac OS X come `python` already installed (the version depends on OS)
 
-1.  Install `pip` on Ubuntu 15.04 `sudo apt-get install python-pip` on Mac OS X `sudo easy_install pip`
-2.  Next up install `mkdocs` using [pip](https://pip.pypa.io/en/stable/): `pip install mkdocs`
+1.  Install `pip` on Ubuntu 18.04 `sudo apt-get install python-pip` on Mac OS X `sudo easy_install pip`
+2.  Install `mkdocs` using [pip](https://pip.pypa.io/en/stable/): `pip install mkdocs`
+3.  Install material theme `pip install mkdocs-material`
 
 ### Windows
 
-Installing Python:
-
-1. Download the installer from the official `python` homepage: <https://www.python.org/downloads/>
-> **NOTE:** Starting with version 2.7.9 and onwards `pip` ships along with python,<br/>
-so there shouldn't be any need to install `pip` separately.
-2. Execute the python installer
-
-Installing Pip:
-
-1. Download [get-pip.py](https://bootstrap.pypa.io/get-pip.py)
-2. Then run the following command (which may require administrator access): `python get-pip.py`
-3. Add C:\Python27\Scripts to the system path (PATH environment variable)
-
-Installing Mkdocs:
-
-Install `mkdocs` using [pip](https://pip.pypa.io/en/stable/): `pip install mkdocs`
-
-Now You're done and can start editing the PDF Validator documentation. 
+1. Install python. Download the installer from the official `python` homepage: <https://www.python.org/downloads/> and install
+> **NOTE:** Starting with version 2.7.9 and onwards `pip` ships along with python, so there shouldn't be any need to install `pip` separately.
+2. Install `mkdocs` using [pip](https://pip.pypa.io/en/stable/): `pip install mkdocs`
+3.  Install material theme `pip install mkdocs-material`
 
 Editing content
 ---------------

diff --git a/...g/siva/qa_strategy/siva2/taskWorkFlow.PNG → ...g/siva/qa_strategy/siva2/taskWorkFlow.png b/...g/siva/qa_strategy/siva2/taskWorkFlow.PNG → ...g/siva/qa_strategy/siva2/taskWorkFlow.png
diff --git a/docs/index.md b/docs/index.md
@@ -34,4 +34,5 @@ SiVa architecture document will cover:
   servers required when deploying SiVa validation web service
   into production
 * [**Quality Assurance**](siva3/qa_strategy) - overview of quality assurance strategy and testing
+* [**Roadmap**](siva3/roadmap) - info about planned releases
 
diff --git a/docs/siva3/appendix/validation_policy.md b/docs/siva3/appendix/validation_policy.md
@@ -98,7 +98,7 @@ http://open-eid.github.io/SiVa/siva3/appendix/validation_policy/#POLv4
 
 1. SiVa implicitly implements constraints that are specified in the specification documents of the signature formats supported by the Service:
 
-	* [BDOC 2.1](http://id.ee/wp-content/uploads/2020/06/bdoc-spec212-eng.pdf) ASiC-E/XAdES signatures
+	* [BDOC 2.1](https://www.id.ee/wp-content/uploads/2021/06/bdoc-spec212-eng.pdf) ASiC-E/XAdES signatures
 	* [X-Road](https://cyber.ee/research/reports/T-4-23-Profile-for-High-Performance-Digital-Signatures.pdf) ASiC-E/XAdES signatures
 	* [PAdES](http://www.etsi.org/deliver/etsi_en/319100_319199/31914201/01.01.01_60/en_31914201v010101p.pdf) signatures
 	* [XAdES](http://www.etsi.org/deliver/etsi_en/319100_319199/31913201/01.01.01_60/en_31913201v010101p.pdf) signatures
@@ -184,7 +184,7 @@ Legend:
 
 
 ### BDOC container spceific requirements
-The BDOC container must conform with [BDOC 2.1](http://id.ee/wp-content/uploads/2020/06/bdoc-spec212-eng.pdf) standard.
+The BDOC container must conform with [BDOC 2.1](https://www.id.ee/wp-content/uploads/2021/06/bdoc-spec212-eng.pdf) standard.
 1.	File extension
 	* ".bdoc" file extension is supported during signature validation.
 2. Only one signature shall be stored in one signatures.xml file.

diff --git a/docs/siva3/interfaces.md b/docs/siva3/interfaces.md
@@ -275,7 +275,7 @@ Structure of validationConclusion block
 | validatedDocument. filename | ValidatedDocument. Filename | - | String | Digitally signed document's file name. Not present for hashcode validation. |
 | validatedDocument. fileHash | ValidatedDocument. FileHash | - | String | Calculated hash for validated document in Base64. Present when report signing is enabled. |
 | validatedDocument. hashAlgo | ValidatedDocument. HashAlgo | - | String | Hash algorithm used. Present when report signing is enabled. |
-| signatureForm | SignatureForm | - | String | Format (and optionally version) of the digitally signed document container. <br> In case of documents in [DIGIDOC-XML](https://www.id.ee/wp-content/uploads/2020/08/digidoc_format_1.3.pdf) (DDOC) format, the "hashcode" suffix is used to denote that the container was validated in [hashcode mode](http://sertkeskus.github.io/dds-documentation/api/api_docs/#ddoc-format-and-hashcode), i.e. without original data files. <br> **Possible values:**  <br> DIGIDOC_XML_1.0 <br> DIGIDOC_XML_1.0_hashcode <br> DIGIDOC_XML_1.1 <br> DIGIDOC_XML_1.1_hashcode <br> DIGIDOC_XML_1.2 <br> DIGIDOC_XML_1.2_hashcode <br> DIGIDOC_XML_1.3 <br> DIGIDOC_XML_1.3_hashcode <br> ASiC_E - used in case of all ASIC-E ([BDOC](http://id.ee/wp-content/uploads/2020/06/bdoc-spec212-eng.pdf)) documents and X-Road simple containers that don't use batch time-stamping (see [specification document](https://cyber.ee/research/reports/T-4-23-Profile-for-High-Performance-Digital-Signatures.pdf))<br> ASiC_E_batchsignature - used in case of X-Road containers with batch signature (see [specification document](https://cyber.ee/research/reports/T-4-23-Profile-for-High-Performance-Digital-Signatures.pdf)) <br> ASiC_S - used in case of all ASIC-S documents |
+| signatureForm | SignatureForm | - | String | Format (and optionally version) of the digitally signed document container. <br> In case of documents in [DIGIDOC-XML](https://www.id.ee/wp-content/uploads/2020/08/digidoc_format_1.3.pdf) (DDOC) format, the "hashcode" suffix is used to denote that the container was validated in [hashcode mode](http://sertkeskus.github.io/dds-documentation/api/api_docs/#ddoc-format-and-hashcode), i.e. without original data files. <br> **Possible values:**  <br> DIGIDOC_XML_1.0 <br> DIGIDOC_XML_1.0_hashcode <br> DIGIDOC_XML_1.1 <br> DIGIDOC_XML_1.1_hashcode <br> DIGIDOC_XML_1.2 <br> DIGIDOC_XML_1.2_hashcode <br> DIGIDOC_XML_1.3 <br> DIGIDOC_XML_1.3_hashcode <br> ASiC_E - used in case of all ASIC-E ([BDOC](https://www.id.ee/wp-content/uploads/2021/06/bdoc-spec212-eng.pdf)) documents and X-Road simple containers that don't use batch time-stamping (see [specification document](https://cyber.ee/research/reports/T-4-23-Profile-for-High-Performance-Digital-Signatures.pdf))<br> ASiC_E_batchsignature - used in case of X-Road containers with batch signature (see [specification document](https://cyber.ee/research/reports/T-4-23-Profile-for-High-Performance-Digital-Signatures.pdf)) <br> ASiC_S - used in case of all ASIC-S documents |
 | signatures | Signatures | - | Array | Collection of signatures found in digitally signed document |
 | signatures[0] | Signature | + | Object | Signature information object |
 | signatures[0]. claimedSigningTime | Signature. ClaimedSigningTime | + | Date | Claimed signing time, i.e. signer's computer time during signature creation |
@@ -299,10 +299,10 @@ Structure of validationConclusion block
 | signatures[0].info. signatureProductionPlace.city | Signature.Info. SignatureProductionPlace.City | - | String | Stated city. |
 | signatures[0].info. signatureProductionPlace.postalCode | Signature.Info. SignatureProductionPlace.PostalCode | - | String | Stated postal code. |
 | signatures[0].info. signingReason | Signature.Info SigningReason | - | String | Free text field for PAdES type signatures for stating the signing reason |
-| signatures[0]. signatureFormat | Signature. SignatureFormat | + | String | Format and profile (according to Baseline Profile) of the signature. See [XAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103171/02.01.01_60/ts_103171v020101p.pdf), [CAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103173/02.02.01_60/ts_103173v020201p.pdf) and [PAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103172/02.02.02_60/ts_103172v020202p.pdf) for detailed description of the Baseline Profile levels. Levels that are accepted in SiVa validation policy are described in [SiVa signature validation policy](/siva3/appendix/validation_policy) <br>**Possible values:**  <br> XAdES_BASELINE_B <br> XAdES_BASELINE_B_BES <br> XAdES_BASELINE_B_EPES <br> XAdES_BASELINE_T <br> XAdES_BASELINE_LT - long-term level XAdES signature where time-stamp is used as a assertion of trusted signing time<br> XAdES_BASELINE_LT_TM - long-term level XAdES signature where time-mark is used as a assertion of trusted signing time. Used in case of [BDOC](http://id.ee/wp-content/uploads/2020/06/bdoc-spec212-eng.pdf) signatures with time-mark profile and [DIGIDOC-XML](https://www.id.ee/wp-content/uploads/2020/08/digidoc_format_1.3.pdf) (DDOC) signatures.<br>  XAdES_BASELINE_LTA <br> CAdES_BASELINE_B <br> CAdES_BASELINE_T <br> CAdES_BASELINE_LT <br> CAdES_BASELINE_LTA<br> PAdES_BASELINE_B <br> PAdES_BASELINE_T <br> PAdES_BASELINE_LT <br> PAdES_BASELINE_LTA |
+| signatures[0]. signatureFormat | Signature. SignatureFormat | + | String | Format and profile (according to Baseline Profile) of the signature. See [XAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103171/02.01.01_60/ts_103171v020101p.pdf), [CAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103173/02.02.01_60/ts_103173v020201p.pdf) and [PAdES Baseline Profile](http://www.etsi.org/deliver/etsi_ts/103100_103199/103172/02.02.02_60/ts_103172v020202p.pdf) for detailed description of the Baseline Profile levels. Levels that are accepted in SiVa validation policy are described in [SiVa signature validation policy](/siva3/appendix/validation_policy) <br>**Possible values:**  <br> XAdES_BASELINE_B <br> XAdES_BASELINE_B_BES <br> XAdES_BASELINE_B_EPES <br> XAdES_BASELINE_T <br> XAdES_BASELINE_LT - long-term level XAdES signature where time-stamp is used as a assertion of trusted signing time<br> XAdES_BASELINE_LT_TM - long-term level XAdES signature where time-mark is used as a assertion of trusted signing time. Used in case of [BDOC](https://www.id.ee/wp-content/uploads/2021/06/bdoc-spec212-eng.pdf) signatures with time-mark profile and [DIGIDOC-XML](https://www.id.ee/wp-content/uploads/2020/08/digidoc_format_1.3.pdf) (DDOC) signatures.<br>  XAdES_BASELINE_LTA <br> CAdES_BASELINE_B <br> CAdES_BASELINE_T <br> CAdES_BASELINE_LT <br> CAdES_BASELINE_LTA<br> PAdES_BASELINE_B <br> PAdES_BASELINE_T <br> PAdES_BASELINE_LT <br> PAdES_BASELINE_LTA |
 | signatures[0]. signatureMethod | Signature. SignatureMethod | + | String | Signature method specification URI used in signature creation. |
 | signatures[0]. signatureLevel | Signature. SignatureLevel | - |String | Legal level of the signature, according to Regulation (EU) No 910/2014. <br> - **Possible values on positive validation result:**<br> QESIG <br> QESEAL <br> QES <br> ADESIG_QC <br> ADESEAL_QC <br> ADES_QC <br> ADESIG <br> ADESEAL <br> ADES <br> - **Possible values on indeterminate validation result:**<br> prefix INDETERMINATE is added to the level described in positive result. For example  INDETERMINATE_QESIG <br> - **Possible values on negative validation result:**<br>In addition to abovementioned<br> NOT_ADES_QC_QSCD <br> NOT_ADES_QC <br> NOT_ADES <br> NA <br> - In case of DIGIDOC-XML 1.0..1.3 formats, value is missing as the signature level is not checked by the JDigiDoc base library that is used for validation. However, the signatures can be indirectly regarded as QES level signatures, see also [SiVa Validation Policy](/siva3/appendix/validation_policy)<br> - In case of XROAD ASICE containers the value is missing as the asicverifier base library do not check the signature level.|
-| signatures[0].signedBy | Signature.SignedBy | + | String | Signers name and identification number, i.e. value of the CN field of the signer's certificate |
+| signatures[0].signedBy | Signature.SignedBy | + | String | In format of "surname, givenName, serialNumber" if  these fields are present in subject distinguished name field. In other cases, value of common name field. |
 | signatures[0].subjectDistinguishedName.serialNumber | Signature.SubjectDistinguishedName.SerialNumber | - | String | SERIALNUMBER value portion in signer's certificate's subject distinguished name |
 | signatures[0].subjectDistinguishedName.commonName | Signature.SubjectDistinguishedName.CommonName | - | String | CN (common name) value portion in signer's certificate's subject distinguished name |
 | signatures[0]. signatureScopes | Signature. SignatureScopes | - | Array | Contains information of the original data that is covered by the signature. |

diff --git a/docs/siva3/references.md b/docs/siva3/references.md
@@ -1,4 +1,4 @@
-# References
+<!--# References:-->
 
   * (1) Lisa_6_Osa_I_SiVa_Testimise_korraldus.pdf
   * (2) Lisa_4_Osa_I_SiVa_Valideerimisteenuse_analuus MUUDETUD.pdf

diff --git a/docs/siva3/roadmap.md b/docs/siva3/roadmap.md
@@ -0,0 +1,15 @@
+<!--# Roadmap:-->
+
+This roadmap is for information purposes and can change without prior notice.
+
+## Planned releases
+### 3.6.0 - June 2022
+- LOTL/TSL loading improvements
+- Dependency updates
+- Digidoc4j 5.0.0
+- Bug fixes
+
+### 3.7.0 - October 2022
+- CRL information improvements in validation report
+- Dependency updates
+- Bug fixes
diff --git a/docs/version_info.md b/docs/version_info.md
@@ -1,16 +1,18 @@
 <!--# Version info-->
 
-| **Version number** | **Change date** | **Author** | **Description** |
-|--------------------|-----------------|------------|-----------------|
-| 0.1 | 06.05.2016 | Mihkel Selgal | Initial SiVa architecture |
-| 1.0 | 26.10.2016 | Priit Reiser, Aare Nurm | Documentation updates |
-| 1.1 | 04.05.2017 | Vadim Pudov, Allan Juhanson, Julia Solovei, Aare Nurm | Documentation updates |
-| 1.2 | 01.11.2017 | Aare Nurm | Update to new version of mkdocs. Addition of SIVA 2.0 documentation structure |
-| 1.3 | 20.12.2017 | Aare Nurm, Siim Suu, Madis Piigli | Documentation updates |
-| 1.4 | 29.01.2019 | Aare Nurm | Addition of SIVA 3.0 document structure |
-| 1.5 | 21.03.2019 | Jorgen Heinsoo | SIVA 3.2 documentation additions with diagnostic data report description |
-| 1.6 | 04.04.2019 | Aare Nurm | Finalizing the documentation for release |
-| 1.7 | 12.06.2020 | Aare Nurm, Priit Üksküla | SIVA 3.3 documentation additions |
-| 1.8 | 01.03.2021 | Markus Kivisalu | SIVA 3.4 documentation additions |
-| 1.9 | 12.04.2021 | Markus Kivisalu | Updated URL-s and reference links |
-| 1.10 | 16.06.2021 | Risto Seene, Markus Kivisalu | SIVA 3.5 documentation additions |
+| **Version number** | **Change date** | **Author**                                            | **Description**                                                               |
+|--------------------|-----------------|-------------------------------------------------------|-------------------------------------------------------------------------------|
+| 0.1                | 06.05.2016      | Mihkel Selgal                                         | Initial SiVa architecture                                                     |
+| 1.0                | 26.10.2016      | Priit Reiser, Aare Nurm                               | Documentation updates                                                         |
+| 1.1                | 04.05.2017      | Vadim Pudov, Allan Juhanson, Julia Solovei, Aare Nurm | Documentation updates                                                         |
+| 1.2                | 01.11.2017      | Aare Nurm                                             | Update to new version of mkdocs. Addition of SIVA 2.0 documentation structure |
+| 1.3                | 20.12.2017      | Aare Nurm, Siim Suu, Madis Piigli                     | Documentation updates                                                         |
+| 1.4                | 29.01.2019      | Aare Nurm                                             | Addition of SIVA 3.0 document structure                                       |
+| 1.5                | 21.03.2019      | Jorgen Heinsoo                                        | SIVA 3.2 documentation additions with diagnostic data report description      |
+| 1.6                | 04.04.2019      | Aare Nurm                                             | Finalizing the documentation for release                                      |
+| 1.7                | 12.06.2020      | Aare Nurm, Priit Üksküla                              | SIVA 3.3 documentation additions                                              |
+| 1.8                | 01.03.2021      | Markus Kivisalu                                       | SIVA 3.4 documentation additions                                              |
+| 1.9                | 12.04.2021      | Markus Kivisalu                                       | Updated URL-s and reference links                                             |
+| 1.10               | 16.06.2021      | Risto Seene, Markus Kivisalu                          | SIVA 3.5 documentation additions                                              |
+| 1.11               | 20.04.2022      | Aare Nurm                                             | Roadmap added                                                                 |
+| 1.12               | 20.05.2022      | Aare Nurm                                             | SignedBy field description update                                             |