Skip to content

Java: Query to detect cleartext storage of sensitive information using Android SharedPreferences #4675

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.

Sign up for GitHub

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

Merged
aschackmull merged 11 commits into from
Jan 8, 2021
Merged

Java: Query to detect cleartext storage of sensitive information using Android SharedPreferences #4675

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0bd6255
Query for cleartext storage using Android SharedPreferences
luchua-bc Nov 16, 2020
85434ca
Format the source code and update qldoc
luchua-bc Nov 17, 2020
a311462
Move to query-test folder and update qldoc
luchua-bc Nov 19, 2020
a491604
Enhance the query and add more test cases
luchua-bc Nov 25, 2020
7ad031c
Move to experimental and update qldoc
luchua-bc Nov 26, 2020
a83ddd6
Add comments about how the future promotion should go
luchua-bc Nov 26, 2020
ad0ac5b
Change kind to problem
luchua-bc Nov 27, 2020
5690bf4
Optimize the query
luchua-bc Jan 6, 2021
f13b881
Update class/method names in the module
luchua-bc Jan 6, 2021
b54e5b1
Revamp the library module
luchua-bc Jan 7, 2021
606d094
Update qldoc
luchua-bc Jan 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Optimize the query
  • Loading branch information
@luchua-bc
luchua-bc committed Jan 6, 2021
commit 5690bf49f46f9cadfb99cb824338b1562a9e0831
13 changes: 3 additions & 10 deletions java/ql/src/experimental/Security/CWE/CWE-312/CleartextStorageSharedPrefs.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ private predicate sharedPreferencesStore(DataFlow::Node sharedPrefs, Expr store)
}

/** Flow from `SharedPreferences` to either a setter or a store method. */
class SharedPreferencesFlowConfig extends TaintTracking::Configuration {
class SharedPreferencesFlowConfig extends DataFlow::Configuration {
SharedPreferencesFlowConfig() {
this = "CleartextStorageSharedPrefs::SharedPreferencesFlowConfig"
}
Expand Down Expand Up @@ -65,7 +65,7 @@ class EncryptedValueFlowConfig extends DataFlow5::Configuration {
EncryptedValueFlowConfig() { this = "CleartextStorageSharedPrefs::EncryptedValueFlowConfig" }

override predicate isSource(DataFlow5::Node src) {
exists(EncryptedSensitiveMethodAccess ema | src.asExpr() = ema.getAnArgument())
exists(EncryptedSensitiveMethodAccess ema | src.asExpr() = ema)
}

override predicate isSink(DataFlow5::Node sink) {
Expand All @@ -74,13 +74,6 @@ class EncryptedValueFlowConfig extends DataFlow5::Configuration {
sink.asExpr() = ma.getArgument(1)
)
}

override predicate isAdditionalFlowStep(DataFlow5::Node n1, DataFlow5::Node n2) {
exists(EncryptedSensitiveMethodAccess ema |
n1.asExpr() = ema.getAnArgument() and
n2.asExpr() = ema
)
}
}

/** Flow from the create method of `androidx.security.crypto.EncryptedSharedPreferences` to its instance. */
Expand Down Expand Up @@ -109,7 +102,7 @@ class SharedPreferencesEditor extends MethodAccess {
)
}

/** Gets an input, for example `input` in `editor.putString("password", password);`. */
/** Gets an input, for example `password` in `editor.putString("password", password);`. */
Expr getAnInput() {
exists(SharedPreferencesFlowConfig conf, DataFlow::Node n |
sharedPreferencesInput(n, result) and
Expand Down
4 changes: 3 additions & 1 deletion java/ql/src/semmle/code/java/frameworks/android/SharedPreferences.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import semmle.code.java.Type
/** Provides classes related to `android.content.SharedPreferences`. */

import java
Comment thread
luchua-bc marked this conversation as resolved.

/** Definitions related to `android.content.SharedPreferences`. */
module SharedPreferences {
Expand Down