Skip to content

Codefend/rollup-plugin-codefend

Repository files navigation

rollup-plugin-codefend

NPM GitHub Workflow Status Bundlephobia Node version NPM

Rollup plugin for code obfuscation based on Codefend

Installation

npm install -D rollup-plugin-codefend

Usage

Step 1: Configuration

Add to your rollup.config.js:

Default options

import { codefend } from "rollup-plugin-codefend";

export default {
  input:...,
  output: ...,
  plugins: [codefend()],
};

Custom options

import { codefend } from "rollup-plugin-codefend";

export default {
  input: ...,
  output: ...,
  plugins: [
    codefend({
      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"],
      },
      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 Ox0 {
  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

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