iXGuard Protect

Protect your iOS archive with iXGuard.

Description

Protect your app archive before export to take advantage of the advanced security features offered by iXGuard.

Configuring the Step

Before you start:

• You will need to have installed iXGuard to the workspace. This can be done using the Step Install iXGuard
• Make sure at the root of your project there can be found a valid ixguard.yml configuration file.

To configure the Step:

1. License Url: Specifies a url for where the iXGuard license file can be downloaded.
2. Archive Path: Specifies the xcarchive that should be protected with iXGuard.

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

Example

workflows:
  example:
    steps:
      - certificate-and-profile-installer@1: {}
      - git::git@github.com:npinney/bitrise-step-install-ixguard.git@main:
          inputs:
            - version: "4.12.2"
      - xcode-archive@5:
          inputs:
            - configuration: Release
            - artifact_name: unprotected
            - xcodebuild_options: -toolchain "com.guardsquare.ixguard"
      - git::git@github.com:npinney/bitrise-step-install-ixguard.git@main: {}

⚙️ Configuration

Inputs

Key	Description	Flags	Default
license_url	License file is required when running iXGuard. It is a text file containing permissions for each app bundle ID.	required	$BITRISEIO_IXGUARD_LICENSE_URL
archive_path	The built-with-ixguard-toolchain xcarchive path.	required	$BITRISE_XCARCHIVE_PATH

Outputs

Environment Variable	Description
PROTECTED_ARCHIVE	The obfuscated and encrypted .xcarchive file's path.
IXGUARD_GENERATED_FILES	All files generated by ixguard (mapping, log, etc) are compressed into a directory located at this path. When paired with Deploy to Bitrise.io this folder will appear in the artifacts of the build.

Learn more about developing steps:

• Create your own step
• Testing your Step