-
Notifications
You must be signed in to change notification settings - Fork 6k
Add web-flux jackson module and add check for javax.servlet package in classpath in web jackson module #6293
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
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
53 changes: 53 additions & 0 deletions
53
...in/java/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixin.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 @@ | ||
/* | ||
* Copyright 2015-2018 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 | ||
* | ||
* 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 org.springframework.security.web.server.jackson2; | ||
|
||
import com.fasterxml.jackson.annotation.JsonCreator; | ||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; | ||
import com.fasterxml.jackson.annotation.JsonProperty; | ||
import com.fasterxml.jackson.annotation.JsonTypeInfo; | ||
|
||
/** | ||
* Jackson mixin class to serialize/deserialize {@link org.springframework.security.web.server.csrf.DefaultCsrfToken} | ||
* serialization support. | ||
* | ||
* <pre> | ||
* ObjectMapper mapper = new ObjectMapper(); | ||
* mapper.registerModule(new WebServerJackson2Module()); | ||
* </pre> | ||
* | ||
* @author Boris Finkelshteyn | ||
* @see WebServerJackson2Module | ||
* @since 5.1 | ||
*/ | ||
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class") | ||
@JsonIgnoreProperties(ignoreUnknown = true) | ||
class DefaultCsrfServerTokenMixin { | ||
|
||
/** | ||
* JsonCreator constructor needed by Jackson to create {@link org.springframework.security.web.server.csrf.DefaultCsrfToken} | ||
* object. | ||
* | ||
* @param headerName the name of the header | ||
* @param parameterName the parameter name | ||
* @param token the CSRF token value | ||
*/ | ||
@JsonCreator | ||
public DefaultCsrfServerTokenMixin(@JsonProperty("headerName") String headerName, | ||
@JsonProperty("parameterName") String parameterName, @JsonProperty("token") String token) { | ||
} | ||
} |
51 changes: 51 additions & 0 deletions
51
...c/main/java/org/springframework/security/web/server/jackson2/WebServerJackson2Module.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,51 @@ | ||
/* | ||
* Copyright 2015-2018 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 | ||
* | ||
* 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 org.springframework.security.web.server.jackson2; | ||
|
||
import com.fasterxml.jackson.core.Version; | ||
import com.fasterxml.jackson.databind.module.SimpleModule; | ||
import org.springframework.security.jackson2.SecurityJackson2Modules; | ||
import org.springframework.security.web.server.csrf.DefaultCsrfToken; | ||
|
||
/** | ||
* Jackson module for spring-security-web-flux. This module register {@link DefaultCsrfServerTokenMixin} | ||
* If no default typing enabled by default then it'll enable it because typing info is needed to | ||
* properly serialize/deserialize objects. | ||
* In order to use this module just add this module into your ObjectMapper configuration. | ||
* | ||
* <pre> | ||
* ObjectMapper mapper = new ObjectMapper(); | ||
* mapper.registerModule(new WebServerJackson2Module()); | ||
* </pre> | ||
* <b>Note: use {@link SecurityJackson2Modules#getModules(ClassLoader)} to get list of all security modules.</b> | ||
* | ||
* @author Boris Finkelshteyn | ||
* @see SecurityJackson2Modules | ||
* @since 5.1 | ||
*/ | ||
public class WebServerJackson2Module extends SimpleModule { | ||
|
||
public WebServerJackson2Module() { | ||
super(WebServerJackson2Module.class.getName(), new Version(1, 0, 0, null, null, null)); | ||
} | ||
|
||
@Override | ||
public void setupModule(SetupContext context) { | ||
SecurityJackson2Modules.enableDefaultTyping(context.getOwner()); | ||
context.setMixInAnnotations(DefaultCsrfToken.class, DefaultCsrfServerTokenMixin.class); | ||
} | ||
} |
73 changes: 73 additions & 0 deletions
73
...va/org/springframework/security/web/server/jackson2/DefaultCsrfServerTokenMixinTests.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,73 @@ | ||
/* | ||
* Copyright 2015-2016 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 | ||
* | ||
* 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 org.springframework.security.web.server.jackson2; | ||
|
||
import com.fasterxml.jackson.core.JsonProcessingException; | ||
import com.fasterxml.jackson.databind.JsonMappingException; | ||
import org.json.JSONException; | ||
import org.junit.Test; | ||
import org.skyscreamer.jsonassert.JSONAssert; | ||
import org.springframework.security.web.jackson2.AbstractMixinTests; | ||
import org.springframework.security.web.server.csrf.DefaultCsrfToken; | ||
|
||
import java.io.IOException; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* @author Boris Finkelshteyn | ||
* @since 5.1 | ||
*/ | ||
public class DefaultCsrfServerTokenMixinTests extends AbstractMixinTests { | ||
|
||
// @formatter:off | ||
private static final String CSRF_JSON = "{" | ||
+ "\"@class\": \"org.springframework.security.web.server.csrf.DefaultCsrfToken\", " | ||
+ "\"headerName\": \"csrf-header\", " | ||
+ "\"parameterName\": \"_csrf\", " | ||
+ "\"token\": \"1\"" | ||
+ "}"; | ||
// @formatter:on | ||
|
||
@Test | ||
public void defaultCsrfTokenSerializedTest() throws JsonProcessingException, JSONException { | ||
DefaultCsrfToken token = new DefaultCsrfToken("csrf-header", "_csrf", "1"); | ||
String serializedJson = mapper.writeValueAsString(token); | ||
JSONAssert.assertEquals(CSRF_JSON, serializedJson, true); | ||
} | ||
|
||
@Test | ||
public void defaultCsrfTokenDeserializeTest() throws IOException { | ||
DefaultCsrfToken token = mapper.readValue(CSRF_JSON, DefaultCsrfToken.class); | ||
assertThat(token).isNotNull(); | ||
assertThat(token.getHeaderName()).isEqualTo("csrf-header"); | ||
assertThat(token.getParameterName()).isEqualTo("_csrf"); | ||
assertThat(token.getToken()).isEqualTo("1"); | ||
} | ||
|
||
@Test(expected = JsonMappingException.class) | ||
public void defaultCsrfTokenDeserializeWithoutClassTest() throws IOException { | ||
String tokenJson = "{\"headerName\": \"csrf-header\", \"parameterName\": \"_csrf\", \"token\": \"1\"}"; | ||
mapper.readValue(tokenJson, DefaultCsrfToken.class); | ||
} | ||
|
||
@Test(expected = JsonMappingException.class) | ||
public void defaultCsrfTokenDeserializeNullValuesTest() throws IOException { | ||
String tokenJson = "{\"@class\": \"org.springframework.security.web.server.csrf.DefaultCsrfToken\", \"headerName\": \"\", \"parameterName\": null, \"token\": \"1\"}"; | ||
mapper.readValue(tokenJson, DefaultCsrfToken.class); | ||
} | ||
} |
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.
Depending on the JDK this can cause issues. The reason is that many JDK's will load all the classes necessary for the entire class to run at once even if the code is not necessarily going to be executed. Instead, this code needs to be isolated in a separate module and then conditionally loaded.
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.
Hm, that's interesting, I didn't know that..
Is that means that some JDK(if it's fast could you give me example of that specific JDK or link to specification?) will try to load all the classes that presents in that class in initialization step of the that class? And that 'Cookie.class' will be try to load without looking at the condition?
But if I put everything in brackets into a separate class(new module) that could be load but will not instantiate, base on condition, that will work?
And that loading of all necessary classes will done only if I will try to create instance of that new module?