webpack-obfuscator

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #android #machine-learning #deep-learning #linux #docker #nodejs #java #cli #kubernetes #vue

webpack-obfuscator

(★ 925)

javascript-obfuscator plugin for Webpack

webpack-obfuscator Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# javascript-obfuscator plugin and loader for Webpack@5

[![npm version](https://badge.fury.io/js/webpack-obfuscator.svg)](https://badge.fury.io/js/webpack-obfuscator)

### Installation

This plugin requires Webpack@5. If you depend on Webpack@4, please use [version 2](https://github.com/javascript-obfuscator/webpack-obfuscator/tree/2.6.0) of the plugin.

Install the plugin with NPM and add it to your devDependencies:

`npm install --save-dev javascript-obfuscator webpack-obfuscator`

### Plugin usage:

```javascript
var WebpackObfuscator = require('webpack-obfuscator');

// ...

// webpack plugins array
plugins: [
    new WebpackObfuscator ({
        rotateStringArray: true
    }, ['excluded_bundle_name.js'])
]
```

### Loader usage:

Define a rule in your webpack config and use the obfuscator-loader as the last of your loaders for your modules. You can add the **enforce: 'post'** flag to ensure the loader will be called after normal loaders:

```javascript
var WebpackObfuscator = require('webpack-obfuscator');

// webpack loader rules array
rules: [
    {
        test: /\.js$/,
        exclude: [
            path.resolve(__dirname, 'excluded_file_name.js')
        ],
        enforce: 'post',
        use: {
            loader: WebpackObfuscator.loader,
            options: {
                rotateStringArray: true
            }
        }
    }
]
```

### obfuscatorOptions
Type: `Object` Default: `null`

Options for [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator). Should be passed exactly like described on their page.

### excludes (plugin only)
Type: `Array` or `String` Default: `[]`

Bundle name is output file name after webpack compilation. With multiple webpack entries you can set bundle name in `output` object with aliases `[name]` or `[id]`.

Syntax for excludes array is syntax for [multimatch](https://github.com/sindresorhus/multimatch) package. You can see examples on package page.

Few syntax examples: `['excluded_bundle_name.js', '**_bundle_name.js'] or 'excluded_bundle_name.js'`

Example:
```
// webpack.config.js
'use strict';

const JavaScriptObfuscator = require('webpack-obfuscator');

module.exports = {
    entry: {
        'abc': './test/input/index.js',
        'cde': './test/input/index1.js'
    },
    output: {
        path: 'dist',
        filename: '[name].js' // output: abc.js, cde.js
    },
    plugins: [
        new JavaScriptObfuscator({
            rotateStringArray: true
        }, ['abc.js'])
    ]
};
```

Can be used to bypass obfuscation of some files.

---

## Pro API Support

The plugin and loader support the [obfuscator.io](https://obfuscator.io) Pro API for cloud-based obfuscation (requires [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator) `^5.0.0`). This allows you to use Virtual Machine-based obfuscation available through the JavaScript Obfuscator Pro API.

### The usage with Pro API

```javascript
var WebpackObfuscator = require('webpack-obfuscator');

plugins: [
    new WebpackObfuscator(
        {
            // obfuscator options
            rotateStringArray: true
        },
        ['excluded_bundle_name.js'],  // excludes
        {
            // Pro API configuration
            apiToken: 'your-api-token-from-obfuscator.io',
            timeout: 300000  // optional, request timeout in ms (default: 5 minutes)
        },
        (message) => {
            // optional progress callback
            console.log('Obfuscation progress:', message);
        }
    )
]
```

### Loader with Pro API

```javascript
var WebpackObfuscator = require('webpack-obfuscator');

rules: [
    {
        test: /\.js$/,
        enforce: 'post',
        use: {
            loader: WebpackObfuscator.loader,
            options: {
                rotateStringArray: true,
                // Pro API configuration
                proApiConfig: {
                    apiToken: 'your-api-token-from-obfuscator.io',
                    timeout: 300000  // optional
                },
                // optional progress callback
                onProgress: (message) => {
                    console.log('Obfuscation progress:', message);
                }
            }
        }
    }
]
```

### Pro API Options

#### proApiConfig
Type: `Object` Default: `undefined`

Configuration object for the Pro API:

| Property | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `apiToken` | `string` | Yes | - | Your API token from [obfuscator.io](https://obfuscator.io) |
| `timeout` | `number` | No | `300000` | Request timeout in milliseconds (5 minutes) |

#### onProgress
Type: `Function` Default: `undefined`

Callback function that receives progress messages during obfuscation.

```typescript
type TProApiProgressCallback = (message: string) => void;
```

### TypeScript Support

The plugin exports TypeScript types for Pro API configuration:

```typescript
import WebpackObfuscator, { IProApiConfig, TProApiProgressCallback } from 'webpack-obfuscator';

const proApiConfig: IProApiConfig = {
    apiToken: 'your-token',
    timeout: 60000
};

const onProgress: TProApiProgressCallback = (message) => {
    console.log(message);
};
```

---

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 <COPYRIGHT HOLDER> BE LIABLE FOR ANY
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.

webpack-obfuscator

webpack-obfuscator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

webpack-obfuscator

webpack-obfuscator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README