Skip to content

Commit

Permalink
SIVA-359 Update links and version numbers
Browse files Browse the repository at this point in the history
  • Loading branch information
@naare
naare committed Nov 7, 2022
1 parent 6d1614a commit 5e0afe5
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
14 changes: 7 additions & 7 deletions docs/siva3/deployment_guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The last lines of build output should look very similar to below image:
```text
[INFO] Reactor Summary:
[INFO]
[INFO] SiVa Digitally signed documents validation service 3.3.0 SUCCESS [ 2.089 s]
[INFO] SiVa Digitally signed documents validation service X.X.X SUCCESS [ 2.089 s]
[INFO] validation-services-parent ......................... SUCCESS [ 0.380 s]
[INFO] validation-commons ................................. SUCCESS [ 13.782 s]
[INFO] tsl-loader ......................................... SUCCESS [ 9.372 s]
Expand All @@ -46,7 +46,7 @@ The last lines of build output should look very similar to below image:
[INFO] siva-webapp ........................................ SUCCESS [ 42.451 s]
[INFO] SiVa Sample Web application ........................ SUCCESS [ 42.236 s]
[INFO] SiVa Web Service integration tests ................. SUCCESS [ 18.830 s]
[INFO] siva-distribution 3.3.0 ............................ SUCCESS [ 5.763 s]
[INFO] siva-distribution X.X.X ............................ SUCCESS [ 5.763 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
Expand All @@ -66,7 +66,7 @@ project by issuing below commands:
**First start the Siva webapp**

```bash
./siva-parent/siva-webapp/target/siva-webapp-3.3.0.jar
./siva-parent/siva-webapp/target/siva-webapp-X.X.X.jar
```

The SiVa webapp by default runs on port **8080**.
Expand All @@ -75,7 +75,7 @@ Easiest way to test out the deployment is to run SiVa demo application and use i
**Start the Demo webapp**

```bash
./siva-parent/siva-sample-application/target/siva-sample-application-3.3.0.jar
./siva-parent/siva-sample-application/target/siva-sample-application-X.X.X.jar
```

Now point Your browser to URL: <http://localhost:9000>
Expand Down Expand Up @@ -115,15 +115,15 @@ WantedBy=multi-user.target
```

Save and close the `siva-webapp.service` file.
Next we need to move `siva-webapp-3.3.0.jar` into newly created `/var/apps` directory and rename to
Next we need to move `siva-webapp-X.X.X.jar` into newly created `/var/apps` directory and rename to
JAR file to `siva-webapp.jar`. match

!!! note
The copied JAR filename must match option `ExecStart` in `siva-webapp.service` file

```bash
sudo mkdir /var/apps
sudo cp siva-parent/siva-webapp/target/executable/siva-webapp-3.3.0.jar /var/apps/siva-webapp.jar
sudo cp siva-parent/siva-webapp/target/executable/siva-webapp-X.X.X.jar /var/apps/siva-webapp.jar
```

Next we need to copy the `siva-webapp.service` file into `/lib/systemd/system` directory.
Expand Down Expand Up @@ -193,7 +193,7 @@ Now we should build the WAR file. We have created helper script with all the cor
Final steps would be copying built WAR file into Tomcat `webapps` directory and starting the servlet container.

```bash
cp siva-parent/siva-webapp/target/siva-webapp-3.3.0.war apache-tomcat-8.5.24/webapps
cp siva-parent/siva-webapp/target/siva-webapp-X.X.X.war apache-tomcat-8.5.24/webapps
./apache-tomcat-7.0.77/bin/catalina.sh run
```

Expand Down
4 changes: 2 additions & 2 deletions docs/siva3/interfaces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Validation request parameters for JSON interface are described in the table belo
| signatureFiles[0].datafiles[0].filename | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.Filename | + | String | File name of the hashed data file, max length 255 characters. |
| signatureFiles[0].datafiles[0].hashAlgo | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.HashAlgo | + | String | Hash algorithm used for hashing the data file (must match with algorithm in signature file). Accepted values are dependant of validation policy |
| signatureFiles[0].datafiles[0].hash | SignatureFiles.SignatureFile.Signature.DataFiles.DataFile.Hash | + | String | Data file hash in Base64 encoded format. |
| signaturePolicy | SignaturePolicy | - | String | Can be used to change the default signature validation policy that is used by the service. <br> See also [SiVa Validation Policy](/siva3/appendix/validation_policy) for more detailed information on given policy constraints.<br>**Possible values:** <br> POLv3 - signatures with all legal levels are accepted (i.e. QES, AdESqc and AdES, according to Regulation (EU) No 910/2014.) <br> POLv4 - the default policy. Accepted signatures depend on their type (i.e. signature, seal or unknown) and legal level (i.e. QES, AdESqc and Ades) |
| signaturePolicy | SignaturePolicy | - | String | Can be used to change the default signature validation policy that is used by the service. <br> See also [SiVa Validation Policy](https://open-eid.github.io/SiVa/siva3/appendix/validation_policy) for more detailed information on given policy constraints.<br>**Possible values:** <br> POLv3 - signatures with all legal levels are accepted (i.e. QES, AdESqc and AdES, according to Regulation (EU) No 910/2014.) <br> POLv4 - the default policy. Accepted signatures depend on their type (i.e. signature, seal or unknown) and legal level (i.e. QES, AdESqc and Ades) |
| reportType | ReportType | - | String | <br>**Possible values:** <br> Simple - default report type. Returns overall validation result (validationConclusion block)<br> Detailed - returns detailed information about the signatures and their validation results (validationConclusion, validationProcess and validationReportSignature. Two later ones are not supported for hashcode). <br> Diagnostic - returns diagnostic data about the information contained in the signature itself, it's revocation data and mathematical validity (validationConclusion, diagnosticData block. Last one is not support for hashcode) |

### Sample JSON request with mandatory parameters (datafile hashcode match verification done on integrators side)
Expand Down Expand Up @@ -242,7 +242,7 @@ Validation request parameters for JSON interface are described in the table belo
```

## Validation response interface
The signature validation report (i.e. the validation response) for JSON and SOAP interfaces depends on what type of validation report was requested. Data types of SOAP parameters are defined in the [SiVa WSDL document](/siva3/appendix/wsdl).
The signature validation report (i.e. the validation response) for JSON and SOAP interfaces depends on what type of validation report was requested. Data types of SOAP parameters are defined in the [SiVa WSDL document](https://open-eid.github.io/SiVa/siva3/appendix/wsdl/).

### Validation response parameters Simple Report (successful scenario)

Expand Down
1 change: 1 addition & 0 deletions docs/version_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
| 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 |
| 1.13 | 07.11.2022 | Aare Nurm | SIVA 3.6 documentation additions. Removal of xroad-validation-service |

0 comments on commit 5e0afe5

Please sign in to comment.