diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2065bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/websocket-authentication/README.md b/websocket-authentication/README.md new file mode 100644 index 0000000..6ffda20 --- /dev/null +++ b/websocket-authentication/README.md @@ -0,0 +1,18 @@ +# Overview + +GraphQL over WebSocket with an authentication token passed through the `"connection_init"` message. + +# Configuration + +The `WebMvcSecurityConfig` and `WebFluxSecurityConfig` configure the `AuthenticationWebSocketInterceptor` +required to perform the authentication. + +To switch between WebMvc or WebFlux as the transport, comment in and out +`spring-boot-starter-web` and `spring-boot-starter-websocket` in build.gradle. + +# Running + +1. Run `GreetingApplication` from your IDE, or `./gradlew bootRun` from the command line to start the server. +2. Run `GreetingClient`, or `./gradlew clientRun` to execute a subscription. + +Or you can run the integration tests in `GreetingApplicationTests`. diff --git a/websocket-authentication/build.gradle b/websocket-authentication/build.gradle new file mode 100644 index 0000000..31a4adc --- /dev/null +++ b/websocket-authentication/build.gradle @@ -0,0 +1,41 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.3.0' + id 'io.spring.dependency-management' version '1.1.4' +} + +group = 'com.example' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +repositories { + mavenLocal() + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-graphql' + implementation 'org.springframework.boot:spring-boot-starter-web' // Comment out for WebFlux + implementation 'org.springframework.boot:spring-boot-starter-websocket' // Comment out for WebFlux + implementation 'org.springframework.boot:spring-boot-starter-webflux' + + implementation 'org.springframework.boot:spring-boot-starter-security' + implementation 'org.springframework.security:spring-security-oauth2-jose' + implementation 'org.springframework.security:spring-security-oauth2-resource-server' + + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'io.projectreactor:reactor-test' + testImplementation 'org.springframework.graphql:spring-graphql-test' +} + +tasks.register('clientRun', JavaExec) { + classpath = sourceSets.main.runtimeClasspath + mainClass = 'com.example.greeting.GreetingClient' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/websocket-authentication/gradle/wrapper/gradle-wrapper.jar b/websocket-authentication/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e644113 Binary files /dev/null and b/websocket-authentication/gradle/wrapper/gradle-wrapper.jar differ diff --git a/websocket-authentication/gradle/wrapper/gradle-wrapper.properties b/websocket-authentication/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..b82aa23 --- /dev/null +++ b/websocket-authentication/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/websocket-authentication/gradlew b/websocket-authentication/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/websocket-authentication/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + 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 +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/websocket-authentication/gradlew.bat b/websocket-authentication/gradlew.bat new file mode 100644 index 0000000..25da30d --- /dev/null +++ b/websocket-authentication/gradlew.bat @@ -0,0 +1,92 @@ +@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=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/websocket-authentication/settings.gradle b/websocket-authentication/settings.gradle new file mode 100644 index 0000000..36f504e --- /dev/null +++ b/websocket-authentication/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'websocket-authentication' diff --git a/websocket-authentication/src/main/java/com/example/greeting/GreetingApplication.java b/websocket-authentication/src/main/java/com/example/greeting/GreetingApplication.java new file mode 100644 index 0000000..39b3e17 --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/GreetingApplication.java @@ -0,0 +1,13 @@ +package com.example.greeting; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class GreetingApplication { + + public static void main(String[] args) { + SpringApplication.run(GreetingApplication.class, args); + } + +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/GreetingClient.java b/websocket-authentication/src/main/java/com/example/greeting/GreetingClient.java new file mode 100644 index 0000000..222635f --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/GreetingClient.java @@ -0,0 +1,25 @@ +package com.example.greeting; + +import java.net.URI; + +import org.springframework.graphql.client.WebSocketGraphQlClient; +import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient; + +public class GreetingClient { + + public static void main(String[] args) { + + WebSocketGraphQlClient graphQlClient = WebSocketGraphQlClient + .builder(URI.create("ws://localhost:8080/graphql"), new ReactorNettyWebSocketClient()) + .interceptor(JwtGraphQlClientInterceptor.create()) + .build(); + + graphQlClient.document("subscription {greetings}") + .retrieveSubscription("greetings") + .toEntity(String.class) + .take(5) + .doOnNext(System.out::println) + .blockLast(); + } + +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/GreetingController.java b/websocket-authentication/src/main/java/com/example/greeting/GreetingController.java new file mode 100644 index 0000000..60ac3cb --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/GreetingController.java @@ -0,0 +1,26 @@ +package com.example.greeting; + +import java.time.Duration; + +import reactor.core.publisher.Flux; + +import org.springframework.graphql.data.method.annotation.QueryMapping; +import org.springframework.graphql.data.method.annotation.SubscriptionMapping; +import org.springframework.security.core.Authentication; +import org.springframework.stereotype.Controller; + +@Controller +public class GreetingController { + + @QueryMapping + String greeting(Authentication authentication) { + return "Hello " + authentication.getName() + "!"; + } + + @SubscriptionMapping + Flux greetings(Authentication authentication) { + return Flux.interval(Duration.ofMillis(50)) + .map((num) -> "Hello " + authentication.getName() + num + "!"); + } + +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/JwtGraphQlClientInterceptor.java b/websocket-authentication/src/main/java/com/example/greeting/JwtGraphQlClientInterceptor.java new file mode 100644 index 0000000..66f09a9 --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/JwtGraphQlClientInterceptor.java @@ -0,0 +1,58 @@ +package com.example.greeting; + +import java.io.IOException; +import java.io.InputStream; +import java.security.interfaces.RSAPrivateKey; +import java.security.interfaces.RSAPublicKey; +import java.util.Map; + +import com.nimbusds.jose.jwk.JWKSet; +import com.nimbusds.jose.jwk.RSAKey; +import com.nimbusds.jose.jwk.source.ImmutableJWKSet; +import reactor.core.publisher.Mono; + +import org.springframework.core.io.ClassPathResource; +import org.springframework.graphql.client.WebSocketGraphQlClientInterceptor; +import org.springframework.security.converter.RsaKeyConverters; +import org.springframework.security.oauth2.jwt.JwtClaimsSet; +import org.springframework.security.oauth2.jwt.JwtEncoder; +import org.springframework.security.oauth2.jwt.JwtEncoderParameters; +import org.springframework.security.oauth2.jwt.NimbusJwtEncoder; + +public final class JwtGraphQlClientInterceptor implements WebSocketGraphQlClientInterceptor { + + private final String token; + + + private JwtGraphQlClientInterceptor(String token) { + this.token = token; + } + + + @Override + public Mono connectionInitPayload() { + return Mono.just(Map.of("Authorization", "Bearer " + this.token)); + } + + + public static JwtGraphQlClientInterceptor create() { + return new JwtGraphQlClientInterceptor(initToken()); + } + + private static String initToken() { + ClassPathResource privResource = new ClassPathResource("simple.priv"); + ClassPathResource pubResource = new ClassPathResource("simple.pub"); + + try (InputStream priv = privResource.getInputStream(); InputStream pub = pubResource.getInputStream()) { + RSAPublicKey publicKey = RsaKeyConverters.x509().convert(pub); + RSAPrivateKey privateKey = RsaKeyConverters.pkcs8().convert(priv); + RSAKey key = new RSAKey.Builder(publicKey).privateKey(privateKey).build(); + JwtEncoder encoder = new NimbusJwtEncoder(new ImmutableJWKSet<>(new JWKSet(key))); + JwtClaimsSet set = JwtClaimsSet.builder().subject("Markey").claim("scope", "greeting:read").build(); + return encoder.encode(JwtEncoderParameters.from(set)).getTokenValue(); + } + catch (IOException ex) { + throw new RuntimeException(ex); + } + } +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/WebFluxSecurityConfig.java b/websocket-authentication/src/main/java/com/example/greeting/WebFluxSecurityConfig.java new file mode 100644 index 0000000..f1e41fb --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/WebFluxSecurityConfig.java @@ -0,0 +1,34 @@ +package com.example.greeting; + +import java.security.interfaces.RSAPublicKey; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.graphql.server.WebSocketGraphQlInterceptor; +import org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor; +import org.springframework.graphql.server.webflux.AuthenticationWebSocketInterceptor; +import org.springframework.security.config.web.server.ServerHttpSecurity; +import org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder; +import org.springframework.security.oauth2.server.resource.authentication.JwtReactiveAuthenticationManager; +import org.springframework.security.web.server.SecurityWebFilterChain; + +@Configuration +@ConditionalOnMissingClass("org.springframework.web.servlet.DispatcherServlet") +public class WebFluxSecurityConfig { + + @Bean + SecurityWebFilterChain webFilters(ServerHttpSecurity http) { + http.authorizeExchange((authorize) -> authorize.anyExchange().permitAll()); + return http.build(); + } + + @Bean + public WebSocketGraphQlInterceptor authenticationInterceptor(@Value("classpath:simple.pub") RSAPublicKey pub) { + return new AuthenticationWebSocketInterceptor( + new BearerTokenAuthenticationExtractor(), + new JwtReactiveAuthenticationManager(NimbusReactiveJwtDecoder.withPublicKey(pub).build())); + } + +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/WebMvcSecurityConfig.java b/websocket-authentication/src/main/java/com/example/greeting/WebMvcSecurityConfig.java new file mode 100644 index 0000000..09f83a7 --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/WebMvcSecurityConfig.java @@ -0,0 +1,34 @@ +package com.example.greeting; + +import java.security.interfaces.RSAPublicKey; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.graphql.server.WebSocketGraphQlInterceptor; +import org.springframework.graphql.server.support.BearerTokenAuthenticationExtractor; +import org.springframework.graphql.server.webmvc.AuthenticationWebSocketInterceptor; +import org.springframework.security.authentication.ProviderManager; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.oauth2.jwt.NimbusJwtDecoder; +import org.springframework.security.oauth2.server.resource.authentication.JwtAuthenticationProvider; +import org.springframework.security.web.SecurityFilterChain; + +@Configuration +@ConditionalOnClass(name = "org.springframework.web.servlet.DispatcherServlet") +public class WebMvcSecurityConfig { + + @Bean + SecurityFilterChain filters(HttpSecurity http) throws Exception { + http.authorizeHttpRequests((authorize) -> authorize.anyRequest().permitAll()); + return http.build(); + } + + @Bean + public WebSocketGraphQlInterceptor authenticationInterceptor(@Value("classpath:simple.pub") RSAPublicKey pub) { + return new AuthenticationWebSocketInterceptor( + new BearerTokenAuthenticationExtractor(), + new ProviderManager(new JwtAuthenticationProvider(NimbusJwtDecoder.withPublicKey(pub).build()))); + } +} diff --git a/websocket-authentication/src/main/java/com/example/greeting/package-info.java b/websocket-authentication/src/main/java/com/example/greeting/package-info.java new file mode 100644 index 0000000..5b9a2f0 --- /dev/null +++ b/websocket-authentication/src/main/java/com/example/greeting/package-info.java @@ -0,0 +1,4 @@ +@NonNullApi +package com.example.greeting; + +import org.springframework.lang.NonNullApi; \ No newline at end of file diff --git a/websocket-authentication/src/main/resources/application.properties b/websocket-authentication/src/main/resources/application.properties new file mode 100644 index 0000000..c14d62a --- /dev/null +++ b/websocket-authentication/src/main/resources/application.properties @@ -0,0 +1,10 @@ +spring.application.name=websocket-authentication + +spring.graphql.websocket.path=/graphql +spring.graphql.graphiql.enabled=true + +logging.level.com.example.greeting=DEBUG +logging.level.org.springframework.graphql=TRACE +logging.level.org.springframework.security=TRACE + +spring.security.oauth2.resourceserver.jwt.public-key-location=classpath:simple.pub diff --git a/websocket-authentication/src/main/resources/graphql/schema.graphqls b/websocket-authentication/src/main/resources/graphql/schema.graphqls new file mode 100644 index 0000000..4828508 --- /dev/null +++ b/websocket-authentication/src/main/resources/graphql/schema.graphqls @@ -0,0 +1,7 @@ +type Query { + greeting: String! +} + +type Subscription { + greetings: String! +} \ No newline at end of file diff --git a/websocket-authentication/src/main/resources/simple.priv b/websocket-authentication/src/main/resources/simple.priv new file mode 100644 index 0000000..5351007 --- /dev/null +++ b/websocket-authentication/src/main/resources/simple.priv @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDcWWomvlNGyQhA +iB0TcN3sP2VuhZ1xNRPxr58lHswC9Cbtdc2hiSbe/sxAvU1i0O8vaXwICdzRZ1JM +g1TohG9zkqqjZDhyw1f1Ic6YR/OhE6NCpqERy97WMFeW6gJd1i5inHj/W19GAbqK +LhSHGHqIjyo0wlBf58t+qFt9h/EFBVE/LAGQBsg/jHUQCxsLoVI2aSELGIw2oSDF +oiljwLaQl0n9khX5ZbiegN3OkqodzCYHwWyu6aVVj8M1W9RIMiKmKr09s/gf31Nc +3WjvjqhFo1rTuurWGgKAxJLL7zlJqAKjGWbIT4P6h/1Kwxjw6X23St3OmhsG6HIn ++jl1++MrAgMBAAECggEBAMf820wop3pyUOwI3aLcaH7YFx5VZMzvqJdNlvpg1jbE +E2Sn66b1zPLNfOIxLcBG8x8r9Ody1Bi2Vsqc0/5o3KKfdgHvnxAB3Z3dPh2WCDek +lCOVClEVoLzziTuuTdGO5/CWJXdWHcVzIjPxmK34eJXioiLaTYqN3XKqKMdpD0ZG +mtNTGvGf+9fQ4i94t0WqIxpMpGt7NM4RHy3+Onggev0zLiDANC23mWrTsUgect/7 +62TYg8g1bKwLAb9wCBT+BiOuCc2wrArRLOJgUkj/F4/gtrR9ima34SvWUyoUaKA0 +bi4YBX9l8oJwFGHbU9uFGEMnH0T/V0KtIB7qetReywkCgYEA9cFyfBIQrYISV/OA ++Z0bo3vh2aL0QgKrSXZ924cLt7itQAHNZ2ya+e3JRlTczi5mnWfjPWZ6eJB/8MlH +Gpn12o/POEkU+XjZZSPe1RWGt5g0S3lWqyx9toCS9ACXcN9tGbaqcFSVI73zVTRA +8J9grR0fbGn7jaTlTX2tnlOTQ60CgYEA5YjYpEq4L8UUMFkuj+BsS3u0oEBnzuHd +I9LEHmN+CMPosvabQu5wkJXLuqo2TxRnAznsA8R3pCLkdPGoWMCiWRAsCn979TdY +QbqO2qvBAD2Q19GtY7lIu6C35/enQWzJUMQE3WW0OvjLzZ0l/9mA2FBRR+3F9A1d +rBdnmv0c3TcCgYEAi2i+ggVZcqPbtgrLOk5WVGo9F1GqUBvlgNn30WWNTx4zIaEk +HSxtyaOLTxtq2odV7Kr3LGiKxwPpn/T+Ief+oIp92YcTn+VfJVGw4Z3BezqbR8lA +Uf/+HF5ZfpMrVXtZD4Igs3I33Duv4sCuqhEvLWTc44pHifVloozNxYfRfU0CgYBN +HXa7a6cJ1Yp829l62QlJKtx6Ymj95oAnQu5Ez2ROiZMqXRO4nucOjGUP55Orac1a +FiGm+mC/skFS0MWgW8evaHGDbWU180wheQ35hW6oKAb7myRHtr4q20ouEtQMdQIF +snV39G1iyqeeAsf7dxWElydXpRi2b68i3BIgzhzebQKBgQCdUQuTsqV9y/JFpu6H +c5TVvhG/ubfBspI5DhQqIGijnVBzFT//UfIYMSKJo75qqBEyP2EJSmCsunWsAFsM +TszuiGTkrKcZy9G0wJqPztZZl2F2+bJgnA6nBEV7g5PA4Af+QSmaIhRwqGDAuROR +47jndeyIaMTNETEmOnms+as17g== +-----END PRIVATE KEY----- \ No newline at end of file diff --git a/websocket-authentication/src/main/resources/simple.pub b/websocket-authentication/src/main/resources/simple.pub new file mode 100644 index 0000000..0b2ee7b --- /dev/null +++ b/websocket-authentication/src/main/resources/simple.pub @@ -0,0 +1,9 @@ +-----BEGIN PUBLIC KEY----- +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3FlqJr5TRskIQIgdE3Dd +7D9lboWdcTUT8a+fJR7MAvQm7XXNoYkm3v7MQL1NYtDvL2l8CAnc0WdSTINU6IRv +c5Kqo2Q4csNX9SHOmEfzoROjQqahEcve1jBXluoCXdYuYpx4/1tfRgG6ii4Uhxh6 +iI8qNMJQX+fLfqhbfYfxBQVRPywBkAbIP4x1EAsbC6FSNmkhCxiMNqEgxaIpY8C2 +kJdJ/ZIV+WW4noDdzpKqHcwmB8FsrumlVY/DNVvUSDIipiq9PbP4H99TXN1o746o +RaNa07rq1hoCgMSSy+85SagCoxlmyE+D+of9SsMY8Ol9t0rdzpobBuhyJ/o5dfvj +KwIDAQAB +-----END PUBLIC KEY----- \ No newline at end of file diff --git a/websocket-authentication/src/test/java/com/example/greeting/GreetingApplicationTests.java b/websocket-authentication/src/test/java/com/example/greeting/GreetingApplicationTests.java new file mode 100644 index 0000000..3efbe86 --- /dev/null +++ b/websocket-authentication/src/test/java/com/example/greeting/GreetingApplicationTests.java @@ -0,0 +1,57 @@ +package com.example.greeting; + +import java.net.URI; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import reactor.core.publisher.Flux; +import reactor.test.StepVerifier; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.server.LocalServerPort; +import org.springframework.graphql.test.tester.GraphQlTester; +import org.springframework.graphql.test.tester.WebSocketGraphQlTester; +import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient; + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +class GreetingApplicationTests { + + @LocalServerPort + private int port; + + @Value("http://localhost:${local.server.port}${spring.graphql.websocket.path}") + private String baseUrl; + + private GraphQlTester graphQlTester; + + + @BeforeEach + void setUp() { + URI url = URI.create(baseUrl); + this.graphQlTester = WebSocketGraphQlTester.builder(url, new ReactorNettyWebSocketClient()) + .interceptor(JwtGraphQlClientInterceptor.create()) + .build(); + } + + @Test + void greeting() { + this.graphQlTester.document("{greeting}") + .execute() + .path("greeting") + .entity(String.class).isEqualTo("Hello Markey!"); + } + + @Test + void greetings() { + Flux flux = this.graphQlTester.document("subscription {greetings}") + .executeSubscription() + .toFlux("greetings", String.class); + + StepVerifier.create(flux) + .expectNext("Hello Markey0!", "Hello Markey1!", "Hello Markey2!", "Hello Markey3!") + .thenCancel() + .verify(); + } + +}