pyjsclear 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. pyjsclear-0.1.0/LICENSE +201 -0
  2. pyjsclear-0.1.0/MANIFEST.in +5 -0
  3. pyjsclear-0.1.0/NOTICE +19 -0
  4. pyjsclear-0.1.0/PKG-INFO +168 -0
  5. pyjsclear-0.1.0/README.md +142 -0
  6. pyjsclear-0.1.0/THIRD_PARTY_LICENSES.md +239 -0
  7. pyjsclear-0.1.0/pyjsclear/__init__.py +47 -0
  8. pyjsclear-0.1.0/pyjsclear/__main__.py +37 -0
  9. pyjsclear-0.1.0/pyjsclear/deobfuscator.py +191 -0
  10. pyjsclear-0.1.0/pyjsclear/generator.py +772 -0
  11. pyjsclear-0.1.0/pyjsclear/parser.py +46 -0
  12. pyjsclear-0.1.0/pyjsclear/scope.py +283 -0
  13. pyjsclear-0.1.0/pyjsclear/transforms/__init__.py +0 -0
  14. pyjsclear-0.1.0/pyjsclear/transforms/aa_decode.py +83 -0
  15. pyjsclear-0.1.0/pyjsclear/transforms/anti_tamper.py +106 -0
  16. pyjsclear-0.1.0/pyjsclear/transforms/base.py +24 -0
  17. pyjsclear-0.1.0/pyjsclear/transforms/constant_prop.py +103 -0
  18. pyjsclear-0.1.0/pyjsclear/transforms/control_flow.py +330 -0
  19. pyjsclear-0.1.0/pyjsclear/transforms/dead_branch.py +71 -0
  20. pyjsclear-0.1.0/pyjsclear/transforms/eval_unpack.py +133 -0
  21. pyjsclear-0.1.0/pyjsclear/transforms/expression_simplifier.py +403 -0
  22. pyjsclear-0.1.0/pyjsclear/transforms/hex_escapes.py +68 -0
  23. pyjsclear-0.1.0/pyjsclear/transforms/jj_decode.py +91 -0
  24. pyjsclear-0.1.0/pyjsclear/transforms/jsfuck_decode.py +93 -0
  25. pyjsclear-0.1.0/pyjsclear/transforms/logical_to_if.py +173 -0
  26. pyjsclear-0.1.0/pyjsclear/transforms/object_packer.py +133 -0
  27. pyjsclear-0.1.0/pyjsclear/transforms/object_simplifier.py +192 -0
  28. pyjsclear-0.1.0/pyjsclear/transforms/property_simplifier.py +43 -0
  29. pyjsclear-0.1.0/pyjsclear/transforms/proxy_functions.py +193 -0
  30. pyjsclear-0.1.0/pyjsclear/transforms/reassignment.py +183 -0
  31. pyjsclear-0.1.0/pyjsclear/transforms/sequence_splitter.py +215 -0
  32. pyjsclear-0.1.0/pyjsclear/transforms/string_revealer.py +1259 -0
  33. pyjsclear-0.1.0/pyjsclear/transforms/unused_vars.py +111 -0
  34. pyjsclear-0.1.0/pyjsclear/traverser.py +195 -0
  35. pyjsclear-0.1.0/pyjsclear/utils/__init__.py +0 -0
  36. pyjsclear-0.1.0/pyjsclear/utils/ast_helpers.py +257 -0
  37. pyjsclear-0.1.0/pyjsclear/utils/string_decoders.py +141 -0
  38. pyjsclear-0.1.0/pyjsclear.egg-info/PKG-INFO +168 -0
  39. pyjsclear-0.1.0/pyjsclear.egg-info/SOURCES.txt +45 -0
  40. pyjsclear-0.1.0/pyjsclear.egg-info/dependency_links.txt +1 -0
  41. pyjsclear-0.1.0/pyjsclear.egg-info/entry_points.txt +2 -0
  42. pyjsclear-0.1.0/pyjsclear.egg-info/requires.txt +1 -0
  43. pyjsclear-0.1.0/pyjsclear.egg-info/top_level.txt +1 -0
  44. pyjsclear-0.1.0/pyproject.toml +63 -0
  45. pyjsclear-0.1.0/setup.cfg +4 -0
  46. pyjsclear-0.1.0/setup.py +18 -0
  47. pyjsclear-0.1.0/tests/test_regression.py +546 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ recursive-include pyjsclear *.py
2
+ include LICENSE
3
+ include README.md
4
+ include NOTICE
5
+ include THIRD_PARTY_LICENSES.md
pyjsclear-0.1.0/NOTICE ADDED
@@ -0,0 +1,19 @@
1
+ PyJSClear
2
+ Copyright 2026 Intezer Labs
3
+
4
+ This product is a derivative work based on the following projects:
5
+
6
+ 1. obfuscator-io-deobfuscator (v1.0.6)
7
+ Copyright Ben (ben-sb)
8
+ Licensed under the Apache License, Version 2.0
9
+ https://github.com/ben-sb/obfuscator-io-deobfuscator
10
+
11
+ 2. javascript-deobfuscator
12
+ Copyright Ben (ben-sb)
13
+ Licensed under the Apache License, Version 2.0
14
+ https://github.com/ben-sb/javascript-deobfuscator
15
+
16
+ This Python library re-implements the deobfuscation algorithms and transform
17
+ logic from the above Node.js/Babel-based tools in pure Python. No source code
18
+ was directly copied; the implementations were written from scratch following
19
+ the same algorithmic approaches.
@@ -0,0 +1,168 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyjsclear
3
+ Version: 0.1.0
4
+ Summary: Pure Python JavaScript deobfuscator
5
+ Author-email: Intezer Labs <info@intezer.com>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/intezer/PyJSClear
8
+ Project-URL: Repository, https://github.com/intezer/PyJSClear
9
+ Project-URL: Issues, https://github.com/intezer/PyJSClear/issues
10
+ Keywords: javascript,deobfuscator,deobfuscation,security,malware-analysis,ast
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Information Technology
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Topic :: Security
18
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
19
+ Classifier: Typing :: Typed
20
+ Requires-Python: >=3.11
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ License-File: NOTICE
24
+ Requires-Dist: esprima2>=5.0.1
25
+ Dynamic: license-file
26
+
27
+ <p align="center">
28
+ <img src="https://raw.githubusercontent.com/intezer/PyJSClear/main/PyJSClear.png" alt="PyJSClear" width="200">
29
+ </p>
30
+
31
+ # PyJSClear
32
+
33
+ Pure Python JavaScript deobfuscator. Combines the functionality of
34
+ [obfuscator-io-deobfuscator](https://github.com/ben-sb/obfuscator-io-deobfuscator)
35
+ (13 AST transforms for obfuscator.io output) and
36
+ [javascript-deobfuscator](https://github.com/ben-sb/javascript-deobfuscator)
37
+ (hex escape decoding, static array unpacking, property access cleanup)
38
+ into a single Python library with no Node.js dependency.
39
+
40
+ ## Installation
41
+
42
+ ```bash
43
+ pip install pyjsclear
44
+ ```
45
+
46
+ For development:
47
+
48
+ ```bash
49
+ git clone https://github.com/intezer/PyJSClear.git
50
+ cd PyJSClear
51
+ pip install -e .
52
+ pip install pytest
53
+ ```
54
+
55
+ ## Usage
56
+
57
+ ### Python API
58
+
59
+ ```python
60
+ from pyjsclear import deobfuscate, deobfuscate_file
61
+
62
+ # From a string
63
+ cleaned = deobfuscate(obfuscated_code)
64
+
65
+ # From a file
66
+ deobfuscate_file("input.js", "output.js")
67
+
68
+ # Or get the result as a string
69
+ cleaned = deobfuscate_file("input.js")
70
+ ```
71
+
72
+ ### Command line
73
+
74
+ ```bash
75
+ # File to stdout
76
+ pyjsclear input.js
77
+
78
+ # File to file
79
+ pyjsclear input.js -o output.js
80
+
81
+ # Stdin to stdout
82
+ cat input.js | pyjsclear -
83
+
84
+ # With custom iteration limit
85
+ pyjsclear input.js --max-iterations 20
86
+ ```
87
+
88
+ ## What it does
89
+
90
+ PyJSClear applies 16 transforms in a multi-pass loop until no further changes
91
+ are made (up to 50 iterations by default):
92
+
93
+ | # | Transform | Description |
94
+ |---|-----------|-------------|
95
+ | 1 | **StringRevealer** | Decode obfuscator.io string arrays (basic, base64, RC4), including rotation IIFEs, wrapper functions, multiple decoders per file, and SequenceExpression-wrapped rotation patterns |
96
+ | 2 | **HexEscapes** | Normalize `\xHH`/`\uHHHH` escape sequences in string literal AST nodes |
97
+ | 3 | **UnusedVariableRemover** | Remove variables with zero references |
98
+ | 4 | **ConstantProp** | Propagate constant literals to all reference sites |
99
+ | 5 | **ReassignmentRemover** | Eliminate redundant `x = y` reassignment chains |
100
+ | 6 | **DeadBranchRemover** | Remove unreachable `if(true)/if(false)` and ternary branches |
101
+ | 7 | **ObjectPacker** | Consolidate sequential `obj.x = ...` assignments into object literals |
102
+ | 8 | **ProxyFunctionInliner** | Inline single-return proxy functions at all call sites |
103
+ | 9 | **SequenceSplitter** | Split comma expressions `(a(), b(), c())` into separate statements; extract `(0, fn)(args)` indirect call prefixes; normalize loop/if bodies to block statements |
104
+ | 10 | **ExpressionSimplifier** | Evaluate static expressions: `3 + 5` -> `8`, `![]` -> `false`, `typeof undefined` -> `"undefined"`, `test ? false : true` -> `!test` |
105
+ | 11 | **LogicalToIf** | Convert `a && b()` / `a \|\| b()` in statement position to if-statements |
106
+ | 12 | **ControlFlowRecoverer** | Recover linear code from `"1\|0\|3".split("\|")` + `while/switch` dispatch patterns |
107
+ | 13 | **PropertySimplifier** | Convert `obj["prop"]` to `obj.prop` where valid |
108
+ | 14 | **AntiTamperRemover** | Remove self-defending and anti-debug IIFEs |
109
+ | 15 | **ObjectSimplifier** | Inline proxy object property accesses |
110
+ | 16 | **StringRevealer** | Second pass to catch strings exposed by earlier transforms |
111
+
112
+ ### Safety guarantees
113
+
114
+ - **Never expands output**: if the deobfuscated result is larger than the input,
115
+ the original code is returned unchanged.
116
+ - **Never crashes on valid JS**: parse errors fall back to returning the original
117
+ source. Transform exceptions are caught per-transform and skipped.
118
+
119
+ ## Testing
120
+
121
+ ```bash
122
+ pytest tests/ # all tests
123
+ pytest tests/test_regression.py # regression suite (35 tests across 25 samples)
124
+ pytest tests/ -n auto # parallel execution (requires pytest-xdist)
125
+ ```
126
+
127
+ Validated against six datasets totalling 47,836 files (full datasets, no sampling):
128
+
129
+ | Dataset | Files | Crashes | Expanded | Reduced | Source |
130
+ |---------|-------|---------|----------|---------|--------|
131
+ | E1 technique samples | 20 | 0 | 0 | 13 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
132
+ | Kaggle Obfuscated | 1,477 | 0 | 0 | 1,199 | [Kaggle](https://www.kaggle.com/datasets/fanbyprinciple/obfuscated-javascript-dataset) |
133
+ | Kaggle NotObfuscated | 1,898 | 0 | 0 | 217 | [Kaggle](https://www.kaggle.com/datasets/fanbyprinciple/obfuscated-javascript-dataset) |
134
+ | MalJS (malware) | 23,212 | 0 | 0 | 3,193 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
135
+ | BenignJS | 21,209 | 0 | 0 | 4,354 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
136
+ | E1 original (clean) | 20 | 0 | 0 | 15 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
137
+
138
+ Files >200KB or exceeding a 15-second wall-clock timeout are skipped and counted as unchanged (14,529 of MalJS, 940 of BenignJS). BenignJS reductions are genuine deobfuscation of obfuscated JS scraped from benign websites. A handful of Kaggle NotObfuscated files are mislabeled (genuinely obfuscated Angular test specs). E1 original reductions come from minor whitespace/formatting cleanup by the code generator.
139
+
140
+ **Head-to-head vs Node.js tools** (obfuscator-io-deobfuscator + javascript-deobfuscator pipeline):
141
+
142
+ On the Kaggle Obfuscated dataset (1,477 files), PyJSClear reduces 1,199 files while the Node.js pipeline changes zero — the dataset's lightweight obfuscation (hex escapes, basic string arrays without `parseInt` checksums) falls outside obfuscator-io-deobfuscator's detection heuristics. On the E1 and MalJS datasets (heavily obfuscated), PyJSClear produces smaller output on 93.8% of files where at least one tool changed output, driven by dead-code removal, proxy-function inlining, bracket-to-dot conversion, and control-flow recovery.
143
+
144
+ **Parse coverage**: PyJSClear uses [esprima2](https://github.com/s0md3v/esprima2) which supports ES2024 syntax, including arrow functions, optional chaining, nullish coalescing, and more.
145
+
146
+ ## Architecture
147
+
148
+ Built on [esprima2](https://github.com/s0md3v/esprima2) (ESTree-compatible JS parser with ES2024 support) with a custom code generator, AST traverser (enter/exit/replace/remove), and scope analysis. Transforms run in a fixed order within a convergence loop; StringRevealer runs both first and last to handle string arrays before and after other transforms modify wrapper function structure.
149
+
150
+ ## Limitations
151
+
152
+ - Large files (>100KB) with deep obfuscation can be slow due to the
153
+ multi-pass architecture. Consider using `max_iterations` to limit passes.
154
+ - Not all obfuscator.io configurations are handled — some advanced string
155
+ encoding patterns may not be fully decoded. Supported encodings: basic
156
+ (index lookup), base64, RC4, and multi-decoder (multiple encoding types
157
+ sharing one string array).
158
+
159
+ ## License
160
+
161
+ Apache License 2.0 — see [LICENSE](LICENSE).
162
+
163
+ This project is a derivative work based on
164
+ [obfuscator-io-deobfuscator](https://github.com/ben-sb/obfuscator-io-deobfuscator)
165
+ (Apache 2.0) and
166
+ [javascript-deobfuscator](https://github.com/ben-sb/javascript-deobfuscator)
167
+ (Apache 2.0). See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) and
168
+ [NOTICE](NOTICE) for full attribution.
@@ -0,0 +1,142 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/intezer/PyJSClear/main/PyJSClear.png" alt="PyJSClear" width="200">
3
+ </p>
4
+
5
+ # PyJSClear
6
+
7
+ Pure Python JavaScript deobfuscator. Combines the functionality of
8
+ [obfuscator-io-deobfuscator](https://github.com/ben-sb/obfuscator-io-deobfuscator)
9
+ (13 AST transforms for obfuscator.io output) and
10
+ [javascript-deobfuscator](https://github.com/ben-sb/javascript-deobfuscator)
11
+ (hex escape decoding, static array unpacking, property access cleanup)
12
+ into a single Python library with no Node.js dependency.
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ pip install pyjsclear
18
+ ```
19
+
20
+ For development:
21
+
22
+ ```bash
23
+ git clone https://github.com/intezer/PyJSClear.git
24
+ cd PyJSClear
25
+ pip install -e .
26
+ pip install pytest
27
+ ```
28
+
29
+ ## Usage
30
+
31
+ ### Python API
32
+
33
+ ```python
34
+ from pyjsclear import deobfuscate, deobfuscate_file
35
+
36
+ # From a string
37
+ cleaned = deobfuscate(obfuscated_code)
38
+
39
+ # From a file
40
+ deobfuscate_file("input.js", "output.js")
41
+
42
+ # Or get the result as a string
43
+ cleaned = deobfuscate_file("input.js")
44
+ ```
45
+
46
+ ### Command line
47
+
48
+ ```bash
49
+ # File to stdout
50
+ pyjsclear input.js
51
+
52
+ # File to file
53
+ pyjsclear input.js -o output.js
54
+
55
+ # Stdin to stdout
56
+ cat input.js | pyjsclear -
57
+
58
+ # With custom iteration limit
59
+ pyjsclear input.js --max-iterations 20
60
+ ```
61
+
62
+ ## What it does
63
+
64
+ PyJSClear applies 16 transforms in a multi-pass loop until no further changes
65
+ are made (up to 50 iterations by default):
66
+
67
+ | # | Transform | Description |
68
+ |---|-----------|-------------|
69
+ | 1 | **StringRevealer** | Decode obfuscator.io string arrays (basic, base64, RC4), including rotation IIFEs, wrapper functions, multiple decoders per file, and SequenceExpression-wrapped rotation patterns |
70
+ | 2 | **HexEscapes** | Normalize `\xHH`/`\uHHHH` escape sequences in string literal AST nodes |
71
+ | 3 | **UnusedVariableRemover** | Remove variables with zero references |
72
+ | 4 | **ConstantProp** | Propagate constant literals to all reference sites |
73
+ | 5 | **ReassignmentRemover** | Eliminate redundant `x = y` reassignment chains |
74
+ | 6 | **DeadBranchRemover** | Remove unreachable `if(true)/if(false)` and ternary branches |
75
+ | 7 | **ObjectPacker** | Consolidate sequential `obj.x = ...` assignments into object literals |
76
+ | 8 | **ProxyFunctionInliner** | Inline single-return proxy functions at all call sites |
77
+ | 9 | **SequenceSplitter** | Split comma expressions `(a(), b(), c())` into separate statements; extract `(0, fn)(args)` indirect call prefixes; normalize loop/if bodies to block statements |
78
+ | 10 | **ExpressionSimplifier** | Evaluate static expressions: `3 + 5` -> `8`, `![]` -> `false`, `typeof undefined` -> `"undefined"`, `test ? false : true` -> `!test` |
79
+ | 11 | **LogicalToIf** | Convert `a && b()` / `a \|\| b()` in statement position to if-statements |
80
+ | 12 | **ControlFlowRecoverer** | Recover linear code from `"1\|0\|3".split("\|")` + `while/switch` dispatch patterns |
81
+ | 13 | **PropertySimplifier** | Convert `obj["prop"]` to `obj.prop` where valid |
82
+ | 14 | **AntiTamperRemover** | Remove self-defending and anti-debug IIFEs |
83
+ | 15 | **ObjectSimplifier** | Inline proxy object property accesses |
84
+ | 16 | **StringRevealer** | Second pass to catch strings exposed by earlier transforms |
85
+
86
+ ### Safety guarantees
87
+
88
+ - **Never expands output**: if the deobfuscated result is larger than the input,
89
+ the original code is returned unchanged.
90
+ - **Never crashes on valid JS**: parse errors fall back to returning the original
91
+ source. Transform exceptions are caught per-transform and skipped.
92
+
93
+ ## Testing
94
+
95
+ ```bash
96
+ pytest tests/ # all tests
97
+ pytest tests/test_regression.py # regression suite (35 tests across 25 samples)
98
+ pytest tests/ -n auto # parallel execution (requires pytest-xdist)
99
+ ```
100
+
101
+ Validated against six datasets totalling 47,836 files (full datasets, no sampling):
102
+
103
+ | Dataset | Files | Crashes | Expanded | Reduced | Source |
104
+ |---------|-------|---------|----------|---------|--------|
105
+ | E1 technique samples | 20 | 0 | 0 | 13 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
106
+ | Kaggle Obfuscated | 1,477 | 0 | 0 | 1,199 | [Kaggle](https://www.kaggle.com/datasets/fanbyprinciple/obfuscated-javascript-dataset) |
107
+ | Kaggle NotObfuscated | 1,898 | 0 | 0 | 217 | [Kaggle](https://www.kaggle.com/datasets/fanbyprinciple/obfuscated-javascript-dataset) |
108
+ | MalJS (malware) | 23,212 | 0 | 0 | 3,193 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
109
+ | BenignJS | 21,209 | 0 | 0 | 4,354 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
110
+ | E1 original (clean) | 20 | 0 | 0 | 15 | [JSIMPLIFIER](https://zenodo.org/records/17531662) |
111
+
112
+ Files >200KB or exceeding a 15-second wall-clock timeout are skipped and counted as unchanged (14,529 of MalJS, 940 of BenignJS). BenignJS reductions are genuine deobfuscation of obfuscated JS scraped from benign websites. A handful of Kaggle NotObfuscated files are mislabeled (genuinely obfuscated Angular test specs). E1 original reductions come from minor whitespace/formatting cleanup by the code generator.
113
+
114
+ **Head-to-head vs Node.js tools** (obfuscator-io-deobfuscator + javascript-deobfuscator pipeline):
115
+
116
+ On the Kaggle Obfuscated dataset (1,477 files), PyJSClear reduces 1,199 files while the Node.js pipeline changes zero — the dataset's lightweight obfuscation (hex escapes, basic string arrays without `parseInt` checksums) falls outside obfuscator-io-deobfuscator's detection heuristics. On the E1 and MalJS datasets (heavily obfuscated), PyJSClear produces smaller output on 93.8% of files where at least one tool changed output, driven by dead-code removal, proxy-function inlining, bracket-to-dot conversion, and control-flow recovery.
117
+
118
+ **Parse coverage**: PyJSClear uses [esprima2](https://github.com/s0md3v/esprima2) which supports ES2024 syntax, including arrow functions, optional chaining, nullish coalescing, and more.
119
+
120
+ ## Architecture
121
+
122
+ Built on [esprima2](https://github.com/s0md3v/esprima2) (ESTree-compatible JS parser with ES2024 support) with a custom code generator, AST traverser (enter/exit/replace/remove), and scope analysis. Transforms run in a fixed order within a convergence loop; StringRevealer runs both first and last to handle string arrays before and after other transforms modify wrapper function structure.
123
+
124
+ ## Limitations
125
+
126
+ - Large files (>100KB) with deep obfuscation can be slow due to the
127
+ multi-pass architecture. Consider using `max_iterations` to limit passes.
128
+ - Not all obfuscator.io configurations are handled — some advanced string
129
+ encoding patterns may not be fully decoded. Supported encodings: basic
130
+ (index lookup), base64, RC4, and multi-decoder (multiple encoding types
131
+ sharing one string array).
132
+
133
+ ## License
134
+
135
+ Apache License 2.0 — see [LICENSE](LICENSE).
136
+
137
+ This project is a derivative work based on
138
+ [obfuscator-io-deobfuscator](https://github.com/ben-sb/obfuscator-io-deobfuscator)
139
+ (Apache 2.0) and
140
+ [javascript-deobfuscator](https://github.com/ben-sb/javascript-deobfuscator)
141
+ (Apache 2.0). See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) and
142
+ [NOTICE](NOTICE) for full attribution.