-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Align Servlet ExchangeFilterFunction CoreSubscriber #7476
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
Closed
Closed
Changes from all commits
Commits
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
143 changes: 143 additions & 0 deletions
143
...ork/security/config/annotation/web/configuration/SecurityReactorContextConfiguration.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,143 @@ | ||
/* | ||
* Copyright 2002-2019 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.security.config.annotation.web.configuration; | ||
|
||
import org.reactivestreams.Subscription; | ||
import org.springframework.beans.factory.DisposableBean; | ||
import org.springframework.beans.factory.InitializingBean; | ||
import org.springframework.context.annotation.Bean; | ||
import org.springframework.context.annotation.Configuration; | ||
import org.springframework.security.core.Authentication; | ||
import org.springframework.security.core.context.SecurityContextHolder; | ||
import org.springframework.web.context.request.RequestContextHolder; | ||
import org.springframework.web.context.request.ServletRequestAttributes; | ||
import reactor.core.CoreSubscriber; | ||
import reactor.core.publisher.Hooks; | ||
import reactor.core.publisher.Operators; | ||
import reactor.util.context.Context; | ||
|
||
import javax.servlet.http.HttpServletRequest; | ||
import javax.servlet.http.HttpServletResponse; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
|
||
/** | ||
* {@link Configuration} that adds a {@code Publisher} for the last operator created | ||
* in every {@code Mono} or {@code Flux}. | ||
* | ||
* <p> | ||
* The {@code Publisher} is solely responsible for adding | ||
* the current {@code HttpServletRequest}, {@code HttpServletResponse} and {@code Authentication} | ||
* to the Reactor {@code Context} so that it's accessible in every flow, if required. | ||
* | ||
* @author Joe Grandja | ||
* @since 5.2 | ||
* @see OAuth2ImportSelector | ||
*/ | ||
@Configuration(proxyBeanMethods = false) | ||
class SecurityReactorContextConfiguration { | ||
|
||
@Bean | ||
SecurityReactorContextSubscriberRegistrar securityReactorContextSubscriberRegistrar() { | ||
return new SecurityReactorContextSubscriberRegistrar(); | ||
} | ||
|
||
static class SecurityReactorContextSubscriberRegistrar implements InitializingBean, DisposableBean { | ||
private static final String SECURITY_REACTOR_CONTEXT_OPERATOR_KEY = "org.springframework.security.SECURITY_REACTOR_CONTEXT_OPERATOR"; | ||
|
||
@Override | ||
public void afterPropertiesSet() throws Exception { | ||
Hooks.onLastOperator(SECURITY_REACTOR_CONTEXT_OPERATOR_KEY, | ||
Operators.liftPublisher((s, sub) -> createSubscriberIfNecessary(sub))); | ||
} | ||
|
||
@Override | ||
public void destroy() throws Exception { | ||
Hooks.resetOnLastOperator(SECURITY_REACTOR_CONTEXT_OPERATOR_KEY); | ||
} | ||
|
||
<T> CoreSubscriber<T> createSubscriberIfNecessary(CoreSubscriber<T> delegate) { | ||
HttpServletRequest servletRequest = null; | ||
HttpServletResponse servletResponse = null; | ||
ServletRequestAttributes requestAttributes = | ||
(ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); | ||
if (requestAttributes != null) { | ||
servletRequest = requestAttributes.getRequest(); | ||
servletResponse = requestAttributes.getResponse(); | ||
} | ||
Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); | ||
if (authentication == null && servletRequest == null && servletResponse == null) { | ||
// No need to create Subscriber so return original | ||
return delegate; | ||
} | ||
|
||
Map<Object, Object> attributes = new HashMap<>(); | ||
if (servletRequest != null) { | ||
attributes.put(HttpServletRequest.class, servletRequest); | ||
} | ||
if (servletResponse != null) { | ||
attributes.put(HttpServletResponse.class, servletResponse); | ||
} | ||
if (authentication != null) { | ||
attributes.put(Authentication.class, authentication); | ||
} | ||
return new SecurityReactorContextSubscriber<>(delegate, attributes); | ||
} | ||
} | ||
|
||
static class SecurityReactorContextSubscriber<T> implements CoreSubscriber<T> { | ||
static final String SECURITY_CONTEXT_ATTRIBUTES = "org.springframework.security.SECURITY_CONTEXT_ATTRIBUTES"; | ||
private final CoreSubscriber<T> delegate; | ||
private final Context context; | ||
|
||
SecurityReactorContextSubscriber(CoreSubscriber<T> delegate, Map<Object, Object> attributes) { | ||
this.delegate = delegate; | ||
Context currentContext = this.delegate.currentContext(); | ||
Context context; | ||
if (currentContext.hasKey(SECURITY_CONTEXT_ATTRIBUTES)) { | ||
context = currentContext; | ||
} else { | ||
context = currentContext.put(SECURITY_CONTEXT_ATTRIBUTES, attributes); | ||
} | ||
this.context = context; | ||
} | ||
|
||
@Override | ||
public Context currentContext() { | ||
return this.context; | ||
} | ||
|
||
@Override | ||
public void onSubscribe(Subscription s) { | ||
this.delegate.onSubscribe(s); | ||
} | ||
|
||
@Override | ||
public void onNext(T t) { | ||
this.delegate.onNext(t); | ||
} | ||
|
||
@Override | ||
public void onError(Throwable t) { | ||
this.delegate.onError(t); | ||
} | ||
|
||
@Override | ||
public void onComplete() { | ||
this.delegate.onComplete(); | ||
} | ||
} | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jgrandja @rwinch
as far as function from
Hooks.onLastOperator
is invoked for each last operator in a chain it means that such simple code will print201
:it means that 200 publishers and probably subscribers and attributes maps will be created just for nothing.
To reduce allocation this code could be rewritten to
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@robotmrv Your tips on the Reactive end of things has been very valuable. Thank you for keeping an eye out on improvements. I applied your suggested changes :) Thanks again!