Repository navigation
Expand file tree
/
Copy pathJavaScriptObfuscatorCLI.ts
More file actions
528 lines (481 loc) · 19.9 KB
/
Copy pathJavaScriptObfuscatorCLI.ts
File metadata and controls
528 lines (481 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
/* eslint-disable max-lines */
import * as commander from 'commander';
import * as path from 'path';
import { TInputCLIOptions } from '../types/options/TInputCLIOptions';
import { TInputOptions } from '../types/options/TInputOptions';
import { IFileData } from '../interfaces/cli/IFileData';
import { IInitializable } from '../interfaces/IInitializable';
import { IObfuscatedCode } from '../interfaces/source-code/IObfuscatedCode';
import { initializable } from '../decorators/Initializable';
import { IdentifierNamesGenerator } from '../enums/generators/identifier-names-generators/IdentifierNamesGenerator';
import { LoggingPrefix } from '../enums/logger/LoggingPrefix';
import { ObfuscationTarget } from '../enums/ObfuscationTarget';
import { OptionsPreset } from '../enums/options/presets/OptionsPreset';
import { RenamePropertiesMode } from '../enums/node-transformers/rename-properties-transformers/RenamePropertiesMode';
import { SourceMapMode } from '../enums/source-map/SourceMapMode';
import { StringArrayEncoding } from '../enums/node-transformers/string-array-transformers/StringArrayEncoding';
import { StringArrayIndexesType } from '../enums/node-transformers/string-array-transformers/StringArrayIndexesType';
import { StringArrayWrappersType } from '../enums/node-transformers/string-array-transformers/StringArrayWrappersType';
import { DEFAULT_PRESET } from '../options/presets/Default';
import { ArraySanitizer } from './sanitizers/ArraySanitizer';
import { BooleanSanitizer } from './sanitizers/BooleanSanitizer';
import { CLIUtils } from './utils/CLIUtils';
import { JavaScriptObfuscator } from '../JavaScriptObfuscatorFacade';
import { Logger } from '../logger/Logger';
import { ObfuscatedCodeWriter } from './utils/ObfuscatedCodeWriter';
import { SourceCodeReader } from './utils/SourceCodeReader';
import { Utils } from '../utils/Utils';
export class JavaScriptObfuscatorCLI implements IInitializable {
/**
* @type {string[]}
*/
public static readonly availableInputExtensions: string[] = [
'.js'
];
/**
* @type {BufferEncoding}
*/
public static readonly encoding: BufferEncoding = 'utf8';
/**
* @type {string}
*/
public static readonly obfuscatedFilePrefix: string = '-obfuscated';
/**
* @type {commander.CommanderStatic}
*/
@initializable()
private commands!: commander.CommanderStatic;
/**
* @type {TInputCLIOptions}
*/
@initializable()
private inputCLIOptions!: TInputCLIOptions;
/**
* @type {string}
*/
@initializable()
private inputPath!: string;
/**
* @type {SourceCodeReader}
*/
@initializable()
private sourceCodeReader!: SourceCodeReader;
/**
* @type {ObfuscatedCodeWriter}
*/
@initializable()
private obfuscatedCodeWriter!: ObfuscatedCodeWriter;
/**
* @type {string[]}
*/
private readonly arguments: string[];
/**
* @type {string[]}
*/
private readonly rawArguments: string[];
/**
* @param {string[]} argv
*/
public constructor (argv: string[]) {
this.rawArguments = argv;
this.arguments = argv.slice(2);
}
/**
* @param {TInputCLIOptions} inputOptions
* @returns {TInputOptions}
*/
private static buildOptions (inputOptions: TInputCLIOptions): TInputOptions {
const inputCLIOptions: TInputOptions = JavaScriptObfuscatorCLI.filterOptions(inputOptions);
const configFilePath: string | undefined = inputOptions.config;
const configFileLocation: string = configFilePath ? path.resolve(configFilePath, '.') : '';
const configFileOptions: TInputOptions = configFileLocation ? CLIUtils.getUserConfig(configFileLocation) : {};
return {
...DEFAULT_PRESET,
...configFileOptions,
...inputCLIOptions
};
}
/**
* @param {TObject} options
* @returns {TInputOptions}
*/
private static filterOptions (options: TInputCLIOptions): TInputOptions {
const filteredOptions: TInputOptions = {};
Object
.keys(options)
.forEach((option: keyof TInputCLIOptions) => {
if (options[option] === undefined) {
return;
}
filteredOptions[option] = options[option];
});
return filteredOptions;
}
public initialize (): void {
this.commands = <commander.CommanderStatic>(new commander.Command());
this.configureCommands();
this.configureHelp();
this.inputPath = path.normalize(this.commands.args[0] || '');
this.inputCLIOptions = JavaScriptObfuscatorCLI.buildOptions(this.commands.opts());
this.sourceCodeReader = new SourceCodeReader(
this.inputPath,
this.inputCLIOptions
);
this.obfuscatedCodeWriter = new ObfuscatedCodeWriter(
this.inputPath,
this.inputCLIOptions
);
}
public run (): void {
const canShowHelp: boolean = !this.arguments.length || this.arguments.includes('--help');
if (canShowHelp) {
this.commands.outputHelp();
return;
}
const sourceCodeData: IFileData[] = this.sourceCodeReader.readSourceCode();
this.processSourceCodeData(sourceCodeData);
}
private configureCommands (): void {
this.commands
.usage('<inputPath> [options]')
.version(
Utils.buildVersionMessage(process.env.VERSION, process.env.BUILD_TIMESTAMP),
'-v, --version'
)
.option(
'-o, --output <path>',
'Output path for obfuscated code'
)
.option(
'--compact <boolean>',
'Disable one line output code compacting',
BooleanSanitizer
)
.option(
'--config <boolean>',
'Name of js / json config file'
)
.option(
'--control-flow-flattening <boolean>',
'Enables control flow flattening',
BooleanSanitizer
)
.option(
'--control-flow-flattening-threshold <number>',
'The probability that the control flow flattening transformation will be applied to the node',
parseFloat
)
.option(
'--dead-code-injection <boolean>',
'Enables dead code injection',
BooleanSanitizer
)
.option(
'--dead-code-injection-threshold <number>',
'The probability that the dead code injection transformation will be applied to the node',
parseFloat
)
.option(
'--debug-protection <boolean>',
'Disable browser Debug panel (can cause DevTools enabled browser freeze)',
BooleanSanitizer
)
.option(
'--debug-protection-interval <boolean>',
'Disable browser Debug panel even after page was loaded (can cause DevTools enabled browser freeze)',
BooleanSanitizer
)
.option(
'--disable-console-output <boolean>',
'Allow console.log, console.info, console.error and console.warn messages output into browser console',
BooleanSanitizer
)
.option(
'--domain-lock <list> (comma separated, without whitespaces)',
'Allows to run the obfuscated source code only on specific domains and/or sub-domains (comma separated)',
ArraySanitizer
)
.option(
'--exclude <list> (comma separated, without whitespaces)',
'A filename or glob which indicates files to exclude from obfuscation',
ArraySanitizer
)
.option(
'--force-transform-strings <list> (comma separated, without whitespaces)',
'Enables force transformation of string literals, which being matched by passed RegExp patterns (comma separated)',
ArraySanitizer
)
.option(
'--identifier-names-generator <string>',
'Sets identifier names generator. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(IdentifierNamesGenerator)}. ` +
`Default: ${IdentifierNamesGenerator.HexadecimalIdentifierNamesGenerator}`
)
.option(
'--identifiers-prefix <string>',
'Sets prefix for all global identifiers'
)
.option(
'--identifiers-dictionary <list> (comma separated, without whitespaces)',
'Identifiers dictionary (comma separated) for `--identifier-names-generator dictionary` option',
ArraySanitizer
)
.option(
'--ignore-require-imports <boolean>', 'Prevents obfuscation of `require` imports',
BooleanSanitizer
)
.option(
'--log <boolean>', 'Enables logging of the information to the console',
BooleanSanitizer
)
.option(
'--numbers-to-expressions <boolean>', 'Enables numbers conversion to expressions',
BooleanSanitizer
)
.option(
'--options-preset <string>',
'Allows to set options preset. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(OptionsPreset)}. ` +
`Default: ${OptionsPreset.Default}`
)
.option(
'--reserved-names <list> (comma separated, without whitespaces)',
'Disables obfuscation and generation of identifiers, which being matched by passed RegExp patterns (comma separated)',
ArraySanitizer
)
.option(
'--reserved-strings <list> (comma separated, without whitespaces)',
'Disables transformation of string literals, which being matched by passed RegExp patterns (comma separated)',
ArraySanitizer
)
.option(
'--rename-globals <boolean>', 'Allows to enable obfuscation of global variable and function names with declaration',
BooleanSanitizer
)
.option(
'--rename-properties <boolean>', 'UNSAFE: Enables renaming of property names. This probably MAY break your code',
BooleanSanitizer
)
.option(
'--rename-properties-mode <boolean>',
'Specify `--rename-properties` option mode. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(RenamePropertiesMode)}. ` +
`Default: ${RenamePropertiesMode.Safe}`
)
.option(
'--rotate-string-array <boolean>', 'Enable rotation of string array values during obfuscation',
BooleanSanitizer
)
.option(
'--seed <string|number>',
'Sets seed for random generator. This is useful for creating repeatable results.',
parseFloat
)
.option(
'--self-defending <boolean>',
'Disables self-defending for obfuscated code',
BooleanSanitizer
)
.option(
'--shuffle-string-array <boolean>', 'Randomly shuffles string array items',
BooleanSanitizer
)
.option(
'--simplify <boolean>', 'Enables additional code obfuscation through simplification',
BooleanSanitizer
)
.option(
'--source-map <boolean>',
'Enables source map generation',
BooleanSanitizer
)
.option(
'--source-map-base-url <string>',
'Sets base url to the source map import url when `--source-map-mode=separate`'
)
.option(
'--source-map-file-name <string>',
'Sets file name for output source map when `--source-map-mode=separate`'
)
.option(
'--source-map-mode <string>',
'Specify source map output mode. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(SourceMapMode)}. ` +
`Default: ${SourceMapMode.Separate}`
)
.option(
'--split-strings <boolean>',
'Splits literal strings into chunks with length of `splitStringsChunkLength` option value',
BooleanSanitizer
)
.option(
'--split-strings-chunk-length <number>',
'Sets chunk length of `splitStrings` option',
parseFloat
)
.option(
'--string-array <boolean>',
'Disables gathering of all literal strings into an array and replacing every literal string with an array call',
BooleanSanitizer
)
.option(
'--string-array-encoding <list> (comma separated, without whitespaces)',
'Encodes each string in strings array using base64 or rc4 (this option can slow down your code speed). ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayEncoding)}. ` +
`Default: ${StringArrayEncoding.None}`,
ArraySanitizer
)
.option(
'--string-array-indexes-type <list> (comma separated, without whitespaces)',
'Encodes each string in strings array using base64 or rc4 (this option can slow down your code speed). ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayIndexesType)}. ` +
`Default: ${StringArrayIndexesType.HexadecimalNumber}`,
ArraySanitizer
)
.option(
'--string-array-index-shift <boolean>',
'Enables additional index shift for all string array calls',
BooleanSanitizer
)
.option(
'--string-array-wrappers-count <number>',
'Sets the count of wrappers for the string array inside each root or function scope',
parseInt
)
.option(
'--string-array-wrappers-chained-calls <boolean>',
'Enables the chained calls between string array wrappers',
BooleanSanitizer
)
.option(
'--string-array-wrappers-parameters-max-count <number>',
'Allows to control the maximum number of string array wrappers parameters',
parseInt
)
.option(
'--string-array-wrappers-type <string>',
'Allows to select a type of the wrappers that are appending by the `--string-array-wrappers-count` option. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(StringArrayWrappersType)}. ` +
`Default: ${StringArrayWrappersType.Variable}`
)
.option(
'--string-array-threshold <number>',
'The probability that the literal string will be inserted into stringArray (Default: 0.8, Min: 0, Max: 1)',
parseFloat
)
.option(
'--target <string>',
'Allows to set target environment for obfuscated code. ' +
`Values: ${CLIUtils.stringifyOptionAvailableValues(ObfuscationTarget)}. ` +
`Default: ${ObfuscationTarget.Browser}`
)
.option(
'--transform-object-keys <boolean>',
'Enables transformation of object keys',
BooleanSanitizer
)
.option(
'--unicode-escape-sequence <boolean>',
'Allows to enable/disable string conversion to unicode escape sequence',
BooleanSanitizer
)
.parse(this.rawArguments);
}
private configureHelp (): void {
this.commands.on('--help', () => {
console.log(' Examples:\n');
console.log(' %> javascript-obfuscator input_file_name.js --compact true --self-defending false');
console.log(' %> javascript-obfuscator input_file_name.js --output output_file_name.js --compact true --self-defending false');
console.log(' %> javascript-obfuscator input_directory_name --compact true --self-defending false');
console.log('');
});
}
/**
* @param {IFileData[]} sourceCodeData
*/
private processSourceCodeData (sourceCodeData: IFileData[]): void {
sourceCodeData.forEach(({ filePath, content }: IFileData, index: number) => {
const outputCodePath: string = this.obfuscatedCodeWriter.getOutputCodePath(filePath);
try {
Logger.log(
Logger.colorInfo,
LoggingPrefix.CLI,
`Obfuscating file: ${filePath}...`
);
this.processSourceCode(content, filePath, outputCodePath, index);
} catch (error) {
Logger.log(
Logger.colorInfo,
LoggingPrefix.CLI,
`Error in file: ${filePath}...`
);
throw error;
}
});
}
/**
* @param {string} sourceCode
* @param {string} inputCodePath
* @param {string} outputCodePath
* @param {number | null} sourceCodeIndex
*/
private processSourceCode (
sourceCode: string,
inputCodePath: string,
outputCodePath: string,
sourceCodeIndex: number | null
): void {
const options: TInputOptions = {
...this.inputCLIOptions,
inputFileName: path.basename(inputCodePath),
...sourceCodeIndex !== null && {
identifiersPrefix: Utils.getIdentifiersPrefixForMultipleSources(
this.inputCLIOptions.identifiersPrefix,
sourceCodeIndex
)
}
};
if (options.sourceMap) {
this.processSourceCodeWithSourceMap(sourceCode, outputCodePath, options);
} else {
this.processSourceCodeWithoutSourceMap(sourceCode, outputCodePath, options);
}
}
/**
* @param {string} sourceCode
* @param {string} outputCodePath
* @param {TInputOptions} options
*/
private processSourceCodeWithoutSourceMap (
sourceCode: string,
outputCodePath: string,
options: TInputOptions
): void {
const obfuscatedCode: string = JavaScriptObfuscator.obfuscate(sourceCode, options).getObfuscatedCode();
this.obfuscatedCodeWriter.writeFile(outputCodePath, obfuscatedCode);
}
/**
* @param {string} sourceCode
* @param {string} outputCodePath
* @param {TInputOptions} options
*/
private processSourceCodeWithSourceMap (
sourceCode: string,
outputCodePath: string,
options: TInputOptions
): void {
const outputSourceMapPath: string = this.obfuscatedCodeWriter.getOutputSourceMapPath(
outputCodePath,
options.sourceMapFileName ?? ''
);
options = {
...options,
sourceMapFileName: path.basename(outputSourceMapPath)
};
const obfuscatedCode: IObfuscatedCode = JavaScriptObfuscator.obfuscate(sourceCode, options);
this.obfuscatedCodeWriter.writeFile(outputCodePath, obfuscatedCode.getObfuscatedCode());
if (options.sourceMapMode === SourceMapMode.Separate && obfuscatedCode.getSourceMap()) {
this.obfuscatedCodeWriter.writeFile(outputSourceMapPath, obfuscatedCode.getSourceMap());
}
}
}