-
Notifications
You must be signed in to change notification settings - Fork 863
Add an interceptor to support AuthenticationManagerResolver #1034
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mehrabisajad
wants to merge
14
commits into
grpc-ecosystem:master
Choose a base branch
from
mehrabisajad:support-AuthenticationManagerResolver
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
13295e3
Add an interceptor to support AuthenticationManagerResolver
mehrabisajad 4f73dcc
Create an abstract class for AuthenticatingServerInterceptor and use …
mehrabisajad 802ad1f
Add test for ManagerResolverAuthenticatingServerInterceptor and refac…
mehrabisajad 9a39d9b
Refactor using spotlessApply and Add new autoconfiguration
mehrabisajad 276ec90
Merge branch 'master' into support-AuthenticationManagerResolver
ST-DDT 23f5fa1
Merge AutoConfig and Edit AuthenticationManagerResolver behavior
mehrabisajad 18bd3e2
Merge branch 'master' into support-AuthenticationManagerResolver
mehrabisajad a5904ab
Merge branch 'master' into support-AuthenticationManagerResolver
mehrabisajad 5c718a0
Merge branch 'master' into support-AuthenticationManagerResolver
ST-DDT 9305837
Update grpc-server-spring-boot-starter/src/main/java/net/devh/boot/gr…
ST-DDT 4a754c2
Update grpc-server-spring-boot-starter/src/main/java/net/devh/boot/gr…
ST-DDT 58b356e
Remove unnecessary Autowired annotation
mehrabisajad 5bbb550
Merge branch 'master' into support-AuthenticationManagerResolver
ST-DDT 0c863e8
Remove unused import statement
mehrabisajad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,13 +25,16 @@ | |
import org.springframework.security.access.AccessDecisionManager; | ||
import org.springframework.security.access.AccessDeniedException; | ||
import org.springframework.security.authentication.AuthenticationManager; | ||
import org.springframework.security.authentication.AuthenticationManagerResolver; | ||
import org.springframework.security.core.AuthenticationException; | ||
|
||
import net.devh.boot.grpc.server.security.authentication.GrpcAuthenticationReader; | ||
import net.devh.boot.grpc.server.security.check.GrpcSecurityMetadataSource; | ||
import net.devh.boot.grpc.server.security.interceptors.AuthenticatingServerInterceptor; | ||
import net.devh.boot.grpc.server.security.interceptors.AuthorizationCheckingServerInterceptor; | ||
import net.devh.boot.grpc.server.security.interceptors.DefaultAuthenticatingServerInterceptor; | ||
import net.devh.boot.grpc.server.security.interceptors.GrpcServerRequest; | ||
import net.devh.boot.grpc.server.security.interceptors.ManagerResolverAuthenticatingServerInterceptor; | ||
import net.devh.boot.grpc.server.security.interceptors.ExceptionTranslatingServerInterceptor; | ||
|
||
/** | ||
|
@@ -59,7 +62,6 @@ | |
* @author Daniel Theuke ([email protected]) | ||
*/ | ||
@Configuration(proxyBeanMethods = false) | ||
@ConditionalOnBean(AuthenticationManager.class) | ||
@AutoConfigureAfter(SecurityAutoConfiguration.class) | ||
public class GrpcServerSecurityAutoConfiguration { | ||
|
||
|
@@ -83,13 +85,30 @@ public ExceptionTranslatingServerInterceptor exceptionTranslatingServerIntercept | |
* @return The authenticatingServerInterceptor bean. | ||
*/ | ||
@Bean | ||
@ConditionalOnBean(AuthenticationManager.class) | ||
@ConditionalOnMissingBean(AuthenticatingServerInterceptor.class) | ||
public DefaultAuthenticatingServerInterceptor authenticatingServerInterceptor( | ||
final AuthenticationManager authenticationManager, | ||
final GrpcAuthenticationReader authenticationReader) { | ||
return new DefaultAuthenticatingServerInterceptor(authenticationManager, authenticationReader); | ||
} | ||
|
||
/** | ||
* The security interceptor that handles the authentication of requests. | ||
* | ||
* @param grpcAuthenticationManagerResolver The authentication manager resolver used to verify the credentials. | ||
* @param authenticationReader The authentication reader used to extract the credentials from the call. | ||
* @return The authenticatingServerInterceptor bean. | ||
*/ | ||
@Bean | ||
@ConditionalOnBean(parameterizedContainer = AuthenticationManagerResolver.class, value = GrpcServerRequest.class) | ||
@ConditionalOnMissingBean(AuthenticatingServerInterceptor.class) | ||
public ManagerResolverAuthenticatingServerInterceptor managerResolverAuthenticatingServerInterceptor( | ||
final AuthenticationManagerResolver<GrpcServerRequest> grpcAuthenticationManagerResolver, | ||
final GrpcAuthenticationReader authenticationReader) { | ||
return new ManagerResolverAuthenticatingServerInterceptor(grpcAuthenticationManagerResolver, authenticationReader); | ||
} | ||
|
||
/** | ||
* The security interceptor that handles the authorization of requests. | ||
* | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,6 +19,7 @@ | |
import static java.util.Objects.requireNonNull; | ||
|
||
import org.springframework.beans.factory.annotation.Autowired; | ||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; | ||
import org.springframework.core.annotation.Order; | ||
import org.springframework.security.access.AccessDeniedException; | ||
import org.springframework.security.authentication.AbstractAuthenticationToken; | ||
|
@@ -58,6 +59,7 @@ | |
* @author Daniel Theuke ([email protected]) | ||
*/ | ||
@Slf4j | ||
@ConditionalOnBean(AuthenticationManager.class) | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
@GrpcGlobalServerInterceptor | ||
@Order(InterceptorOrder.ORDER_SECURITY_AUTHENTICATION) | ||
public class DefaultAuthenticatingServerInterceptor implements AuthenticatingServerInterceptor { | ||
|
53 changes: 53 additions & 0 deletions
53
...gure/src/main/java/net/devh/boot/grpc/server/security/interceptors/GrpcServerRequest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package net.devh.boot.grpc.server.security.interceptors; | ||
|
||
import brave.grpc.GrpcRequest; | ||
import io.grpc.Metadata; | ||
import io.grpc.MethodDescriptor; | ||
import io.grpc.ServerCall; | ||
import io.grpc.ServerInterceptor; | ||
|
||
/** | ||
* Allows access gRPC specific aspects of a server request during sampling and parsing. | ||
* | ||
* @see GrpcRequest for a parsing example | ||
* @since 5.12 | ||
*/ | ||
public class GrpcServerRequest { | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
final ServerCall<?, ?> call; | ||
final Metadata headers; | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
public GrpcServerRequest(ServerCall<?, ?> call, Metadata headers) { | ||
if (call == null) throw new NullPointerException("call == null"); | ||
if (headers == null) throw new NullPointerException("headers == null"); | ||
this.call = call; | ||
this.headers = headers; | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
/** | ||
* Returns the {@linkplain ServerCall server call} passed to {@link | ||
* ServerInterceptor#interceptCall}. | ||
* | ||
* @since 5.12 | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
*/ | ||
public ServerCall<?, ?> call() { | ||
return call; | ||
} | ||
|
||
/** | ||
* Returns {@linkplain ServerCall#getMethodDescriptor()}} from the {@link #call()}. | ||
* | ||
* @since 5.12 | ||
*/ | ||
public MethodDescriptor<?, ?> methodDescriptor() { | ||
return call.getMethodDescriptor(); | ||
} | ||
|
||
/** | ||
* Returns the {@linkplain Metadata headers} passed to {@link ServerInterceptor#interceptCall}. | ||
* | ||
* @since 5.12 | ||
*/ | ||
public Metadata headers() { | ||
return headers; | ||
} | ||
} |
106 changes: 106 additions & 0 deletions
106
...oot/grpc/server/security/interceptors/ManagerResolverAuthenticatingServerInterceptor.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
/* | ||
* Copyright (c) 2016-2023 The gRPC-Spring 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 | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package net.devh.boot.grpc.server.security.interceptors; | ||
|
||
import io.grpc.*; | ||
import io.grpc.ServerCall.Listener; | ||
import lombok.extern.slf4j.Slf4j; | ||
import net.devh.boot.grpc.common.util.InterceptorOrder; | ||
import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor; | ||
import net.devh.boot.grpc.server.security.authentication.GrpcAuthenticationReader; | ||
import org.springframework.beans.factory.annotation.Autowired; | ||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; | ||
import org.springframework.core.annotation.Order; | ||
import org.springframework.security.access.AccessDeniedException; | ||
import org.springframework.security.authentication.*; | ||
import org.springframework.security.core.AuthenticationException; | ||
import org.springframework.security.core.context.SecurityContextHolder; | ||
|
||
|
||
import static java.util.Objects.requireNonNull; | ||
|
||
/** | ||
* A server interceptor that tries to {@link GrpcAuthenticationReader read} the credentials from the client and | ||
* {@link AuthenticationManagerResolver#resolve (Context) grpcServerRequest} them. This interceptor create new {@link DefaultAuthenticatingServerInterceptor} to sets the | ||
* authentication to both grpc's {@link Context} and {@link SecurityContextHolder}. | ||
* | ||
* <p> | ||
* This works similar to the {@code org.springframework.security.web.authentication.AuthenticationFilter}. | ||
* </p> | ||
* | ||
* <p> | ||
* <b>Note:</b> This interceptor works similar to | ||
* {@link Contexts#interceptCall(Context, ServerCall, Metadata, ServerCallHandler)}. | ||
* </p> | ||
* | ||
* @author Sajad Mehrabi ([email protected]) | ||
*/ | ||
@Slf4j | ||
@ConditionalOnBean(parameterizedContainer = AuthenticationManagerResolver.class, value = GrpcServerRequest.class) | ||
@GrpcGlobalServerInterceptor | ||
@Order(InterceptorOrder.ORDER_SECURITY_AUTHENTICATION) | ||
public class ManagerResolverAuthenticatingServerInterceptor implements AuthenticatingServerInterceptor { | ||
|
||
private final AuthenticationManagerResolver<GrpcServerRequest> authenticationManagerResolver; | ||
private final GrpcAuthenticationReader grpcAuthenticationReader; | ||
|
||
/** | ||
* Creates a new ManagerResolverAuthenticatingServerInterceptor with the given authentication manager resolver and reader. | ||
* | ||
* @param authenticationManagerResolver The authentication manager resolver used to verify the credentials. | ||
* @param authenticationReader The authentication reader used to extract the credentials from the call. | ||
*/ | ||
@Autowired | ||
public ManagerResolverAuthenticatingServerInterceptor(final AuthenticationManagerResolver<GrpcServerRequest> authenticationManagerResolver, | ||
final GrpcAuthenticationReader authenticationReader) { | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
this.authenticationManagerResolver = requireNonNull(authenticationManagerResolver, "authenticationManagerResolver"); | ||
this.grpcAuthenticationReader = requireNonNull(authenticationReader, "authenticationReader"); | ||
} | ||
|
||
@Override | ||
public <ReqT, RespT> Listener<ReqT> interceptCall(final ServerCall<ReqT, RespT> call, | ||
final Metadata headers, final ServerCallHandler<ReqT, RespT> next) { | ||
|
||
GrpcServerRequest grpcServerRequest = new GrpcServerRequest(call, headers); | ||
AuthenticationManager authenticationManager = this.authenticationManagerResolver.resolve(grpcServerRequest); | ||
|
||
if (authenticationManager == null) { | ||
log.debug("No authenticationManager found: Continuing unauthenticated"); | ||
try { | ||
return next.startCall(call, headers); | ||
} catch (final AccessDeniedException e) { | ||
throw newNoAuthenticationManagerException(e); | ||
} | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
DefaultAuthenticatingServerInterceptor authenticatingServerInterceptor = new DefaultAuthenticatingServerInterceptor(authenticationManager, this.grpcAuthenticationReader); | ||
return authenticatingServerInterceptor.interceptCall(call, headers, next); | ||
ST-DDT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
} | ||
|
||
|
||
/** | ||
* Wraps the given {@link AccessDeniedException} in an {@link AuthenticationException} to reflect, that no | ||
* authentication was originally present in the request. | ||
* | ||
* @param denied The caught exception. | ||
* @return The newly created {@link AuthenticationException}. | ||
*/ | ||
private static AuthenticationException newNoAuthenticationManagerException(final AccessDeniedException denied) { | ||
return new BadCredentialsException("No credentials found in the request", denied); | ||
} | ||
|
||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.