diff --git a/HTTP-Validator/Makefile b/HTTP-Validator/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea --- /dev/null +++ b/HTTP-Validator/Makefile @@ -0,0 +1,3 @@ +SHELL := /bin/bash + +include ../Makefile.generic diff --git a/HTTP-Validator/images/ValidationMenu.png b/HTTP-Validator/images/ValidationMenu.png new file mode 100644 index 0000000000000000000000000000000000000000..e6a2ced7fe269787a7e81fa9080737da4900d8da Binary files /dev/null and b/HTTP-Validator/images/ValidationMenu.png differ diff --git a/HTTP-Validator/images/ValidationResultEVS.png b/HTTP-Validator/images/ValidationResultEVS.png new file mode 100644 index 0000000000000000000000000000000000000000..81645cb31d9adacd08b35317dbdee48b7f764d1c Binary files /dev/null and b/HTTP-Validator/images/ValidationResultEVS.png differ diff --git a/HTTP-Validator/installation.md b/HTTP-Validator/installation.md new file mode 100644 index 0000000000000000000000000000000000000000..50d08ad930af2ac304e2f711ba5c71428dd4769f --- /dev/null +++ b/HTTP-Validator/installation.md @@ -0,0 +1,46 @@ +--- +title: User Manual +subtitle: HTTP Validator +author: Clément LAGORCE +function: Software Engineer +date: 22/08/2023 +toolversion: 0.3.0 +version: 1_03 +status: Reviewed +reference: KER1-MAN-IHE-HTTP-VALIDATOR_USER-1_03 +customer: IHE-EUROPE +--- + +# Purpose + +Here is a guide to help you install the IUA-Simulator. + +# Deployment + +## Minimal requirements + +* Debian squeeze or ubuntu 12.04 64bits or higher with an Internet access. +* Java virtual machine : JDK 17 +* Application server : Wildfly 27 + +To install those requirements you can refer to the documentation of installation of Wildfly : [*General Requirements Wildfly 27*](https://docs.wildfly.org/27/Getting_Started_Guide.html) + +## Instructions + +Copy the http-validator.war into the "/usr/local/wildfly27/standalone/deployments" directory of your Wildfly server. + +You'll have to specify Environment variable before starting the server. +Here are the mandatory environment variables to be able to deploy correctly the application : +- GZL_PROFILE_REPOSITORY_PATH +- GZL_PROFILE_CACHE_MAX_ELEMENTS +- GZL_TOKEN_API_URL +- APPLICATION_URL + +Then, the specified path for GZL_PROFILE_REPOSITORY_PATH variable need to point to an existing folder, if not, you'll have to create it. +It is usually equals to /opt/http-validator/validationProfiles + +Finally, start your server. + +Once the application is deployed, open a browser and go to http://yourserver/http-validator/rest/metadata in order to check of the service is available. + +If the deployment is successful, you should receive a 200 Ok Response. \ No newline at end of file diff --git a/HTTP-Validator/release-note.md b/HTTP-Validator/release-note.md new file mode 100644 index 0000000000000000000000000000000000000000..e077d98ecb56c0db5af5db636c27aa28179a56d5 --- /dev/null +++ b/HTTP-Validator/release-note.md @@ -0,0 +1,42 @@ +--- +title: Release note +subtitle: HTTP Validator +toolversion: 0.3.0 +releasedate: 2023-08-28 +author: Clément LAGORCE +function: Software Engineer +customer: IHE Europe +reference: KER1-RNO-IHE-HTTP_VALIDATOR +--- + +# 0.3.0 +_Release date: 2023-08-28_ + +__Story__ +* \[[HTTP-16](https://gazelle.ihe.net/jira/browse/HTTP-16)\] Release/Doc +* \[[HTTP-43](https://gazelle.ihe.net/jira/browse/HTTP-43)\] Use new Validation API and Reports + +__Improvement__ +* \[[HTTP-40](https://gazelle.ihe.net/jira/browse/HTTP-40)\] CRLF Improvements + +# 0.2.0 +_Release date: 2023-02-22_ + +__Story__ +* \[[HTTP-10](https://gazelle.ihe.net/jira/browse/HTTP-10)\] Support HTTP Header +* \[[HTTP-11](https://gazelle.ihe.net/jira/browse/HTTP-11)\] Selector using EL expression +* \[[HTTP-12](https://gazelle.ihe.net/jira/browse/HTTP-12)\] Support list of checker +* \[[HTTP-13](https://gazelle.ihe.net/jira/browse/HTTP-13)\] Support Conditionality +* \[[HTTP-14](https://gazelle.ihe.net/jira/browse/HTTP-14)\] Add needed Checkers +* \[[HTTP-19](https://gazelle.ihe.net/jira/browse/HTTP-19)\] Security integration (gazelle-token-service) + +# 0.1.0 +_Release date: 2023-01-30_ + +__Story__ +* \[[HTTP-3](https://gazelle.ihe.net/jira/browse/HTTP-3)\] Import a validation profile via API +* \[[HTTP-4](https://gazelle.ihe.net/jira/browse/HTTP-4)\] Create model for validation profile (Minimal, V0.1) +* \[[HTTP-5](https://gazelle.ihe.net/jira/browse/HTTP-5)\] Project creation +* \[[HTTP-6](https://gazelle.ihe.net/jira/browse/HTTP-6)\] Engine (minimal, V0.1) +* \[[HTTP-7](https://gazelle.ihe.net/jira/browse/HTTP-7)\] Create Webservice +* \[[HTTP-8](https://gazelle.ihe.net/jira/browse/HTTP-8)\] Integrate into EVSClient \ No newline at end of file diff --git a/HTTP-Validator/user.md b/HTTP-Validator/user.md new file mode 100644 index 0000000000000000000000000000000000000000..5cdf4f836de8e3c71e54192d036c04f7c201ab3b --- /dev/null +++ b/HTTP-Validator/user.md @@ -0,0 +1,92 @@ +--- +title: User Manual +subtitle: HTTP Validator +author: Clément LAGORCE +function: Software Engineer +date: 21=2/08/2023 +toolversion: 0.3.0 +version: 1_03 +status: Reviewed +reference: KER1-MAN-IHE-HTTP-VALIDATOR_USER-1_03 +customer: IHE-EUROPE +--- + +# Introduction +This application has been developed with the purpose of validating any HTTP Message (Request or Response) in a full raw String format. +- For an HTTP Request : The message is a String containing the HTTP Method, URI, Query parameters, HTTP Version and HTTP Headers. +- For an HTTP Response : The message is a String containing the HTTP Version, the Status Code, the Reason Phrase and the HTTP Headers. + +Every message shall be formatted as specified in the [RFC 2616](https://www.rfc-editor.org/rfc/rfc2616) of the HTTP Protocol. This includes the double CRLF at the end of the HTTP Headers. + +As we can see in [Section 2.2](https://www.rfc-editor.org/rfc/rfc2616#section-2.2), [Section 5](https://www.rfc-editor.org/rfc/rfc2616#section-5) and [Section 6](https://www.rfc-editor.org/rfc/rfc2616#section-6), the HTTP message shall be provided to the tool with the following format : +~~~text +CRLF = CR LF +CR = <US-ASCII CR, carriage return (13)> +LF = <US-ASCII LF, linefeed (10)> +SP = <US-ASCII SP, space (32)> + +Request = Method SP Request-URI SP HTTP-Version CRLF + *(( general-header + | request-header + | entity-header ) CRLF) + CRLF + [ message-body ] + +Response = HTTP-Version SP Status-Code SP Reason-Phrase CRLF + *(( general-header + | response-header + | entity-header ) CRLF) + CRLF + [ message-body ] +~~~ + +This tool provides a way to validate automatically any HTTP Message from any standard or profile that uses RestFul Web Services. +The messages are validated against a configuration file called Validation Profile formatted in Json. + +## Purpose of the document +This document is the Customer user manual for the Gazelle HTTP Validator module. + +## Scope of the document +The scope of this document is limited to the usage of Gazelle HTTP Validator, how to create a Validation Profile and how to perform an HTTP Message validation. + +How to install, configure and maintain the tool is described in the Installation manual. + +## HTTP Validator Engine +This part of the application is the validation Engine that will validate the HTTP message provided to the validator. It is directly connected to EVS Client. + +### EVSClient Validation +The other way to perform HTTP message validation is by using EVSClient. A configuration shall be done in EVSClient in the same platform where HTTP-Validator is deployed. +Once EVS is configured, this menu should appear at the top bar : + +The Validation Report is displayed in a similar manner as it is for other validators. +Below is the result of the same HTTP message against the same Validation Profile as for the Rest API : + + +# Tools needed + +## HTTP Validator Service + +### Sources and libraries +The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/test-execution/validator/http-validator_ + +Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/#nexus-search;gav~~http-validator_ + +### Issue tracker +Issues and features requests shall be entered through the issue bug tracking system of the Gazelle platform, at _https://gazelle.ihe.net/jira/browse/HTTP_VAL_. + +## EVSClient + +### Sources and libraries +The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/test-execution/validator/EVSClient_. + +Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~EVSClient_ + +### Issue tracker +For an issue specific to the gazelle-x-validation module, please use the issue tracker at _https://gazelle.ihe.net/jira/browse/HTTP_VAL_. For an issue specific to the EVS Client, you can use _https://gazelle.ihe.net/jira/browse/EVSCLT_. + +## Gazelle Token Service + +### Sources and libraries +The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/core/gazelle-token_. + +Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-token_. \ No newline at end of file