Skip to content

Commit 937b735

Browse files
EricLafortuneEricLafortune
committed
Initial commit.
0 parents  commit 937b735

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+8749
-0
lines changed

‎LICENSE.md

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
The ProGuard Assembler and Disassembler are licensed under the Apache License
2+
Version 2.0.
3+
4+
Copyright 2002-2020 Guardsquare NV
5+
6+
Apache License
7+
Version 2.0, January 2004
8+
http://www.apache.org/licenses/
9+
10+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11+
12+
1. Definitions.
13+
14+
"License" shall mean the terms and conditions for use, reproduction,
15+
and distribution as defined by Sections 1 through 9 of this document.
16+
17+
"Licensor" shall mean the copyright owner or entity authorized by
18+
the copyright owner that is granting the License.
19+
20+
"Legal Entity" shall mean the union of the acting entity and all
21+
other entities that control, are controlled by, or are under common
22+
control with that entity. For the purposes of this definition,
23+
"control" means (i) the power, direct or indirect, to cause the
24+
direction or management of such entity, whether by contract or
25+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
26+
outstanding shares, or (iii) beneficial ownership of such entity.
27+
28+
"You" (or "Your") shall mean an individual or Legal Entity
29+
exercising permissions granted by this License.
30+
31+
"Source" form shall mean the preferred form for making modifications,
32+
including but not limited to software source code, documentation
33+
source, and configuration files.
34+
35+
"Object" form shall mean any form resulting from mechanical
36+
transformation or translation of a Source form, including but
37+
not limited to compiled object code, generated documentation,
38+
and conversions to other media types.
39+
40+
"Work" shall mean the work of authorship, whether in Source or
41+
Object form, made available under the License, as indicated by a
42+
copyright notice that is included in or attached to the work
43+
(an example is provided in the Appendix below).
44+
45+
"Derivative Works" shall mean any work, whether in Source or Object
46+
form, that is based on (or derived from) the Work and for which the
47+
editorial revisions, annotations, elaborations, or other modifications
48+
represent, as a whole, an original work of authorship. For the purposes
49+
of this License, Derivative Works shall not include works that remain
50+
separable from, or merely link (or bind by name) to the interfaces of,
51+
the Work and Derivative Works thereof.
52+
53+
"Contribution" shall mean any work of authorship, including
54+
the original version of the Work and any modifications or additions
55+
to that Work or Derivative Works thereof, that is intentionally
56+
submitted to Licensor for inclusion in the Work by the copyright owner
57+
or by an individual or Legal Entity authorized to submit on behalf of
58+
the copyright owner. For the purposes of this definition, "submitted"
59+
means any form of electronic, verbal, or written communication sent
60+
to the Licensor or its representatives, including but not limited to
61+
communication on electronic mailing lists, source code control systems,
62+
and issue tracking systems that are managed by, or on behalf of, the
63+
Licensor for the purpose of discussing and improving the Work, but
64+
excluding communication that is conspicuously marked or otherwise
65+
designated in writing by the copyright owner as "Not a Contribution."
66+
67+
"Contributor" shall mean Licensor and any individual or Legal Entity
68+
on behalf of whom a Contribution has been received by Licensor and
69+
subsequently incorporated within the Work.
70+
71+
2. Grant of Copyright License. Subject to the terms and conditions of
72+
this License, each Contributor hereby grants to You a perpetual,
73+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74+
copyright license to reproduce, prepare Derivative Works of,
75+
publicly display, publicly perform, sublicense, and distribute the
76+
Work and such Derivative Works in Source or Object form.
77+
78+
3. Grant of Patent License. Subject to the terms and conditions of
79+
this License, each Contributor hereby grants to You a perpetual,
80+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81+
(except as stated in this section) patent license to make, have made,
82+
use, offer to sell, sell, import, and otherwise transfer the Work,
83+
where such license applies only to those patent claims licensable
84+
by such Contributor that are necessarily infringed by their
85+
Contribution(s) alone or by combination of their Contribution(s)
86+
with the Work to which such Contribution(s) was submitted. If You
87+
institute patent litigation against any entity (including a
88+
cross-claim or counterclaim in a lawsuit) alleging that the Work
89+
or a Contribution incorporated within the Work constitutes direct
90+
or contributory patent infringement, then any patent licenses
91+
granted to You under this License for that Work shall terminate
92+
as of the date such litigation is filed.
93+
94+
4. Redistribution. You may reproduce and distribute copies of the
95+
Work or Derivative Works thereof in any medium, with or without
96+
modifications, and in Source or Object form, provided that You
97+
meet the following conditions:
98+
99+
(a) You must give any other recipients of the Work or
100+
Derivative Works a copy of this License; and
101+
102+
(b) You must cause any modified files to carry prominent notices
103+
stating that You changed the files; and
104+
105+
(c) You must retain, in the Source form of any Derivative Works
106+
that You distribute, all copyright, patent, trademark, and
107+
attribution notices from the Source form of the Work,
108+
excluding those notices that do not pertain to any part of
109+
the Derivative Works; and
110+
111+
(d) If the Work includes a "NOTICE" text file as part of its
112+
distribution, then any Derivative Works that You distribute must
113+
include a readable copy of the attribution notices contained
114+
within such NOTICE file, excluding those notices that do not
115+
pertain to any part of the Derivative Works, in at least one
116+
of the following places: within a NOTICE text file distributed
117+
as part of the Derivative Works; within the Source form or
118+
documentation, if provided along with the Derivative Works; or,
119+
within a display generated by the Derivative Works, if and
120+
wherever such third-party notices normally appear. The contents
121+
of the NOTICE file are for informational purposes only and
122+
do not modify the License. You may add Your own attribution
123+
notices within Derivative Works that You distribute, alongside
124+
or as an addendum to the NOTICE text from the Work, provided
125+
that such additional attribution notices cannot be construed
126+
as modifying the License.
127+
128+
You may add Your own copyright statement to Your modifications and
129+
may provide additional or different license terms and conditions
130+
for use, reproduction, or distribution of Your modifications, or
131+
for any such Derivative Works as a whole, provided Your use,
132+
reproduction, and distribution of the Work otherwise complies with
133+
the conditions stated in this License.
134+
135+
5. Submission of Contributions. Unless You explicitly state otherwise,
136+
any Contribution intentionally submitted for inclusion in the Work
137+
by You to the Licensor shall be under the terms and conditions of
138+
this License, without any additional terms or conditions.
139+
Notwithstanding the above, nothing herein shall supersede or modify
140+
the terms of any separate license agreement you may have executed
141+
with Licensor regarding such Contributions.
142+
143+
6. Trademarks. This License does not grant permission to use the trade
144+
names, trademarks, service marks, or product names of the Licensor,
145+
except as required for reasonable and customary use in describing the
146+
origin of the Work and reproducing the content of the NOTICE file.
147+
148+
7. Disclaimer of Warranty. Unless required by applicable law or
149+
agreed to in writing, Licensor provides the Work (and each
150+
Contributor provides its Contributions) on an "AS IS" BASIS,
151+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152+
implied, including, without limitation, any warranties or conditions
153+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154+
PARTICULAR PURPOSE. You are solely responsible for determining the
155+
appropriateness of using or redistributing the Work and assume any
156+
risks associated with Your exercise of permissions under this License.
157+
158+
8. Limitation of Liability. In no event and under no legal theory,
159+
whether in tort (including negligence), contract, or otherwise,
160+
unless required by applicable law (such as deliberate and grossly
161+
negligent acts) or agreed to in writing, shall any Contributor be
162+
liable to You for damages, including any direct, indirect, special,
163+
incidental, or consequential damages of any character arising as a
164+
result of this License or out of the use or inability to use the
165+
Work (including but not limited to damages for loss of goodwill,
166+
work stoppage, computer failure or malfunction, or any and all
167+
other commercial damages or losses), even if such Contributor
168+
has been advised of the possibility of such damages.
169+
170+
9. Accepting Warranty or Additional Liability. While redistributing
171+
the Work or Derivative Works thereof, You may choose to offer,
172+
and charge a fee for, acceptance of support, warranty, indemnity,
173+
or other liability obligations and/or rights consistent with this
174+
License. However, in accepting such obligations, You may act only
175+
on Your own behalf and on Your sole responsibility, not on behalf
176+
of any other Contributor, and only if You agree to indemnify,
177+
defend, and hold each Contributor harmless for any liability
178+
incurred by, or claims asserted against, such Contributor by reason
179+
of your accepting any such warranty or additional liability.
180+
181+
END OF TERMS AND CONDITIONS

‎README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
The ProGuard Assembler and Disassembler for Java class files
2+
============================================================
3+
4+
The **ProGuard Assembler and Disassembler** can assemble and disassemble
5+
Java class files.
6+
7+
The disassembler takes `class` files and converts them to readable `jbc`
8+
(Java ByteCode) files, following the [ProGuard Assembly Language
9+
specification](docs/md/specification.md).
10+
11+
The assembler does the opposite; it takes readable `jbc` files and
12+
converts them to `class` files.
13+
14+
# Usage
15+
16+
The program is distributed as a single executable jar file that serves both as
17+
an assembler and as a disassembler. When the program detects a `jbc` file as
18+
input, it assembles it. Vice versa, when it detects a `class` file, it
19+
disassembles it. It can handle any combination of both; a jar file containing
20+
both `jbc` files and `class` files will have its `jbc` files assembled in the
21+
output and its `class` files disassembled in the output.
22+
23+
bin/assembler [<classpath>] <input> <output>
24+
25+
The _input_ and the _output_ can be .class/.jbc/.jar/.jmod files or
26+
directories, where _.jbc files_ contain disassembled Java bytecode.
27+
28+
The _classpath_ (with runtime classes and library classes) is only necessary
29+
for preverifying assembled code.
30+
31+
# Example
32+
33+
As a small test, you can let the program disassemble itself:
34+
35+
bin/assembler lib/assembler.jar disassembled
36+
37+
The program will create a `disassembled` directory with readable files
38+
disassembled from the input jar. You can then let the program assemble the
39+
assembly files again:
40+
41+
bin/assembler /usr/lib/jvm/java-12-oracle/jmods/java.base.jmod disassembled assembled.jar
42+
43+
The program will now create an `assembled.jar` file with reassembled class
44+
files. It will use the `jmod` file as a run-time library to properly preverify
45+
the code.
46+
47+
# Preverification
48+
49+
The ProGuard Assembly Language contains some syntactic sugar, notably for the
50+
`StackMap` and `StackMapTable` attributes. As of Java version 7, each `Code`
51+
attribute must contain a `StackMapTable` attribute. Since it would be very
52+
cumbersome to write these attributes by hand, the assembler automatically
53+
preverifies every method using the ProGuard preverifier, and creates the
54+
`StackMapTable` using the preverification info. As a consequence, the
55+
assembler needs to know the location of any library jars when assembling
56+
`class` files.
57+
58+
# Downloads
59+
60+
The **ProGuard Assembler and Disassembler** are distributed under the terms of
61+
the Apache License Version 2.0. Please consult the [license
62+
page](docs/md/license.md) for more details.
63+
64+
The code is written in Java, so it requires a Java Runtime Environment
65+
JRE 1.8 or higher).
66+
67+
You can download the assembler and disassembler in various forms:
68+
69+
- [Pre-built artifacts](https://bintray.com/guardsquare/proguard) at JCenter
70+
- [Pre-built artifacts](https://search.maven.org/search?q=g:net.sf.proguard) at Maven Central
71+
- A [Git repository of the source code](https://github.com/Guardsquare/proguard-assembler) at Github
72+
73+
# Building
74+
75+
If you've downloaded the source code, you can build it in a number of ways:
76+
77+
- build.gradle : a Gradle build file for all platforms
78+
79+
gradle clean assemble
80+
81+
- pom.xml: a Maven POM for all platforms
82+
83+
mvn clean package
84+
85+
- build.sh: a simple and fast shell script for GNU/Linux
86+
87+
./build.sh
88+
89+
Once built, you can [run the assembler and disassembler](index.md) with the
90+
scripts in the `bin` directory.
91+
92+
Enjoy!
93+
94+
Copyright (c) 2002-2020 [Guardsquare NV](https://www.guardsquare.com/)

‎assembler.iml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<module type="JAVA_MODULE" version="4">
3+
<component name="NewModuleRootManager">
4+
<output url="file://$MODULE_DIR$/build/classes/java/main" />
5+
<output-test url="file://$MODULE_DIR$/build/classes/java/main" />
6+
<exclude-output />
7+
<content url="file://$MODULE_DIR$">
8+
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
9+
<excludeFolder url="file://$MODULE_DIR$/build" />
10+
<excludeFolder url="file://$MODULE_DIR$/out" />
11+
<excludeFolder url="file://$MODULE_DIR$/target" />
12+
</content>
13+
<orderEntry type="inheritedJdk" />
14+
<orderEntry type="sourceFolder" forTests="false" />
15+
<orderEntry type="module" module-name="core" />
16+
</component>
17+
</module>

‎bin/assembler.bat

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
@ECHO OFF
2+
3+
REM Start-up script for the ProGuard Assembler and Disassembler.
4+
REM
5+
REM Note: when passing file names containing spaces to this script,
6+
REM you'll have to add escaped quotes around them, e.g.
7+
REM "\"C:/My Directory/My File.txt\""
8+
9+
IF EXIST "%PROGUARD_HOME%" GOTO home
10+
SET PROGUARD_HOME=%~dp0\..
11+
:home
12+
13+
java -jar "%PROGUARD_HOME%\lib\assembler.jar" %*

‎bin/assembler.sh

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/bin/sh
2+
#
3+
# Start-up script for the ProGuard Assembler and Disassembler.
4+
#
5+
# Note: when passing file names containing spaces to this script,
6+
# you'll have to add escaped quotes around them, e.g.
7+
# "\"/My Directory/My File.txt\""
8+
9+
# Account for possibly missing/basic readlink.
10+
# POSIX conformant (dash/ksh/zsh/bash).
11+
ASSEMBLER=`readlink -f "$0" 2>/dev/null`
12+
if test "$ASSEMBLER" = ''
13+
then
14+
ASSEMBLER=`readlink "$0" 2>/dev/null`
15+
if test "$ASSEMBLER" = ''
16+
then
17+
ASSEMBLER="$0"
18+
fi
19+
fi
20+
21+
ASSEMBLER_HOME=`dirname "$ASSEMBLER"`/..
22+
23+
# Find the compiled jar.
24+
if [ -f "$ASSEMBLER_HOME/lib/proguard-assembler.jar" ]
25+
then
26+
ASSEMBLER_JAR=$ASSEMBLER_HOME/lib/proguard-assembler.jar
27+
elif [ -f "$ASSEMBLER_HOME/lib/assembler.jar" ]
28+
then
29+
ASSEMBLER_JAR=$ASSEMBLER_HOME/lib/assembler.jar
30+
elif [ -f "$ASSEMBLER_HOME/target/proguard-assembler-7.0.0.jar" ]
31+
then
32+
ASSEMBLER_JAR=$ASSEMBLER_HOME/target/proguard-assembler-7.0.0.jar
33+
else
34+
echo 'Please build the project first'
35+
exit 1
36+
fi
37+
38+
exec java -jar "$ASSEMBLER_JAR" "$@"

‎build.gradle

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Gradle build script for the ProGuard Assembler and Disassembler.
2+
3+
apply plugin: 'java'
4+
5+
repositories {
6+
mavenLocal()
7+
jcenter()
8+
}
9+
10+
sourceCompatibility = "${target}"
11+
targetCompatibility = "${target}"
12+
13+
sourceSets.main {
14+
java {
15+
srcDirs = ['src']
16+
}
17+
resources {
18+
srcDirs = ['src']
19+
include '**/*.properties'
20+
include '**/*.gif'
21+
include '**/*.png'
22+
include '**/*.pro'
23+
}
24+
}
25+
26+
dependencies {
27+
compile 'net.sf.proguard:proguard-core:7.0.0'
28+
}
29+
30+
jar {
31+
manifest.from 'src/META-INF/MANIFEST.MF'
32+
}
33+
34+
task copyToLib(type: Copy) {
35+
from jar
36+
from configurations.runtime
37+
into 'lib'
38+
}
39+
40+
assemble.dependsOn copyToLib

0 commit comments

Comments
 (0)