updated change log documentation, examples, and properties for 4.1.0

Author: thomasbehr

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.1.0]
+
+### Added
+- Added support for obfuscating Java 21 class files.
+
+### Changed
+- Updated and improved examples. 
+
+### Fixed
+- Stand-alone package names in resource files are no longer adjusted when using `replaceContentPolicy` `strict`.
+
 ## [4.0.0]
 
 ### Added
@@ -26,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support for obfuscating multi-release jars.
   (Shrinking multi-release jars is not supported.)
 
-### Improved
+### Changed
 - Improved support for type annotations.
 
 ### Fixed

build.gradle

@@ -28,9 +28,9 @@ configurations {
 dependencies {
     annotation project(':annotation')
     implementation project(':annotation')
-    implementation 'org.ow2.asm:asm:9.2'
-    implementation 'org.apache.ant:ant:1.10.12'
-    testImplementation 'junit:junit:4.13-beta-3'
+    implementation 'org.ow2.asm:asm:9.6'
+    implementation 'org.apache.ant:ant:1.10.14'
+    testImplementation 'junit:junit:4.13.2'
 }
 
 compileJava {
@@ -50,7 +50,7 @@ task generateSources(type: Copy) {
 // Use generated sources
 compileJava.dependsOn generateSources
 
-def LIBRARIES = ["asm-9.2.jar"]
+def LIBRARIES = ["asm-9.6.jar"]
 def LIBRARY_JARS = configurations.dependents.filter {
   file -> file.name in LIBRARIES
 }

docs/compatibility.md

@@ -4,6 +4,12 @@
 
 yGuard requires JDK 1.7.x or greater and Ant 1.5 or greater installed on your system. It may work with earlier versions of these pieces of software as well, however this has not been tested thoroughly. yGuard 1.3.x and upwards works together with Ant 1.6.
 
+## Java 18 - Java 21 Compatibility
+
+Beginning with version 4.1.0, yGuard supports obfuscation of Java class files that use `ClassDesc`, `Enum.EnumDesc`, and `SwitchBootstraps` bootstrap method factories which were introduced in Java 12 and Java 21.
+
+(This also means yGuard now supports obfuscating `dynamic` instructions which were introduced with the Java 11 `.class` file format.)
+
 ## Java 14 - Java 17 Compatibility
 
 Beginning with version 3.1.0, yGuard supports obfuscation of Java class files that contain `record` or `permittedsubclasses` attributes which were introduced with the Java 16 and Java 17 `.class` file formats.
@@ -31,9 +37,8 @@ While yGuard does fully support obfuscating `invokedynamic` instructions and the
 ## Compatibility to 3rd party JVM
 
 Obfuscating `dynamic` and `invokedynamic` instructions is a task that is theoretically infeasible. An obfuscation program cannot determine the type and parameters of such instructions in a generic way.
-A trade-off solution for this is supporting known `MetaFactory` objects by their signature.
-The `JRE` makes this task quite trivial. 
-`yGuard` supports the built-in `LambdaMetafactory` and `StringConcatFactory`.
+A trade-off solution for this is supporting known bootstrap method factories by their signature. 
+`yGuard` supports Java's built-in `LambdaMetafactory`, `StringConcatFactory`, `SwitchBootstraps`, `Enum.EnumDesc`, and `ClassDesc` bootstrap method factory classes. 
 
 This trade-off however means `yGuard` offers only limited support for instruction sets based on `invokedynamic` or `dynamic`.
 In particular, supporting new `JVM` targets, such as Scala, might require manual work.
@@ -45,18 +50,21 @@ Below is a documentation on the design process involved in supporting the `Lambd
 
 To check that JVM compatibility is ensured in new releases, we verified that there are no differences in the class file format in JVM >= 11.
 This can be checked in the documentation of the [class file format](https://docs.oracle.com/javase/specs/jvms/se13/html/jvms-4.html).
-The JRE ships two targets for the `invokedynamic` and `dynamic` instruction sets. These are:
+The JRE ships several targets for the `invokedynamic` and `dynamic` instruction sets. These are:
 
-- `LambdaMetafactory`
-- `StringConcatFactory`
+- `LambdaMetafactory`,
+- `StringConcatFactory`,
+- `SwitchBootstraps`,
+- `Enum.EnumDesc`, and
+- `ClassDesc`
 
-We can recognise these factories in the obfuscation and shrinking steps using their signature. 
-Looking at the [documentation](https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/invoke/LambdaMetafactory.html) tells us that we should cover two signatures for `LambdaMetaFactory`:
+We can recognise these factories in the obfuscation steps using their signature. 
+Looking at the [documentation](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/invoke/LambdaMetafactory.html) tells us that we should cover two signatures for `LambdaMetaFactory`:
 
 - `java/lang/invoke/LambdaMetafactory#metafactory`
 - `java/lang/invoke/LambdaMetafactory#altMetafactory`
 
-`yFiles` recognises these methods [during renaming](https://github.com/yWorks/yGuard/blob/master/retroguard/src/main/java/com/yworks/yguard/obf/classfile/ClassFile.java#L1189).
+`yGuard` recognises these methods [during renaming](https://github.com/yWorks/yGuard/blob/master/retroguard/src/main/java/com/yworks/yguard/obf/classfile/ClassFile.java#L1189).
 In order to obfuscate lambdas, these steps are performed:
 
 - if an instance of `InvokeDynamicCpInfo` is found [while parsing the constant pool](https://github.com/yWorks/yGuard/blob/master/retroguard/src/main/java/com/yworks/yguard/obf/classfile/ClassFile.java#L1041), check its signature

docs/setup.md

@@ -6,7 +6,7 @@ Depending on your build system, you will use [`AntRun`](http://maven.apache.org/
 Download the bundle from the [Github release page](https://github.com/yWorks/yguard/releases/latest). After downloading and extracting the `jar` files, place them in a path near to your build script. You may use absolute paths, but our examples expect the jar file to lie in the same directory as your build file. Once extracted, you can use the `yguard` element like so:
 
 ```xml
-<property name="version" value="4.0.0"/>
+<property name="version" value="4.1.0"/>
 
 <target name="yguard">
     <taskdef name="yguard" classname="com.yworks.yguard.YGuardTask" classpath="${projectDir}/yguard-${version}.jar"/>
@@ -23,7 +23,7 @@ You can use `yGuard` directly from `Maven` central. Add the `yGuard` dependency
 <dependency>
     <groupId>com.yworks</groupId>
     <artifactId>yguard</artifactId>
-    <version>4.0.0</version>
+    <version>4.1.0</version>
     <scope>compile</scope>
 </dependency>
 ```
@@ -64,7 +64,7 @@ repositories {
 }
 
 dependencies {
-  compileOnly 'com.yworks:yguard:4.0.0'
+  compileOnly 'com.yworks:yguard:4.1.0'
 }
 
 task yguard {

examples/annotation/build.gradle

@@ -11,8 +11,8 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
-  compile 'com.yworks:annotation:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
+  compile 'com.yworks:annotation:4.1.0'
 }
 
 task obfuscate {

examples/annotation/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="annotation"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/annotation/pom.xml

@@ -16,13 +16,13 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>annotation</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
     </dependency>
   </dependencies>
   <build>

examples/application/build.gradle

@@ -23,7 +23,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate {

examples/application/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="application"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/application/pom.xml

@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

examples/external_library/build.gradle

@@ -30,7 +30,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
   gson 'com.google.code.gson:gson:2.8.9'
   implementation configurations.gson.dependencies
 }

examples/external_library/build.xml

@@ -3,7 +3,7 @@
   <property name="libraryDir" value="${basedir}/lib"/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="external_library"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/external_library/pom.xml

@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

examples/fxml/build.gradle

@@ -33,7 +33,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate {

examples/fxml/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="fxml"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/fxml/pom.xml

@@ -19,7 +19,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

examples/library/build.gradle

@@ -11,7 +11,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate   {

examples/library/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="library"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/library/pom.xml

@@ -17,7 +17,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

examples/processing/build.gradle

@@ -14,7 +14,7 @@ configurations {
 
 dependencies {
   implementation('org.springframework.boot:spring-boot-starter')
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate {

examples/processing/build.xml

@@ -22,7 +22,7 @@
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
   <property name="bundleDir" value="${target.dir}/jar"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="processing"/>
   <property name="project.jar.unobf" value="${bundleDir}/${project.name}_unobf.jar"/>

examples/processing/pom.xml

@@ -25,7 +25,7 @@
 		<dependency>
 			<groupId>com.yworks</groupId>
 			<artifactId>yguard</artifactId>
-			<version>4.0.0</version>
+			<version>4.1.0</version>
 			<!--
 			  prevent the spring boot plug-in from bundling yGuard and its
 			  dependencies into the project jar / project build artefact

examples/resources/build.gradle

@@ -23,7 +23,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate {

examples/resources/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="resources"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/resources/pom.xml

@@ -16,7 +16,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

examples/serializable_exclusion/build.gradle

@@ -23,7 +23,7 @@ configurations {
 }
 
 dependencies {
-  yguard 'com.yworks:yguard:4.0.0'
+  yguard 'com.yworks:yguard:4.1.0'
 }
 
 task obfuscate {

examples/serializable_exclusion/build.xml

@@ -2,7 +2,7 @@
   <property name="project.dir" value="${basedir}/../.."/>
   <property name="source.dir" value="${basedir}/src"/>
   <property name="target.dir" value="${basedir}/build"/>
-  <property name="yguard.version" value="4.0.0"/>
+  <property name="yguard.version" value="4.1.0"/>
 
   <property name="project.name" value="serializable_exclusion"/>
   <property name="project.jar.unobf" value="${target.dir}/jar/${project.name}_unobf.jar"/>

examples/serializable_exclusion/pom.xml

@@ -18,7 +18,7 @@
     <dependency>
       <groupId>com.yworks</groupId>
       <artifactId>yguard</artifactId>
-      <version>4.0.0</version>
+      <version>4.1.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

gradle.properties

@@ -1,5 +1,5 @@
-VERSION_MAJOR=4.0
-VERSION_MINOR=1-SNAPSHOT
+VERSION_MAJOR=4.1
+VERSION_MINOR=0
 
 POM_DESCRIPTION=The open-source Java obfuscation tool working with Ant and Gradle by yWorks - the diagramming experts
 POM_URL=https://github.com/yWorks/yGuard