diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2065bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..c3ad1bb --- /dev/null +++ b/Dockerfile @@ -0,0 +1,5 @@ +FROM openjdk:17 +WORKDIR /. +COPY hermes/build/libs/hermes-0.0.1-SNAPSHOT.jar ./app.jar + +ENTRYPOINT ["java", "-jar", "./app.jar"] diff --git a/README.md b/README.md index 6f85764..bd1e857 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,25 @@ Notification Relay for Artemis Push Notifications. Allows secure and private push notifications from [Artemis](https://github.com/ls1intum/Artemis) to the mobile apps for [iOS](https://github.com/ls1intum/artemis-ios) and [Android](https://github.com/ls1intum/artemis-android). + +![](hermes-system-decomposition.png) + +### How to run: +1. Replace placeholder values `<...>` in Docker-Compose file +2. Adjust port if necessary +3. Run `docker-compose up` + +### Further Information on Dockerfile + +To run the services as an APNS relay the following Environment Variables are required: +- APNS_CERTIFICATE_PATH: String - Path to the APNs certificate .p12 file as described [here](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns) +- APNS_CERTIFICATE_PWD: String - The APNS certificate password +- APNS_PROD_ENVIRONMENT: Bool - True if it should use the Production APNS Server (Default false) +Furthermore the .p8 needs to be mounted into the Docker under the above specified path. + + +To run the services as a Firebase relay the following Environment Variable is required: +- GOOGLE_APPLICATION_CREDENTIALS: String - Path to the firebase.json +Furthermore the Firebase.json needs to be mounted into the Docker under the above specified path. + +To run both APNS and Firebase configure the Environment Variables for both. \ No newline at end of file diff --git a/apns/build.gradle b/apns/build.gradle new file mode 100644 index 0000000..9abe0cc --- /dev/null +++ b/apns/build.gradle @@ -0,0 +1,28 @@ +plugins { + id 'java' + id 'org.springframework.boot' + id 'io.spring.dependency-management' +} + +group = 'de.tum.cit.artemis.push.artemispushnotificationrelay' +version = '0.0.1-SNAPSHOT' +sourceCompatibility = '17' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter' + implementation 'org.springframework.boot:spring-boot-starter-web' + + implementation 'com.eatthepath:pushy:0.15.2' + + implementation 'javax.annotation:javax.annotation-api:1.3.2' + + implementation(project(":common")) +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/apns/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/apns/ApnsSendService.java b/apns/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/apns/ApnsSendService.java new file mode 100644 index 0000000..a7132af --- /dev/null +++ b/apns/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/apns/ApnsSendService.java @@ -0,0 +1,101 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay.apns; + +import com.eatthepath.pushy.apns.*; +import com.eatthepath.pushy.apns.util.SimpleApnsPayloadBuilder; +import com.eatthepath.pushy.apns.util.SimpleApnsPushNotification; +import com.eatthepath.pushy.apns.util.concurrent.PushNotificationFuture; +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.NotificationRequest; +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.SendService; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.scheduling.annotation.Async; +import org.springframework.stereotype.Service; + +import javax.annotation.PostConstruct; +import java.io.File; +import java.io.IOException; +import java.time.Duration; +import java.time.Instant; +import java.util.concurrent.ExecutionException; + +@Service +public class ApnsSendService implements SendService { + + @Value("${APNS_CERTIFICATE_PATH: #{null}}") + private String apnsCertificatePath; + @Value("${APNS_CERTIFICATE_PWD: #{null}}") + private String apnsCertificatePwd; + + @Value("${APNS_PROD_ENVIRONMENT: #{false}}") + private Boolean apnsProdEnvironment = false; + + private final Logger log = LoggerFactory.getLogger(ApnsSendService.class); + private ApnsClient apnsClient; + + @PostConstruct + public void initialize() { + log.info("apnsCertificatePwd: " + apnsCertificatePwd); + log.info("apnsCertificatePath: " + apnsCertificatePath); + log.info("apnsProdEnvironment: " + apnsProdEnvironment); + if (apnsCertificatePwd == null || apnsCertificatePath == null || apnsProdEnvironment == null) { + log.error("Could not init APNS service. Certificate information missing."); + return; + } + try { + apnsClient = new ApnsClientBuilder() + .setApnsServer(apnsProdEnvironment ? ApnsClientBuilder.PRODUCTION_APNS_HOST : ApnsClientBuilder.DEVELOPMENT_APNS_HOST) + .setClientCredentials(new File(apnsCertificatePath), apnsCertificatePwd) + .build(); + log.info("Started APNS client successfully!"); + } catch (IOException e) { + log.error("Could not init APNS service", e); + } + } + + @Override + public ResponseEntity send(NotificationRequest request) { + return sendApnsRequest(request); + } + + @Async + ResponseEntity sendApnsRequest(NotificationRequest request) { + String payload = new SimpleApnsPayloadBuilder() + .setContentAvailable(true) + .addCustomProperty("iv", request.getInitializationVector()) + .addCustomProperty("payload", request.getPayloadCipherText()) + .build(); + + SimpleApnsPushNotification notification = new SimpleApnsPushNotification(request.getToken(), + "de.tum.cit.artemis", + payload, + Instant.now().plus(Duration.ofDays(7)), + DeliveryPriority.getFromCode(5), + PushType.BACKGROUND); + + + PushNotificationFuture> responsePushNotificationFuture = apnsClient.sendNotification(notification); + try { + final PushNotificationResponse pushNotificationResponse = + responsePushNotificationFuture.get(); + if (pushNotificationResponse.isAccepted()) { + log.info("Send notification to " + request.getToken()); + return ResponseEntity.ok().build(); + } else { + log.error("Notification rejected by the APNs gateway: " + + pushNotificationResponse.getRejectionReason()); + + pushNotificationResponse.getTokenInvalidationTimestamp().ifPresent(timestamp -> { + log.error("\t…and the token is invalid as of " + timestamp); + }); + return ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).build(); + } + } catch (ExecutionException | InterruptedException e) { + log.error("Failed to send push notification."); + e.printStackTrace(); + return ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).build(); + } + } +} diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..3dea893 --- /dev/null +++ b/build.gradle @@ -0,0 +1,14 @@ +buildscript { + repositories { + mavenCentral() + } +} + +plugins { +} + +allprojects { + repositories { + mavenCentral() + } +} diff --git a/common/build.gradle b/common/build.gradle new file mode 100644 index 0000000..d509094 --- /dev/null +++ b/common/build.gradle @@ -0,0 +1,21 @@ +plugins { + id 'java' + id 'org.springframework.boot' + id 'io.spring.dependency-management' +} + +group = 'de.tum.cit.artemis.push.artemispushnotificationrelay' +version = '0.0.1-SNAPSHOT' +sourceCompatibility = '17' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/NotificationRequest.java b/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/NotificationRequest.java new file mode 100644 index 0000000..1f73d6e --- /dev/null +++ b/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/NotificationRequest.java @@ -0,0 +1,25 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay.common; + +public class NotificationRequest { + private final String initializationVector; + private final String payloadCipherText; + private final String token; + + public NotificationRequest(String initializationVector, String payloadCipherText, String token) { + this.initializationVector = initializationVector; + this.payloadCipherText = payloadCipherText; + this.token = token; + } + + public String getInitializationVector() { + return initializationVector; + } + + public String getPayloadCipherText() { + return payloadCipherText; + } + + public String getToken() { + return token; + } +} diff --git a/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/SendService.java b/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/SendService.java new file mode 100644 index 0000000..86b9873 --- /dev/null +++ b/common/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/common/SendService.java @@ -0,0 +1,8 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay.common; + +import org.springframework.http.ResponseEntity; + +public interface SendService { + + ResponseEntity send(T request); +} diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..2b71d5b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,19 @@ +version: '3' +services: + hermes: + # either build image with run.sh before running or adapt image to point to Docker Hub: e.g. sven0311tum/hermes:latest + image: hermes + container_name: hermes + ports: + - "17333:8080" + environment: + - APNS_CERTIFICATE_PATH=/key/artemis-apns.p12 + # adapt the following line + - APNS_CERTIFICATE_PWD= + - APNS_PROD_ENVIRONMENT=false + - GOOGLE_APPLICATION_CREDENTIALS=/firebase.json + volumes: + # adapt the following lines + - :/key/artemis-apns.p12 + - :/firebase.json + restart: on-failure diff --git a/firebase/build.gradle b/firebase/build.gradle new file mode 100644 index 0000000..98fc543 --- /dev/null +++ b/firebase/build.gradle @@ -0,0 +1,25 @@ +plugins { + id 'java' + id 'org.springframework.boot' + id 'io.spring.dependency-management' +} + +group = 'de.tum.cit.artemis.push.artemispushnotificationrelay' +version = '0.0.1-SNAPSHOT' +sourceCompatibility = '17' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter' + implementation 'org.springframework.boot:spring-boot-starter-web' + + implementation "com.google.firebase:firebase-admin:9.1.1" + implementation(project(":common")) +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendPushNotificationsRequest.java b/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendPushNotificationsRequest.java new file mode 100644 index 0000000..fd73c69 --- /dev/null +++ b/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendPushNotificationsRequest.java @@ -0,0 +1,10 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay.firebase; + +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.NotificationRequest; + +import java.util.List; + +public record FirebaseSendPushNotificationsRequest( + List notificationRequest +) { +} diff --git a/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendService.java b/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendService.java new file mode 100644 index 0000000..f0a0b15 --- /dev/null +++ b/firebase/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/firebase/FirebaseSendService.java @@ -0,0 +1,71 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay.firebase; + +import com.google.auth.oauth2.GoogleCredentials; +import com.google.firebase.FirebaseApp; +import com.google.firebase.FirebaseOptions; +import com.google.firebase.messaging.FirebaseMessaging; +import com.google.firebase.messaging.FirebaseMessagingException; +import com.google.firebase.messaging.Message; +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.NotificationRequest; +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.SendService; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; + +import java.io.IOException; +import java.util.List; +import java.util.Optional; + +@Service +public class FirebaseSendService implements SendService> { + + private Optional firebaseApp = Optional.empty(); + + private final Logger log = LoggerFactory.getLogger(FirebaseSendService.class); + + public FirebaseSendService() { + try { + FirebaseOptions options = FirebaseOptions + .builder() + // Get credentials from GOOGLE_APPLICATION_CREDENTIALS env var. + .setCredentials(GoogleCredentials.getApplicationDefault()) + .build(); + + firebaseApp = Optional.of(FirebaseApp.initializeApp(options)); + } catch (IOException e) { + log.error("Exception while loading Firebase credentials", e); + } + } + + @Override + public ResponseEntity send(List requests) { + if (requests.size() > 500) { + return ResponseEntity.status(HttpStatus.BAD_REQUEST).build(); + } + + // If the firebase app is not present, we do not have to do anything + if (firebaseApp.isPresent()) { + List batch = requests + .stream() + .map((request) -> + Message + .builder() + .putData("payload", request.getPayloadCipherText()) + .putData("iv", request.getInitializationVector()) + .setToken(request.getToken()) + .build() + ) + .toList(); + + try { + FirebaseMessaging.getInstance(firebaseApp.get()).sendAll(batch); + } catch (FirebaseMessagingException e) { + return ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).build(); + } + } + + return ResponseEntity.ok().build(); + } +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..070cb70 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..a69d9cb --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..f127cfd --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/hermes-system-decomposition.png b/hermes-system-decomposition.png new file mode 100644 index 0000000..8f88caa Binary files /dev/null and b/hermes-system-decomposition.png differ diff --git a/hermes/build.gradle b/hermes/build.gradle new file mode 100644 index 0000000..19dd42a --- /dev/null +++ b/hermes/build.gradle @@ -0,0 +1,25 @@ +plugins { + id 'java' + id 'org.springframework.boot' + id 'io.spring.dependency-management' +} + +group = 'de.tum.cit.artemis.push' +version = '0.0.1-SNAPSHOT' +sourceCompatibility = '17' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + + implementation(project(":common")) + implementation(project(":apns")) + implementation(project(":firebase")) +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/ArtemisPushNotificationRelayApplication.java b/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/ArtemisPushNotificationRelayApplication.java new file mode 100644 index 0000000..2648991 --- /dev/null +++ b/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/ArtemisPushNotificationRelayApplication.java @@ -0,0 +1,12 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class ArtemisPushNotificationRelayApplication { + + public static void main(String[] args) { + SpringApplication.run(ArtemisPushNotificationRelayApplication.class, args); + } +} diff --git a/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/RelayRestController.java b/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/RelayRestController.java new file mode 100644 index 0000000..f500467 --- /dev/null +++ b/hermes/src/main/java/de/tum/cit/artemis/push/artemispushnotificationrelay/RelayRestController.java @@ -0,0 +1,34 @@ +package de.tum.cit.artemis.push.artemispushnotificationrelay; + +import de.tum.cit.artemis.push.artemispushnotificationrelay.apns.ApnsSendService; +import de.tum.cit.artemis.push.artemispushnotificationrelay.common.NotificationRequest; +import de.tum.cit.artemis.push.artemispushnotificationrelay.firebase.FirebaseSendPushNotificationsRequest; +import de.tum.cit.artemis.push.artemispushnotificationrelay.firebase.FirebaseSendService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +@RestController +@RequestMapping("/api/push_notification") +public class RelayRestController { + + @Autowired + private FirebaseSendService firebaseSendService; + @Autowired + private ApnsSendService apnsSendService; + + @PostMapping("send_firebase") + public ResponseEntity send(@RequestBody FirebaseSendPushNotificationsRequest notificationRequests) { + return firebaseSendService.send(notificationRequests.notificationRequest()); + } + + @PostMapping("send_apns") + public ResponseEntity send(@RequestBody NotificationRequest notificationRequest) { + return apnsSendService.send(notificationRequest); + } + + @GetMapping("alive") + public ResponseEntity alive() { + return ResponseEntity.ok().build(); + } +} diff --git a/hermes/src/main/resources/application.properties b/hermes/src/main/resources/application.properties new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/hermes/src/main/resources/application.properties @@ -0,0 +1 @@ + diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..9e0b86d --- /dev/null +++ b/run.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +gradlew hermes:bootJar +docker build -t hermes . diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..bf75acf --- /dev/null +++ b/settings.gradle @@ -0,0 +1,18 @@ +pluginManagement { + repositories { + mavenCentral() + } + + plugins { + id 'java' apply false + id 'org.springframework.boot' version '3.0.2' apply false + id 'io.spring.dependency-management' version '1.1.0' apply false + } +} + +include("common") +include("apns") +include("firebase") +include("hermes") + +rootProject.name = 'artemis-push-notification-relay' \ No newline at end of file