diff --git a/backend/.dockerignore b/backend/.dockerignore new file mode 100644 index 0000000..94810d0 --- /dev/null +++ b/backend/.dockerignore @@ -0,0 +1,5 @@ +* +!target/*-runner +!target/*-runner.jar +!target/lib/* +!target/quarkus-app/* \ No newline at end of file diff --git a/backend/.gitignore b/backend/.gitignore new file mode 100644 index 0000000..91a800a --- /dev/null +++ b/backend/.gitignore @@ -0,0 +1,45 @@ +#Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +release.properties +.flattened-pom.xml + +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode +.factorypath + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Local environment +.env + +# Plugin directory +/.quarkus/cli/plugins/ +# TLS Certificates +.certs/ diff --git a/backend/.mvn/wrapper/maven-wrapper.properties b/backend/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..a3c407f --- /dev/null +++ b/backend/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,4 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.16/apache-maven-3.9.16-bin.zip +distributionSha256Sum=5af3b743dd8b876b5c45da33b676251e5f1687712644abb4ee519ca56e1d89ce diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..cc885b2 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,79 @@ +# backend + +This project uses Quarkus, the Supersonic Subatomic Java Framework. + +If you want to learn more about Quarkus, please visit its website: . + +## Running the application in dev mode + +You can run your application in dev mode that enables live coding using: + +```shell script +./mvnw compile quarkus:dev +``` + +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at . + +## Packaging and running the application + +The application can be packaged using: + +```shell script +./mvnw package +``` + +It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. +Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. + +The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. + +If you want to build an _über-jar_, execute the following command: + +```shell script +./mvnw package -Dquarkus.package.jar.type=uber-jar +``` + +The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. + +## Creating a native executable + +You can create a native executable using: + +```shell script +./mvnw package -Dnative +``` + +Or, if you don't have GraalVM installed, you can run the native executable build in a container using: + +```shell script +./mvnw package -Dnative -Dquarkus.native.container-build=true +``` + +You can then execute your native executable with: `./target/backend-1.0.0-SNAPSHOT-runner` + +If you want to learn more about building native executables, please consult . + +## Related Guides + +- Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplified JPA/Hibernate data access layer with active record and repository patterns +- REST ([guide](https://quarkus.io/guides/rest)): Build RESTful web services and APIs using Jakarta REST (formerly JAX-RS) +- JDBC Driver - PostgreSQL ([guide](https://quarkus.io/guides/datasource)): Connect to the PostgreSQL database via JDBC +- REST Jackson ([guide](https://quarkus.io/guides/rest#json-serialisation)): Jackson serialization support for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it + +## Provided Code + +### Hibernate ORM + +Create your first JPA entity + +[Related guide section...](https://quarkus.io/guides/hibernate-orm) + + +[Related Hibernate with Panache section...](https://quarkus.io/guides/hibernate-orm-panache) + + +### REST + +Easily start your REST Web Services + +[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources) diff --git a/backend/mvnw b/backend/mvnw new file mode 100755 index 0000000..bd8896b --- /dev/null +++ b/backend/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/backend/mvnw.cmd b/backend/mvnw.cmd new file mode 100644 index 0000000..92450f9 --- /dev/null +++ b/backend/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/backend/pipeline.sh b/backend/pipeline.sh new file mode 100755 index 0000000..022b530 --- /dev/null +++ b/backend/pipeline.sh @@ -0,0 +1,27 @@ +#!/usr/bin/env bash +set -euo pipefail +cd "$(dirname "${BASH_SOURCE[0]}")" + +DEV_TAG=2 + +IMAGE="harbor.dinauer.dev/lockaway/backend:dev-${DEV_TAG}" + +echo "==> Building Quarkus application" +./mvnw clean package + +echo "==> Building Docker image ${IMAGE}" +docker build --no-cache -t "${IMAGE}" -f src/main/docker/Dockerfile.jvm . + +echo "==> Pushing image to Harbor" +if [[ -n "${HARBOR_USERNAME:-}" && -n "${HARBOR_PASSWORD:-}" ]]; then + echo "${HARBOR_PASSWORD}" | docker login harbor.dinauer.dev -u "${HARBOR_USERNAME}" --password-stdin + docker push "${IMAGE}" + docker logout harbor.dinauer.dev +else + docker push "${IMAGE}" +fi + +echo "==> Removing local image" +docker image rm --force "${IMAGE}" + +echo "==> Done: ${IMAGE}" diff --git a/backend/pom.xml b/backend/pom.xml new file mode 100644 index 0000000..e864ded --- /dev/null +++ b/backend/pom.xml @@ -0,0 +1,144 @@ + + + 4.0.0 + dev.dinauer.lockaway + backend + 1.0.0-SNAPSHOT + + + 3.15.0 + 21 + UTF-8 + UTF-8 + quarkus-bom + io.quarkus.platform + 3.37.3 + true + 3.5.6 + + + + + + ${quarkus.platform.group-id} + ${quarkus.platform.artifact-id} + ${quarkus.platform.version} + pom + import + + + + + + + io.quarkus + quarkus-hibernate-orm-panache + + + io.quarkus + quarkus-rest + + + io.quarkus + quarkus-jdbc-postgresql + + + io.quarkus + quarkus-rest-jackson + + + io.quarkus + quarkus-arc + + + io.quarkus + quarkus-hibernate-orm + + + io.quarkus + quarkus-flyway + + + io.quarkus + quarkus-junit5 + test + + + io.rest-assured + rest-assured + test + + + + + + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ${quarkus.platform.version} + true + + + + build + generate-code + generate-code-tests + native-image-agent + + + + + + maven-compiler-plugin + ${compiler-plugin.version} + + true + + + + maven-surefire-plugin + ${surefire-plugin.version} + + + org.jboss.logmanager.LogManager + ${maven.home} + + + + + maven-failsafe-plugin + ${surefire-plugin.version} + + + + integration-test + verify + + + + + + ${project.build.directory}/${project.build.finalName}-runner + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + + + + native + + + native + + + + false + true + + + + diff --git a/backend/src/main/docker/Dockerfile.jvm b/backend/src/main/docker/Dockerfile.jvm new file mode 100644 index 0000000..3c9dec1 --- /dev/null +++ b/backend/src/main/docker/Dockerfile.jvm @@ -0,0 +1,100 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/backend-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend-jvm +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/backend-jvm +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") - Be aware that this will override +# the default JVM options, use `JAVA_OPTS_APPEND` to append options +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +# You can find more information about the UBI base runtime images and their configuration here: +# https://rh-openjdk.github.io/redhat-openjdk-containers/ +### +FROM registry.access.redhat.com/ubi8/openjdk-21:1.23 + +ENV LANGUAGE='en_US:en' + + +# We make four distinct layers so if there are application changes the library layers can be re-used +COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ +COPY --chown=185 target/quarkus-app/*.jar /deployments/ +COPY --chown=185 target/quarkus-app/app/ /deployments/app/ +COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] + diff --git a/backend/src/main/docker/Dockerfile.legacy-jar b/backend/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 0000000..257f17a --- /dev/null +++ b/backend/src/main/docker/Dockerfile.legacy-jar @@ -0,0 +1,96 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package -Dquarkus.package.jar.type=legacy-jar +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/backend-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend-legacy-jar +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/backend-legacy-jar +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") - Be aware that this will override +# the default JVM options, use `JAVA_OPTS_APPEND` to append options +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +# You can find more information about the UBI base runtime images and their configuration here: +# https://rh-openjdk.github.io/redhat-openjdk-containers/ +### +FROM registry.access.redhat.com/ubi8/openjdk-21:1.23 + +ENV LANGUAGE='en_US:en' + + +COPY target/lib/* /deployments/lib/ +COPY target/*-runner.jar /deployments/quarkus-run.jar + +EXPOSE 8080 +USER 185 +ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] diff --git a/backend/src/main/docker/Dockerfile.native b/backend/src/main/docker/Dockerfile.native new file mode 100644 index 0000000..02ca75c --- /dev/null +++ b/backend/src/main/docker/Dockerfile.native @@ -0,0 +1,29 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native -t quarkus/backend . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend +# +# The ` registry.access.redhat.com/ubi8/ubi-minimal:8.10` base image is based on UBI 9. +# To use UBI 8, switch to `quay.io/ubi8/ubi-minimal:8.10`. +### +FROM registry.access.redhat.com/ubi8/ubi-minimal:8.10 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root --chmod=0755 target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/backend/src/main/docker/Dockerfile.native-micro b/backend/src/main/docker/Dockerfile.native-micro new file mode 100644 index 0000000..9cfdd03 --- /dev/null +++ b/backend/src/main/docker/Dockerfile.native-micro @@ -0,0 +1,32 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# It uses a micro base image, tuned for Quarkus native executables. +# It reduces the size of the resulting container image. +# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/backend . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/backend +# +# The `quay.io/quarkus/quarkus-micro-image:2.0` base image is based on UBI 9. +# To use UBI 8, switch to `quay.io/quarkus/quarkus-micro-image:2.0`. +### +FROM quay.io/quarkus/quarkus-micro-image:2.0 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root --chmod=0755 target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/backend/src/main/java/dev/dinauer/lockaway/Dev.java b/backend/src/main/java/dev/dinauer/lockaway/Dev.java new file mode 100644 index 0000000..4c92213 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/Dev.java @@ -0,0 +1,50 @@ +package dev.dinauer.lockaway; + +import dev.dinauer.lockaway.secret.SecretService; +import dev.dinauer.lockaway.secret.dto.SecretCreate; +import io.quarkus.arc.profile.IfBuildProfile; +import io.quarkus.runtime.StartupEvent; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.enterprise.event.Observes; +import jakarta.inject.Inject; +import java.util.List; +import java.util.Map; + +@ApplicationScoped +@IfBuildProfile("dev") +public class Dev +{ + @Inject + SecretService secretService; + + void onStart(@Observes StartupEvent event) + { + if (!secretService.getAll(null).isEmpty()) + { + return; + } + + secretService.create(new SecretCreate( + "smtp-creds", + List.of("demo-1"), + Map.of("password", "0ombOg6l6dUTcdvBT33MmZpTFHYnD1Ri/l0V0thaJDLxIxWbfUc+5m2lBZu0"), + "Opaque") + ); + secretService.create(new SecretCreate( + "postgres-user", + List.of("demo-2", "demo-3"), + Map.ofEntries(Map.entry("password", "FnMkHYDu06a0B8tu/vngT/7Fq46dsxnGJf417ba21XGeV6EPoch+6hfZVphB"), + Map.entry("username", "Jwd5fO/H5iPvZBjFLJZn33tgBsBzUtmpVOqlEP8bo6Noxe2i"), + Map.entry("host", "Jv/vWzljHl69MbgzS6T98jSiOs9IAhS23q7oOYqM+QXx9oBuR88eXFsXy2jFb7tcLQl82EfEu6m4evw="), + Map.entry("port", "QQ6pfAxcEbRnI5LO8G6uQuy9XuWa5KfU9feI30xYPOw=")), + "Opaque") + ); + secretService.create(new SecretCreate( + "minio-keys", + List.of("demo-4", "demo-5", "demo-6"), + Map.ofEntries(Map.entry("access-key", "DPbtxA3fZ3LZbbpCRD8eXUNAc6NZ2FxipREEKcw4NUegipUfg7yXBXKZkvSDERw="), + Map.entry("secret-key", "zeaJXSZqWjKAgnUUxG8jB4rcPha35Jt4aE3LS+8QbRlFiKk6+xGH/GN/X8LSVgSIU+KkPxRpeQ8GL6WM16XRKBrsgo8=")), + "Opaque") + ); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/ExportResource.java b/backend/src/main/java/dev/dinauer/lockaway/secret/ExportResource.java new file mode 100644 index 0000000..53892a5 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/ExportResource.java @@ -0,0 +1,46 @@ +package dev.dinauer.lockaway.secret; + +import com.fasterxml.jackson.databind.ObjectMapper; +import dev.dinauer.lockaway.secret.dto.Secret; +import jakarta.inject.Inject; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.WebApplicationException; +import jakarta.ws.rs.core.MediaType; +import jakarta.ws.rs.core.Response; +import java.util.List; + +@Path("/_export") +public class ExportResource +{ + @Inject + SecretService secretService; + + @Inject + SecretMapper secretMapper; + + @Inject + ObjectMapper objectMapper; + + @GET + @Produces(MediaType.APPLICATION_JSON) + public Response export() + { + List secrets = secretService.getAll(null).stream().map(secretMapper::toDto).toList(); + + String pretty; + try + { + pretty = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(secrets); + } + catch (Exception e) + { + throw new WebApplicationException(e); + } + + return Response.ok(pretty) + .header("Content-Disposition", "attachment; filename=\"lockaway-export.json\"") + .build(); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/ImportResource.java b/backend/src/main/java/dev/dinauer/lockaway/secret/ImportResource.java new file mode 100644 index 0000000..2770a1c --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/ImportResource.java @@ -0,0 +1,27 @@ +package dev.dinauer.lockaway.secret; + +import dev.dinauer.lockaway.secret.dto.Secret; +import dev.dinauer.lockaway.secret.dto.SecretCreate; +import jakarta.inject.Inject; +import jakarta.ws.rs.Consumes; +import jakarta.ws.rs.POST; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.core.MediaType; +import java.util.List; + +@Path("/_import") +public class ImportResource +{ + @Inject + SecretService secretService; + + @POST + @Consumes(MediaType.APPLICATION_JSON) + public void importAll(List secrets) + { + for (Secret secret : secrets) + { + secretService.create(new SecretCreate(secret.name(), secret.namespaces(), secret.entries(), secret.type())); + } + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/SecretEntity.java b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretEntity.java new file mode 100644 index 0000000..3f65e9f --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretEntity.java @@ -0,0 +1,91 @@ +package dev.dinauer.lockaway.secret; + +import dev.dinauer.lockaway.secret.entry.EntryEntity; +import jakarta.persistence.*; +import java.util.ArrayList; +import java.util.List; +import org.hibernate.annotations.UuidGenerator; + +@Entity +@Table(name = "secret") +public class SecretEntity +{ + @Id + @GeneratedValue + @UuidGenerator + private String id; + + private String name; + + @ElementCollection + @CollectionTable(name = "secret_namespace", joinColumns = @JoinColumn(name = "secret_id")) + @Column(name = "namespace") + private List namespaces = new ArrayList<>(); + + private String contentHash; + + private String type; + + @OneToMany(mappedBy = "secret", cascade = CascadeType.ALL, orphanRemoval = true) + private List entries = new ArrayList<>(); + + public String getId() + { + return id; + } + + public void setId(String id) + { + this.id = id; + } + + public String getName() + { + return name; + } + + public void setName(String name) + { + this.name = name; + } + + public List getNamespaces() + { + return namespaces; + } + + public void setNamespaces(List namespaces) + { + this.namespaces = namespaces; + } + + public String getContentHash() + { + return contentHash; + } + + public void setContentHash(String contentHash) + { + this.contentHash = contentHash; + } + + public String getType() + { + return type; + } + + public void setType(String type) + { + this.type = type; + } + + public List getEntries() + { + return entries; + } + + public void setEntries(List entries) + { + this.entries = entries; + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/SecretMapper.java b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretMapper.java new file mode 100644 index 0000000..077bf2e --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretMapper.java @@ -0,0 +1,21 @@ +package dev.dinauer.lockaway.secret; + +import dev.dinauer.lockaway.secret.dto.Secret; +import dev.dinauer.lockaway.secret.entry.EntryEntity; +import jakarta.enterprise.context.ApplicationScoped; +import java.util.stream.Collectors; + +@ApplicationScoped +public class SecretMapper +{ + public Secret toDto(SecretEntity entity) + { + return new Secret( + entity.getId(), + entity.getName(), + entity.getNamespaces(), + entity.getContentHash(), + entity.getEntries().stream().collect(Collectors.toMap(EntryEntity::getKey, EntryEntity::getValue)), + entity.getType()); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/SecretRepository.java b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretRepository.java new file mode 100644 index 0000000..2fd523e --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretRepository.java @@ -0,0 +1,15 @@ +package dev.dinauer.lockaway.secret; + +import io.quarkus.hibernate.orm.panache.PanacheRepositoryBase; +import jakarta.enterprise.context.ApplicationScoped; +import java.util.List; + +@ApplicationScoped +public class SecretRepository implements PanacheRepositoryBase +{ + public List findByNameAndNamespace(String name, List namespaces) + { + return list("select distinct s from SecretEntity s join s.namespaces n where s.name = ?1 and n in ?2", + name, namespaces); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/SecretResource.java b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretResource.java new file mode 100644 index 0000000..2257728 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretResource.java @@ -0,0 +1,57 @@ +package dev.dinauer.lockaway.secret; + +import dev.dinauer.lockaway.secret.dto.Secret; +import dev.dinauer.lockaway.secret.dto.SecretCreate; +import jakarta.inject.Inject; +import jakarta.ws.rs.Consumes; +import jakarta.ws.rs.DELETE; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.POST; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.PUT; +import jakarta.ws.rs.PathParam; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.core.MediaType; +import java.util.List; + +@Path("/secrets") +public class SecretResource +{ + @Inject + SecretService secretService; + + @Inject + SecretMapper secretMapper; + + @GET + @Produces(MediaType.APPLICATION_JSON) + public List getAll(@QueryParam("searchText") String searchText) + { + return secretService.getAll(searchText).stream().map(secretMapper::toDto).toList(); + } + + @POST + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public SecretEntity create(SecretCreate create) + { + return secretService.create(create); + } + + @PUT + @Path("/{id}") + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public SecretEntity update(@PathParam("id") String id, SecretCreate update) + { + return secretService.update(id, update); + } + + @DELETE + @Path("/{id}") + public void delete(@PathParam("id") String id) + { + secretService.delete(id); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/SecretService.java b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretService.java new file mode 100644 index 0000000..c64a2dd --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/SecretService.java @@ -0,0 +1,139 @@ +package dev.dinauer.lockaway.secret; + +import dev.dinauer.lockaway.secret.dto.SecretCreate; +import dev.dinauer.lockaway.secret.entry.EntryEntity; +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import jakarta.transaction.Transactional; +import jakarta.ws.rs.NotFoundException; +import jakarta.ws.rs.WebApplicationException; +import jakarta.ws.rs.core.Response; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +@ApplicationScoped +public class SecretService +{ + @Inject + SecretRepository secretRepository; + + @Transactional + public SecretEntity create(SecretCreate create) + { + checkForCollisions(null, create.name(), create.namespaces()); + + SecretEntity secret = new SecretEntity(); + secret.setName(create.name()); + secret.setNamespaces(create.namespaces()); + secret.setEntries(toEntries(secret, create.entries())); + secret.setContentHash(hash(create.type(), create.entries())); + secret.setType(create.type()); + + secretRepository.persist(secret); + return secret; + } + + @Transactional + public SecretEntity update(String id, SecretCreate update) + { + SecretEntity secret = secretRepository.findByIdOptional(id) + .orElseThrow(() -> new NotFoundException("Secret not found: " + id)); + + checkForCollisions(id, update.name(), update.namespaces()); + + secret.setName(update.name()); + secret.setNamespaces(update.namespaces()); + secret.getEntries().clear(); + secret.getEntries().addAll(toEntries(secret, update.entries())); + secret.setContentHash(hash(update.type(), update.entries())); + secret.setType(update.type()); + + return secret; + } + + private void checkForCollisions(String excludeId, String name, List namespaces) + { + boolean collision = secretRepository.findByNameAndNamespace(name, namespaces).stream() + .anyMatch(existing -> !existing.getId().equals(excludeId)); + + if (collision) + { + throw new WebApplicationException(Response.status(Response.Status.CONFLICT) + .entity(Map.of("error", "secret_conflict")) + .build()); + } + } + + public List getAll(String searchText) + { + List secrets = secretRepository.listAll(); + if (searchText == null || searchText.isBlank()) + { + return secrets; + } + + String needle = searchText.toLowerCase(); + return secrets.stream().filter(secret -> matches(secret, needle)).toList(); + } + + private boolean matches(SecretEntity secret, String needle) + { + if (secret.getName().toLowerCase().contains(needle)) + { + return true; + } + if (secret.getNamespaces().stream().anyMatch(namespace -> namespace.toLowerCase().contains(needle))) + { + return true; + } + return secret.getEntries().stream().anyMatch(entry -> entry.getKey().toLowerCase().contains(needle)); + } + + @Transactional + public void delete(String id) + { + secretRepository.deleteById(id); + } + + private List toEntries(SecretEntity secret, Map entries) + { + return entries.entrySet().stream() + .map(e -> + { + EntryEntity entry = new EntryEntity(); + entry.setSecret(secret); + entry.setKey(e.getKey()); + entry.setValue(e.getValue()); + return entry; + }) + .toList(); + } + + private String hash(String type, Map entries) + { + String content = entries.entrySet().stream() + .sorted(Map.Entry.comparingByKey()) + .map(e -> e.getKey() + "=" + e.getValue()) + .collect(Collectors.joining(";")); + return hash(type + ";" + content); + } + + private String hash(String value) + { + try + { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + byte[] bytes = digest.digest(value.getBytes(StandardCharsets.UTF_8)); + return HexFormat.of().formatHex(bytes); + } + catch (NoSuchAlgorithmException e) + { + throw new IllegalStateException(e); + } + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/dto/Secret.java b/backend/src/main/java/dev/dinauer/lockaway/secret/dto/Secret.java new file mode 100644 index 0000000..8b06188 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/dto/Secret.java @@ -0,0 +1,8 @@ +package dev.dinauer.lockaway.secret.dto; + +import java.util.List; +import java.util.Map; + +public record Secret(String id, String name, List namespaces, String contentHash, Map entries, String type) +{ +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/dto/SecretCreate.java b/backend/src/main/java/dev/dinauer/lockaway/secret/dto/SecretCreate.java new file mode 100644 index 0000000..ad0025c --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/dto/SecretCreate.java @@ -0,0 +1,8 @@ +package dev.dinauer.lockaway.secret.dto; + +import java.util.List; +import java.util.Map; + +public record SecretCreate(String name, List namespaces, Map entries, String type) +{ +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/secret/entry/EntryEntity.java b/backend/src/main/java/dev/dinauer/lockaway/secret/entry/EntryEntity.java new file mode 100644 index 0000000..5ce5198 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/secret/entry/EntryEntity.java @@ -0,0 +1,63 @@ +package dev.dinauer.lockaway.secret.entry; + +import dev.dinauer.lockaway.secret.SecretEntity; +import jakarta.persistence.*; +import org.hibernate.annotations.UuidGenerator; + +@Entity +@Table(name = "entry") +public class EntryEntity +{ + @Id + @GeneratedValue + @UuidGenerator + private String id; + + @ManyToOne + private SecretEntity secret; + + private String key; + + @Column(columnDefinition = "TEXT") + private String value; + + public String getId() + { + return id; + } + + public void setId(String id) + { + this.id = id; + } + + public SecretEntity getSecret() + { + return secret; + } + + public void setSecret(SecretEntity secret) + { + this.secret = secret; + } + + public String getKey() + { + return key; + } + + public void setKey(String key) + { + this.key = key; + } + + public String getValue() + { + return value; + } + + public void setValue(String value) + { + this.value = value; + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationEntity.java b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationEntity.java new file mode 100644 index 0000000..06fc695 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationEntity.java @@ -0,0 +1,37 @@ +package dev.dinauer.lockaway.verification; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import jakarta.persistence.Table; + +@Entity +@Table(name = "verification") +public class VerificationEntity +{ + public static final long SINGLETON_ID = 1L; + + @Id + private Long id = SINGLETON_ID; + + private String value; + + public Long getId() + { + return id; + } + + public void setId(Long id) + { + this.id = id; + } + + public String getValue() + { + return value; + } + + public void setValue(String value) + { + this.value = value; + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationRepository.java b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationRepository.java new file mode 100644 index 0000000..424b606 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationRepository.java @@ -0,0 +1,14 @@ +package dev.dinauer.lockaway.verification; + +import io.quarkus.hibernate.orm.panache.PanacheRepositoryBase; +import jakarta.enterprise.context.ApplicationScoped; +import java.util.Optional; + +@ApplicationScoped +public class VerificationRepository implements PanacheRepositoryBase +{ + public Optional findSingleton() + { + return findByIdOptional(VerificationEntity.SINGLETON_ID); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationResource.java b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationResource.java new file mode 100644 index 0000000..e147ea6 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationResource.java @@ -0,0 +1,31 @@ +package dev.dinauer.lockaway.verification; + +import dev.dinauer.lockaway.verification.dto.VerificationValue; +import jakarta.inject.Inject; +import jakarta.ws.rs.Consumes; +import jakarta.ws.rs.GET; +import jakarta.ws.rs.POST; +import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; +import jakarta.ws.rs.core.MediaType; + +@Path("/verification") +public class VerificationResource +{ + @Inject + VerificationService verificationService; + + @GET + @Produces(MediaType.APPLICATION_JSON) + public VerificationValue get() + { + return verificationService.getValue().map(VerificationValue::new).orElse(null); + } + + @POST + @Consumes(MediaType.APPLICATION_JSON) + public void set(VerificationValue body) + { + verificationService.setValue(body.value()); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationService.java b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationService.java new file mode 100644 index 0000000..88d3d75 --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/verification/VerificationService.java @@ -0,0 +1,26 @@ +package dev.dinauer.lockaway.verification; + +import jakarta.enterprise.context.ApplicationScoped; +import jakarta.inject.Inject; +import jakarta.transaction.Transactional; +import java.util.Optional; + +@ApplicationScoped +public class VerificationService +{ + @Inject + VerificationRepository verificationRepository; + + public Optional getValue() + { + return verificationRepository.findSingleton().map(VerificationEntity::getValue); + } + + @Transactional + public void setValue(String value) + { + VerificationEntity verification = verificationRepository.findSingleton().orElseGet(VerificationEntity::new); + verification.setValue(value); + verificationRepository.persist(verification); + } +} diff --git a/backend/src/main/java/dev/dinauer/lockaway/verification/dto/VerificationValue.java b/backend/src/main/java/dev/dinauer/lockaway/verification/dto/VerificationValue.java new file mode 100644 index 0000000..2d0ce2d --- /dev/null +++ b/backend/src/main/java/dev/dinauer/lockaway/verification/dto/VerificationValue.java @@ -0,0 +1,5 @@ +package dev.dinauer.lockaway.verification.dto; + +public record VerificationValue(String value) +{ +} diff --git a/backend/src/main/resources/application.properties b/backend/src/main/resources/application.properties new file mode 100644 index 0000000..b24662d --- /dev/null +++ b/backend/src/main/resources/application.properties @@ -0,0 +1,13 @@ +quarkus.datasource.db-kind=postgresql +%dev.quarkus.datasource.username=postgres +%dev.quarkus.datasource.password=postgres +%dev.quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:32876/postgres + +quarkus.hibernate-orm.schema-management.strategy=validate +quarkus.hibernate-orm.physical-naming-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategySnakeCaseImpl + +quarkus.flyway.migrate-at-start=true +%dev.quarkus.flyway.clean-at-start=true + +quarkus.http.cors.enabled=true +quarkus.http.cors.origins=/http:\/\/localhost:[0-9]+/ \ No newline at end of file diff --git a/backend/src/main/resources/db/migration/V1__init.sql b/backend/src/main/resources/db/migration/V1__init.sql new file mode 100644 index 0000000..2af3b7d --- /dev/null +++ b/backend/src/main/resources/db/migration/V1__init.sql @@ -0,0 +1,24 @@ +CREATE TABLE secret +( + id VARCHAR(255) NOT NULL, + name VARCHAR(255), + content_hash VARCHAR(255), + PRIMARY KEY (id) +); + +CREATE TABLE secret_namespace +( + secret_id VARCHAR(255) NOT NULL, + namespace VARCHAR(255), + CONSTRAINT fk_secret_namespace_secret FOREIGN KEY (secret_id) REFERENCES secret (id) +); + +CREATE TABLE entry +( + id VARCHAR(255) NOT NULL, + secret_id VARCHAR(255), + key VARCHAR(255), + value VARCHAR(255), + PRIMARY KEY (id), + CONSTRAINT fk_entry_secret FOREIGN KEY (secret_id) REFERENCES secret (id) +); diff --git a/backend/src/main/resources/db/migration/V2__verification.sql b/backend/src/main/resources/db/migration/V2__verification.sql new file mode 100644 index 0000000..86cea1d --- /dev/null +++ b/backend/src/main/resources/db/migration/V2__verification.sql @@ -0,0 +1,6 @@ +CREATE TABLE verification +( + id BIGINT NOT NULL, + value VARCHAR(255) NOT NULL, + PRIMARY KEY (id) +); diff --git a/backend/src/main/resources/db/migration/V3__entry_value_text.sql b/backend/src/main/resources/db/migration/V3__entry_value_text.sql new file mode 100644 index 0000000..4cb3558 --- /dev/null +++ b/backend/src/main/resources/db/migration/V3__entry_value_text.sql @@ -0,0 +1,2 @@ +ALTER TABLE entry + ALTER COLUMN value TYPE TEXT; diff --git a/backend/src/main/resources/db/migration/V4__secret_type.sql b/backend/src/main/resources/db/migration/V4__secret_type.sql new file mode 100644 index 0000000..87457e5 --- /dev/null +++ b/backend/src/main/resources/db/migration/V4__secret_type.sql @@ -0,0 +1,2 @@ +ALTER TABLE secret + ADD COLUMN type VARCHAR(255); diff --git a/backend/src/main/resources/import.sql b/backend/src/main/resources/import.sql new file mode 100644 index 0000000..16aa523 --- /dev/null +++ b/backend/src/main/resources/import.sql @@ -0,0 +1,6 @@ +-- This file allow to write SQL commands that will be emitted in test and dev. +-- The commands are commented as their support depends of the database +-- insert into myentity (id, field) values(1, 'field-1'); +-- insert into myentity (id, field) values(2, 'field-2'); +-- insert into myentity (id, field) values(3, 'field-3'); +-- alter sequence myentity_seq restart with 4; \ No newline at end of file