Java: CWE-502 Add UnsafeDeserialization sinks #5881
Merged
Conversation
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
1 task
smowton
reviewed
May 13, 2021
| /** | ||
| * The class `com.caucho.hessian.io.HessianInput` or `com.caucho.hessian.io.Hessian2Input`. | ||
| */ | ||
| class UnSafeHessianInput extends RefType { |
There was a problem hiding this comment.
Suggested change
| class UnSafeHessianInput extends RefType { | |
| class UnsafeHessianInput extends RefType { |
And similarly elsewhere
| * A JYaml unsafe load method. This is either `YAML.load` or | ||
| * `YAML.loadType` or `YAML.loadStream` or `YAML.loadStreamOfType`. | ||
| */ | ||
| class JYamlUnSafeLoadMethod extends Method { |
There was a problem hiding this comment.
Suggested change
| class JYamlUnSafeLoadMethod extends Method { | |
| class JYamlUnsafeLoadMethod extends Method { |
And similarly elsewhere
| @@ -50,6 +55,29 @@ class SafeKryo extends DataFlow2::Configuration { | |||
| } | |||
| } | |||
|
|
|||
| class SafeJsonIo extends DataFlow2::Configuration { | |||
There was a problem hiding this comment.
Suggested change
| class SafeJsonIo extends DataFlow2::Configuration { | |
| class SafeJsonIoConfig extends DataFlow2::Configuration { |
| } | ||
|
|
||
| @GetMapping(value = "jsonio") | ||
| public void bad2(HttpServletRequest request) { |
There was a problem hiding this comment.
Rename test case (it contains both good and bad cases)
smowton
reviewed
May 13, 2021
| cie.getConstructor().getDeclaringType() instanceof JsonReader and | ||
| cie.getArgument(0) = prod.asExpr() and | ||
| cie = succ.asExpr() and | ||
| not exists(SafeJsonIo sji | sji.hasFlowToExpr(cie.getArgument(1))) |
There was a problem hiding this comment.
This and the other similar exclusion would be better expressed using isSanitizer
smowton
reviewed
May 13, 2021
| not exists(SafeJsonIo sji | sji.hasFlowToExpr(cie.getArgument(1))) | ||
| ) | ||
| or | ||
| exists(ClassInstanceExpr cie | |
There was a problem hiding this comment.
Once the not exists(SafeJsonIo sji | sji.hasFlowToExpr(cie.getArgument(1))) has been moved to isSanitizer, you can factor this like
exists(ClassInstanceExpr cie |
cie.getArgument(0) = prod.asExpr() and
cie = succ.asExpr() and
(
cie.getConstructor().getDeclaringType() instanceof YamlReader or
cie.getConstructor().getDeclaringType() instanceof JsonReader or
...
)
There was a problem hiding this comment.
Thanks for the suggestion.
pwntester
reviewed
May 14, 2021
| @@ -50,6 +55,29 @@ class SafeKryo extends DataFlow2::Configuration { | |||
| } | |||
| } | |||
|
|
|||
| class SafeJsonIo extends DataFlow2::Configuration { | |||
There was a problem hiding this comment.
Should be moved to the JsonIO.qll lib
There was a problem hiding this comment.
Haha, I see other tracing flows are in this qll file, so put it here.
| @@ -21,6 +21,39 @@ class UnsafeDeserializationConfig extends TaintTracking::Configuration { | |||
| override predicate isSource(DataFlow::Node source) { source instanceof RemoteFlowSource } | |||
|
|
|||
| override predicate isSink(DataFlow::Node sink) { sink instanceof UnsafeDeserializationSink } | |||
|
|
|||
| override predicate isAdditionalTaintStep(DataFlow::Node prod, DataFlow::Node succ) { | |||
| exists(ClassInstanceExpr cie | | |||
There was a problem hiding this comment.
@smowton, is ClassInstanceExpr preferred over ConstructorCall? I find the later more readable but it seems the former is a subtype of the later.
There was a problem hiding this comment.
ConstructorCall includes super(...) and this(...), while ClassInstanceExpr is strictly new XYZ(...)
| /** | ||
| * The class `org.exolab.castor.xml.Unmarshaller`. | ||
| */ | ||
| class Unmarshaller extends RefType { |
There was a problem hiding this comment.
Please rename to CastorUnmarshaller, otherwise, its not clear what lib this class belongs to when reading UnsafeDeserialization
| */ | ||
| class UnSafeHessianInput extends RefType { | ||
| UnSafeHessianInput() { | ||
| this.hasQualifiedName("com.caucho.hessian.io", ["HessianInput", "Hessian2Input"]) |
There was a problem hiding this comment.
Suggested change
| this.hasQualifiedName("com.caucho.hessian.io", ["HessianInput", "Hessian2Input"]) | |
| this.hasQualifiedName(["com.caucho.hessian.io", "com.alibaba.com.caucho.hessian.io"], ["AbstractHessianInput", "Hessian2StreamingInput"]) |
Ive used this in the past, I think it covers more classes
| */ | ||
| class UnSafeHessianInputReadObjectMethod extends Method { | ||
| UnSafeHessianInputReadObjectMethod() { | ||
| this.getDeclaringType() instanceof UnSafeHessianInput and |
There was a problem hiding this comment.
If using the above suggestion, this one should account for getASupertype*()
| * Provides classes and predicates for working with the Hession framework. | ||
| */ | ||
|
|
||
| import java |
There was a problem hiding this comment.
Perhaps rename this file to HessianBurlap and adapt file top comment
| /** | ||
| * The class `com.esotericsoftware.yamlbeans.YamlReader`. | ||
| */ | ||
| class YamlReader extends RefType { |
There was a problem hiding this comment.
Perhaps rename it to YamlBeansReader to make it clear that this class belongs to this library when reading UnsafeDeserialization files
| /** | ||
| * The class `com.cedarsoftware.util.io.JsonReader`. | ||
| */ | ||
| class JsonReader extends RefType { |
There was a problem hiding this comment.
Same here, please rename it to JsonIoJsonReader or alike
|
@smowton Modified based on the suggestions of the two reviewers, please review again. Thank you. |
smowton
reviewed
May 14, 2021
| import java | ||
|
|
||
| /** | ||
| * The class `com.caucho.hessian.io.AbstractHessianInput` or `com.alibaba.com.caucho.hessian.io.Hessian2StreamingInput`. |
There was a problem hiding this comment.
Suggested change
| * The class `com.caucho.hessian.io.AbstractHessianInput` or `com.alibaba.com.caucho.hessian.io.Hessian2StreamingInput`. | |
| * The classes `[com.alibaba.]com.caucho.hessian.io.AbstractHessianInput` or `[com.alibaba.]com.caucho.hessian.io.Hessian2StreamingInput`. |
Comment on lines
15
to
16
| * A JYaml unsafe load method. This is either `YAML.load` or | ||
| * `YAML.loadType` or `YAML.loadStream` or `YAML.loadStreamOfType`. |
There was a problem hiding this comment.
Suggested change
| * A JYaml unsafe load method. This is either `YAML.load` or | |
| * `YAML.loadType` or `YAML.loadStream` or `YAML.loadStreamOfType`. | |
| * A JYaml unsafe load method, declared on either `Yaml` or `YamlConfig`. |
| * The class `org.ho.yaml.Yaml`. | ||
| */ | ||
| class JYaml extends RefType { | ||
| JYaml() { this.hasQualifiedName("org.ho.yaml", "Yaml") } |
There was a problem hiding this comment.
Suggested change
| JYaml() { this.hasQualifiedName("org.ho.yaml", "Yaml") } | |
| JYamlLoader() { this.hasQualifiedName("org.ho.yaml", ["Yaml", "YamlConfig"]) } |
Comment on lines
24
to
41
|
|
||
| /** | ||
| * The class `org.ho.yaml.YamlConfig`. | ||
| */ | ||
| class JYamlConfig extends RefType { | ||
| JYamlConfig() { this.hasQualifiedName("org.ho.yaml", "YamlConfig") } | ||
| } | ||
|
|
||
| /** | ||
| * A JYamlConfig unsafe load method. This is either `YamlConfig.load` or | ||
| * `YAML.loadType` or `YamlConfig.loadStream` or `YamlConfig.loadStreamOfType`. | ||
| */ | ||
| class JYamlConfigUnsafeLoadMethod extends Method { | ||
| JYamlConfigUnsafeLoadMethod() { | ||
| this.getDeclaringType() instanceof JYamlConfig and | ||
| this.getName() in ["load", "loadType", "loadStream", "loadStreamOfType"] | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The class `org.ho.yaml.YamlConfig`. | |
| */ | |
| class JYamlConfig extends RefType { | |
| JYamlConfig() { this.hasQualifiedName("org.ho.yaml", "YamlConfig") } | |
| } | |
| /** | |
| * A JYamlConfig unsafe load method. This is either `YamlConfig.load` or | |
| * `YAML.loadType` or `YamlConfig.loadStream` or `YamlConfig.loadStreamOfType`. | |
| */ | |
| class JYamlConfigUnsafeLoadMethod extends Method { | |
| JYamlConfigUnsafeLoadMethod() { | |
| this.getDeclaringType() instanceof JYamlConfig and | |
| this.getName() in ["load", "loadType", "loadStream", "loadStreamOfType"] | |
| } | |
| } |
| /** | ||
| * A call to `Map.put` method, set the value of the `USE_MAPS` key to `true`. | ||
| */ | ||
| class JsonIoSafeOptionalArgs extends MethodAccess { |
There was a problem hiding this comment.
Suggested change
| class JsonIoSafeOptionalArgs extends MethodAccess { | |
| class JsonIoUseMapsSetter extends MethodAccess { |
Comment on lines
92
to
94
| or | ||
| ma.getMethod() instanceof JYamlConfigUnsafeLoadMethod and | ||
| sink = ma.getArgument(0) |
There was a problem hiding this comment.
Suggested change
| or | |
| ma.getMethod() instanceof JYamlConfigUnsafeLoadMethod and | |
| sink = ma.getArgument(0) |
smowton
reviewed
May 17, 2021
java/change-notes/2021-05-17-add-unsafe-deserialization-sinks.md
Outdated
Show resolved
Hide resolved
| /** | ||
| * A call to `Map.put` method, set the value of the `USE_MAPS` key to `true`. | ||
| */ | ||
| class JsonIoSafeOptionalArgs extends MethodAccess { |
|
Otherwise looks good to me; over to @aschackmull for final review. Note you need to rebase to resolve the UnsafeDeserialization.expected conflict. |
Co-authored-by: Chris Smowton <smowton@github.com>
|
@smowton @pwntester Thanks for review. |
|
@aschackmull Please do the final review, thank you. |
aschackmull
reviewed
Jun 15, 2021
| } | ||
|
|
||
| /** A method with the name `unmarshal` declared in `org.exolab.castor.xml.Unmarshaller`. */ | ||
| class UnmarshalMethod extends Method { |
There was a problem hiding this comment.
This name is a little too generic, let's include Castor in the name:
Suggested change
| class UnmarshalMethod extends Method { | |
| class CastorUnmarshalMethod extends Method { |
aschackmull
reviewed
Jun 15, 2021
|
Still needs a rebase to resolve the conflict in |
Can you review it again? |
|
The expected output of |
You try again. |
|
It is strange that there is no file conflict reported this time, did I do something wrong... |
|
That fix looks incorrect to me. I guess you're testing against the merge base rather than current main? |
There is no |
|
The test is still failing. You likely forgot to pull latest main when you merged main into your branch. Please fix the test. |
Please review again. |
aschackmull
approved these changes
Jun 17, 2021
|
@aschackmull Thank you. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the study of Java deserialization vulnerabilities, some sinks were recorded. This pr adds these sinks to the CodeQL query. A total of 8 sinks have been added.
Mainly known:
JYaml.load,JsonReader.jsonToJava,YamlReader.read,HessianInput.readObject,Hessian2Input.readObject,Unmarshaller.unmarshal,BurlapInput.readObject. There are also some sink points not mentioned:YamlConfig.load,JsonReader.readObject.