Merge pull request #234 from javascript-obfuscator/import-specifier-obfuscation

Import specifier obfuscation

src/JavaScriptObfuscator.ts

@@ -61,6 +61,7 @@ export class JavaScriptObfuscator implements IJavaScriptObfuscator {
         NodeTransformer.CatchClauseTransformer,
         NodeTransformer.FunctionDeclarationTransformer,
         NodeTransformer.FunctionTransformer,
+        NodeTransformer.ImportDeclarationTransformer,
         NodeTransformer.LabeledStatementTransformer,
         NodeTransformer.LiteralTransformer,
         NodeTransformer.MemberExpressionTransformer,

src/container/modules/node-transformers/ObfuscatingTransformersModule.ts

@@ -16,6 +16,7 @@ import { CatchClauseTransformer } from '../../../node-transformers/obfuscating-t
 import { ClassDeclarationTransformer } from '../../../node-transformers/obfuscating-transformers/ClassDeclarationTransformer';
 import { FunctionDeclarationTransformer } from '../../../node-transformers/obfuscating-transformers/FunctionDeclarationTransformer';
 import { FunctionTransformer } from '../../../node-transformers/obfuscating-transformers/FunctionTransformer';
+import { ImportDeclarationTransformer } from '../../../node-transformers/obfuscating-transformers/ImportDeclarationTransformer';
 import { LabeledStatementTransformer } from '../../../node-transformers/obfuscating-transformers/LabeledStatementTransformer';
 import { LiteralTransformer } from '../../../node-transformers/obfuscating-transformers/LiteralTransformer';
 import { NumberLiteralObfuscatingReplacer } from '../../../node-transformers/obfuscating-transformers/obfuscating-replacers/literal-obfuscating-replacers/NumberLiteralObfuscatingReplacer';
@@ -40,6 +41,10 @@ export const obfuscatingTransformersModule: interfaces.ContainerModule = new Con
         .to(FunctionTransformer)
         .whenTargetNamed(NodeTransformer.FunctionTransformer);
 
+    bind<INodeTransformer>(ServiceIdentifiers.INodeTransformer)
+        .to(ImportDeclarationTransformer)
+        .whenTargetNamed(NodeTransformer.ImportDeclarationTransformer);
+
     bind<INodeTransformer>(ServiceIdentifiers.INodeTransformer)
         .to(LabeledStatementTransformer)
         .whenTargetNamed(NodeTransformer.LabeledStatementTransformer);

src/enums/node-transformers/NodeTransformer.ts

@@ -9,6 +9,7 @@ export enum NodeTransformer {
     CatchClauseTransformer = 'CatchClauseTransformer',
     FunctionDeclarationTransformer = 'FunctionDeclarationTransformer',
     FunctionTransformer = 'FunctionTransformer',
+    ImportDeclarationTransformer = 'ImportDeclarationTransformer',
     LabeledStatementTransformer = 'LabeledStatementTransformer',
     LiteralTransformer = 'LiteralTransformer',
     MemberExpressionTransformer = 'MemberExpressionTransformer',

src/enums/node/NodeType.ts

@@ -19,6 +19,9 @@ export enum NodeType {
     Identifier = 'Identifier',
     IfStatement = 'IfStatement',
     ImportDeclaration = 'ImportDeclaration',
+    ImportDefaultSpecifier = 'ImportDefaultSpecifier',
+    ImportNamespaceSpecifier = 'ImportNamespaceSpecifier',
+    ImportSpecifier = 'ImportSpecifier',
     LabeledStatement = 'LabeledStatement',
     Literal = 'Literal',
     LogicalExpression = 'LogicalExpression',

src/node-transformers/obfuscating-transformers/ImportDeclarationTransformer.ts

@@ -0,0 +1,173 @@
+import { inject, injectable, } from 'inversify';
+import { ServiceIdentifiers } from '../../container/ServiceIdentifiers';
+
+import * as estraverse from 'estraverse';
+import * as ESTree from 'estree';
+
+import { TIdentifierObfuscatingReplacerFactory } from "../../types/container/node-transformers/TIdentifierObfuscatingReplacerFactory";
+import { TImportSpecifier } from '../../types/node/TimportSpecifier';
+import { TNodeWithBlockScope } from '../../types/node/TNodeWithBlockScope';
+
+import { IIdentifierObfuscatingReplacer } from '../../interfaces/node-transformers/obfuscating-transformers/obfuscating-replacers/IIdentifierObfuscatingReplacer';
+import { IOptions } from '../../interfaces/options/IOptions';
+import { IRandomGenerator } from '../../interfaces/utils/IRandomGenerator';
+import { IVisitor } from '../../interfaces/node-transformers/IVisitor';
+
+import { IdentifierObfuscatingReplacer } from "../../enums/node-transformers/obfuscating-transformers/obfuscating-replacers/IdentifierObfuscatingReplacer";
+import { TransformationStage } from '../../enums/node-transformers/TransformationStage';
+
+import { AbstractNodeTransformer } from '../AbstractNodeTransformer';
+import { NodeGuards } from '../../node/NodeGuards';
+import { NodeMetadata } from '../../node/NodeMetadata';
+import { NodeUtils } from '../../node/NodeUtils';
+
+/**
+ * replaces:
+ *     import foo from './foo';
+ *     import * as bar from './bar';
+ *
+ * on:
+ *     import _0x12d45f from './foo';
+ *     import * as _0x12d45f from './bar';
+ */
+@injectable()
+export class ImportDeclarationTransformer extends AbstractNodeTransformer {
+    /**
+     * @type {IIdentifierObfuscatingReplacer}
+     */
+    private readonly identifierObfuscatingReplacer: IIdentifierObfuscatingReplacer;
+
+    /**
+     * @type {Map<ESTree.Node, ESTree.Identifier[]>}
+     */
+    private readonly replaceableIdentifiers: Map <ESTree.Node, ESTree.Identifier[]> = new Map();
+
+    /**
+     * @param {TIdentifierObfuscatingReplacerFactory} identifierObfuscatingReplacerFactory
+     * @param {IRandomGenerator} randomGenerator
+     * @param {IOptions} options
+     */
+    constructor (
+        @inject(ServiceIdentifiers.Factory__IIdentifierObfuscatingReplacer)
+            identifierObfuscatingReplacerFactory: TIdentifierObfuscatingReplacerFactory,
+        @inject(ServiceIdentifiers.IRandomGenerator) randomGenerator: IRandomGenerator,
+        @inject(ServiceIdentifiers.IOptions) options: IOptions
+    ) {
+        super(randomGenerator, options);
+
+        this.identifierObfuscatingReplacer = identifierObfuscatingReplacerFactory(
+            IdentifierObfuscatingReplacer.BaseIdentifierObfuscatingReplacer
+        );
+    }
+
+    /**
+     * @param {TImportSpecifier} importSpecifierNode
+     * @returns {boolean}
+     */
+    private static isProhibitedImportSpecifierNode (importSpecifierNode: TImportSpecifier): boolean {
+        return NodeGuards.isImportSpecifierNode(importSpecifierNode)
+            && importSpecifierNode.imported.name === importSpecifierNode.local.name;
+    }
+
+    /**
+     * @param {TransformationStage} transformationStage
+     * @returns {IVisitor | null}
+     */
+    public getVisitor (transformationStage: TransformationStage): IVisitor | null {
+        switch (transformationStage) {
+            case TransformationStage.Obfuscating:
+                return {
+                    enter: (node: ESTree.Node, parentNode: ESTree.Node | null) => {
+                        if (parentNode && NodeGuards.isImportDeclarationNode(node)) {
+                            return this.transformNode(node, parentNode);
+                        }
+                    }
+                };
+
+            default:
+                return null;
+        }
+    }
+
+    /**
+     * @param {ImportDeclaration} importDeclarationNode
+     * @param {Node} parentNode
+     * @returns {Node}
+     */
+    public transformNode (importDeclarationNode: ESTree.ImportDeclaration, parentNode: ESTree.Node): ESTree.Node {
+        const nodeIdentifier: number = this.nodeIdentifier++;
+        const blockScopeNode: TNodeWithBlockScope = NodeUtils.getBlockScopesOfNode(importDeclarationNode)[0];
+
+        this.storeImportSpecifierNames(importDeclarationNode, nodeIdentifier);
+
+        // check for cached identifiers for current scope node. If exist - loop through them.
+        if (this.replaceableIdentifiers.has(blockScopeNode)) {
+            this.replaceScopeCachedIdentifiers(blockScopeNode, nodeIdentifier);
+        } else {
+            this.replaceScopeIdentifiers(blockScopeNode, nodeIdentifier);
+        }
+
+        return importDeclarationNode;
+    }
+
+    /**
+     * @param {ImportDefaultSpecifier | ImportNamespaceSpecifier} importDeclarationNode
+     * @param {number} nodeIdentifier
+     */
+    private storeImportSpecifierNames (importDeclarationNode: ESTree.ImportDeclaration, nodeIdentifier: number): void {
+        importDeclarationNode.specifiers.forEach((importSpecifierNode: TImportSpecifier) => {
+            if (ImportDeclarationTransformer.isProhibitedImportSpecifierNode(importSpecifierNode)) {
+                return;
+            }
+
+            this.identifierObfuscatingReplacer.storeGlobalName(importSpecifierNode.local.name, nodeIdentifier);
+        });
+    }
+
+    /**
+     * @param {TNodeWithBlockScope} blockScopeNode
+     * @param {number} nodeIdentifier
+     */
+    private replaceScopeCachedIdentifiers (blockScopeNode: TNodeWithBlockScope, nodeIdentifier: number): void {
+        const cachedReplaceableIdentifiers: ESTree.Identifier[] = <ESTree.Identifier[]>this.replaceableIdentifiers.get(blockScopeNode);
+
+        cachedReplaceableIdentifiers.forEach((replaceableIdentifier: ESTree.Identifier) => {
+            const newReplaceableIdentifier: ESTree.Identifier = this.identifierObfuscatingReplacer
+                .replace(replaceableIdentifier.name, nodeIdentifier);
+
+            replaceableIdentifier.name = newReplaceableIdentifier.name;
+            NodeMetadata.set(replaceableIdentifier, { renamedIdentifier: true });
+        });
+    }
+
+    /**
+     * @param {TNodeWithBlockScope} blockScopeNode
+     * @param {number} nodeIdentifier
+     */
+    private replaceScopeIdentifiers (blockScopeNode: TNodeWithBlockScope, nodeIdentifier: number): void {
+        const storedReplaceableIdentifiers: ESTree.Identifier[] = [];
+
+        estraverse.replace(blockScopeNode, {
+            enter: (node: ESTree.Node, parentNode: ESTree.Node | null): void => {
+                if (
+                    parentNode
+                    && NodeGuards.isReplaceableIdentifierNode(node, parentNode)
+                    && !NodeMetadata.isRenamedIdentifier(node)
+                ) {
+                    const newIdentifier: ESTree.Identifier = this.identifierObfuscatingReplacer
+                        .replace(node.name, nodeIdentifier);
+                    const newIdentifierName: string = newIdentifier.name;
+
+                    if (node.name !== newIdentifierName) {
+                        node.name = newIdentifierName;
+                        NodeMetadata.set(node, { renamedIdentifier: true });
+                    } else {
+                        storedReplaceableIdentifiers.push(node);
+                    }
+                }
+            }
+        });
+
+        this.replaceableIdentifiers.set(blockScopeNode, storedReplaceableIdentifiers);
+    }
+}

src/node/NodeGuards.ts

@@ -152,6 +152,30 @@ export class NodeGuards {
         return node.type === NodeType.ImportDeclaration;
     }
 
+    /**
+     * @param {Node} node
+     * @returns {boolean}
+     */
+    public static isImportDefaultSpecifierNode (node: ESTree.Node): node is ESTree.ImportDefaultSpecifier {
+        return node.type === NodeType.ImportDefaultSpecifier;
+    }
+
+    /**
+     * @param {Node} node
+     * @returns {boolean}
+     */
+    public static isImportNamespaceSpecifierNode (node: ESTree.Node): node is ESTree.ImportNamespaceSpecifier {
+        return node.type === NodeType.ImportNamespaceSpecifier;
+    }
+
+    /**
+     * @param {Node} node
+     * @returns {boolean}
+     */
+    public static isImportSpecifierNode (node: ESTree.Node): node is ESTree.ImportSpecifier {
+        return node.type === NodeType.ImportSpecifier;
+    }
+
     /**
      * @param {Node} node
      * @param {Node} parentNode

src/types/node/TimportSpecifier.d.ts

@@ -0,0 +1,5 @@
+import * as ESTree from 'estree';
+
+export type TImportSpecifier = ESTree.ImportSpecifier
+    | ESTree.ImportDefaultSpecifier
+    | ESTree.ImportNamespaceSpecifier;

test/functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/ImportDeclarationTransformer.spec.ts

@@ -0,0 +1,152 @@
+import { assert } from 'chai';
+
+import { IObfuscationResult } from '../../../../../src/interfaces/IObfuscationResult';
+
+import { NO_ADDITIONAL_NODES_PRESET } from '../../../../../src/options/presets/NoCustomNodes';
+
+import { getRegExpMatch } from '../../../../helpers/getRegExpMatch';
+import { readFileAsString } from '../../../../helpers/readFileAsString';
+
+import { JavaScriptObfuscator } from '../../../../../src/JavaScriptObfuscatorFacade';
+
+describe('ImportDeclarationTransformer', () => {
+    describe('transformation of `importSpecifier` node identifiers', () => {
+        describe('Variant #1: `defaultImportSpecifier` node', () => {
+            const importSpecifierRegExp: RegExp = /import (_0x[a-f0-9]{4,6}) from *'\.\/foo';/;
+            const consoleLogRegExp: RegExp = /console\['log']\((_0x[a-f0-9]{4,6})\);/;
+
+            let obfuscatedCode: string,
+                importSpecifierIdentifier: string,
+                consoleLogIdentifier: string;
+
+            before(() => {
+                const code: string = readFileAsString(__dirname + '/fixtures/default-import.js');
+                const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(
+                    code,
+                    {
+                        ...NO_ADDITIONAL_NODES_PRESET
+                    }
+                );
+
+                obfuscatedCode = obfuscationResult.getObfuscatedCode();
+                importSpecifierIdentifier = getRegExpMatch(obfuscatedCode, importSpecifierRegExp);
+                consoleLogIdentifier = getRegExpMatch(obfuscatedCode, consoleLogRegExp);
+            });
+
+            it('should transform import specifier identifier name', () => {
+                assert.equal(importSpecifierIdentifier, consoleLogIdentifier);
+            });
+        });
+
+        describe('Variant #2: `namespaceImportSpecifier` node', () => {
+            const importSpecifierRegExp: RegExp = /import *\* *as *(_0x[a-f0-9]{4,6}) *from *'\.\/foo';/;
+            const consoleLogRegExp: RegExp = /console\['log']\((_0x[a-f0-9]{4,6})\);/;
+
+            let obfuscatedCode: string,
+                importSpecifierIdentifier: string,
+                consoleLogIdentifier: string;
+
+            before(() => {
+                const code: string = readFileAsString(__dirname + '/fixtures/namespace-import.js');
+                const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(
+                    code,
+                    {
+                        ...NO_ADDITIONAL_NODES_PRESET
+                    }
+                );
+
+                obfuscatedCode = obfuscationResult.getObfuscatedCode();
+                importSpecifierIdentifier = getRegExpMatch(obfuscatedCode, importSpecifierRegExp);
+                consoleLogIdentifier = getRegExpMatch(obfuscatedCode, consoleLogRegExp);
+            });
+
+            it('should transform import specifier identifier name', () => {
+                assert.equal(importSpecifierIdentifier, consoleLogIdentifier);
+            });
+        });
+
+        describe('Variant #3: named `importSpecifier` node', () => {
+            describe('Variant #1: named import specifier with same `import` and `local` names', () => {
+                const importSpecifierRegExp: RegExp = /import *{foo} *from *'\.\/foo';/;
+                const consoleLogRegExp: RegExp = /console\['log']\(foo\);/;
+
+                let obfuscatedCode: string;
+
+                before(() => {
+                    const code: string = readFileAsString(__dirname + '/fixtures/named-import-1.js');
+                    const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(
+                        code,
+                        {
+                            ...NO_ADDITIONAL_NODES_PRESET
+                        }
+                    );
+
+                    obfuscatedCode = obfuscationResult.getObfuscatedCode();
+                });
+
+                it('Match #1: shouldn\'t transform import specifier identifier name', () => {
+                    assert.match(obfuscatedCode, importSpecifierRegExp);
+                });
+
+                it('Match #2: shouldn\'t transform import specifier identifier name', () => {
+                    assert.match(obfuscatedCode, consoleLogRegExp);
+                });
+            });
+
+            describe('Variant #2: named import specifier with different `import` and `local` names', () => {
+                const importSpecifierRegExp: RegExp = /import *{foo as (_0x[a-f0-9]{4,6})} *from *'\.\/foo';/;
+                const consoleLogRegExp: RegExp = /console\['log']\((_0x[a-f0-9]{4,6})\);/;
+
+                let obfuscatedCode: string,
+                    importSpecifierIdentifier: string,
+                    consoleLogIdentifier: string;
+
+                before(() => {
+                    const code: string = readFileAsString(__dirname + '/fixtures/named-import-2.js');
+                    const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(
+                        code,
+                        {
+                            ...NO_ADDITIONAL_NODES_PRESET
+                        }
+                    );
+
+                    obfuscatedCode = obfuscationResult.getObfuscatedCode();
+                    importSpecifierIdentifier = getRegExpMatch(obfuscatedCode, importSpecifierRegExp);
+                    consoleLogIdentifier = getRegExpMatch(obfuscatedCode, consoleLogRegExp);
+                });
+
+                it('should transform import specifier identifier name', () => {
+                    assert.equal(importSpecifierIdentifier, consoleLogIdentifier);
+                });
+            });
+        });
+
+        describe('Variant #4: `identifiersPrefix` option', () => {
+            const importSpecifierRegExp: RegExp = /import *\* *as *(bark_0x[a-f0-9]{4,6}) *from *'\.\/foo';/;
+            const consoleLogRegExp: RegExp = /console\['log']\((bark_0x[a-f0-9]{4,6})\);/;
+
+            let obfuscatedCode: string,
+                importSpecifierIdentifier: string,
+                consoleLogIdentifier: string;
+
+            before(() => {
+                const code: string = readFileAsString(__dirname + '/fixtures/namespace-import.js');
+                const obfuscationResult: IObfuscationResult = JavaScriptObfuscator.obfuscate(
+                    code,
+                    {
+                        ...NO_ADDITIONAL_NODES_PRESET,
+                        identifiersPrefix: 'bark'
+                    }
+                );
+
+                obfuscatedCode = obfuscationResult.getObfuscatedCode();
+                importSpecifierIdentifier = getRegExpMatch(obfuscatedCode, importSpecifierRegExp);
+                consoleLogIdentifier = getRegExpMatch(obfuscatedCode, consoleLogRegExp);
+            });
+
+            it('should transform import specifier identifier name', () => {
+                assert.equal(importSpecifierIdentifier, consoleLogIdentifier);
+            });
+        });
+    });
+});

test/functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/fixtures/default-import.js

@@ -0,0 +1,2 @@
+import foo from './foo';
+console.log(foo);

test/functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/fixtures/named-import-1.js

@@ -0,0 +1,2 @@
+import {foo} from './foo';
+console.log(foo);

test/functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/fixtures/named-import-2.js

@@ -0,0 +1,2 @@
+import {foo as bar} from './foo';
+console.log(bar);

test/functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/fixtures/namespace-import.js

@@ -0,0 +1,2 @@
+import * as foo from './foo';
+console.log(foo);

test/index.spec.ts

@@ -62,6 +62,7 @@ import './functional-tests/node-transformers/obfuscating-transformers/catch-clau
 import './functional-tests/node-transformers/obfuscating-transformers/class-declaration-transformer/ClassDeclarationTransformer.spec';
 import './functional-tests/node-transformers/obfuscating-transformers/function-declaration-transformer/FunctionDeclarationTransformer.spec';
 import './functional-tests/node-transformers/obfuscating-transformers/function-transformer/FunctionTransformer.spec';
+import './functional-tests/node-transformers/obfuscating-transformers/impot-declaration-transformer/ImportDeclarationTransformer.spec';
 import './functional-tests/node-transformers/obfuscating-transformers/labeled-statement-transformer/LabeledStatementTransformer.spec';
 import './functional-tests/node-transformers/obfuscating-transformers/literal-transformer/LiteralTransformer.spec';
 import './functional-tests/node-transformers/obfuscating-transformers/variable-declaration-transformer/VariableDeclarationTransformer.spec';