Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

webpack-plugin-codefend

Package Overview
Dependencies
Maintainers
0
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

webpack-plugin-codefend

Webpack plugin for code obfuscation based on Codefend

  • 3.2.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
13
decreased by-23.53%
Maintainers
0
Weekly downloads
 
Created
Source

webpack-plugin-codefend

GitHub Workflow Status NPM Bundlephobia Node version NPM

Webpack plugin for code obfuscation based on Codefend

Installation

npm install -D webpack-plugin-codefend

Usage

Step 1: Configuration

Add to your webpack.config.js:

Default options
import { WebpackPluginCodefend } from "webpack-plugin-codefend";

export default {
  entry: ...
  output: ...,
  plugins: [new WebpackPluginCodefend()],
};
Custom options
import { WebpackPluginCodefend } from "webpack-plugin-codefend";

export default {
  entry: ...
  output: ...,
  plugins: [
    new WebpackPluginCodefend({
      transformation:{
            // the prefix to use for each obfuscated variable
            prefix: "Ox",

            // control how a specific variable should be obfuscated
            static: [
              {
                from: "predefined_secret",
                to: "123456",
              },
            ],

            //will skip obfuscation for the following words
            ignore: ["node_modules"],

            /* By using everyday words such as books or lorem ipsum in the pool,
            you can subtly obfuscate your code,
            concealing its true nature without making it apparent that obfuscation is occurring.*/
            pool: ["QueenOfHeart"],
      },
      debug: {
            // to display detailed stats about the words that have been obfuscated
            stats: true,
      },
    }),
  ],
};

For a more detailed explanation, refer to the configuration section of the codefend docs.

Step 2: Naming convention

In your code, add prefixes to the words that you want Codefend to encrypt.

Make sure to read the Philosophy behind Codefend obfuscation First to understand why Codefend can work with any code written in any language.

//node js example
//as a starting point:  prefix the words that should be encrypted with l_

class l_Calculator {
  l_sum(l_a, l_b) {
    const l_results = l_a + l_b;
    console.log("node_modules");
    console.log("predefined_secret");
    return l_results;
  }
}

//>>>>>>==== Will Become ======<<<<<<

class QueenOfHeart /* 'QueenOfHeart' defined in pool*/ {
  /* Ox1, Ox2... prefix transformation*/
  Ox1(Ox2, Ox3) {
    const Ox4 = Ox2 + Ox3;
    console.log("node_modules"); // has not been obfuscated
    console.log("123456"); // has transformed from "predefined_secret" to "123456"
    return Ox4;
  }
}
<!-- Html example, can work also with Angular,React,Vue,Svelte... in the same way -->

<html>
  <head>
    <style>
      .l_red {
        color: red;
      }
    </style>
  </head>
  <body>
    <div class="l_red">l_secret</div>
    <div class="l_red">Hello World</div>
  </body>
</html>

<!-- Will Become -->

<html>
  <head>
    <style>
      .Ox1 {
        color: red;
      }
    </style>
  </head>
  <body>
    <div class="Ox1">Ox0</div>
    <div class="Ox1">Hello World</div>
  </body>
</html>

Examples

  1. Node js

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Keywords

FAQs

Package last updated on 18 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc