Скачать или смотреть How to Obfuscate Specific Packages in a Fat Jar using yGuard

A guide on using yGuard for obfuscating specific packages in a fat jar. Learn to avoid errors and configure your Ant task effectively.
---
This video is based on the question https://stackoverflow.com/q/67620826/ asked by the user 'kallada' ( https://stackoverflow.com/u/2504705/ ) and on the answer https://stackoverflow.com/a/71600751/ provided by the user 'Thomas Behr' ( https://stackoverflow.com/u/9535950/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Obfuscating specific packages in a fat jar (maven project) with yGuard

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Obfuscate Specific Packages in a Fat Jar using yGuard

When working on Java projects, it's often necessary to protect your code by obfuscating it. This is particularly true for projects that are distributed in a fat jar format. One tool that many developers turn to for this purpose is yGuard, an obfuscation tool specifically designed for Java applications. In this post, we'll discuss how to use yGuard to obfuscate specific packages in a fat jar, while avoiding common pitfalls that can lead to errors during the process.

The Challenge

You might encounter issues like trying to obfuscate external libraries (e.g., the Batik library), which can result in runtime exceptions such as java.io.IOException: An error ('No mapping found for: Field org/apache/batik/bridge/SVGPathElementBridge.ctx'). This occurs because the obfuscation process fails to recognize certain mappings in external libraries.
The goal is to effectively obfuscate your custom code without causing conflicts with external dependencies.

Steps to Obfuscate a Fat Jar with yGuard

Let's break down the solution into clear steps that will help you successfully create your obfuscated fat jar:

Step 1: Create a Fat Jar with Maven Shaded Plugin

Before you start with yGuard, ensure that you have created a fat jar of your application using the Maven shaded plugin. The fat jar will contain all the necessary dependencies, making it easier to manage obfuscation.

Step 2: Configure the yGuard Ant Task

The next step involves setting up the yGuard Ant task to handle your fat jar. Below is how to configure it correctly:

[[See Video to Reveal this Text or Code Snippet]]

Key Configuration Changes

Understanding <keep> and <exclude>:

The <keep> child works in reverse. Any class included in <keep> will not be obfuscated. Thus, if your aim is to retain the integrity of external libraries, you should include them in the <keep> section using <include> tags within a new <class> element.

Exclusion Isn't Required:

After understanding that <exclude> is unnecessary if your intention is to preserve certain classes, you can streamline your configuration by focusing on what to keep rather than what to exclude.

Specific Packages to Keep:

Ensure that you include the necessary package patterns for classes you want to keep intact, such as org.apache.**.* and javax.**.*.

Conclusion

By following the steps outlined above and configuring your yGuard task properly, you can successfully obfuscate your custom packages in a fat jar while avoiding conflicts with external libraries. This will provide you with a layer of protection against reverse engineering and unauthorized access.

If you have further questions or run into issues, feel free to comment below, and happy coding!