Merge pull request #1 from bc-ticketing/develop

Develop

.gitignore

@@ -0,0 +1,33 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### VS Code ###
+.vscode/

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,2 @@
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

Dockerfile

@@ -0,0 +1,37 @@
+# Build Stage for Spring boot application image
+FROM openjdk:8-jdk-alpine as build
+
+ENV LC_ALL=C
+
+WORKDIR /app
+
+COPY mvnw .
+COPY .mvn .mvn
+COPY pom.xml .
+
+RUN chmod +x ./mvnw
+
+RUN ./mvnw dependency:go-offline -B
+
+COPY src src
+
+RUN ./mvnw package -DskipTests
+RUN mkdir -p target/dependency && (cd target/dependency; jar -xf ../*.jar)
+
+# Production Stage for Spring boot application image
+FROM openjdk:8-jre-alpine as production
+ARG DEPENDENCY=/app/target/dependency
+ENV LC_ALL=C
+
+RUN apk update
+
+
+# Copy the dependency application file from build stage artifact
+COPY --from=build ${DEPENDENCY}/BOOT-INF/lib /app/lib
+COPY --from=build ${DEPENDENCY}/META-INF /app/META-INF
+COPY --from=build ${DEPENDENCY}/BOOT-INF/classes /app
+
+
+# Run the Spring boot application
+ENTRYPOINT [ "java", "-cp", "app:app/lib/*","com.idetix.hostbackend.HostbackendApplication"]
+

README.md

@@ -0,0 +1,86 @@
+# host-backend
+Spring Boot application for managing access control
+
+### Description
+
+This Spring boot application is the backend of our access control implementation. In order for a guest to access an event, he has to prove ownership over his ETH address.
+To do this, he will be prompted with a random string. He then needs to sign this string using the eth address holding the tickets.
+This will proof ownership of the address.
+
+### Implementation
+
+#### Terminal Part
+
+The String will be presented as a QR code. This will be done by our terminals. These terminals interact via the following way:
+
+Following is the representation of Terminal in the backend:
+
+| Type          | Name            | Description                                                         | Annotation                     |
+|---------------|-----------------|---------------------------------------------------------------------|--------------------------------|
+| UUID          | terminalID      | unique identifier of the terminal                                   | auto generated                 |
+| String        | randID          | Random Value presented to guest to sign                             | current length 42              |
+| List<String>  | ticketType      | List of ticket types required to access area controlled by terminal | empty list if general entrance |
+| String        | areaAccessTo    | Area the guest is in, after he passed this terminal                 |                                |
+| int           | numberOfTickets | Number of Tickets per Request                                       |                                |
+| RequestStatus | requestStatus   | flag to save whether a response has been done to this randID        | PENDING,GRANTED,DENIED         |
+
+
+A Terminal uses the following Post to register :
+
+| Parameter               | Value                                                                   |
+|-------------------------|-------------------------------------------------------------------------|
+| URL                     | "/registerTerminal"                                                     |
+| String secret           | secret Token to add terminal                                            |
+| List<String> ticketType | ticket type required to access the area (empty list if general access)  |
+|                         |                                                                         |
+| Return                  | terminalID                                                              |
+
+Response is the terminal Entity
+
+Whenever a terminal has been registered, an initial random string has been generated. The terminal can then display this string.
+
+At the same time, it should start querying following request:
+
+| Parameter       | Value                       |
+|-----------------|-----------------------------|
+| URL             | "/getTerminalStatus"        |
+| UUID terminalId | terminal ID of the terminal |
+|                 |                             |
+| Return          | requestStatus               |
+
+This will return the terminal Entity. 
+As already described, the guest will submit a post request with the signed data.
+This will set the boolean responseDone of the terminal entity to true.
+
+The backend will evaluate, whether the guest has a valid ticket.
+When the guest has authorization to access, the boolean accessAllowed will be set to true.
+
+Once the responseDone flag changes, the Terminal will have to show the access status.
+
+After that, the terminal can request a new random string via this post:
+
+| Parameter       | Value                       |
+|-----------------|-----------------------------|
+| URL             | "/NewSecretCode"         |
+| UUID terminalId | terminal ID of the terminal |
+|                 |                             |
+| Return          | randID                      |
+
+This will save the guest as accessed to the area the terminal grants access to and return a new random string.
+
+Here the process starts from the beginning.
+
+To unregister a terminal, use:
+
+| Parameter       | Value                       |
+|-----------------|-----------------------------|
+| URL             | "/unRegisterTerminal"       |
+| UUID terminalId | terminal ID of the terminal |
+|                 |                             |
+| Return          | boolean                     |
+
+
+#### Guest Part
+
+
+