-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add DefaultRelyingPartyRegistrationResolver #8899
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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
133 changes: 133 additions & 0 deletions
133
...ramework/security/saml2/provider/service/web/DefaultRelyingPartyRegistrationResolver.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,133 @@ | ||
| /* | ||
| * Copyright 2002-2020 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.saml2.provider.service.web; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.function.Function; | ||
| import javax.servlet.http.HttpServletRequest; | ||
|
|
||
| import org.springframework.core.convert.converter.Converter; | ||
| import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration; | ||
| import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistrationRepository; | ||
| import org.springframework.security.web.util.matcher.AntPathRequestMatcher; | ||
| import org.springframework.security.web.util.matcher.RequestMatcher; | ||
| import org.springframework.util.StringUtils; | ||
| import org.springframework.web.util.UriComponents; | ||
| import org.springframework.web.util.UriComponentsBuilder; | ||
|
|
||
| import static org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.withRelyingPartyRegistration; | ||
| import static org.springframework.security.web.util.UrlUtils.buildFullRequestUrl; | ||
| import static org.springframework.web.util.UriComponentsBuilder.fromHttpUrl; | ||
|
|
||
| /** | ||
| * A {@link Converter} that resolves a {@link RelyingPartyRegistration} by extracting the | ||
| * registration id from the request, querying a {@link RelyingPartyRegistrationRepository}, | ||
| * and resolving any template values. | ||
| * | ||
| * @since 5.4 | ||
| * @author Josh Cummings | ||
| */ | ||
| public final class DefaultRelyingPartyRegistrationResolver | ||
| implements Converter<HttpServletRequest, RelyingPartyRegistration> { | ||
|
|
||
| private static final char PATH_DELIMITER = '/'; | ||
|
|
||
| private final RelyingPartyRegistrationRepository relyingPartyRegistrationRepository; | ||
| private final Converter<HttpServletRequest, String> registrationIdResolver = new RegistrationIdResolver(); | ||
|
|
||
| public DefaultRelyingPartyRegistrationResolver | ||
| (RelyingPartyRegistrationRepository relyingPartyRegistrationRepository) { | ||
|
|
||
| this.relyingPartyRegistrationRepository = relyingPartyRegistrationRepository; | ||
| } | ||
|
|
||
| @Override | ||
| public RelyingPartyRegistration convert(HttpServletRequest request) { | ||
| String registrationId = this.registrationIdResolver.convert(request); | ||
| if (registrationId == null) { | ||
| return null; | ||
| } | ||
| RelyingPartyRegistration relyingPartyRegistration = | ||
| this.relyingPartyRegistrationRepository.findByRegistrationId(registrationId); | ||
| if (relyingPartyRegistration == null) { | ||
| return null; | ||
| } | ||
|
|
||
| String applicationUri = getApplicationUri(request); | ||
| Function<String, String> templateResolver = templateResolver(applicationUri, relyingPartyRegistration); | ||
| String relyingPartyEntityId = templateResolver.apply(relyingPartyRegistration.getEntityId()); | ||
| String assertionConsumerServiceLocation = templateResolver.apply( | ||
| relyingPartyRegistration.getAssertionConsumerServiceLocation()); | ||
| return withRelyingPartyRegistration(relyingPartyRegistration) | ||
| .entityId(relyingPartyEntityId) | ||
| .assertionConsumerServiceLocation(assertionConsumerServiceLocation) | ||
| .build(); | ||
| } | ||
|
|
||
| private Function<String, String> templateResolver(String applicationUri, RelyingPartyRegistration relyingParty) { | ||
| return template -> resolveUrlTemplate(template, applicationUri, relyingParty); | ||
| } | ||
|
|
||
| private static String resolveUrlTemplate(String template, String baseUrl, RelyingPartyRegistration relyingParty) { | ||
| String entityId = relyingParty.getAssertingPartyDetails().getEntityId(); | ||
| String registrationId = relyingParty.getRegistrationId(); | ||
| Map<String, String> uriVariables = new HashMap<>(); | ||
| UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl(baseUrl) | ||
| .replaceQuery(null) | ||
| .fragment(null) | ||
| .build(); | ||
| String scheme = uriComponents.getScheme(); | ||
| uriVariables.put("baseScheme", scheme == null ? "" : scheme); | ||
| String host = uriComponents.getHost(); | ||
| uriVariables.put("baseHost", host == null ? "" : host); | ||
| // following logic is based on HierarchicalUriComponents#toUriString() | ||
| int port = uriComponents.getPort(); | ||
| uriVariables.put("basePort", port == -1 ? "" : ":" + port); | ||
| String path = uriComponents.getPath(); | ||
| if (StringUtils.hasLength(path) && path.charAt(0) != PATH_DELIMITER) { | ||
| path = PATH_DELIMITER + path; | ||
| } | ||
| uriVariables.put("basePath", path == null ? "" : path); | ||
| uriVariables.put("baseUrl", uriComponents.toUriString()); | ||
| uriVariables.put("entityId", StringUtils.hasText(entityId) ? entityId : ""); | ||
| uriVariables.put("registrationId", StringUtils.hasText(registrationId) ? registrationId : ""); | ||
|
|
||
| return UriComponentsBuilder.fromUriString(template) | ||
| .buildAndExpand(uriVariables) | ||
| .toUriString(); | ||
| } | ||
|
|
||
| private static String getApplicationUri(HttpServletRequest request) { | ||
| UriComponents uriComponents = fromHttpUrl(buildFullRequestUrl(request)) | ||
| .replacePath(request.getContextPath()) | ||
| .replaceQuery(null) | ||
| .fragment(null) | ||
| .build(); | ||
| return uriComponents.toUriString(); | ||
| } | ||
|
|
||
| private static class RegistrationIdResolver implements Converter<HttpServletRequest, String> { | ||
| private final RequestMatcher requestMatcher = new AntPathRequestMatcher("/**/{registrationId}"); | ||
|
|
||
| @Override | ||
| public String convert(HttpServletRequest request) { | ||
| RequestMatcher.MatchResult result = this.requestMatcher.matcher(request); | ||
| return result.getVariables().get("registrationId"); | ||
| } | ||
| } | ||
| } |
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.
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.
I think it would be better to have a single
returnstatement.new DefaultSaml2AuthenticationRequestContextResolvercan be moved intogetDefaultContextResolvermethod.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.
I'm of a different opinion on this one. I think returning early is more readable.
However, since that's probably in the eye of the beholder, what I'd propose for now is aligning with how other similar methods in the class, like
getResolver. We can consider changing both methods at another time.