Release preparation for version 2.11.0

java/ql/lib/CHANGELOG.md

@@ -1,3 +1,50 @@
+## 0.4.0
+
+### Breaking Changes
+
+* The `Member.getQualifiedName()` predicate result now includes the qualified name of the declaring type.
+
+### Deprecated APIs
+
+* The predicate `Annotation.getAValue()` has been deprecated because it might lead to obtaining the value of the wrong annotation element by accident. `getValue(string)` (or one of the value type specific predicates) should be used to explicitly specify the name of the annotation element.
+* The predicate `Annotation.getAValue(string)` has been renamed to `getAnArrayValue(string)`.
+* The predicate `SuppressWarningsAnnotation.getASuppressedWarningLiteral()` has been deprecated because it unnecessarily restricts the result type; `getASuppressedWarning()` should be used instead.
+* The predicates `TargetAnnotation.getATargetExpression()` and `RetentionAnnotation.getRetentionPolicyExpression()` have been deprecated because getting the enum constant read expression is rarely useful, instead the corresponding predicates for getting the name of the referenced enum constants should be used.
+
+### New Features
+
+* Added a new predicate, `allowsBackup`, in the `AndroidApplicationXmlElement` class. This predicate detects if the application element does not disable the `android:allowBackup` attribute.
+* The predicates of the CodeQL class `Annotation` have been improved:
+  * Convenience value type specific predicates have been added, such as `getEnumConstantValue(string)` or `getStringValue(string)`.
+  * Convenience predicates for elements with array values have been added, such as `getAnEnumConstantArrayValue(string)`. While the behavior of the existing predicates has not changed, usage of them should be reviewed (or replaced with the newly added predicate) to make sure they work correctly for elements with array values.
+  * Some internal CodeQL usage of the `Annotation` predicates has been adjusted and corrected; this might affect the results of some queries.
+* New predicates have been added to the CodeQL class `Annotatable` to support getting declared and associated annotations. As part of that, `hasAnnotation()` has been changed to also consider inherited annotations, to be consistent with `hasAnnotation(string, string)` and `getAnAnnotation()`. The newly added predicate `hasDeclaredAnnotation()` can be used as replacement for the old functionality.
+* New predicates have been added to the CodeQL class `AnnotationType` to simplify getting information about usage of JDK meta-annotations, such as `@Retention`.
+
+### Major Analysis Improvements
+
+* The virtual dispatch relation used in data flow now favors summary models over source code for dispatch to interface methods from `java.util` unless there is evidence that a specific source implementation is reachable. This should provide increased precision for any projects that include, for example, custom `List` or `Map` implementations.
+
+### Minor Analysis Improvements
+
+* Added new sinks to the query `java/android/implict-pendingintents` to take into account the classes `androidx.core.app.NotificationManagerCompat` and `androidx.core.app.AlarmManagerCompat`.
+* Added new flow steps for `androidx.core.app.NotificationCompat` and its inner classes.
+* Added flow sinks, sources and summaries for the Kotlin standard library.
+* Added flow summary for `org.springframework.data.repository.CrudRepository.save()`.
+* Added new flow steps for the following Android classes:
+  * `android.content.ContentResolver`
+  * `android.content.ContentProviderClient`
+  * `android.content.ContentProviderOperation`
+  * `android.content.ContentProviderOperation$Builder`
+  * `android.content.ContentProviderResult`
+  * `android.database.Cursor`
+* Added taint flow models for the `java.lang.String.(charAt|getBytes)` methods.
+* Improved taint flow models for the `java.lang.String.(replace|replaceFirst|replaceAll)` methods. Additional results may be found where users do not properly sanitize their inputs.
+
+### Bug Fixes
+
+* Fixed an issue in the taint tracking analysis where implicit reads were not allowed by default in sinks or additional taint steps that used flow states.
+
 ## 0.3.5
 
 ## 0.3.4
@@ -21,7 +68,7 @@
 
 ### Minor Analysis Improvements
 
-* Added new flow steps for the classes `java.io.Path` and `java.nio.Paths`.
+* Added new flow steps for the classes `java.nio.file.Path` and `java.nio.file.Paths`.
 * The class `AndroidFragment` now also models the Android Jetpack version of the `Fragment` class (`androidx.fragment.app.Fragment`).
 * Java 19 builds can now be extracted. There are no non-preview new language features in this release, so the only user-visible change is that the CodeQL extractor will now correctly trace compilations using the JDK 19 release of `javac`.
 * Classes and methods that are seen with several different paths during the extraction process (for example, packaged into different JAR files) now report an arbitrarily selected location via their `getLocation` and `hasLocationInfo` predicates, rather than reporting all of them. This may lead to reduced alert duplication.

java/ql/lib/change-notes/2022-04-01-annotation-deprecations.md

@@ -1,7 +0,0 @@
----
-category: deprecated
----
-* The predicate `Annotation.getAValue()` has been deprecated because it might lead to obtaining the value of the wrong annotation element by accident. `getValue(string)` (or one of the value type specific predicates) should be used to explicitly specify the name of the annotation element.
-* The predicate `Annotation.getAValue(string)` has been renamed to `getAnArrayValue(string)`.
-* The predicate `SuppressWarningsAnnotation.getASuppressedWarningLiteral()` has been deprecated because it unnecessarily restricts the result type; `getASuppressedWarning()` should be used instead.
-* The predicates `TargetAnnotation.getATargetExpression()` and `RetentionAnnotation.getRetentionPolicyExpression()` have been deprecated because getting the enum constant read expression is rarely useful, instead the corresponding predicates for getting the name of the referenced enum constants should be used.

java/ql/lib/change-notes/2022-04-01-annotation-features.md

@@ -1,9 +0,0 @@
----
-category: feature
----
-* The predicates of the CodeQL class `Annotation` have been improved:
-  * Convenience value type specific predicates have been added, such as `getEnumConstantValue(string)` or `getStringValue(string)`.
-  * Convenience predicates for elements with array values have been added, such as `getAnEnumConstantArrayValue(string)`. While the behavior of the existing predicates has not changed, usage of them should be reviewed (or replaced with the newly added predicate) to make sure they work correctly for elements with array values.
-  * Some internal CodeQL usage of the `Annotation` predicates has been adjusted and corrected; this might affect the results of some queries.
-* New predicates have been added to the CodeQL class `Annotatable` to support getting declared and associated annotations. As part of that, `hasAnnotation()` has been changed to also consider inherited annotations, to be consistent with `hasAnnotation(string, string)` and `getAnAnnotation()`. The newly added predicate `hasDeclaredAnnotation()` can be used as replacement for the old functionality.
-* New predicates have been added to the CodeQL class `AnnotationType` to simplify getting information about usage of JDK meta-annotations, such as `@Retention`.

java/ql/lib/change-notes/2022-08-18-android-manifest-backup-predicate.md

@@ -1,4 +0,0 @@
----
-category: feature
----
-* Added a new predicate, `allowsBackup`, in the `AndroidApplicationXmlElement` class. This predicate detects if the application element does not disable the `android:allowBackup` attribute.

java/ql/lib/change-notes/2022-08-19-string-taint-models.md

@@ -1,5 +0,0 @@
----
-category: minorAnalysis
----
-* Added taint flow models for the `java.lang.String.(charAt|getBytes)` methods.
-* Improved taint flow models for the `java.lang.String.(replace|replaceFirst|replaceAll)` methods. Additional results may be found where users do not properly sanitize their inputs.

java/ql/lib/change-notes/2022-08-23-contentresolver-summaries.md

@@ -1,10 +0,0 @@
----
-category: minorAnalysis
----
-* Added new flow steps for the following Android classes:
-  * `android.content.ContentResolver`
-  * `android.content.ContentProviderClient`
-  * `android.content.ContentProviderOperation`
-  * `android.content.ContentProviderOperation$Builder`
-  * `android.content.ContentProviderResult`
-  * `android.database.Cursor`

java/ql/lib/change-notes/2022-08-25-taint-model-spring-crudrepository.md

@@ -1,4 +0,0 @@
----
-category: minorAnalysis
----
-* Added flow summary for `org.springframework.data.repository.CrudRepository.save()`.

java/ql/lib/change-notes/2022-08-31-kotlin-stdlib.md

@@ -1,4 +0,0 @@
----
-category: minorAnalysis
----
-* Added flow sinks, sources and summaries for the Kotlin standard library.

java/ql/lib/change-notes/2022-09-06-notificationcompat-summaries.md

@@ -1,5 +0,0 @@
----
-category: minorAnalysis
----
-* Added new flow steps for `androidx.core.app.NotificationCompat` and its inner classes.
-  

java/ql/lib/change-notes/2022-09-07-implicit-pendingintents-compat-sinks.md

@@ -1,5 +0,0 @@
----
-category: minorAnalysis
----
-* Added new sinks to the query `java/android/implict-pendingintents` to take into account the classes `androidx.core.app.NotificationManagerCompat` and `androidx.core.app.AlarmManagerCompat`.
-  

java/ql/lib/change-notes/2022-09-08-implicit-read-flowstates.md

@@ -1,4 +0,0 @@
----
-category: fix
----
-* Fixed an issue in the taint tracking analysis where implicit reads were not allowed by default in sinks or additional taint steps that used flow states.

java/ql/lib/change-notes/2022-09-13-Member-getQualifiedName.md

@@ -1,4 +0,0 @@
----
-category: breaking
----
-* The `Member.getQualifiedName()` predicate result now includes the qualified name of the declaring type.

java/ql/lib/change-notes/2022-09-16-dispatch-confidence.md

@@ -1,4 +0,0 @@
----
-category: majorAnalysis
----
-* The virtual dispatch relation used in data flow now favors summary models over source code for dispatch to interface methods from `java.util` unless there is evidence that a specific source implementation is reachable. This should provide increased precision for any projects that include, for example, custom `List` or `Map` implementations.

java/ql/lib/change-notes/released/0.4.0.md

@@ -0,0 +1,46 @@
+## 0.4.0
+
+### Breaking Changes
+
+* The `Member.getQualifiedName()` predicate result now includes the qualified name of the declaring type.
+
+### Deprecated APIs
+
+* The predicate `Annotation.getAValue()` has been deprecated because it might lead to obtaining the value of the wrong annotation element by accident. `getValue(string)` (or one of the value type specific predicates) should be used to explicitly specify the name of the annotation element.
+* The predicate `Annotation.getAValue(string)` has been renamed to `getAnArrayValue(string)`.
+* The predicate `SuppressWarningsAnnotation.getASuppressedWarningLiteral()` has been deprecated because it unnecessarily restricts the result type; `getASuppressedWarning()` should be used instead.
+* The predicates `TargetAnnotation.getATargetExpression()` and `RetentionAnnotation.getRetentionPolicyExpression()` have been deprecated because getting the enum constant read expression is rarely useful, instead the corresponding predicates for getting the name of the referenced enum constants should be used.
+
+### New Features
+
+* Added a new predicate, `allowsBackup`, in the `AndroidApplicationXmlElement` class. This predicate detects if the application element does not disable the `android:allowBackup` attribute.
+* The predicates of the CodeQL class `Annotation` have been improved:
+  * Convenience value type specific predicates have been added, such as `getEnumConstantValue(string)` or `getStringValue(string)`.
+  * Convenience predicates for elements with array values have been added, such as `getAnEnumConstantArrayValue(string)`. While the behavior of the existing predicates has not changed, usage of them should be reviewed (or replaced with the newly added predicate) to make sure they work correctly for elements with array values.
+  * Some internal CodeQL usage of the `Annotation` predicates has been adjusted and corrected; this might affect the results of some queries.
+* New predicates have been added to the CodeQL class `Annotatable` to support getting declared and associated annotations. As part of that, `hasAnnotation()` has been changed to also consider inherited annotations, to be consistent with `hasAnnotation(string, string)` and `getAnAnnotation()`. The newly added predicate `hasDeclaredAnnotation()` can be used as replacement for the old functionality.
+* New predicates have been added to the CodeQL class `AnnotationType` to simplify getting information about usage of JDK meta-annotations, such as `@Retention`.
+
+### Major Analysis Improvements
+
+* The virtual dispatch relation used in data flow now favors summary models over source code for dispatch to interface methods from `java.util` unless there is evidence that a specific source implementation is reachable. This should provide increased precision for any projects that include, for example, custom `List` or `Map` implementations.
+
+### Minor Analysis Improvements
+
+* Added new sinks to the query `java/android/implict-pendingintents` to take into account the classes `androidx.core.app.NotificationManagerCompat` and `androidx.core.app.AlarmManagerCompat`.
+* Added new flow steps for `androidx.core.app.NotificationCompat` and its inner classes.
+* Added flow sinks, sources and summaries for the Kotlin standard library.
+* Added flow summary for `org.springframework.data.repository.CrudRepository.save()`.
+* Added new flow steps for the following Android classes:
+  * `android.content.ContentResolver`
+  * `android.content.ContentProviderClient`
+  * `android.content.ContentProviderOperation`
+  * `android.content.ContentProviderOperation$Builder`
+  * `android.content.ContentProviderResult`
+  * `android.database.Cursor`
+* Added taint flow models for the `java.lang.String.(charAt|getBytes)` methods.
+* Improved taint flow models for the `java.lang.String.(replace|replaceFirst|replaceAll)` methods. Additional results may be found where users do not properly sanitize their inputs.
+
+### Bug Fixes
+
+* Fixed an issue in the taint tracking analysis where implicit reads were not allowed by default in sinks or additional taint steps that used flow states.

java/ql/lib/codeql-pack.release.yml

@@ -1,2 +1,2 @@
 ---
-lastReleaseVersion: 0.3.5
+lastReleaseVersion: 0.4.0

java/ql/lib/qlpack.yml

@@ -1,5 +1,5 @@
 name: codeql/java-all
-version: 0.4.0-dev
+version: 0.4.0
 groups: java
 dbscheme: config/semmlecode.dbscheme
 extractor: java

java/ql/src/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.4.0
+
+### New Queries
+
+* The query "Server-side template injection" (`java/server-side-template-injection`) has been promoted from experimental to the main query pack. This query was originally [submitted as an experimental query by @porcupineyhairs](https://github.com/github/codeql/pull/5935).
+* Added a new query, `java/android/backup-enabled`, to detect if Android applications allow backups.
+
+### Query Metadata Changes
+
+* Removed the `@security-severity` tag from several queries not in the `Security/` folder that also had missing `security` tags.
+
+### Minor Analysis Improvements
+
+* The Java extractor now populates the `Method` relating to a `MethodAccess` consistently for calls using an explicit and implicit `this` qualifier. Previously if the method `foo` was inherited from a specialised generic type `ParentType<String>`, then an explicit call `this.foo()` would yield a `MethodAccess` whose `getMethod()` accessor returned the bound method `ParentType<String>.foo`, whereas an implicitly-qualified `foo()` `MethodAccess`'s `getMethod()` would return the unbound method `ParentType.foo`. Now both scenarios produce a bound method. This means that all data-flow queries may return more results where a relevant path transits a call to such an implicitly-qualified call to a member method with a bound generic type, while queries that inspect the result of `MethodAccess.getMethod()` may need to tolerate bound generic methods in more circumstances. The queries `java/iterator-remove-failure`, `java/non-static-nested-class`, `java/internal-representation-exposure`, `java/subtle-inherited-call` and `java/deprecated-call` have been amended to properly handle calls to bound generic methods, and in some instances may now produce more results in the explicit-`this` case as well.
+* Added taint model for arguments of `java.net.URI` constructors to the queries `java/path-injection` and `java/path-injection-local`.
+* Added new sinks related to Android's `AlarmManager` to the query `java/android/implicit-pendingintents`.
+* The alert message of many queries have been changed to make the message consistent with other languages.
+
 ## 0.3.4
 
 ## 0.3.3

java/ql/src/change-notes/2022-08-18-android-allowbackup-query.md

@@ -1,4 +0,0 @@
----
-category: newQuery
----
-* Added a new query, `java/android/backup-enabled`, to detect if Android applications allow backups.

java/ql/src/change-notes/2022-08-23-alert-messages.md

@@ -1,4 +0,0 @@
----
-category: minorAnalysis
----
-* The alert message of many queries have been changed to make the message consistent with other languages.

java/ql/src/change-notes/2022-08-29-remove-security-tag.md

@@ -1,4 +0,0 @@
----
-category: queryMetadata
----
-* Removed the `@security-severity` tag from several queries not in the `Security/` folder that also had missing `security` tags.

java/ql/src/change-notes/2022-09-01-implicit-pendingintents-new-sinks.md

@@ -1,4 +0,0 @@
----
-category: minorAnalysis
----
-* Added new sinks related to Android's `AlarmManager` to the query `java/android/implicit-pendingintents`.

java/ql/src/change-notes/2022-09-08-server-side-template-injection-query.md

@@ -1,4 +0,0 @@
----
-category: newQuery
----
-* The query "Server-side template injection" (`java/server-side-template-injection`) has been promoted from experimental to the main query pack. This query was originally [submitted as an experimental query by @porcupineyhairs](https://github.com/github/codeql/pull/5935).

java/ql/src/change-notes/2022-09-13-flow-model-for-uri-constructors.md

@@ -1,4 +0,0 @@
----
-category: minorAnalysis
----
-* Added taint model for arguments of `java.net.URI` constructors to the queries `java/path-injection` and `java/path-injection-local`.

java/ql/src/change-notes/released/0.4.0.md

@@ -1,4 +1,17 @@
----
-category: minorAnalysis
----
+## 0.4.0
+
+### New Queries
+
+* The query "Server-side template injection" (`java/server-side-template-injection`) has been promoted from experimental to the main query pack. This query was originally [submitted as an experimental query by @porcupineyhairs](https://github.com/github/codeql/pull/5935).
+* Added a new query, `java/android/backup-enabled`, to detect if Android applications allow backups.
+
+### Query Metadata Changes
+
+* Removed the `@security-severity` tag from several queries not in the `Security/` folder that also had missing `security` tags.
+
+### Minor Analysis Improvements
+
 * The Java extractor now populates the `Method` relating to a `MethodAccess` consistently for calls using an explicit and implicit `this` qualifier. Previously if the method `foo` was inherited from a specialised generic type `ParentType<String>`, then an explicit call `this.foo()` would yield a `MethodAccess` whose `getMethod()` accessor returned the bound method `ParentType<String>.foo`, whereas an implicitly-qualified `foo()` `MethodAccess`'s `getMethod()` would return the unbound method `ParentType.foo`. Now both scenarios produce a bound method. This means that all data-flow queries may return more results where a relevant path transits a call to such an implicitly-qualified call to a member method with a bound generic type, while queries that inspect the result of `MethodAccess.getMethod()` may need to tolerate bound generic methods in more circumstances. The queries `java/iterator-remove-failure`, `java/non-static-nested-class`, `java/internal-representation-exposure`, `java/subtle-inherited-call` and `java/deprecated-call` have been amended to properly handle calls to bound generic methods, and in some instances may now produce more results in the explicit-`this` case as well.
+* Added taint model for arguments of `java.net.URI` constructors to the queries `java/path-injection` and `java/path-injection-local`.
+* Added new sinks related to Android's `AlarmManager` to the query `java/android/implicit-pendingintents`.
+* The alert message of many queries have been changed to make the message consistent with other languages.

java/ql/src/codeql-pack.release.yml

@@ -1,2 +1,2 @@
 ---
-lastReleaseVersion: 0.3.4
+lastReleaseVersion: 0.4.0

java/ql/src/qlpack.yml

@@ -1,5 +1,5 @@
 name: codeql/java-queries
-version: 0.4.0-dev
+version: 0.4.0
 groups: 
   - java
   - queries