🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@bytehide/react-native-shield

Package Overview
Dependencies
Maintainers
0
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@bytehide/react-native-shield

React Native plugin for ByteHide Shield obfuscation.

1.0.18
latest
npm
Version published
Weekly downloads
83
1085.71%
Maintainers
0
Weekly downloads
 
Created
Source

ByteHide React Native Shield Plugin

This README provides step-by-step instructions for integrating and using the ByteHide React Native Shield Plugin for obfuscating your React Native project's source code.

Installation

Install the plugin as a development dependency in your project:

npm install @bytehide/react-native-shield --save-dev

Usage Options

1. Using a Standalone Script

You can create a standalone script to perform obfuscation manually.

  • Create a script file in the root of your project, e.g., obfuscate.js, and add the following:
  const shield = require('@bytehide/react-native-shield');

const distDir = './dist';                       // Path to the dist directory
const projectToken = 'your_project_token';      // Project token    
const replace = true;                           // Whether to replace the original files or save as new files
const excludePatterns = [];                     // Patterns to exclude from obfuscation
const obfuscatedExtension = '.obf';             // Extension for obfuscated files

shield
  .obfuscate(distDir, projectToken, replace, excludePatterns, obfuscatedExtension)
  .then(() => console.log('Obfuscation completed successfully!'))
  .catch((err) => console.error('Error during obfuscation:', err));
  • Run the script manually when needed:

    node obfuscate.js
    

2. Adding to package.json Scripts

Include the obfuscation step as a script in your project's package.json:

  • Modify package.json:

    "scripts": {
      "obfuscate": "node obfuscate.js"
    }
    
  • Execute the obfuscation script:

    npm run obfuscate
    

3. Integration into Build Processes

For Android (build.gradle)

  • Add a custom task to android/app/build.gradle:

    task obfuscateJs(type: Exec) {
        commandLine "node", "${project.rootDir}/obfuscate.js"
    }
    
    preBuild.dependsOn obfuscateJs
    

For iOS (Run Script in Xcode)

  • Go to Build Phases > + Add Run Script Phase in Xcode.

  • Add the following script:

    node "$SRCROOT/../obfuscate.js"
    

4. Adding a Custom CLI Command

You can integrate the obfuscation step as a custom React Native CLI command.

  • Add the following to react-native.config.js:
   module.exports = {
    commands: [
        {
            name: 'obfuscate',
            func: () => {
                const shield = require('@bytehide/react-native-shield');
                const distDir = './dist'; // Path to the dist directory
                const projectToken = process.env.BYTEHIDE_PROJECT_TOKEN || 'your_project_token';

                if (projectToken === 'your_project_token') {
                    console.error('Project token is required. Please provide it as an argument or set the BYTEHIDE_PROJECT_TOKEN environment variable.');
                    process.exit(1);
                }

                // Optional parameters: replace, excludePatterns, obfuscatedExtension
                const replace = false;              // If true, the original files will be replaced with the obfuscated files
                const excludePatterns = [];         // Patterns to exclude from obfuscation
                const obfuscatedExtension = '.obf'; // Extension for obfuscated files       

                shield
                    .obfuscate(distDir, projectToken, replace, excludePatterns, obfuscatedExtension)
                    .then(() => console.log('Obfuscation completed successfully!'))
                    .catch((err) => console.error('Error during obfuscation:', err));
            },
        },
    ],
};
  • Run the command:

    npx react-native obfuscate
    

5. Using the bin Command

You can use the bin command to obfuscate your project.

npx @bytehide/react-native-shield obfuscate --src ./dist --projectToken your_project_token --replace false --obfuscatedExtension .obf --exclude "*.test.js, *.spec.js"

This command will obfuscate the files in the ./dist directory, excluding any files matching the patterns *.test.js and *.spec.js. If --replace is set to true, the original files will be replaced with the obfuscated files, omitting the --obfuscatedExtension parameter.

License

MIT

Happy coding but keep it safe with @bytehide/react-native-shield! 🛡️

Keywords

security

FAQs

Package last updated on 26 Nov 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