Merge remote-tracking branch 'remotes/origin/development' into 2624_sormas-to-sormas-rest-endpoints

# Conflicts:
#	sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java
#	sormas-api/src/main/java/de/symeda/sormas/api/caze/CaseDataDto.java
#	sormas-api/src/main/java/de/symeda/sormas/api/caze/CaseIndexDto.java
#	sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java
#	sormas-api/src/main/java/de/symeda/sormas/api/sample/SampleIndexDto.java
#	sormas-api/src/main/java/de/symeda/sormas/api/symptoms/SymptomsDto.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/backend/caze/Case.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/backend/caze/CaseDtoHelper.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/backend/common/DatabaseHelper.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/caze/edit/CaseEditFragment.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/component/dialog/LocationDialog.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/contact/edit/ContactEditFragment.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/person/edit/PersonEditFragment.java
#	sormas-app/app/src/main/java/de/symeda/sormas/app/person/read/PersonReadFragment.java
#	sormas-backend/src/main/java/de/symeda/sormas/backend/caze/Case.java
#	sormas-backend/src/main/java/de/symeda/sormas/backend/caze/CaseFacadeEjb.java
#	sormas-backend/src/main/java/de/symeda/sormas/backend/common/ConfigFacadeEjb.java
#	sormas-backend/src/main/java/de/symeda/sormas/backend/contact/ContactFacadeEjb.java
#	sormas-backend/src/main/java/de/symeda/sormas/backend/sormas2sormas/ServerAccessDataFacadeEjb.java
#	sormas-backend/src/main/resources/sql/sormas_schema.sql
#	sormas-rest/src/main/webapp/WEB-INF/web.xml
#	sormas-ui/src/main/java/de/symeda/sormas/ui/caze/CaseDataView.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/caze/CaseFilterForm.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/clinicalcourse/ClinicalCourseView.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/contact/ContactDataView.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/contact/ContactPersonView.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/events/EventDataView.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/events/EventParticipantEditForm.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/location/LocationEditForm.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/person/PersonController.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/person/PersonEditForm.java
#	sormas-ui/src/main/java/de/symeda/sormas/ui/samples/SampleDataView.java

Author: lgal

.github/ISSUE_TEMPLATE/bug-report.md

@@ -24,5 +24,7 @@ If you've never submitted an issue to the SORMAS repository before or this is yo
 * Device:
 * SORMAS version:
 * Android version/Browser:
+* Server URL:
+* User Role:
 
 ### Additional Information

.gitignore

@@ -23,3 +23,6 @@ deploy
 /sormas-app/java_pid21052.hprof
 bin
 /sormas-base/setup/setup.log
+/sormas-cargoserver/.env
+/sormas-cargoserver/custom.env
+/sormas-cargoserver/custom.properties

.travis.yml

@@ -2,5 +2,8 @@ language: java
 jdk:
   - openjdk8 # FIXME remove after transition period (#2617)
   - openjdk11
-before_install: cd sormas-base
-install: mvn test -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn
+before_install:
+  - cd sormas-base
+install: skip
+script:
+  - mvn install -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn

DEVELOPMENT_ENVIRONMENT.md

@@ -2,7 +2,8 @@
 # SORMAS Development Environment
 
 ## Server
-- Install [your local server](SERVER_SETUP.md).
+- Install [your local server](SERVER_SETUP.md)
+- Or install your local development server using [maven cargo](sormas-cargoserver/README.md)
 - Alternatively [SERVER_DEV_SETUP.md](SERVER_DEV_SETUP.md) could be used (at this time not recommended)
 
 ## Git

README.md

@@ -25,6 +25,9 @@ Please [create a new issue](https://github.com/hzi-braunschweig/SORMAS-Project/i
 #### Which Browsers and Android Versions Are Supported?
 SORMAS officially supports and is tested on **Chromium-based browsers** (like Google Chrome) and **Mozilla Firefox**, and all Android versions starting from **Android 7.0** (Nougat). In principle, SORMAS should be usable with all web browsers that are supported by Vaadin 8 (Chrome, Firefox, Safari, Edge, Internet Explorer 11; see https://vaadin.com/faq).
 
+#### Is there a ReST API documentation?
+Yes! Please download the [latest release](https://github.com/hzi-braunschweig/SORMAS-Project/releases/latest) and copy the content of /deploy/openapi/sormas-rest.yaml to an editor that generates a visual API documentation (e.g. https://editor.swagger.io/).
+
 <p align="center"><img src="https://user-images.githubusercontent.com/23701005/74659600-ebb8fc00-5194-11ea-836b-a7ca9d682301.png"/></p>
 
 ## Project Structure
@@ -37,6 +40,8 @@ The project consists of the following modules:
 - **sormas-ear:** The ear needed to build the application
 - **sormas-rest:** The REST interface; see [`sormas-rest/README.md`](sormas-rest/README.md)
 - **sormas-ui:** The web application
+- **sormas-base/dependencies:** dependencies to be deployed with the payara server
+- **sormas-cargoserver:** setup for a local dev server using maven-cargo
 
 ## Server Management
 

SERVER_DEV_SETUP.md

@@ -44,6 +44,12 @@ Other steps :
 * Adjust the logging configuration in ``${HOME}/opt/domains/sormas/config/logback.xml`` based on your needs (e.g. configure and activate email appender)
 * Build and deploy applications (ear and war) with you IDE.
 
+## Keycloak
+
+See [Keycloak](SERVER_SETUP.md#keycloak-server) for how to install Docker locally.
+
+If you are doing active development on Keycloak (themes, authentication mechanisms, translations, etc.) it's recommended to install the standalone variant.
+
 
 ## Other components
 

SERVER_SETUP.md

@@ -8,6 +8,7 @@
   * [Java 11](#java-11)
   * [Postgres Database](#postgres-database)
 * [SORMAS Server](#sormas-server)
+* [Keycloak Server](#keycloak-server)
 * [Web Server Setup](#web-server-setup)
   * [Apache Web Server](#apache-web-server)
   * [Firewall](#firewall)
@@ -18,6 +19,7 @@
 
 ## Related
 * [Creating an App for a Demo Server](DEMO_APP.md)
+* [SORMAS Docker Repository](https://github.com/hzi-braunschweig/SORMAS-Docker)
 
 ## Prerequisites
 
@@ -71,6 +73,62 @@
 * Adjust the logging configuration in ``/opt/domains/sormas/config/logback.xml`` based on your needs (e.g. configure and activate email appender)
 * Linux: [Update the SORMAS domain](SERVER_UPDATE.md)
 
+## Keycloak Server
+
+By default Keycloak is run as a Docker container, which can be set up in two ways:
+* As a Docker container
+* As a Standalone installation
+
+### Keycloak as a Docker container
+*To be done only in the situation when SORMAS is already installed on the machine as a standalone installation.*
+
+*For complete Docker setup see the [SORMAS-Docker](https://github.com/hzi-braunschweig/SORMAS-Docker/tree/keycloak-integration) repository.*
+
+**Prerequisites**
+* SORMAS Server is installed
+* PostgreSQL is installed
+* Docker is installed
+* Open and edit [keycloak-setup.sh](sormas-base/setup/keycloak/keycloak-setup.sh) with your system's actual values
+
+**Setup**
+* Run [keycloak-setup.sh](sormas-base/setup/keycloak/keycloak-setup.sh)
+* Update `sormas.properties` file in the SORMAS domain with the property `authentication.provider=KEYCLOAK`
+
+
+### Keycloak as a standalone installation
+
+**Prerequisites**
+* SORMAS Server is installed
+* PostgreSQL is installed
+
+**Setup**
+
+Setting Keycloak up as a standalone installation [Server Installation and Configuration Guide](https://www.keycloak.org/docs/11.0/server_installation/#installation)
+* Make sure to configure Keycloak with PostgreSQL Database [Relational Database Setup](https://www.keycloak.org/docs/11.0/server_installation/#_database)
+* Setup an Admin User
+* Copy the `themes` folder content to `${KEYCLOAK_HOME}/themes` [Deploying Themes](https://www.keycloak.org/docs/11.0/server_development/#deploying-themes)
+* Create the SORMAS Realm by importing [SORMAS.json](sormas-base/setup/keycloak/SORMAS.json) see [Create a New Realm](https://www.keycloak.org/docs/11.0/server_admin/#_create-realm)
+* Update the `sormas-*` clients by generating new secrets for them
+* Update the realm's email settings to allow sending emails to users
+
+To update the SORMAS Server run the following commands
+```shell script
+${ASADMIN} set-config-property --propertyName=payara.security.openid.clientSecret --propertyValue=${KEYCLOAK_SORMAS_UI_SECRET} --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.clientId --propertyValue=sormas-ui --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.scope --propertyValue=openid --source=domain
+${ASADMIN} set-config-property --propertyName=payara.security.openid.providerURI --propertyValue=http://localhost:${KEYCLOAK_PORT}/keycloak/auth/realms/SORMAS --source=domain
+${ASADMIN} set-config-property --propertyName=sormas.rest.security.oidc.json --propertyValue="{\"realm\":\"SORMAS\",\"auth-server-url\":\"http://localhost:${KEYCLOAK_PORT}/auth\",\"ssl-required\":\"external\",\"resource\":\"sormas-rest\",\"credentials\":{\"secret\":\"${KEYCLOAK_SORMAS_REST_SECRET}\"},\"confidential-port\":0,\"principal-attribute\":\"preferred_username\",\"enable-basic-auth\":true}" --source=domain
+${ASADMIN} set-config-property --propertyName=sormas.backend.security.oidc.json --propertyValue="{\"realm\":\"SORMAS\",\"auth-server-url\":\"http://localhost:${KEYCLOAK_PORT}/auth/\",\"ssl-required\":\"external\",\"resource\":\"sormas-backend\",\"credentials\":{\"secret\":\"${KEYCLOAK_SORMAS_BACKEND_SECRET}\"},\"confidential-port\":0}" --source=domain
+```
+where:
+* `${ASADMIN}` - represents the location to `${PAYARA_HOME}\bin\asadmin`
+* `${KEYCLOAK_PORT}` - the port on which keycloak will run
+* `${KEYCLOAK_SORMAS_UI_SECRET}` - is the secret generated in Keycloak for the `sormas-ui` client
+* `${KEYCLOAK_SORMAS_REST_SECRET}` - is the secret generated in Keycloack for the `sormas-rest` client
+* `${KEYCLOAK_SORMAS_BACKEND_SECRET}` - is the secret generated in Keycloack for the `sormas-backend` client
+
+Then update `sormas.properties` file in the SORMAS domain with the property `authentication.provider=KEYCLOAK`
+
 ## Web Server Setup
 
 ### Apache Web Server

sormas-api/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>de.symeda.sormas</groupId>
 		<artifactId>sormas-base</artifactId>
-		<version>1.49.0-SNAPSHOT</version>
+		<version>1.50.0-SNAPSHOT</version>
 		<relativePath>../sormas-base</relativePath>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>

sormas-api/src/main/java/de/symeda/sormas/api/AuthProvider.java

@@ -0,0 +1,33 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2020 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.api;
+
+/**
+ * Authentication provider which can be obtained trough the {@link ConfigFacade#getAuthenticationProvider()} property.
+ *
+ * @author Alex Vidrean
+ * @since 13-Aug-20
+ */
+public class AuthProvider {
+
+	public static final String KEYCLOAK = "KEYCLOAK";
+
+	public static final String SORMAS = "SORMAS";
+
+}

sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java

@@ -28,6 +28,8 @@ public interface ConfigFacade {
 
 	String getCountryLocale();
 
+	String getCountryCode();
+
 	boolean isConfiguredCountry(String countryCode);
 
 	String getEpidPrefix();
@@ -96,9 +98,13 @@ public interface ConfigFacade {
 
 	String getSymptomJournalSecret();
 
+	String getPatientDiaryUrl();
+
 	String getSormasToSormasUserPassword();
 
 	void validateExternalUrls();
 
 	SormasToSormasConfig getSormasToSormasConfig();
+
+	String getAuthenticationProvider();
 }