Skip to content
Snippets Groups Projects
Commit b98680cf authored by Chris Lemaire's avatar Chris Lemaire
Browse files

Initial setup for Labradoor

Labradoor will be a library that can be used by Queue and CPM2.0
to allow for easy configuration of Spring Security to connect to
the TUD SAML or some in-memory authentication provider.

Additionally, labradoor will allow 'the door' to Labracore in the
form of an API specification and the implementation of such a spec.
This implementation is done through the OpenAPI generator plugin for
gradle.
parent 1f1ca650
No related branches found
No related tags found
No related merge requests found
Showing
with 2110 additions and 0 deletions
generated
# Gradle
.gradle/
build/
bin/
out/
# Maven
target/
# IntelliJ
.idea/
*.iml
*.ipr
*.iws
# Eclipse
.classpath
.project
.settings/
.springBeans
application.properties
log4j.properties
sentry.properties
#h2 databases
*.db
#MacOS
*.DS_Store
# zsh autocompletion
.gradletasknamecache
application.yml
LICENSE 0 → 100644
This diff is collapsed.
Labracore - A connecting core service for Labrador products
Copyright (C) 2020- Delft University of Technology
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import com.diffplug.gradle.spotless.SpotlessExtension
import nl.javadude.gradle.plugins.license.DownloadLicensesExtension
import nl.javadude.gradle.plugins.license.LicenseExtension
import org.openapitools.generator.gradle.plugin.tasks.GenerateTask
import org.springframework.boot.gradle.tasks.bundling.BootJar
group = "nl.tudelft.ewi.labrador"
version = "0.1.0"
val javaVersion = JavaVersion.VERSION_11
val springBootVersion: String = "2.1.7.RELEASE"
val hibernateVersion = "5.4.8.Final"
val lombokVersion = "1.18.12"
val springDocVersion = "1.2.32"
val jacksonVersion = "2.10.3"
val genSourceDir = file("$buildDir/labracore-api/src/main/java")
// The repositories used to lookup dependencies.
repositories {
mavenLocal()
mavenCentral()
maven {
url = uri("https://build.shibboleth.net/nexus/content/repositories/releases")
}
}
// The plugins used by Gradle to generate files, start Spring boot, perform static analysis etc.
plugins {
// Plugin for the Kotlin-DSL to be on classpath, disabled
// because it does not need to be applied during build.
`kotlin-dsl` apply false
// Standard plugins for Gradle to work properly
java
idea
jacoco
maven
// Spring plugins for managing dependencies and creating
// a nice Spring Boot application.
id("org.springframework.boot").version("2.1.7.RELEASE")
id("io.spring.dependency-management").version("1.0.9.RELEASE")
// Spotless plugin for checking style of Java code.
id("com.diffplug.gradle.spotless").version("3.27.2")
// Plugin for checking license headers within our code and files.
id("com.github.hierynomus.license").version("0.15.0")
id("com.github.hierynomus.license-report").version("0.15.0")
// Open API generator for generating the Client code for Labracore.
id("org.openapi.generator").version("4.2.3")
}
sourceSets {
main {
java {
srcDir(file("src/main/java"))
srcDir(genSourceDir)
}
}
test {
java {
srcDir(file("src/test/java"))
}
}
}
val developmentOnly = configurations.create("developmentOnly")
configurations {
developmentOnly
runtimeClasspath {
extendsFrom(developmentOnly)
}
compileOnly {
extendsFrom(configurations.annotationProcessor.get())
}
}
///// Plugins configurations ///////
java {
sourceCompatibility = javaVersion
targetCompatibility = javaVersion
}
// Configure license plugins.
configure<DownloadLicensesExtension> {
includeProjectDependencies = true
}
configure<LicenseExtension> {
header = file("$rootDir/LICENSE.header")
skipExistingHeaders = false
mapping(mapOf(
"java" to "SLASHSTAR_STYLE"
))
excludes(listOf(
"**/*.json",
"labracore-api/**/*.java"
))
}
// Configure Spotless plugin for style checking Java code.
configure<SpotlessExtension> {
java {
// Use the eclipse formatter format and import order.
eclipse().configFile(file("eclipse-formatter.xml"))
importOrderFile(file("$rootDir/importorder.txt"))
// Check for a license header in the form of LICENSE.header.java.
licenseHeaderFile(file("$rootDir/LICENSE.header.java"))
// Default added rules.
paddedCell()
removeUnusedImports()
trimTrailingWhitespace()
endWithNewline()
}
}
/////// TASKS ///////
val jacocoTestReport by tasks.getting(JacocoReport::class) {
group = "Reporting"
reports {
xml.isEnabled = true
csv.isEnabled = false
html.destination = file("$buildDir/reports/coverage")
}
}
// Task for generating the client code for connecting with the Labracore API
val generateLabracoreClient by tasks.register("generateLabracoreClient", GenerateTask::class) {
// Name of the Client code generator.
generatorName.set("java")
// Set output directory, specification and configuration.
outputDir.set("$buildDir/labracore-api")
inputSpec.set("${rootDir}/oa-spec-labracore.json")
configFile.set("${rootDir}/oa-config-labracore.json")
// Mark the output directory for this task to prevent gradle from marking it as stale
outputs.dir("$buildDir/labracore-api")
}
val processResources by tasks.getting(ProcessResources::class)
val compileJava by tasks.getting(JavaCompile::class) {
// Set the compiler to incremental and to show warnings
options.isIncremental = true
options.compilerArgs.addAll(setOf(
"-Xlint:deprecation",
"-Xlint:unchecked"
))
// Add dependencies for generating sources and copying resources
dependsOn.addAll(setOf(
processResources,
generateLabracoreClient
))
}
// Configure JAR making task with name and version
val jar by tasks.getting(Jar::class) {
archiveBaseName.set("labracore-lib")
archiveVersion.set("1.0.0")
}
// Configure Spring Boot plugin task for running the application.
val bootJar by tasks.getting(BootJar::class) {
enabled = false
}
tasks.withType<Test>().configureEach {
useJUnitPlatform()
testLogging {
events("passed", "skipped", "failed")
}
}
dependencies {
// Generic Spring Boot starter dependencies
implementation("org.springframework.boot", "spring-boot-starter", springBootVersion)
implementation("org.springframework.boot", "spring-boot-devtools", springBootVersion)
implementation("org.springframework.boot", "spring-boot-starter-webflux", springBootVersion)
// Spring Boot security dependencies
implementation("org.springframework.boot", "spring-boot-starter-security", springBootVersion)
implementation("com.github.ulisesbocchio", "spring-boot-security-saml", "1.17")
implementation("com.google.code.findbugs", "jsr305", "3.0.2")
// Dependencies for compiling the generated open API spec code
implementation("io.springfox", "springfox-swagger2", "2.9.2")
implementation("org.openapitools", "jackson-databind-nullable", "0.2.1")
// Dependency for mapping one data class to another
implementation("org.modelmapper", "modelmapper", "2.3.6")
// Test dependencies
testImplementation("org.springframework.boot", "spring-boot-starter-test", springBootVersion) {
exclude("junit", "junit")
}
testImplementation("org.springframework.security", "spring-security-test", "5.3.1.RELEASE") {
exclude("junit", "junit")
}
testImplementation("org.springframework.boot", "spring-boot-starter-web", springBootVersion)
testImplementation("org.junit.jupiter", "junit-jupiter", "5.6.2")
runtimeOnly("org.junit.jupiter", "junit-jupiter-engine", "5.3.1")
// Jackson core specific version for dependency vulnerabilities check
implementation("com.fasterxml.jackson.core", "jackson-core", jacksonVersion)
// Lombok for generation of builder pattern, getters, setters, constructors, etc.
compileOnly("org.projectlombok", "lombok", lombokVersion)
testCompileOnly("org.projectlombok", "lombok", lombokVersion)
annotationProcessor("org.projectlombok", "lombok", lombokVersion)
testAnnotationProcessor("org.projectlombok", "lombok", lombokVersion)
}
This diff is collapsed.
File suppressed by a .gitattributes entry, the file's encoding is unsupported, or the file size exceeds the limit.
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
gradlew 0 → 100755
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# 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 UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$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 "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# 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
;;
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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"
@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 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%" == "0" goto init
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 init
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
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
: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 %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="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!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
#Organize Import Order
#Fri Aug 23 16:13:26 CEST 2019
3=com
2=org
1=javax
0=java
{
"library": "webclient",
"invokerPackage": "nl.tudelft.ewi.queue.labracore",
"apiPackage": "nl.tudelft.ewi.queue.labracore.api",
"modelPackage": "nl.tudelft.ewi.queue.labracore.dto",
"java8": "true",
"serializationLibrary": "jackson",
"prependFormOrBodyParameters": "true",
"performBeanValidation": "true",
"useBeanValidation": "true",
"serializableModel": "true",
"snapshotVersion": "true",
"fullJavaUtil": "false"
}
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost:8082","description":"Generated server url"}],"paths":{"/api/course":{"get":{"tags":["course-controller"],"operationId":"getAll","responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CourseViewDTO"}}}}}}},"post":{"tags":["course-controller"],"operationId":"add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseCreateDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}}},"/api/course/{id}":{"get":{"tags":["course-controller"],"operationId":"getById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CourseViewDTO"}}}}}},"post":{"tags":["course-controller"],"operationId":"addWithId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseCreateDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}},"patch":{"tags":["course-controller"],"operationId":"patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoursePatchDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}}},"/api/course/program/{id}":{"get":{"tags":["course-controller"],"operationId":"getAllByProgram","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CourseViewDTO"}}}}}}}},"/api/edition":{"get":{"tags":["edition-controller"],"operationId":"getAll_1","responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EditionViewDTO"}}}}}}},"post":{"tags":["edition-controller"],"operationId":"add_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditionCreateDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}}},"/api/edition/{id}":{"get":{"tags":["edition-controller"],"operationId":"getById_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditionViewDTO"}}}}}},"post":{"tags":["edition-controller"],"operationId":"addWithId_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditionCreateDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}},"patch":{"tags":["edition-controller"],"operationId":"patch_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditionPatchDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"integer","format":"int64"}}}}}}},"/api/edition/program/{id}":{"get":{"tags":["edition-controller"],"operationId":"getAllByCourse","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EditionViewDTO"}}}}}}}},"/api/person/{id}":{"get":{"tags":["person-controller"],"operationId":"getPersonById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonViewDTO"}}}}}}},"/api/person/update":{"post":{"tags":["person-controller"],"operationId":"updatePerson","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonCreateDTO"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonViewDTO"}}}}}}},"/api/person/by/username":{"get":{"tags":["person-controller"],"operationId":"getPersonByUsername","parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonViewDTO"}}}}}}}},"components":{"schemas":{"Address":{"type":"object","properties":{"street":{"type":"string"},"number":{"type":"integer","format":"int32"},"numberPostfix":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"}}},"Assignment":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"edition":{"$ref":"#/components/schemas/Edition"},"deadline":{"type":"string","format":"date-time"},"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/Session"}}}},"Building":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"abbreviation":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"description":{"type":"string"},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/Room"}}}},"Course":{"required":["code","hasGroups","isArchived","manager","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"code":{"type":"string"},"submissionUrl":{"type":"string"},"hasGroups":{"type":"boolean"},"isArchived":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time"},"program":{"$ref":"#/components/schemas/Program"},"manager":{"$ref":"#/components/schemas/Person"},"editions":{"type":"array","items":{"$ref":"#/components/schemas/Edition"}}}},"CourseCreateDTO":{"required":["code","hasGroups","isArchived","manager","name"],"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"submissionUrl":{"type":"string"},"hasGroups":{"type":"boolean"},"isArchived":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time"},"program":{"$ref":"#/components/schemas/Program"},"manager":{"$ref":"#/components/schemas/Person"}}},"Edition":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"course":{"$ref":"#/components/schemas/Course"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/Session"}},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/StudentGroup"}}}},"Person":{"required":["number"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"defaultRole":{"type":"string","enum":["STUDENT","TA","HEAD_TA","TEACHER","TEACHER_RO"]},"number":{"type":"integer","format":"int32"},"programs":{"type":"array","items":{"$ref":"#/components/schemas/Program"}},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"directs":{"type":"array","items":{"$ref":"#/components/schemas/Program"}},"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/Program"}},"manages":{"type":"array","items":{"$ref":"#/components/schemas/Course"}}}},"Program":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"director":{"$ref":"#/components/schemas/Person"},"coordinators":{"type":"array","items":{"$ref":"#/components/schemas/Person"}},"courses":{"type":"array","items":{"$ref":"#/components/schemas/Course"}},"people":{"type":"array","items":{"$ref":"#/components/schemas/Person"}}}},"Role":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["STUDENT","TA","HEAD_TA","TEACHER","TEACHER_RO"]},"person":{"$ref":"#/components/schemas/Person"},"edition":{"$ref":"#/components/schemas/Edition"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/StudentGroup"}}}},"Room":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"abbreviation":{"type":"string"},"capacity":{"type":"integer","format":"int32"},"description":{"type":"string"},"building":{"$ref":"#/components/schemas/Building"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/Session"}}}},"Session":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"description":{"type":"string"},"rooms":{"type":"array","items":{"$ref":"#/components/schemas/Room"}},"editions":{"type":"array","items":{"$ref":"#/components/schemas/Edition"}},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}}}},"StudentGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"edition":{"$ref":"#/components/schemas/Edition"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"submissions":{"type":"array","items":{"$ref":"#/components/schemas/Submission"}}}},"Submission":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"assignment":{"$ref":"#/components/schemas/Assignment"},"group":{"$ref":"#/components/schemas/StudentGroup"},"submissionTime":{"type":"string","format":"date-time"},"approvalTime":{"type":"string","format":"date-time"},"grade":{"type":"number","format":"double"}}},"CoursePatchDTO":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"submissionUrl":{"type":"string"},"hasGroups":{"type":"boolean"},"isArchived":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time"},"program":{"$ref":"#/components/schemas/Program"},"manager":{"$ref":"#/components/schemas/Person"},"editions":{"type":"array","items":{"$ref":"#/components/schemas/Edition"}}}},"CourseViewDTO":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":"string"},"submissionUrl":{"type":"string"},"hasGroups":{"type":"boolean"},"isArchived":{"type":"boolean"},"deletedAt":{"type":"string","format":"date-time"}}},"EditionCreateDTO":{"type":"object"},"EditionPatchDTO":{"type":"object"},"EditionViewDTO":{"type":"object"},"PersonViewDTO":{"type":"object"},"PersonCreateDTO":{"type":"object"}}}}
rootProject.name = "labracore-lib"
pluginManagement {
repositories {
mavenLocal()
mavenCentral()
gradlePluginPortal()
}
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib;
import java.util.Base64;
import java.util.Date;
import java.util.UUID;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import nl.tudelft.ewi.queue.labracore.ApiClient;
import nl.tudelft.ewi.queue.labracore.RFC3339DateFormat;
import nl.tudelft.ewi.queue.labracore.api.CourseControllerApi;
import nl.tudelft.ewi.queue.labracore.api.EditionControllerApi;
import nl.tudelft.ewi.queue.labracore.api.PersonControllerApi;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.function.client.*;
import reactor.core.publisher.Mono;
import com.fasterxml.jackson.databind.ObjectMapper;
/**
* Configuration for the Labracore API Client and security involving the Labracore service.
*/
@Configuration
public class LabracoreApiConfig {
private static final String HMAC_ALGORITHM = "HmacSHA256";
/**
* Base URL where the labracore API is hosted. When running locally this would for instance be
* localhost:8082. If Labracore is running under a servlet context, the context should also be included,
* for instance: localhost:8082/labracore.
*/
@Value("${labracore.url}")
private String labracoreUrl;
/**
* The (semantic) version of the API we want to connect to, for instance: 0.0.1.
*/
@Value("${labracore.version}")
private String apiVersion;
/**
* The key under which Queue is registered with Labracore.
*/
@Value("${labracore.apiKey}")
private String apiKey;
/**
* The secret given by Labracore upon registration.
*/
@Value("${labracore.apiSecret}")
private String apiSecret;
/**
* Creates and returns the message that will be encoded to be the digest. This function does no further
* checks on the input.
*
* (Copied from Labracore AKAuthenticationFilter)
*
* @param apiKey The API key.
* @param date The current time in epoch millis.
* @param method The HTTP method used in the request.
* @param host The name of the host that is addressed.
* @param path The path to the resources requested.
* @param nonce The nonce added to the message to make it random.
* @return The digest message.
*/
private static String createHmacMessage(String apiKey, String date, String method, String host,
String path, String nonce) {
return apiKey + "\n" +
date + "\n" +
method + "\n" +
host + "\n" +
path + "\n" +
nonce;
}
/**
* Encodes the given message using the given secret. This function uses an HMAC algorithm to encode the
* message and then uses Base64 to make the message ready for transport.
*
* (Copied from Labracore AKAuthenticationFilter)
*
* @param apiSecret The secret key used to encode the message.
* @param hmacMessage The message to encode.
* @return The encoded Base64 message.
*/
private static String encodeHmacMessage(String apiSecret, String hmacMessage) {
try {
SecretKeySpec secretKeySpec = new SecretKeySpec(apiSecret.getBytes(), HMAC_ALGORITHM);
Mac mac = Mac.getInstance(HMAC_ALGORITHM);
mac.init(secretKeySpec);
return Base64.getEncoder()
.encodeToString(mac.doFinal(hmacMessage.getBytes()));
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* A filter that can be applied to an outgoing request. The outgoing request is adjusted so that it
* contains the right Authorization, Signature, Host and Date headers.
*/
private class ApiKeyFilter implements ExchangeFilterFunction {
@Override
public Mono<ClientResponse> filter(ClientRequest request, ExchangeFunction next) {
String date = new Date().getTime() + "";
String method = request.method().name();
String path = request.url().getPath();
String nonce = UUID.randomUUID().toString();
String host = request.headers().getFirst("Host");
if (host == null) {
host = request.url().getHost() + ":" + request.url().getPort();
}
String hmacMessage = createHmacMessage(apiKey, date, method, host, path, nonce);
return next.exchange(ClientRequest.from(request)
.header("Date", date)
.header("Signature", nonce)
.header("Host", host)
.header("Authorization",
"ApiKey " + apiKey + ":" + encodeHmacMessage(apiSecret, hmacMessage))
.build());
}
}
/**
* @return Bean for the labracore.ApiClient class with the necessary filters adding Authorization headers
* and signatures.
*/
@Bean
public ApiClient labracoreApiClient() {
ApiClient client = new ApiClient(WebClient.builder()
.filter(new ApiKeyFilter())
.build(),
new ObjectMapper(), new RFC3339DateFormat());
client.setBasePath(labracoreUrl);
client.addDefaultHeader("Version", apiVersion);
return client;
}
/**
* @return Bean for CourseControllerApi to be injected in Controllers.
*/
@Bean
public CourseControllerApi courseControllerApi() {
return new CourseControllerApi(labracoreApiClient());
}
/**
* @return Bean for EditionControllerApi to be injected in Controllers.
*/
@Bean
public EditionControllerApi editionControllerApi() {
return new EditionControllerApi(labracoreApiClient());
}
/**
* @return Bean for PersonControllerApi to be injected in Controllers.
*/
@Bean
public PersonControllerApi personControllerApi() {
return new PersonControllerApi(labracoreApiClient());
}
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib.security;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
public interface LabradorSSOConfigurer {
/**
* Authorizes requests for the Single-Sign On service before configuring other authorized requests and
* before configuring the Single-Sign On method.
*
* @param http HttpSecurity to configure.
* @param loginPath The path of the login page.
* @param logoutPath The path of the logout page.
* @throws Exception when something goes wrong in configuration.
*/
void authorizeRequests(HttpSecurity http, String loginPath, String logoutPath)
throws Exception;
/**
* Configures the HttpSecurity object for the current security configuration.
*
* @param http HttpSecurity to configure.
* @param loginPath The path of the login page.
* @param logoutPath The path of the logout page.
* @throws Exception when something goes wrong in configuration.
*/
void configure(HttpSecurity http, String loginPath, String logoutPath) throws Exception;
default void configure(AuthenticationManagerBuilder auth) throws Exception {
}
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib.security;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.access.ExceptionTranslationFilter;
public abstract class LabradorSecurityConfigurerAdapter extends WebSecurityConfigurerAdapter {
@Value("${labrador.sso.login-path:/login}")
private String loginPath;
@Value("${labrador.sso.logout-path:/logout}")
private String logoutPath;
@Autowired
private LabradorUserUpdateFilter updateFilter;
@Autowired
private LabradorSSOConfigurer ssoConfigurer;
public LabradorSecurityConfigurerAdapter() {
}
public LabradorSecurityConfigurerAdapter(String loginPath, String logoutPath) {
this.loginPath = loginPath;
this.logoutPath = logoutPath;
}
@Override
protected void configure(AuthenticationManagerBuilder auth) throws Exception {
ssoConfigurer.configure(auth);
}
@Override
protected void configure(HttpSecurity http) throws Exception {
ssoConfigurer.authorizeRequests(http, loginPath, logoutPath);
configureAuthorizations(http);
http.addFilterBefore(updateFilter, ExceptionTranslationFilter.class);
ssoConfigurer.configure(http, loginPath, logoutPath);
}
protected abstract void configureAuthorizations(HttpSecurity http) throws Exception;
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib.security;
import java.util.Collection;
import java.util.Collections;
import lombok.Getter;
import nl.tudelft.ewi.queue.labracore.dto.Person;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
public class LabradorUserDetails implements UserDetails {
@Getter
private final Person user;
@Getter
private final String password;
public LabradorUserDetails(Person user) {
this.user = user;
this.password = "";
}
public LabradorUserDetails(Person user, String password) {
this.user = user;
this.password = password;
}
@Override
public Collection<? extends GrantedAuthority> getAuthorities() {
return Collections.emptyList();
}
@Override
public String getUsername() {
return user.getUsername();
}
@Override
public boolean isAccountNonExpired() {
return false;
}
@Override
public boolean isAccountNonLocked() {
return false;
}
@Override
public boolean isCredentialsNonExpired() {
return false;
}
@Override
public boolean isEnabled() {
return false;
}
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib.security;
import nl.tudelft.ewi.queue.labracore.dto.Person;
import org.springframework.security.core.userdetails.UserDetails;
public interface LabradorUserHandler {
/**
* Handle a user logging in. The user was matched to the given Person object and authenticated before
* hand. This method should be implemented to update any locally persisted instances of the user with the
* given user information (in the Person object). This method should additionally return a client server
* specific implementation of the UserDetails interface that will be used in the Client server when an
* Authenticated user is required.
*
* @param person The Person object representing the authenticated user.
* @return UserDetails object to be used to represent the authenticated user in the rest of the
* client server execution.
*/
UserDetails handleUserLogin(Person person);
}
/*
* Labracore - A connecting core service for Labrador products
* Copyright (C) 2020- Delft University of Technology
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package nl.tudelft.labracore.lib.security;
import java.util.Collections;
import javax.servlet.FilterChain;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import nl.tudelft.ewi.queue.labracore.api.PersonControllerApi;
import nl.tudelft.ewi.queue.labracore.dto.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.GenericFilterBean;
@Component
public class LabradorUserUpdateFilter extends GenericFilterBean {
@Autowired
private PersonControllerApi pApi;
@Autowired
private LabradorUserHandler userHandler;
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
final Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
final LabradorUserDetails userDetails = (LabradorUserDetails) authentication.getPrincipal();
final Person person = userDetails.getUser();
pApi.updatePerson(person);
SecurityContextHolder.getContext()
.setAuthentication(new PreAuthenticatedAuthenticationToken(
userHandler.handleUserLogin(person), "N/A", Collections.emptyList()));
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment