@russcarver/ngx-source-obfuscation

ngx-source-obfuscation

Angular Builder CLI which integrates the javascript-obfuscation project into angular.

Getting Started

Prerequisites

• Package manager like yarn or npm
• Angular 8 or higher.

Installing

Yarn

yarn add -D @russcarver/ngx-source-obfuscation

Npm

npm i -D @russcarver/ngx-source-obfuscation

Version Table

Version	Angular
^1.0.0	8
^2.0.0	9
^16.0.0	16
^17.0.0	17
^18.0.0	18

Angular Setup

Create a target in your angular.json file. Like the one shown bellow. Other targets like lint or build are located in the same place.

Important make sure your levels of obfuscation and performance is suitable for your project! The default parameters are most likely not what you want.

Example:

{
  "obfuscate": {
    "builder": "@russcarver/ngx-source-obfuscation:obfuscate",
    "options": {
      "files": [
        {
          "fileExtensions": ["js"],
          "filePatternsToExclude": ["polyfills"],
          "input": "dist",
          "output": "."
        }
      ]
    },
    "configurations": {
      "production": {
        "debugProtection": true,
        "debugProtectionInterval": true,
        "sourceMap": false
      }
    }
  }
}

Files options

1. fileExtensions (required). This is an array of strings representing exact, case-insensitive file extensions of files you want to obfuscate.
2. filePatternsToExclude (optional). This is an array of case-insensitive strings representing strings, that if found anywhere in the filename or extension (or combined aka: a full name.ext), will be excluded from obfuscation.
3. input (required). This is the relative input path in which to search for files. It will search 30 nested directories deep from this path.
4. output (required). This is the relative output path from the input path in which to place the obfuscated results.

If the output path refers to the same directory as the input path, then files are obfuscated in-place (existing files are modified). A Live Demo of the obfuscation library https://obfuscator.io/ is provided by the author of the library. A list of available configuration options can be found here

Running the task

General

The angular cli target can be invoked like every other target <project>:<target>:<configuration>.

Examples

Yarn

"Dev Build"

yarn ng run app:obfuscate

Prod Build

yarn ng run app:obfuscate:production

Npm

"Dev Build"

npx ng run app:obfuscate

Prod Build

npx ng run app:obfuscate:production

Built With

• Angular-Devkti - Used to create the builder.
• Yarn - Dependency Management
• javascript-obfuscator - The library which does all the work.
• multi-stage-sourcemap - Used to merge the source maps of Angular build output and javascript-obfuscator.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Nicolas Schäfli - Initial work - d3r1w
• Russ Carver - Angular 16-19 upgrades - russcarver

Acknowledgments

• Huge thanks to Timofey Kachalov, contributers and supporters of the javascript-obfuscator project.

License

This project is licensed under the GPL-v3 License - see the LICENSE.md file for details

@russcarver/ngx-source-obfuscation Copyright (C) 2023-2024

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Changelog

[18.0.0] - 2024-10-02

Added

• Angular 18 support
• BREAKING CHANGES:
  1. Glob support has been removed due to it also being removed from the underlying implementation of readdirp.
     • You must now use fileExtensions (string array, required) and, filePatternsToExclude (string array, optional).