diff --git a/samples/grpc-secure/README.md b/samples/grpc-secure/README.md new file mode 100644 index 0000000..2e2ff0b --- /dev/null +++ b/samples/grpc-secure/README.md @@ -0,0 +1,70 @@ +# Spring Boot gRPC Sample + +This project is a copy one of the samples from the [gRPC Spring Boot Starter](https://github.com/yidongnan/grpc-spring-boot-starter/blob/master/examples/local-grpc-server/build.gradle). Build and run any way you like to run Spring Boot. E.g: + +``` +$ ./mvnw spring-boot:run +... + . ____ _ __ _ _ + /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ +( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ + \\/ ___)| |_)| | | | | || (_| | ) ) ) ) + ' |____| .__|_| |_|_| |_\__, | / / / / + =========|_|==============|___/=/_/_/_/ + :: Spring Boot :: (v3.0.0) + +2022-12-08T05:32:24.934-08:00 INFO 551632 --- [ main] com.example.demo.DemoApplication : Starting DemoApplication using Java 17.0.5 with PID 551632 (/home/dsyer/dev/scratch/demo/target/classes started by dsyer in /home/dsyer/dev/scratch/demo) +2022-12-08T05:32:24.938-08:00 INFO 551632 --- [ main] com.example.demo.DemoApplication : No active profile set, falling back to 1 default profile: "default" +2022-12-08T05:32:25.377-08:00 WARN 551632 --- [ main] ocalVariableTableParameterNameDiscoverer : Using deprecated '-debug' fallback for parameter name resolution. Compile the affected code with '-parameters' instead or avoid its introspection: net.devh.boot.grpc.server.autoconfigure.GrpcHealthServiceAutoConfiguration +2022-12-08T05:32:25.416-08:00 WARN 551632 --- [ main] ocalVariableTableParameterNameDiscoverer : Using deprecated '-debug' fallback for parameter name resolution. Compile the affected code with '-parameters' instead or avoid its introspection: net.devh.boot.grpc.server.autoconfigure.GrpcServerAutoConfiguration +2022-12-08T05:32:25.425-08:00 WARN 551632 --- [ main] ocalVariableTableParameterNameDiscoverer : Using deprecated '-debug' fallback for parameter name resolution. Compile the affected code with '-parameters' instead or avoid its introspection: net.devh.boot.grpc.server.autoconfigure.GrpcServerFactoryAutoConfiguration +2022-12-08T05:32:25.427-08:00 INFO 551632 --- [ main] g.s.a.GrpcServerFactoryAutoConfiguration : Detected grpc-netty: Creating NettyGrpcServerFactory +2022-12-08T05:32:25.712-08:00 INFO 551632 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: Simple, bean: grpcServerService, class: com.example.demo.GrpcServerService +2022-12-08T05:32:25.712-08:00 INFO 551632 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: grpc.health.v1.Health, bean: grpcHealthService, class: io.grpc.protobuf.services.HealthServiceImpl +2022-12-08T05:32:25.712-08:00 INFO 551632 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: grpc.reflection.v1alpha.ServerReflection, bean: protoReflectionService, class: io.grpc.protobuf.services.ProtoReflectionService +2022-12-08T05:32:25.820-08:00 INFO 551632 --- [ main] n.d.b.g.s.s.GrpcServerLifecycle : gRPC Server started, listening on address: *, port: 9090 +2022-12-08T05:32:25.831-08:00 INFO 551632 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 1.264 seconds (process running for 1.623) +``` + +The server starts by default on port 9090. Test with [gRPCurl](https://github.com/fullstorydev/grpcurl). There is a B/S insecure channel that lets you authenticate by asserting in a header that you are a user: + +``` +$ grpcurl -H "X-User: user" -d '{"name":"Hi"}' -plaintext localhost:9090 Simple.SayHello +{ + "message": "Hello ==\u003e Hi" +} +``` + +There is also an HTTP Basic authentication channel that requires a username and password (the user's password is the same as the username): + +``` +$ grpcurl -H "Authorization: Basic $(echo -n user:user | base64)" -d '{"name":"Hi"}' -plaintext localhost:9090 Simple.SayHello +{ + "message": "Hello ==\u003e Hi" +} +``` + +## Native Image + +The app compiles to a native image if the JVM is GraalVM: + +``` +$ ./mvnw -Pnative native:compile +$ ./target/demo + . ____ _ __ _ _ + /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ +( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ + \\/ ___)| |_)| | | | | || (_| | ) ) ) ) + ' |____| .__|_| |_|_| |_\__, | / / / / + =========|_|==============|___/=/_/_/_/ + :: Spring Boot :: (v3.0.0) + +2022-12-08T05:36:54.365-08:00 INFO 554359 --- [ main] com.example.demo.DemoApplication : Starting AOT-processed DemoApplication using Java 17.0.5 with PID 554359 (/home/dsyer/dev/scratch/demo/target/demo started by dsyer in /home/dsyer/dev/scratch/demo) +2022-12-08T05:36:54.366-08:00 INFO 554359 --- [ main] com.example.demo.DemoApplication : No active profile set, falling back to 1 default profile: "default" +2022-12-08T05:36:54.377-08:00 INFO 554359 --- [ main] g.s.a.GrpcServerFactoryAutoConfiguration : Detected grpc-netty: Creating NettyGrpcServerFactory +2022-12-08T05:36:54.392-08:00 INFO 554359 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: Simple, bean: grpcServerService, class: com.example.demo.GrpcServerService +2022-12-08T05:36:54.392-08:00 INFO 554359 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: grpc.health.v1.Health, bean: grpcHealthService, class: io.grpc.protobuf.services.HealthServiceImpl +2022-12-08T05:36:54.392-08:00 INFO 554359 --- [ main] n.d.b.g.s.s.AbstractGrpcServerFactory : Registered gRPC service: grpc.reflection.v1alpha.ServerReflection, bean: protoReflectionService, class: io.grpc.protobuf.services.ProtoReflectionService +2022-12-08T05:36:54.396-08:00 INFO 554359 --- [ main] n.d.b.g.s.s.GrpcServerLifecycle : gRPC Server started, listening on address: *, port: 9090 +2022-12-08T05:36:54.396-08:00 INFO 554359 --- [ main] com.example.demo.DemoApplication : Started DemoApplication in 0.046 seconds (process running for 0.052) +``` diff --git a/samples/grpc-secure/build.gradle b/samples/grpc-secure/build.gradle new file mode 100644 index 0000000..6b748a5 --- /dev/null +++ b/samples/grpc-secure/build.gradle @@ -0,0 +1,60 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.4.0' + id 'io.spring.dependency-management' version '1.1.6' + id 'org.graalvm.buildtools.native' version '0.10.3' + id 'com.google.protobuf' version '0.9.4' +} + +group = 'com.example' +version = '0.3.0-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenLocal() + mavenCentral() + maven { url 'https://repo.spring.io/milestone' } + maven { url 'https://repo.spring.io/snapshot' } +} + +dependencyManagement { + imports { + mavenBom 'org.springframework.grpc:spring-grpc-dependencies:0.3.0-SNAPSHOT' + } +} + +dependencies { + implementation 'org.springframework.grpc:spring-grpc-spring-boot-starter' + implementation 'org.springframework.boot:spring-boot-starter-security' + implementation 'io.grpc:grpc-services' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testImplementation 'org.springframework.grpc:spring-grpc-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +tasks.named('test') { + useJUnitPlatform() +} + +protobuf { + protoc { + artifact = "com.google.protobuf:protoc:${dependencyManagement.importedProperties['protobuf-java.version']}" + } + plugins { + grpc { + artifact = "io.grpc:protoc-gen-grpc-java:${dependencyManagement.importedProperties['grpc.version']}" + } + } + generateProtoTasks { + all()*.plugins { + grpc { + option 'jakarta_omit' + } + } + } +} diff --git a/samples/grpc-secure/gradle/wrapper/gradle-wrapper.jar b/samples/grpc-secure/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/samples/grpc-secure/gradle/wrapper/gradle-wrapper.jar differ diff --git a/samples/grpc-secure/gradle/wrapper/gradle-wrapper.properties b/samples/grpc-secure/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..df97d72 --- /dev/null +++ b/samples/grpc-secure/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/samples/grpc-secure/gradlew b/samples/grpc-secure/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/samples/grpc-secure/gradlew @@ -0,0 +1,252 @@ +#!/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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# 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/platforms/jvm/plugins-application/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 -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || 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/samples/grpc-secure/gradlew.bat b/samples/grpc-secure/gradlew.bat new file mode 100644 index 0000000..9b42019 --- /dev/null +++ b/samples/grpc-secure/gradlew.bat @@ -0,0 +1,94 @@ +@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 +@rem SPDX-License-Identifier: Apache-2.0 +@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/samples/grpc-secure/pom.xml b/samples/grpc-secure/pom.xml new file mode 100644 index 0000000..692053d --- /dev/null +++ b/samples/grpc-secure/pom.xml @@ -0,0 +1,182 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.4.0 + + + org.springframework.grpc + grpc-secure-sample + 0.3.0-SNAPSHOT + Spring gRPC Server Sample + Demo project for Spring gRPC + + + + + + + + + + + + + + + 17 + 0.0.39 + 3.25.5 + 1.63.2 + + + + + org.springframework.grpc + spring-grpc-dependencies + 0.3.0-SNAPSHOT + pom + import + + + + + + org.springframework.grpc + spring-grpc-spring-boot-starter + + + org.springframework.boot + spring-boot-starter-security + + + io.grpc + grpc-services + + + io.projectreactor.netty + reactor-netty-core + + + + org.springframework.grpc + spring-grpc-test + test + + + + + + + kr.motd.maven + os-maven-plugin + 1.7.1 + + + + + org.graalvm.buildtools + native-maven-plugin + + + --verbose + + + + + org.springframework.boot + spring-boot-maven-plugin + + + org.apache.maven.plugins + maven-deploy-plugin + + true + + + + io.spring.javaformat + spring-javaformat-maven-plugin + ${spring-javaformat-maven-plugin.version} + + + + validate + true + + validate + + + + + + org.xolstice.maven.plugins + protobuf-maven-plugin + 0.6.1 + + + com.google.protobuf:protoc:${protobuf-java.version}:exe:${os.detected.classifier} + grpc-java + + io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier} + + + + + + jakarta_omit,@generated=omit + + + + compile + compile-custom + + + + + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + + + diff --git a/samples/grpc-secure/settings.gradle b/samples/grpc-secure/settings.gradle new file mode 100644 index 0000000..d294bd1 --- /dev/null +++ b/samples/grpc-secure/settings.gradle @@ -0,0 +1,8 @@ +pluginManagement { + repositories { + maven { url 'https://repo.spring.io/milestone' } + maven { url 'https://repo.spring.io/snapshot' } + gradlePluginPortal() + } +} +rootProject.name = 'demo' diff --git a/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerApplication.java b/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerApplication.java new file mode 100644 index 0000000..e11b211 --- /dev/null +++ b/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerApplication.java @@ -0,0 +1,61 @@ +package org.springframework.grpc.sample; + +import static org.springframework.security.config.Customizer.withDefaults; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Import; +import org.springframework.grpc.server.GlobalServerInterceptor; +import org.springframework.grpc.server.security.GrpcSecurity; +import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration; +import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity; +import org.springframework.security.core.authority.AuthorityUtils; +import org.springframework.security.core.userdetails.User; +import org.springframework.security.provisioning.InMemoryUserDetailsManager; +import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken; + +import io.grpc.Metadata; +import io.grpc.ServerInterceptor; + +@SpringBootApplication +@EnableMethodSecurity +@Import(AuthenticationConfiguration.class) +public class GrpcServerApplication { + + public static final Metadata.Key USER_KEY = Metadata.Key.of("X-USER", Metadata.ASCII_STRING_MARSHALLER); + + public static void main(String[] args) { + SpringApplication.run(GrpcServerApplication.class, args); + } + + @Bean + public InMemoryUserDetailsManager inMemoryUserDetailsManager() { + return new InMemoryUserDetailsManager( + User.withUsername("user").password("{noop}user").authorities("ROLE_USER").build(), + User.withUsername("admin").password("{noop}admin").authorities("ROLE_ADMIN").build()); + } + + @Bean + @GlobalServerInterceptor + public ServerInterceptor securityInterceptor(GrpcSecurity security) throws Exception { + return security + .authorizeRequests(requests -> requests + .methods("Simple/StreamHello").hasAuthority("ROLE_ADMIN") + .methods("Simple/SayHello").hasAuthority("ROLE_USER") + .allRequests().permitAll()) + .httpBasic(withDefaults()) + .preauth(withDefaults()) + .authenticationExtractor((headers, attributes) -> { + String user = headers.get(USER_KEY); + if (user != null) { + return new PreAuthenticatedAuthenticationToken(user, "N/A", + AuthorityUtils.createAuthorityList("ROLE_" + user.toUpperCase())); + } + return null; + }) + .build(); + + } + +} diff --git a/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerService.java b/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerService.java new file mode 100644 index 0000000..3f8eb8f --- /dev/null +++ b/samples/grpc-secure/src/main/java/org/springframework/grpc/sample/GrpcServerService.java @@ -0,0 +1,50 @@ +package org.springframework.grpc.sample; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.springframework.grpc.sample.proto.HelloReply; +import org.springframework.grpc.sample.proto.HelloRequest; +import org.springframework.grpc.sample.proto.SimpleGrpc; +import org.springframework.stereotype.Service; + +import io.grpc.stub.StreamObserver; + +@Service +public class GrpcServerService extends SimpleGrpc.SimpleImplBase { + + private static Log log = LogFactory.getLog(GrpcServerService.class); + + @Override + // @PreAuthorize("hasAuthority('ROLE_USER')") + public void sayHello(HelloRequest req, StreamObserver responseObserver) { + log.info("Hello " + req.getName()); + if (req.getName().startsWith("error")) { + throw new IllegalArgumentException("Bad name: " + req.getName()); + } + HelloReply reply = HelloReply.newBuilder().setMessage("Hello ==> " + req.getName()).build(); + responseObserver.onNext(reply); + responseObserver.onCompleted(); + } + + @Override + // @PreAuthorize("hasAuthority('ROLE_ADMIN')") + public void streamHello(HelloRequest req, StreamObserver responseObserver) { + log.info("Hello " + req.getName()); + int count = 0; + while (count < 10) { + HelloReply reply = HelloReply.newBuilder().setMessage("Hello(" + count + ") ==> " + req.getName()).build(); + responseObserver.onNext(reply); + count++; + try { + Thread.sleep(1000L); + } + catch (InterruptedException e) { + Thread.currentThread().interrupt(); + responseObserver.onError(e); + return; + } + } + responseObserver.onCompleted(); + } + +} \ No newline at end of file diff --git a/samples/grpc-secure/src/main/proto/hello.proto b/samples/grpc-secure/src/main/proto/hello.proto new file mode 100644 index 0000000..731679c --- /dev/null +++ b/samples/grpc-secure/src/main/proto/hello.proto @@ -0,0 +1,23 @@ +syntax = "proto3"; + +option java_multiple_files = true; +option java_package = "org.springframework.grpc.sample.proto"; +option java_outer_classname = "HelloWorldProto"; + +// The greeting service definition. +service Simple { + // Sends a greeting + rpc SayHello (HelloRequest) returns (HelloReply) { + } + rpc StreamHello(HelloRequest) returns (stream HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { + string name = 1; +} + +// The response message containing the greetings +message HelloReply { + string message = 1; +} \ No newline at end of file diff --git a/samples/grpc-secure/src/main/resources/META-INF/native-image/org.springframework.samples/grpc-server-sample/native-image.properties b/samples/grpc-secure/src/main/resources/META-INF/native-image/org.springframework.samples/grpc-server-sample/native-image.properties new file mode 100644 index 0000000..5c43451 --- /dev/null +++ b/samples/grpc-secure/src/main/resources/META-INF/native-image/org.springframework.samples/grpc-server-sample/native-image.properties @@ -0,0 +1,2 @@ +# Ignored unless building in Nix (https://github.com/oracle/graal/issues/8639) +Args = -ENIX_LDFLAGS -ENIX_CC_WRAPPER_TARGET_HOST_x86_64_unknown_linux_gnu diff --git a/samples/grpc-secure/src/main/resources/application.properties b/samples/grpc-secure/src/main/resources/application.properties new file mode 100644 index 0000000..5cf9afd --- /dev/null +++ b/samples/grpc-secure/src/main/resources/application.properties @@ -0,0 +1,2 @@ +spring.application.name=grpc-server +logging.level.org.springframework.security=debug diff --git a/samples/grpc-secure/src/test/java/org/springframework/grpc/sample/GrpcServerApplicationTests.java b/samples/grpc-secure/src/test/java/org/springframework/grpc/sample/GrpcServerApplicationTests.java new file mode 100644 index 0000000..3349ee1 --- /dev/null +++ b/samples/grpc-secure/src/test/java/org/springframework/grpc/sample/GrpcServerApplicationTests.java @@ -0,0 +1,129 @@ +package org.springframework.grpc.sample; + +import static org.junit.Assert.assertThrows; +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.util.List; + +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Lazy; +import org.springframework.grpc.client.ChannelBuilderOptions; +import org.springframework.grpc.client.GrpcChannelFactory; +import org.springframework.grpc.client.security.BasicAuthenticationInterceptor; +import org.springframework.grpc.sample.proto.HelloReply; +import org.springframework.grpc.sample.proto.HelloRequest; +import org.springframework.grpc.sample.proto.SimpleGrpc; +import org.springframework.grpc.test.LocalGrpcPort; +import org.springframework.test.annotation.DirtiesContext; + +import io.grpc.CallOptions; +import io.grpc.Channel; +import io.grpc.ClientCall; +import io.grpc.ClientInterceptor; +import io.grpc.ForwardingClientCall.SimpleForwardingClientCall; +import io.grpc.MethodDescriptor; +import io.grpc.Status.Code; +import io.grpc.StatusRuntimeException; + +@SpringBootTest(properties = { "spring.grpc.server.port=0", + "spring.grpc.client.channels.stub.address=static://0.0.0.0:${local.grpc.port}", + "spring.grpc.client.channels.basic.address=static://0.0.0.0:${local.grpc.port}", + "spring.grpc.client.channels.secure.address=static://0.0.0.0:${local.grpc.port}" }) +public class GrpcServerApplicationTests { + + public static void main(String[] args) { + new SpringApplicationBuilder(GrpcServerApplication.class, ExtraConfiguration.class) + .run(args); + } + + @Autowired + @Qualifier("stub") + private SimpleGrpc.SimpleBlockingStub stub; + + @Autowired + @Qualifier("secure") + private SimpleGrpc.SimpleBlockingStub secure; + + @Autowired + @Qualifier("basic") + private SimpleGrpc.SimpleBlockingStub basic; + + @Test + @DirtiesContext + void contextLoads() { + } + + @Test + @DirtiesContext + void unauthenticated() { + StatusRuntimeException exception = assertThrows(StatusRuntimeException.class, + () -> stub.sayHello(HelloRequest.newBuilder().setName("Alien").build())); + assertEquals(Code.UNAUTHENTICATED, exception.getStatus().getCode()); + } + + @Test + @DirtiesContext + void unauthauthorized() { + StatusRuntimeException exception = assertThrows(StatusRuntimeException.class, + () -> secure.streamHello(HelloRequest.newBuilder().setName("Alien").build()).next()); + assertEquals(Code.PERMISSION_DENIED, exception.getStatus().getCode()); + } + + @Test + @DirtiesContext + void authenticated() { + HelloReply response = secure.sayHello(HelloRequest.newBuilder().setName("Alien").build()); + assertEquals("Hello ==> Alien", response.getMessage()); + } + + @Test + @DirtiesContext + void basic() { + HelloReply response = basic.sayHello(HelloRequest.newBuilder().setName("Alien").build()); + assertEquals("Hello ==> Alien", response.getMessage()); + } + + @TestConfiguration + static class ExtraConfiguration { + + @Bean + @Lazy + SimpleGrpc.SimpleBlockingStub secure(GrpcChannelFactory channels) { + return SimpleGrpc.newBlockingStub(channels.createChannel("secure", + ChannelBuilderOptions.defaults().withInterceptors(List.of(new ClientInterceptor() { + @Override + public ClientCall interceptCall(MethodDescriptor method, + CallOptions callOptions, Channel next) { + return new SimpleForwardingClientCall(next.newCall(method, callOptions)) { + public void start(ClientCall.Listener responseListener, + io.grpc.Metadata headers) { + headers.put(GrpcServerApplication.USER_KEY, "user"); + super.start(responseListener, headers); + }; + }; + } + })))); + } + + @Bean + @Lazy + SimpleGrpc.SimpleBlockingStub basic(GrpcChannelFactory channels) { + return SimpleGrpc.newBlockingStub(channels.createChannel("basic", ChannelBuilderOptions.defaults() + .withInterceptors(List.of(new BasicAuthenticationInterceptor("user", "user"))))); + } + + @Bean + @Lazy + SimpleGrpc.SimpleBlockingStub stub(GrpcChannelFactory channels, @LocalGrpcPort int port) { + return SimpleGrpc.newBlockingStub(channels.createChannel("stub")); + } + + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/AuthenticationServerInterceptor.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/AuthenticationServerInterceptor.java new file mode 100644 index 0000000..091d94d --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/AuthenticationServerInterceptor.java @@ -0,0 +1,118 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import org.springframework.core.Ordered; +import org.springframework.security.access.AccessDeniedException; +import org.springframework.security.authentication.AnonymousAuthenticationToken; +import org.springframework.security.authentication.AuthenticationManager; +import org.springframework.security.authorization.AuthorizationManager; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.authority.AuthorityUtils; +import org.springframework.security.core.context.SecurityContext; +import org.springframework.security.core.context.SecurityContextHolder; + +import io.grpc.ForwardingServerCallListener; +import io.grpc.Metadata; +import io.grpc.ServerCall; +import io.grpc.ServerCall.Listener; +import io.grpc.ServerCallHandler; +import io.grpc.ServerInterceptor; + +/** + * An interceptor that extracts the authentication credentials from the gRPC + * request + * headers and metadata, authenticates the user, and sets the authentication in + * the + * SecurityContext. This interceptor should be registered with the gRPC server + * to handle + * authentication. + * + * @author Dave Syer + */ +public class AuthenticationServerInterceptor implements ServerInterceptor, Ordered { + + private final AuthenticationManager authenticationManager; + + private final GrpcAuthenticationExtractor extractor; + + private final AuthorizationManager authorizationManager; + + @Override + public int getOrder() { + return GrpcSecurity.CONTEXT_FILTER_ORDER - 10; + } + + public AuthenticationServerInterceptor(AuthenticationManager authenticationManager, + GrpcAuthenticationExtractor extractor, AuthorizationManager authorizationManager) { + this.authenticationManager = authenticationManager; + this.extractor = extractor; + this.authorizationManager = authorizationManager; + } + + @Override + public Listener interceptCall(ServerCall call, Metadata headers, + ServerCallHandler next) { + SecurityContext securityContext = SecurityContextHolder.getContext(); + Authentication user = this.extractor.extract(headers, call.getAttributes()); + Authentication authenticated; + if (user != null) { + authenticated = this.authenticationManager.authenticate(user); + } else { + authenticated = new AnonymousAuthenticationToken("anonymous", "anonymous", + AuthorityUtils.createAuthorityList("ROLE_ANONYMOUS")); + } + securityContext.setAuthentication(authenticated); + CallContext context = new CallContext(headers, call.getAttributes(), call.getMethodDescriptor()); + if (this.authorizationManager != null && authenticated != null) { + return new AuthenticationListener(next.startCall(call, headers), this.authorizationManager, context, + authenticated); + } + return next.startCall(call, headers); + } + + static class AuthenticationListener extends ForwardingServerCallListener { + + private final Listener delegate; + private final AuthorizationManager authorizationManager; + private final CallContext context; + private final Authentication authentication; + + AuthenticationListener(io.grpc.ServerCall.Listener delegate, + AuthorizationManager authorizationManager, CallContext context, + Authentication authenticated) { + this.delegate = delegate; + this.authorizationManager = authorizationManager; + this.context = context; + this.authentication = authenticated; + } + + @Override + public void onReady() { + if (!this.authorizationManager.authorize(() -> authentication, this.context).isGranted()) { + throw new AccessDeniedException("not allowed"); + } + super.onReady(); + } + + @Override + protected Listener delegate() { + return this.delegate; + } + + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallContext.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallContext.java new file mode 100644 index 0000000..2a85dbe --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallContext.java @@ -0,0 +1,8 @@ +package org.springframework.grpc.server.security; + +import io.grpc.Attributes; +import io.grpc.Metadata; +import io.grpc.MethodDescriptor; + +public record CallContext(Metadata headers, Attributes attributes, MethodDescriptor method) { +} \ No newline at end of file diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallMatcher.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallMatcher.java new file mode 100644 index 0000000..368b3e5 --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/CallMatcher.java @@ -0,0 +1,24 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +public interface CallMatcher { + + CallMatcher ALL = (context) -> true; + + boolean matches(CallContext context); + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/GrpcAuthenticationExtractor.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/GrpcAuthenticationExtractor.java new file mode 100644 index 0000000..71a7d98 --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/GrpcAuthenticationExtractor.java @@ -0,0 +1,27 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import org.springframework.security.core.Authentication; + +import io.grpc.Attributes; +import io.grpc.Metadata; + +public interface GrpcAuthenticationExtractor { + + Authentication extract(Metadata headers, Attributes attributes); + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicAuthenticationExtractor.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicAuthenticationExtractor.java new file mode 100644 index 0000000..0fbbf5d --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicAuthenticationExtractor.java @@ -0,0 +1,60 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.Locale; + +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +import org.springframework.security.core.Authentication; + +import io.grpc.Attributes; +import io.grpc.Metadata; + +/** + * Extracts the HTTP Basic authentication credentials from the gRPC request headers. If + * the 'Authorization' header is present and starts with 'Basic ', the username and + * password are extracted from the Base64-encoded header value and returned as a + * {@link UsernamePasswordAuthenticationToken}. If the header is not present or does not + * start with 'Basic ', this method returns null. + * + * @author Dave Syer + */ +public class HttpBasicAuthenticationExtractor implements GrpcAuthenticationExtractor { + + @Override + public Authentication extract(Metadata headers, Attributes attributes) { + String auth = headers.get(GrpcSecurity.AUTHORIZATION_KEY); + if (auth == null) { + return null; + } + if (!auth.toLowerCase(Locale.ROOT).startsWith("basic ")) { + return null; + } + auth = auth.substring("basic ".length()); + return extract(auth); + } + + private Authentication extract(String auth) { + String[] parts = new String(Base64.getDecoder().decode(auth), StandardCharsets.UTF_8).split(":"); + if (parts.length != 2) { + return null; + } + return new UsernamePasswordAuthenticationToken(parts[0], parts[1]); + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicConfigurer.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicConfigurer.java new file mode 100644 index 0000000..15c9189 --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/HttpBasicConfigurer.java @@ -0,0 +1,58 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import org.springframework.context.ApplicationContext; +import org.springframework.security.authentication.dao.DaoAuthenticationProvider; +import org.springframework.security.config.annotation.SecurityBuilder; +import org.springframework.security.config.annotation.SecurityConfigurerAdapter; +import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; +import org.springframework.security.core.userdetails.UserDetailsService; + +public final class HttpBasicConfigurer> + extends SecurityConfigurerAdapter { + + private final ApplicationContext context; + + private final AuthenticationManagerBuilder authenticationManagerBuilder; + + private UserDetailsService userDetailsService; + + public HttpBasicConfigurer(AuthenticationManagerBuilder authenticationManagerBuilder, ApplicationContext context) { + this.authenticationManagerBuilder = authenticationManagerBuilder; + this.context = context; + } + + public HttpBasicConfigurer userDetailsService(UserDetailsService userDetailsService) { + this.userDetailsService = userDetailsService; + return this; + } + + @Override + public void configure(H builder) throws Exception { + DaoAuthenticationProvider provider = new DaoAuthenticationProvider(); + UserDetailsService userDetailsService = this.userDetailsService; + if (userDetailsService == null) { + userDetailsService = this.authenticationManagerBuilder.getDefaultUserDetailsService(); + } + if (userDetailsService == null) { + userDetailsService = this.context.getBean(UserDetailsService.class); + } + provider.setUserDetailsService(userDetailsService); + this.authenticationManagerBuilder.authenticationProvider(provider); + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/PreAuthConfigurer.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/PreAuthConfigurer.java new file mode 100644 index 0000000..208b86b --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/PreAuthConfigurer.java @@ -0,0 +1,62 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import org.springframework.context.ApplicationContext; +import org.springframework.security.config.annotation.SecurityBuilder; +import org.springframework.security.config.annotation.SecurityConfigurerAdapter; +import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; +import org.springframework.security.core.userdetails.UserDetailsByNameServiceWrapper; +import org.springframework.security.core.userdetails.UserDetailsService; +import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationProvider; +import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken; + +public final class PreAuthConfigurer> + extends SecurityConfigurerAdapter { + + private final ApplicationContext context; + + private final AuthenticationManagerBuilder authenticationManagerBuilder; + + private UserDetailsService userDetailsService; + + public PreAuthConfigurer(AuthenticationManagerBuilder authenticationManagerBuilder, ApplicationContext context) { + this.authenticationManagerBuilder = authenticationManagerBuilder; + this.context = context; + } + + public PreAuthConfigurer userDetailsService(UserDetailsService userDetailsService) { + this.userDetailsService = userDetailsService; + return this; + } + + @Override + public void configure(H builder) throws Exception { + PreAuthenticatedAuthenticationProvider provider = new PreAuthenticatedAuthenticationProvider(); + UserDetailsService userDetailsService = this.userDetailsService; + if (userDetailsService == null) { + userDetailsService = this.authenticationManagerBuilder.getDefaultUserDetailsService(); + } + if (userDetailsService == null) { + userDetailsService = this.context.getBean(UserDetailsService.class); + } + UserDetailsByNameServiceWrapper details = new UserDetailsByNameServiceWrapper<>( + userDetailsService); + provider.setPreAuthenticatedUserDetailsService(details); + this.authenticationManagerBuilder.authenticationProvider(provider); + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/RequestMapperConfigurer.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/RequestMapperConfigurer.java new file mode 100644 index 0000000..8069513 --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/RequestMapperConfigurer.java @@ -0,0 +1,152 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import java.util.ArrayList; +import java.util.List; +import java.util.function.Supplier; + +import org.springframework.context.ApplicationContext; +import org.springframework.security.access.hierarchicalroles.NullRoleHierarchy; +import org.springframework.security.access.hierarchicalroles.RoleHierarchy; +import org.springframework.security.authorization.AuthorityAuthorizationManager; +import org.springframework.security.authorization.AuthorizationDecision; +import org.springframework.security.authorization.AuthorizationManager; +import org.springframework.security.authorization.AuthorizationManagers; +import org.springframework.security.config.annotation.SecurityConfigurerAdapter; +import org.springframework.security.core.Authentication; +import org.springframework.util.Assert; +import org.springframework.util.PatternMatchUtils; +import org.springframework.util.function.SingletonSupplier; + +public class RequestMapperConfigurer + extends SecurityConfigurerAdapter { + + private List authorizedCalls = new ArrayList<>(); + + private final Supplier roleHierarchy; + + public RequestMapperConfigurer(ApplicationContext context) { + this.roleHierarchy = SingletonSupplier.of(() -> (context.getBeanNamesForType(RoleHierarchy.class).length > 0) + ? context.getBean(RoleHierarchy.class) + : new NullRoleHierarchy()); + } + + @Override + public void configure(GrpcSecurity builder) throws Exception { + builder.authorizationManager(new RequestMapperAuthorizationManager(this.authorizedCalls)); + } + + public AuthorizedCall allRequests() { + AuthorizedCall call = new AuthorizedCall(CallMatcher.ALL); + this.authorizedCalls.add(call); + return call; + } + + public AuthorizedCall methods(String... patterns) { + AuthorizedCall call = new AuthorizedCall(new MethodCallMatcher(patterns)); + this.authorizedCalls.add(call); + return call; + } + + private static class MethodCallMatcher implements CallMatcher { + + private String[] patterns; + + public MethodCallMatcher(String... patterns) { + this.patterns = patterns; + } + + @Override + public boolean matches(CallContext context) { + return PatternMatchUtils.simpleMatch(patterns, context.method().getFullMethodName()); + } + } + + public class AuthorizedCall { + + static final AuthorizationManager permitAllAuthorizationManager = (a, + o) -> new AuthorizationDecision(true); + + private CallMatcher matcher; + + private boolean not; + + private AuthorizationManager authorizationManager; + + public AuthorizedCall(CallMatcher matcher) { + this.matcher = matcher; + } + + public AuthorizedCall not() { + this.not = true; + return this; + } + + public RequestMapperConfigurer permitAll() { + return access(permitAllAuthorizationManager); + } + + public RequestMapperConfigurer denyAll() { + return access((a, o) -> new AuthorizationDecision(false)); + } + + public RequestMapperConfigurer hasAuthority(String authority) { + return access(withRoleHierarchy(AuthorityAuthorizationManager.hasAuthority(authority))); + } + + public RequestMapperConfigurer hasAnyAuthority(String... authorities) { + return access(withRoleHierarchy(AuthorityAuthorizationManager.hasAnyAuthority(authorities))); + } + + public RequestMapperConfigurer access(AuthorizationManager manager) { + Assert.notNull(manager, "manager cannot be null"); + this.authorizationManager = (this.not) + ? AuthorizationManagers.not(manager) + : manager; + return RequestMapperConfigurer.this; + } + + private AuthorityAuthorizationManager withRoleHierarchy( + AuthorityAuthorizationManager manager) { + manager.setRoleHierarchy(RequestMapperConfigurer.this.roleHierarchy.get()); + return manager; + } + + } + + public static class RequestMapperAuthorizationManager implements AuthorizationManager { + + private final List authorizedCalls; + + public RequestMapperAuthorizationManager(List authorizedCalls) { + this.authorizedCalls = authorizedCalls; + } + + @SuppressWarnings("deprecation") + @Override + public AuthorizationDecision check(Supplier authentication, CallContext context) { + for (AuthorizedCall authorizedCall : this.authorizedCalls) { + if (authorizedCall.matcher.matches(context)) { + return authorizedCall.authorizationManager.check(authentication, context); + } + } + return new AuthorizationDecision(false); + } + + } + +} diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/SslContextPreAuthenticationExtractor.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/SslContextPreAuthenticationExtractor.java new file mode 100644 index 0000000..9772e22 --- /dev/null +++ b/spring-grpc-core/src/main/java/org/springframework/grpc/server/security/SslContextPreAuthenticationExtractor.java @@ -0,0 +1,79 @@ +/* + * Copyright 2024-2024 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. + */ +package org.springframework.grpc.server.security; + +import java.security.cert.Certificate; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.List; + +import javax.net.ssl.SSLSession; + +import org.springframework.lang.Nullable; +import org.springframework.security.core.Authentication; +import org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken; +import org.springframework.security.web.authentication.preauth.x509.SubjectDnX509PrincipalExtractor; +import org.springframework.security.web.authentication.preauth.x509.X509PrincipalExtractor; + +import io.grpc.Attributes; +import io.grpc.Grpc; +import io.grpc.Metadata; + +public class SslContextPreAuthenticationExtractor implements GrpcAuthenticationExtractor { + + private X509PrincipalExtractor principalExtractor; + + public SslContextPreAuthenticationExtractor() { + this(new SubjectDnX509PrincipalExtractor()); + } + + public SslContextPreAuthenticationExtractor(X509PrincipalExtractor principalExtractor) { + this.principalExtractor = principalExtractor; + } + + @Override + public Authentication extract(Metadata headers, Attributes attributes) { + SSLSession session = attributes.get(Grpc.TRANSPORT_ATTR_SSL_SESSION); + if (session != null) { + X509Certificate[] certificates = initCertificates(session); + if (certificates != null) { + return new PreAuthenticatedAuthenticationToken( + this.principalExtractor.extractPrincipal(certificates[0]), certificates[0]); + } + } + return null; + } + + @Nullable + private static X509Certificate[] initCertificates(SSLSession session) { + Certificate[] certificates; + try { + certificates = session.getPeerCertificates(); + } + catch (Throwable ex) { + return null; + } + + List result = new ArrayList<>(certificates.length); + for (Certificate certificate : certificates) { + if (certificate instanceof X509Certificate x509Certificate) { + result.add(x509Certificate); + } + } + return (!result.isEmpty() ? result.toArray(new X509Certificate[0]) : null); + } + +}