The open-source Java obfuscation tool working with Ant and Gradle by yWorks - the diagramming experts

yGuard yGuard is an open-source Java obfuscation tool. With yGuard it is easy as pie 🍰 to configure obfuscation through an extensive ant task. yGuard is brought to you by yWorks GmbH, creator of the family of

README
Issues 12

yGuard

yGuard is an open-source Java obfuscation tool. With yGuard it is easy as pie 🍰 to configure obfuscation through an extensive ant task.

yGuard is brought to you by yWorks GmbH, creator of the family of graph and diagram visualization frameworks yFiles and other fine products.

Obtaining yGuard

Recent yGuard releases can be downloaded from GitHub, or used from Maven central directly.

Legacy code ported from retroguard under LGPL is compiled into a seperate archive called retroguard-${VERSION}.jar.

Previous releases may still be downloaded from the yWorks download center.

Usage

An online version of this documentation is available.

Additionally, yGuard is distributed with usage instructions. In your distribution, the docs folder contains informtion about yGuard. In order to properly view the offline documentation, a web server is needed. A quick way to accomplish this is using:

cd docs/
python3 -m http.server 4000

Building

To build yGuard you will need Java >= 7 and Gradle.

Once installed you can build yGuard using gradle build.

Using IntellIJ with yGuard

yGuard will be loaded without further ado from IntellIJ thanks to the Gradle integration. Opening the yGuard folder will set up Gradle and mark sources, tests and resources accordingly.

Using this repository with a wrapper

This repository does not contain a copy of the Gradle wrapper. There has been extensive discussions about this topic, however committing a binary file to a VCS is simply considered bad practice.

If you prefer to use the wrapper, you can always generate it yourself with an installation of Gradle at hand:

gradle wrapper --gradle-version 5.2.1

If you do not have an installation of Gradle, you may use a workaround.

7 Open More issues

Closed

Yguard Obfuscation in a Spring Boot Project

Let me ask you something. Have a an application that is written on spring boot. To obfuscate the jar via yguard, i have no success that i would like to exclude BOOT-INF/lib folder. Could you help me on it?

Thanks a lot.

needs-information question

opened Feb 7, 2020 by angelsinistanbul 16

Closed

Question: how do I make sure that packaged dependencies are not stripped out from the obfuscated jar?

First of all let me compliment you for this amazing tool.

I have the following question: I am packaging my Java jar with Maven and the maven-assembly-plugin with the jar-with-dependencies configuration this makes it so that all the required dependencies are packaged as part of my final jar.

When I try to obfuscate this jar using yGuard all the packed dependencies are stripped out and thus the resulting jar is not working properly: how can I address this?

Based on my understanding of the documentation this should be managed with the externalclasses element and I have not been able to make it work correctly. Can I get some help with this? Below is my current configuration.

Thank you.

<target>
	<property name="compile_classpath" refid="maven.compile.classpath"/>
	<property name="runtime_classpath" refid="maven.runtime.classpath"/>
	<property name="test_classpath" refid="maven.test.classpath"/>
	<property name="plugin_classpath" refid="maven.plugin.classpath"/>

	<taskdef name="yguard" classname="com.yworks.yguard.YGuardTask" classpath="${runtime_classpath}"/>
	<yguard>
		<!-- see the yGuard task documentation for information about the <yguard> element-->
		<inoutpair in="${project.build.directory}/${project.build.finalName}.jar" out="${project.build.directory}/obfuscated.jar" resources="copy" />

		<rename  mainclass="com.github.ilpersi.BHBot.BHBot" logfile="${basedir}/yguard.log.xml"
				 replaceClassNameStrings="true">
		</rename>
		<externalclasses>
			<pathelement path="${runtime_classpath}" />
		</externalclasses>
	</yguard>
</target>

needs-information

opened Sep 9, 2020 by ilpersi 12

Closed

Fix JavaDoc warnings

Currently there are about 100 JavaDoc warnings generated from our source code. Fix these warnings by properly implementing the comments.

Hacktoberfest difficulty:beginner documentation good first issue

opened Sep 23, 2020 by Fohlen 8

Closed

JavaFX fxml support

After obsufiaction, my jar does not start due to an error: caused by: java.lang.ClassNotFoundException: com.example.Controller at java.net.URLClassLoader.findClass(URLClassLoader.java:382) at java.lang.ClassLoader.loadClass(ClassLoader.java:418) at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:355) at java.lang.ClassLoader.loadClass(ClassLoader.java:351) at javafx.fxml.FXMLLoader$ValueElement.processAttribute(FXMLLoader.java:920)

Because the name of the old class remains in the fxml file.

Hacktoberfest difficulty:medium enhancement good first issue

opened Mar 11, 2020 by meetinger 7

Closed

Annotation @Obfuscation causes error: package com.yworks.util.annotation does not exist

Based on this documentation page: https://yworks.github.io/yGuard/task_documentation/#controlling-obfuscation-exclusion-with-annotations

...I am trying to exclude the main function of my class from Obfuscation using:

  @com.yworks.util.annotation.Obfuscation( exclude = true, applyToMembers = false)
  public static void main(String[] args) {
    try {
      new Start();
    } catch (SQLException e) {
      LOGGER.error(e, e);
    }
  }

My IDE (Eclipse 2019-14) apparently believes that package path to be valid, since it does not show an error.

However, when I try to Gradle build the project, I get the following error:

...\Start.java:22: error: package com.yworks.util.annotation does not exist
  @com.yworks.util.annotation.Obfuscation( exclude = true, applyToMembers = false)
                             ^

In my build.gradle, I only import the following from yGuard:

	compile 'com.yworks:yguard:2.9.2'

I don't know the dependency tree, or where I would get the com.yworks.util.annotation package from. I have tried various approaches, but most of them made it only worse.

At best, I am doing something wrong, in which case I would be grateful if the documentation about how to use these annotations could be made clearer.

At worst, something is broken right now and the @Obfuscation Annotation is not working.

opened May 7, 2020 by KiraResari 6

Closed

Allow subclasses to instantiate their own specialized implementations

The emphasis of this commit is to be able to extend to provide our own custom ResourceAdjuster, along with custom attributes in the related Ant tasks.

We have replaced the direct instantiation of key classes via the new operator with calls to protected methods that create the instances. We have made this change for Ant tasks and ResourceAdjuster-related classes.

A couple classes that were package-private are now accessible for sub-classing.

Furthermore, we have removed "final" from any class that may now have customized implementations.

Within these classes, we have also exposed some private fields as "protected final".

opened Dec 11, 2020 by aoindustries 6

Open

('Unrecognized bootstrap method: scala/runtime/LambdaDeserialize#bootstrap(...)') occured during the remapping

Hi, trying to obfuscate scala app, here is my gradle snippet:

rename(mainclass: 'org.SearchAgentServer', logfile: "${buildDir}/yguard.log.xml") {
                keep {
                    'package' {
                        patternset {
                            include(name: "scala.*")
                            include(name: "org.*")
                        }
                    }
                }
                property(name: "error-checking", value: "pedantic")
            }

the idea is to obfuscate only app classes and do nothing with the rest. I get exception. Why does yGuard tries to do smth with class from scala package? It's marked as 'keep"

Caused by: : yGuard encountered an IO problem!
        at com.yworks.yguard.ObfuscatorTask.execute(ObfuscatorTask.java:1093)
        at com.yworks.yguard.YGuardTask.execute(YGuardTask.java:118)
        at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:292)
        at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
        at org.gradle.api.internal.project.ant.BasicAntBuilder.nodeCompleted(BasicAntBuilder.java:80)
        at org.gradle.api.internal.project.ant.BasicAntBuilder.doInvokeMethod(BasicAntBuilder.java:107)

Caused by: java.io.IOException: An error ('Unrecognized bootstrap method: scala/runtime/LambdaDeserialize#bootstrap(...)') occured during the remapping! See the log!)
        at com.yworks.yguard.obf.GuardDB.remapTo(GuardDB.java:547)
        at com.yworks.yguard.ObfuscatorTask.execute(ObfuscatorTask.java:1064)

difficulty:medium enhancement

opened Feb 3, 2021 by serega-upgini 4

Open

Some file streams are not closed during shrinking

File stream of the following types are not closed during shrinking:

com.yworks.util.abstractjar.StreamProvider
com.yworks.yshrink.core.Writer.write
com.yworks.yshrink.core.Analyzer.visitAllClasses

This problem has been here before the 3.0.0 release and has only been identified during the release process. The result may potentially be many IO access requests and memory consumption. Reading from JAR files however will at the most open 2 streams. This situation changes with directory support. In order to properly solve this ticket an implementation needs to modify abstraction to add a close method to these classes and make sure they are called everywhere accordingly.

This ticket is currently rated at low priority. If you encounter problems in production that make this refactoring more pressing, please ammend this ticket.

bug difficulty:beginner

opened Jan 29, 2021 by Fohlen 0

Open

Add support for invokeconstant

See https://openjdk.java.net/jeps/309 Apparently this is an unused feature in terms of bytecode. Needs to be implemented once it becomes relevant in Java >= 15. This is a follow-up of #69

difficulty:medium

opened Sep 28, 2020 by Fohlen 0

Open

Research obfuscation techniques

There are many possible ways of obfuscation. It would be good to create a table / chart in the documentation which ones exist and are supported by yGuard. Inspiration could be drawn from this paper. The scope of this ticket is to create a new documentation page with mentioned details.

Hacktoberfest difficulty:beginner documentation good first issue

opened Sep 7, 2020 by Fohlen 0

Open

Propose a flow obfuscation mode

Many obfuscation tools throughout different languages support "flow obfuscation". The process how this can be done is fairly accurately described in this post. yGuard may (or may not) support such a mode. The implementation should try to generate some simple flow obfuscation that can be optionally enabled (during the rename task). One could then enhance these capabilities.

Hacktoberfest difficulty:medium enhancement good first issue

opened Sep 7, 2020 by Fohlen 0

Open

Add Android example

yGuard can be used to obfuscate code that will result in an APK. In order to this one needs to:

disable R8 obfuscation and shrinking
use yGuard as an extra step in the build file
run D8 after yGuard

This has the benefit that yGuard is very extensible and well documented in comparison to R8. Potentially this should be accompanied with a small Hello World app and Android Studio Project file.

Useful information can be found in the Google documentation.

Hacktoberfest difficulty:beginner enhancement good first issue

opened Sep 7, 2020 by Fohlen 0

Information

Category: Java / Miscellaneous
Watchers: 9
Star: 128
Fork: 18
Last update: Mar 4, 2021

Resource links

https://github.com/yWorks/yGuard

Share this repo

Related Repos

Miscellaneous

347

An open source project by OverOps. Generate massive random Java applications with a comman...

About An open source project by OverOps. Visit the site to download a sample result or read more on the blog Requirements Groovy installed Gradle installed Java installed Installation Downlo

Miscellaneous

859

Clojure Text Editor, for editing clojure code and markdown. Written entirely in Clojure wi...

Salza λiquid text editor Fluidable - Embed your code into λiquid or λiquid into your code Dependency free - Everything is pure Clojure Translatable - Tiny core, simple model, no tricks Comfortable keybindings - Mos

Miscellaneous

A Java application launcher and class loader which can load and run classes directly from ...

ModRun - Modularity for Java Without Jigsaw ModRun can load and run classes directly from Maven repositories and resolve dependencies at runtime. For a more complete tutorial, read this: ModRun Tutorialhttp://tutorials.jenkov.co

Popular

Miscellaneous

4.6k

Apache Beam is a unified programming model for Batch and Streaming

Apache Beam (incubating) Apache Beam is a unified model for defining both batch and streaming data-parallel processing pipelines, as well as a set of language-specific SDKs for constructing pipelines and Runners for executing the

Miscellaneous

151

Mirror of Apache Myriad (Incubating)

Myriad Myriad is a Mesos framework designed for scaling a YARN cluster on Mesos. Myriad can expand or shrink the resources managed by a YARN cluster in response to events as per configured rules and policies. The name Myriad m

Miscellaneous

Elastic-Grok-Script-Plugin is a provider of Grok ElasticSearch plug-in

Introduction Elastic-Grok-Script-Plugin is a provider of Grok ElasticSearch plug-in Install fork this project and change the elasticsearch in maven ,default is 2.3.3 run mvn assembly:assembly ,you can find the re

Miscellaneous

Mirror of Apache Tamaya

Apache Tamaya (incubating) Tamaya is a very powerful yet flexible configuration solution. It's core is built based on a few simple concepts. There are at least two main usage scenarios for Tamaya, which are synergetic: In an

Miscellaneous

152

Live-coding the cluster!

powderkeg Live-coding the cluster! Usage First, add Powderkeg and Spark (1.5 to 2.1 are supported, any scala version) to your dependencies: E.g. :dependencies [[hcadatalab/powderkeg "0.5.1"] [com.