Merge pull request #158 from MichaelXF/new

2.0

Author: MichaelXF

.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,7 +9,7 @@ assignees: ''
 
 **Describe the bug:**
 
-The program gets stuck in a infinite loop
+The program enters an infinite loop and does not produce the expected output.
 
 **Config and Small code sample**
 
@@ -30,12 +30,14 @@ console.log("My Small Code Sample");
 
 **Expected behavior**
 
-The program should output "My Small Code Sample"
+Example: The program should output "My Small Code Sample"
 
 **Actual behavior**
 
-The program stalls forever and never outputs anything
+Example: The program stalls indefinitely and never outputs the expected message.
 
 **Additional context**
 
-Seems the program gets stuck in a infinite loop due to Control Flow Flattening. Disabling the feature seems to rid of the bug.
+Example: It appears that the issue is caused by Control Flow Flattening. Disabling this feature resolves the problem.
+
+

.github/workflows/node.js.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.15, 16.10, 18.0, 20.16]
+        node-version: [18.0, 20.16, 22.11, 23.3]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.gitignore

@@ -112,6 +112,7 @@ dev.error.js
 dev.input.js
 dev.output.js
 dev.ts
+dev.profile.json
 
 package-lock.json
 

.npmignore

@@ -0,0 +1,136 @@
+# Decrease NPM bunlde size
+src_old/
+test/
+docs/
+babel.config.js
+babel.register.js
+
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+coverage/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# VS Code prettier ignore list
+.prettierignore
+
+dev.error.js
+dev.input.js
+dev.output.js
+dev.ts
+dev.profile.json
+
+package-lock.json
+
+Cash.output.js
+
+ES6.output.js
+
+.vscode/
+
+src/dev.ts
+
+.DS_Store
+

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "singleQuote": false
+}

CHANGELOG.md

@@ -1,3 +1,105 @@
+# `2.0.0`
+2.0 Rewrite 🎉
+
+### Complete rewrite of JS-Confuser using Babel! 🎉
+
+**⚠️ Breaking changes**
+
+> Check out the [Migration guide](./Migration.md) on how to properly update from 1.X to 2.0. The obfuscation upgrades in 2.0 are worth the small refactoring.
+
+- Revamped API Interface
+
+- - JSConfuser.obfuscate() resolves to an object
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `code` | `string` | The obfuscated code. |
+
+- Renamed `Stack` to `Variable Masking`
+
+- Added configurable limits to options:
+
+```js
+const options = {
+  target: "node",
+
+  rgf: {
+    value: 0.5, // = 50% of eligible functions
+    limit: 10 // Maximum of 10 changes for performance reasons
+  },
+
+  // Original format is still valid (No limit applied)
+  rgf: 0.5
+}
+```
+
+### 2.0 Changes
+
+- Added [Custom String Encoding](https://js-confuser.com/docs/options/customStringEncodings) and [Custom Lock Code](https://js-confuser.com/docs/options/customLocks) options
+
+- Added `Rename Labels` [Learn more here](https://js-confuser.com/docs/options/renamelabels#rename-labels)
+
+- Added `Pack` [Learn more here](https://js-confuser.com/docs/options/pack#pack)
+
+- RGF no longers uses `new Function` instead uses `eval`
+
+- Improved code transforms!
+
+- Improved `Control Flow Flattening`
+
+- - Obfuscates the [Call Graph](https://en.wikipedia.org/wiki/Call_graph)
+
+- - Now supports lexical bindings (`let`, `const`, `class`)
+
+- - `with () { }` statement obfuscation
+
+- Improved `Minify`
+
+- - Removes unused variables and functions
+
+- Improved `Moved Declaration` ability to move variables as unused function parameters
+
+- Improved `String` transforms
+
+- - [Template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) are now obfuscated (First converted into equivalent String Literal)
+
+- - [Regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) are now obfuscated (First converted into equivalent RegExp() constructor calls)
+
+- - `String Compression` now uses LZ-string compression ([lz-string](https://www.npmjs.com/package/lz-string))
+
+- New Comment Syntax
+
+- - `/* @js-confuser-var */ "name"` for improved variable mappings, such as eval() calls
+
+```js
+// Input
+var name = "Internet User";
+eval( "console.log(" + /* @js-confuser-var */ "name" + ")" );
+
+// Output
+var zC3PLKu = "Internet User";
+eval("console.log(" + "zC3PLKu" + ")");
+```
+
+Note: The function `__JS_CONFUSER_VAR__` is still supported.
+
+### JS-Confuser.com Revamp
+
+A new UI for [JS-Confuser.com](https://js-confuser.com), featuring an advanced playground and documentation pages.
+
+The previous version will remain available at [old--confuser.netlify.com](https://old--confuser.netlify.app/).
+
+**Removed features**
+
+- Removed `ES5` option - Use Babel Instead
+
+- Removed `Browser Lock` and `OS Lock` - Use [Custom Locks](https://js-confuser.com/docs/options/customlocks#custom-locks) instead
+
+- Removed `Shuffle`'s Hash option
+
+- Removed `Indent` option
+
+
 # `1.7.3`
 Tamper Protection
 
@@ -30,7 +132,7 @@ eval('console.log(' + 'CA1HU0' + ')');
 
 - Improve `String Compression`
 
-- New Web UI sneak peak: https://new--confuser.netlify.app/
+- New Web UI sneak peak: https://js-confuser.com/
 
 
 # `1.7.2`

Migration.md

@@ -0,0 +1,73 @@
+## Migration guide to JS-Confuser 2.0
+
+JS-Confuser 2.0 is complete rewrite of the original JS-Confuser created in 2020!
+
+## API Interface changed
+
+### JSConfuser.obfuscate() returns an object now
+
+The method `JSConfuser.obfuscate()` resolves to a object now instead of a string. This result object contains a property `code` which is the obfuscated code.
+
+```diff
+const JSConfuser = require("js-confuser");
+const sourceCode = `console.log("Hello World")`;
+const options = {
+  target: "node",
+  preset: "high"
+};
+
+JSConfuser.obfuscate(sourceCode, options).then(result=>{
+  // 'result' is now an object
+- console.log(result);
++ console.log(result.code);
+});
+```
+
+### Removed Anti Debug Lock / Browser Lock / OS Lock
+
+These features have been removed but you can still add these locks using the `lock.customLocks` option.
+
+```js
+{
+  target: "node",
+  
+  // ... Your obfuscator settings ...
+
+  lock: {
+    customLocks: [
+      {
+        code: `
+        // This code will be sprinkled throughout your source code
+        // (Will also be obfuscated)
+
+        if( window.navigator.userAgent.includes('Chrome') ){
+          {countermeasures}
+        }
+
+        // The {countermeasures} template variable is required.
+        // Must be placed in a Block or Switch Case body
+        `,
+        percentagePerBlock: 0.1, // = 10%
+        maxCount: 25, // Default = 25 - You probably don't want an excessive amount placed
+        minCount: 1 // Default = 1 - Ensures this custom lock is placed
+      }
+    ]
+  }
+}
+```
+
+### Stack renamed to Variable Masking
+
+The option `stack` has been renamed to `variableMasking`
+
+[Similar to JScrambler's Variable Masking](https://docs.jscrambler.com/code-integrity/documentation/transformations/variable-masking)
+
+```diff
+const options = {
+  target: "node",
+  preset: "high"
+
+- stack: true,
++ variableMasking: true
+};
+```