javascript-obfuscator-x
v0.18.2TypeScript
JavaScript obfuscator
0/weekUpdated 3 years agoBSD-2-ClauseUnpacked: 3.1 MB
Published by Timofey Kachalov
npm install javascript-obfuscator-xJavaScript obfuscator
#### Right now i haven't time to maintain this project and i looking for for maintainers! Create issue if you want to maintain this project.
!logo
JavaScript obfuscator is a powerful free obfuscator for JavaScript with a wide number of features which provides protection for your source code.
Example of obfuscated code: gist.github.com
#### Online version:
obfuscator.io
#### Plugins:
* Webpack plugin: webpack-obfuscator
* Webpack loader: obfuscator-loader
* Gulp: gulp-javascript-obfuscator
* Grunt: grunt-contrib-obfuscator
* Rollup: rollup-plugin-javascript-obfuscator
* Weex: weex-devtool
* Malta: malta-js-obfuscator
#### You can support this project by donating:
* (Bitcoin) 14yhtZxLNp6ekZAgmEmPJqEKUP2VtUxQK6
* (Ether) 0x5Df9eBcFB2D0f3315d03Ac112104b9023C409dc1
* (OpenCollective) https://opencollective.com/javascript-obfuscator
Big thanks to all supporters!
#### NOTE! the README on the master branch might not match that of the latest stable release!
#### If you have a question - check this section first: FAQ
:warning: Important
##### Obfuscate only the code that belongs to you.
It is not recommended to obfuscate vendor scripts and polyfills, since the obfuscated code is 15-80% slower (depends on options) and the files are significantly larger.
Installation
#### Using Yarn or NPM
Install the package with Yarn or NPM and add it to your dependencies or devDependencies:
``sh`
$ yarn add --dev javascript-obfuscator
orsh`
$ npm install --save-dev javascript-obfuscator
#### In a Browser
From CDN:
`html`
From node_modules:
`html`
Usage
`javascript
var JavaScriptObfuscator = require('javascript-obfuscator');
var obfuscationResult = JavaScriptObfuscator.obfuscate(
(function(){
var variable1 = '5' - 3;
var variable2 = '5' + 3;
var variable3 = '5' + - '2';
var variable4 = ['10','10','10','10','10'].map(parseInt);
var variable5 = 'foo ' + 1 + 1;
console.log(variable1);
console.log(variable2);
console.log(variable3);
console.log(variable4);
console.log(variable5);
})();
,
{
compact: false,
controlFlowFlattening: true
}
);
console.log(obfuscationResult.getObfuscatedCode());
/*
var _0x2218 = [
'8|3|1|2|0|4|6|9|7|5',
'bqndd',
'dySIh',
'kTiiG',
'log',
'tuvgv'
];
(function (_0x38b423, _0x1d6bd4) {
var _0x39a849 = function (_0x5794c7) {
while (--_0x5794c7) {
_0x38b423'push');
}
};
_0x39a849(++_0x1d6bd4);
}(_0x2218, 0x114));
var _0x8221 = function (_0xcac13e, _0x3627d7) {
_0xcac13e = _0xcac13e - 0x0;
var _0x1eae4d = _0x2218[_0xcac13e];
return _0x1eae4d;
};
(function () {
var _0x5336d5 = {
'bqndd': _0x8221('0x0'),
'islRd': function _0x2abb6c(_0x2f45f8, _0x4d47b0) {
return _0x2f45f8 + _0x4d47b0;
},
'kTiiG': function _0x32525a(_0x44ba8d, _0x2c5e0c) {
return _0x44ba8d + _0x2c5e0c;
},
'dySIh': 'foo\x20',
'tuvgv': function _0x28d015(_0x35d81a, _0x2d2463) {
return _0x35d81a - _0x2d2463;
}
};
var _0x5000ba = _0x5336d5[_0x8221('0x1')]'split', _0x5c972f = 0x0;
while (!![]) {
switch (_0x5000ba[_0x5c972f++]) {
case '0':
var _0x586faa = _0x5336d5'islRd'], 0x1), 0x1);
continue;
case '1':
var _0xab6a82 = _0x5336d5_0x8221('0x3');
continue;
case '2':
var _0x19ab9d = [
'10',
'10',
'10',
'10',
'10'
]'map';
continue;
case '3':
var _0x321653 = _0x5336d5_0x8221('0x3');
continue;
case '4':
console'log';
continue;
case '5':
console_0x8221('0x4');
continue;
case '6':
console_0x8221('0x4');
continue;
case '7':
console_0x8221('0x4');
continue;
case '8':
var _0x2c1b0c = _0x5336d5_0x8221('0x5');
continue;
case '9':
console_0x8221('0x4');
continue;
}
break;
}
}());
*/
`
$3
Returns ObfuscationResult object which contains two public methods:
* getObfuscatedCode() - returns string with obfuscated code;getSourceMap()
* - if sourceMap option is enabled - returns string with source map or an empty string if sourceMapMode option is set as inline.
Calling toString() for ObfuscationResult object will return string with obfuscated code.
Method takes two parameters, sourceCode and options – the source code and the opitons respectively:
* sourceCode (string, default: null) – any valid source code, passed as a string;options
* (Object, default: null) – an object with options.
For available options see options.
CLI usage
See CLI options.
#### Obfuscate single file
Usage:
`sh`
javascript-obfuscator input_file_name.js [options]
javascript-obfuscator input_file_name.js --output output_file_name.js [options]
Obfuscation of single input file with .js extension.
If the destination path is not specified with the --output option, obfuscated file will saved into the input file directory with INPUT_FILE_NAME-obfuscated.js name.
Examples:
`sh
javascript-obfuscator samples/sample.js --compact true --self-defending false
// creates a new file samples/sample-obfuscated.js
javascript-obfuscator samples/sample.js --output output/output.js --compact true --self-defending false
// creates a new file output/output.js
`
#### Obfuscate directory recursively
Usage:
`sh./dist
javascript-obfuscator ./dist [options]
// creates a new obfuscated files under directory near the input files with obfuscated postfix
javascript-obfuscator ./dist --output ./dist/obfuscated [options]
// creates a folder structure with obfuscated files under ./dist/obfuscated path`
Obfuscation of all .js files under input directory. If this directory contains already obfuscated files with -obfuscated postfix - these files will ignored.
Obfuscated files will saved into the input directory under INPUT_FILE_NAME-obfuscated.js name.
Conditional comments
You can disable and enable obfuscation for specific parts of the code by adding following comments:
disable: // javascript-obfuscator:disable
or / javascript-obfuscator:disable */;
enable: // javascript-obfuscator:enable or / javascript-obfuscator:enable */.Example:
`javascript
// input
var foo = 1;
// javascript-obfuscator:disable
var bar = 2;// output
var _0xabc123 = 0x1;
var bar = 2;
`
Conditional comments affect only direct transformations of AST-tree nodes. All child transformations still will be applied to the AST-tree nodes. For example:
* Obfuscation of the variable's name at its declaration is called direct transformation;
* Obfuscation of the variable's name beyond its declaration is called child transformation.
Antiviruses false positive virus alerts
Some input source code that will obfuscated with some obfuscation options can trigger false positive alerts in a few antiviruses. If you will get this false positive triggers, try to play with obfuscation options.
* Try to change
option value between rc4 and base64 values or disable it completely;
* Try to change identifierNamesGenerator option value from hexadecimal on mangled;
* Try to disable selfDefending.If this wont help - attach your source code and describe your obfuscation options here:
https://github.com/javascript-obfuscator/javascript-obfuscator/issues/51
JavaScript Obfuscator Options
Following options are available for the JS Obfuscator:
#### options:
`javascript
{
compact: true,
controlFlowFlattening: false,
controlFlowFlatteningThreshold: 0.75,
deadCodeInjection: false,
deadCodeInjectionThreshold: 0.4,
debugProtection: false,
debugProtectionInterval: false,
disableConsoleOutput: false,
domainLock: [],
identifierNamesGenerator: 'hexadecimal',
identifiersPrefix: '',
inputFileName: '',
log: false,
renameGlobals: false,
reservedNames: [],
reservedStrings: [],
rotateStringArray: true,
seed: 0,
selfDefending: false,
sourceMap: false,
sourceMapBaseUrl: '',
sourceMapFileName: '',
sourceMapMode: 'separate',
stringArray: true,
stringArrayEncoding: false,
stringArrayThreshold: 0.75,
target: 'browser',
transformObjectKeys: false,
unicodeEscapeSequence: false
}
`#### CLI options:
sh
-v, --version
-h, --help -o, --output
--compact
--config
--control-flow-flattening
--control-flow-flattening-threshold
--dead-code-injection
--dead-code-injection-threshold
--debug-protection
--debug-protection-interval
--disable-console-output
--domain-lock '' (comma separated)
--exclude '' (comma separated)
--identifier-names-generator [hexadecimal, mangled]
--identifiers-prefix
--log
--rename-globals
--reserved-names '' (comma separated)
--reserved-strings '' (comma separated)
--rotate-string-array
--seed
--self-defending
--source-map
--source-map-base-url
--source-map-file-name
--source-map-mode [inline, separate]
--string-array
--string-array-encoding [true, false, base64, rc4]
--string-array-threshold
--target [browser, browser-no-eval, node]
--transform-object-keys
--unicode-escape-sequence
`$3
Type: Default: trueCompact code output on one line.
$3
Type: Default: Name of JS/JSON config file which contains obfuscator options. These will be overridden by options passed directly to CLI
$3
Type: Default: false##### :warning: This option greatly affects the performance up to 1.5x slower runtime speed. Use
to set percentage of nodes that will affected by control flow flattening. Enables code control flow flattening. Control flow flattening is a structure transformation of the source code that hinders program comprehension.
Example:
`ts
// input
(function(){
function foo () {
return function () {
var sum = 1 + 2;
console.log(1);
console.log(2);
console.log(3);
console.log(4);
console.log(5);
console.log(6);
}
}
foo()();
})();// output
(function () {
function _0x3bfc5c() {
return function () {
var _0x3260a5 = {
'WtABe': '4|0|6|5|3|2|1',
'GokKo': function _0xf87260(_0x427a8e, _0x43354c) {
return _0x427a8e + _0x43354c;
}
};
var _0x1ad4d6 = _0x3260a5['WtABe']'split', _0x1a7b12 = 0x0;
while (!![]) {
switch (_0x1ad4d6[_0x1a7b12++]) {
case '0':
console'log';
continue;
case '1':
console'log';
continue;
case '2':
console'log';
continue;
case '3':
console'log';
continue;
case '4':
var _0x1f2f2f = _0x3260a5'GokKo';
continue;
case '5':
console'log';
continue;
case '6':
console'log';
continue;
}
break;
}
};
}
_0x3bfc5c()();
}());
`$3
Type: Default: 0.75 Min: 0 Max: 1 transformation will be applied to the node.This setting is especially useful for large code size because large amounts of control flow transformations can slow down your code and increase code size.
controlFlowFlatteningThreshold: 0 equals to controlFlowFlattening: false.$3
Type: boolean Default: false##### :warning: Dramatically increases size of obfuscated code (up to 200%), use only if size of obfuscated code doesn't matter. Use
to set percentage of nodes that will affected by dead code injection.
##### :warning: This option forcibly enables stringArray option.With this option random blocks of dead code will add to the obfuscated code.
Example:
`ts
// input
(function(){
if (true) {
var foo = function () {
console.log('abc');
console.log('cde');
console.log('efg');
console.log('hij');
};
var bar = function () {
console.log('klm');
console.log('nop');
console.log('qrs');
};
var baz = function () {
console.log('tuv');
console.log('wxy');
console.log('z');
};
foo();
bar();
baz();
}
})();// output
var _0x5024 = [
'zaU',
'log',
'tuv',
'wxy',
'abc',
'cde',
'efg',
'hij',
'QhG',
'TeI',
'klm',
'nop',
'qrs',
'bZd',
'HMx'
];
var _0x4502 = function (_0x1254b1, _0x583689) {
_0x1254b1 = _0x1254b1 - 0x0;
var _0x529b49 = _0x5024[_0x1254b1];
return _0x529b49;
};
(function () {
if (!![]) {
var _0x16c18d = function () {
if (_0x4502('0x0') !== _0x4502('0x0')) {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1');
} else {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
}
};
var _0x1f7292 = function () {
if (_0x4502('0x8') === _0x4502('0x9')) {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
} else {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
}
};
var _0x33b212 = function () {
if (_0x4502('0xd') !== _0x4502('0xe')) {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1');
} else {
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
console_0x4502('0x1'));
}
};
_0x16c18d();
_0x1f7292();
_0x33b212();
}
}());
`$3
Type: Default: 0.4 Min: 0 Max: 1Allows to set percentage of nodes that will affected by
.$3
Type: boolean Default: false##### :warning: Can freeze your browser if you open the Developer Tools.
This option makes it almost impossible to use the
tab of the Developer Tools (both on WebKit-based and Mozilla Firefox).* WebKit-based: blocks the site window, but you still can navigate through Developer Tools panel.
Firefox: does not* block the site window, but still won't let you use DevTools.
$3
Type: boolean Default: false##### :warning: Can freeze your browser! Use at own risk.
If checked, an interval is used to force the debug mode on the Console tab, making it harder to use other features of the Developer Tools. Works if
is enabled.$3
Type: boolean Default: falseDisables the use of
, console.info, console.error, console.warn, console.debug, console.exception and console.trace by replacing them with empty functions. This makes the use of the debugger harder.$3
Type: string[] Default: []Locks the obfuscated source code so it only runs on specific domains and/or sub-domains. This makes really hard for someone just copy and paste your source code and run elsewhere.
##### Multiple domains and sub-domains
It's possible to lock your code to more than one domain or sub-domain. For instance, to lock it so the code only runs on www.example.com add
, to make it work on any sub-domain from example.com, use .example.com.$3
Type: string[] Default: []A file names or globs which indicates files to exclude from obfuscation.
$3
Type: Default: hexadecimalSets identifier names generator.
Available values:
*
: identifier names like _0xabc123
* : short identifier names like a, b, c$3
Type: Default: ''Sets prefix for all global identifiers.
Use this option when you want to obfuscate multiple files. This option helps to avoid conflicts between global identifiers of these files. Prefix should be different for every file.
$3
Type: Default: ''Allows to set name of the input file with source code. This name will used internally for source map generation.
$3
Type: Default: falseEnables logging of the information to the console.
$3
Type: Default: false##### :warning: this option can break your code. Enable it only if you know what it does!
Enables obfuscation of global variable and function names with declaration.
$3
Type: Default: []Disables obfuscation and generation of identifiers, which being matched by passed RegExp patterns.
Example:
ts
{
reservedNames: [
'^someVariable',
'functionParameter_\d'
]
}
`$3
Type: Default: []Disables transformation of string literals, which being matched by passed RegExp patterns.
Example:
ts
{
reservedStrings: [
'react-native',
'\.\/src\/test',
'some-string_\d'
]
}
`$3
Type: Default: true must be enabledShift the
stringArray array by a fixed and random (generated at the code obfuscation) places. This makes it harder to match the order of the removed strings to their original place.This option is recommended if your original source code isn't small, as the helper function can attract attention.
$3
Type: number Default: 0This option sets seed for random generator. This is useful for creating repeatable results.
If seed is
- random generator will work without seed.$3
Type: boolean Default: false##### :warning: Don't change obfuscated code in any way after obfuscation with this option, because any change like uglifying of code can trigger self defending and code wont work anymore!
##### :warning: This option forcibly sets
value to trueThis option makes the output code resilient against formatting and variable renaming. If one tries to use a JavaScript beautifier on the obfuscated code, the code won't work anymore, making it harder to understand and modify it.
$3
Type: Default: falseEnables source map generation for obfuscated code.
Source maps can be useful to help you debug your obfuscated JavaScript source code. If you want or need to debug in production, you can upload the separate source map file to a secret location and then point your browser there.
$3
Type: Default: .
CLI example:
`
javascript-obfuscator input.js --output out.js --sourceMap true --sourceMapBaseUrl 'http://localhost:9000'
Result:
//# sourceMappingURL=http://localhost:9000/out.js.map
$3
Type: Default: Sets file name for output source map when
.CLI example:
`
javascript-obfuscator input.js --output out.js --source-map true --source-map-base-url 'http://localhost:9000' --source-map-file-name example
Result:
//# sourceMappingURL=http://localhost:9000/example.js.map
$3
Type: Default: separateSpecifies source map generation mode:
*
- emit a single file with source maps instead of having a separate file;
* separate - generates corresponding '.map' file with source map. In case you run obfuscator through CLI - adds link to source map file to the end of file with obfuscated code //# sourceMappingUrl=file.js.map.$3
Type: boolean Default: trueRemoves string literals and place them in a special array. For instance, the string
in var m = "Hello World"; will be replaced with something like var m = _0x12c456[0x1];
$3
Type: Default: false##### :warning:
option must be enabledThis option can slow down your script.
stringArray using base64 or rc4 and inserts a special code that used to decode it back at runtime.Available values:
*
true (boolean): encode stringArray values using base64
* (boolean): don't encode stringArray values
* 'base64' (string): encode stringArray values using base64
* (string): encode stringArray values using rc4. About 30-50% slower than base64, but more harder to get initial values. It is recommended to disable unicodeEscapeSequence option with rc4 encoding to prevent very large size of obfuscated code.
$3
Type: number Default: 0.8 Min: 0 Max: 1 option must be enabledYou can use this setting to adjust the probability (from 0 to 1) that a string literal will be inserted into the
stringArray.This setting is especially useful for large code size because it repeatedly calls to the
string array and can slow down your code.stringArrayThreshold: 0 equals to stringArray: false.$3
Type: string Default: browserAllows to set target environment for obfuscated code.
Available values:
*
;
* browser-no-eval;
* node.Currently output code for
browser and node targets is identical.
Output code for browser-no-eval target is not using eval.$3
Type: boolean Default: falseEnables transformation of object keys.
Example:
ts
// input
(function(){
var object = {
foo: 'test1',
bar: {
baz: 'test2'
}
};
})();// output
var _0x5a21 = [
'foo',
'test1',
'bar',
'baz',
'test2'
];
var _0x223f = function (_0x474dc0, _0x10db96) {
_0x474dc0 = _0x474dc0 - 0x0;
var _0x4c8bf7 = _0x5a21[_0x474dc0];
return _0x4c8bf7;
};
(function () {
var _0x2e1a8e = {};
_0x2e1a8e[_0x223f('0x0')] = _0x223f('0x1');
_0x2e1a8e[_0x223f('0x2')] = {};
_0x2e1a8e[_0x223f('0x2')][_0x223f('0x3')] = _0x223f('0x4');
}());
`$3
Type: Default: falseAllows to enable/disable string conversion to unicode escape sequence.
Unicode escape sequence increases code size greatly and strings easily can be reverted to their original view. Recommended to enable this option only for small source code.
Preset Options
$3
Performance will 50-100% slower than without obfuscation
javascript
{
compact: true,
controlFlowFlattening: true,
controlFlowFlatteningThreshold: 1,
deadCodeInjection: true,
deadCodeInjectionThreshold: 1,
debugProtection: true,
debugProtectionInterval: true,
disableConsoleOutput: true,
identifierNamesGenerator: 'hexadecimal',
log: false,
renameGlobals: false,
rotateStringArray: true,
selfDefending: true,
stringArray: true,
stringArrayEncoding: 'rc4',
stringArrayThreshold: 1,
transformObjectKeys: true,
unicodeEscapeSequence: false
}
`$3
Performance will 30-35% slower than without obfuscation
javascript
{
compact: true,
controlFlowFlattening: true,
controlFlowFlatteningThreshold: 0.75,
deadCodeInjection: true,
deadCodeInjectionThreshold: 0.4,
debugProtection: false,
debugProtectionInterval: false,
disableConsoleOutput: true,
identifierNamesGenerator: 'hexadecimal',
log: false,
renameGlobals: false,
rotateStringArray: true,
selfDefending: true,
stringArray: true,
stringArrayEncoding: 'base64',
stringArrayThreshold: 0.75,
transformObjectKeys: true,
unicodeEscapeSequence: false
}
`$3
Performance will slightly slower than without obfuscation
javascript
{
compact: true,
controlFlowFlattening: false,
deadCodeInjection: false,
debugProtection: false,
debugProtectionInterval: false,
disableConsoleOutput: true,
identifierNamesGenerator: 'hexadecimal',
log: false,
renameGlobals: false,
rotateStringArray: true,
selfDefending: true,
stringArray: true,
stringArrayEncoding: false,
stringArrayThreshold: 0.75,
unicodeEscapeSequence: false
}
`Frequently Asked Questions
$3
, es5, es2015, es2016 and es2017$3
The README on the master branch might not match that of the latest stable release.
$3
Try to run
command or install it globally with npm i -g javascript-obfuscator$3
Likely this is mechanism. Something is changing source code after obfuscation with selfDefending` option.$3
$3
No. JSX support isn't planned.
Backers
Support us with a monthly donation and help us continue our activities. [Become a backer]
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]
License
Copyright (C) 2016-2018 Timofey Kachalov.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.