How to integrate ByteHide Shield with .NET projects?

Install the ByteHide.Shield.Integration NuGet package, configure your project token, and build your project. Protection applies automatically during MSBuild compilation.

Which .NET frameworks are supported by Shield?

Shield supports .NET Framework 4.0+, .NET Core 2.0+, .NET 5-8+, .NET Standard, Xamarin, MAUI, Unity, Blazor, ASP.NET, WPF, and WinRT.

How to configure Shield protection settings?

Configure Shield through MSBuild properties, environment variables, or the bytehide.json configuration file. Set protection levels, exclusions, and runtime options.

How to troubleshoot Shield integration issues?

Enable verbose logging, check build output for error messages, verify project token configuration, and ensure compatible .NET version and MSBuild tools.

How to exclude specific assemblies from protection?

Use the ExcludeAssemblies MSBuild property or add exclusion rules in bytehide.json configuration file to skip protection for specific assemblies or namespaces.

How to verify Shield protection was applied?

Check MSBuild output for Shield processing messages, examine protected assembly metadata, or use reflection tools to verify obfuscation was applied.

How to configure Shield for Unity projects?

Install Shield Unity package, configure project token in Unity settings, enable IL2CPP backend, and ensure compatible Unity version (2019.4+).

How to set up Shield in CI/CD pipelines?

Set project token as environment variable, ensure NuGet package restore, configure MSBuild parameters, and handle licensing for build agents.

Installation & Setup

Shield for iOS is distributed as a Python package and installed via pip. This guide covers installation, verification, and initial setup.

Requirements

Python 3.8 or later
pip package manager
macOS recommended (required for code signing and full Xcode integration)
Linux supported for CI/CD pipelines and headless builds

Install Shield

Install the Shield CLI tool from pip:

Bash

pip install shield-ios

pip install shield-ios

This installs the shield-ios command-line tool and all required dependencies.

Verify Installation

Confirm that Shield is installed correctly:

Bash

shield-ios version

shield-ios version

This displays the installed version and confirms the tool is available in your PATH.

Initialize a Project

Navigate to your iOS project directory and generate a default configuration file:

Bash

cd /path/to/your/ios-project
shield-ios init

cd /path/to/your/ios-project
shield-ios init

This creates a shield-ios.json file with a default configuration template. Open it and add your project token and desired protections.

Dependencies

Shield installs the following dependencies automatically:

Dependency	Purpose
`lief`	Binary parsing and modification
`click`	Command-line interface
`pyyaml`	Configuration file parsing
`colorama`	Terminal output formatting
`pycryptodome`	Cryptographic operations
`requests`	Cloud Panel communication

All dependencies are installed automatically when you run pip install shield-ios.

Updating Shield

To update to the latest version:

Bash

pip install --upgrade shield-ios

pip install --upgrade shield-ios

Virtual Environments

For isolated installations, you can use a Python virtual environment:

Bash

python3 -m venv shield-env
source shield-env/bin/activate
pip install shield-ios

python3 -m venv shield-env
source shield-env/bin/activate
pip install shield-ios

This is useful when you want to keep Shield separate from your system Python packages.

Quick Start - Protect your first application
Xcode Integration - Integrate Shield into your Xcode build
CI/CD Integration - Set up Shield in CI pipelines

Requirements

Install Shield

Verify Installation

Initialize a Project

Dependencies

Updating Shield

Virtual Environments

Related