Verimatrix XTD provides features for CI/CD integration. These allow XTD protection to be integrated into any build pipeline.

On the Overview page, select Setup CI/CD for up-to-date APS (Application Protection Service) API documentation.

API Key Manager

Verimatrix provides REST APIs for integration with external systems. To use any of the integration methods, you require an API key to authenticate the integration. Create and retrieve keys in the platform under the Settings menu in the API Key Manager panel.

Access API keys and documentation from Settings at the top right of the screen:

From the Settings dropdown, select API Key Manager to view your API keys, generate new keys, or learn about how to use the keys.

For detailed instructions, select How to Use API Keys at the top right of the API Key Manager screen.

Generate New API Key

Select Generate New API Key to generate a new key.

The generated key is downloaded. Store it in a secure location.

{
  "appClientId": "7m.........0s5i",
  "appClientSecret": "cm1m65g.......jt",
  "encodedKey": "Njd.........tbzBzNW.......0"
}

NOTE Make sure you record the owner (username - email) of the generated key, as it is also required for authentication.

CI/CD GitHub Action

The Verimatrix GitHub Action automates the protection of your mobile applications within your GitHub workflows.

Prerequisites

• A Verimatrix XTD or Counterspy subscription
• An API key obtained from the Verimatrix Platform

Usage

To incorporate the GitHub Action into your workflow, add the following step to your GitHub Actions YAML file:

- name: Protect App with Verimatrix
        uses: verimatrix/[email protected]
        with:
          app-file: path/to/your/app.apk
          api-key-secret: ${{ secrets.APP_CLIENT_SECRET }}

Replace the placeholders with your actual values:

• app-file: Path to your application's file
• api-key-secret: Value of the 'encodedKey' from your API key file

For more configuration options refer to the GitHub Action page.

App Protection CLI Tool

For environments outside GitHub or for more customized workflows, Verimatrix provides the vmx-aps command-line interface (CLI) tool, available as a Python package on PyPI.

Installation

Ensure you have Python 3 installed, then install the CLI tool using pip:

$ pip install vmx-aps

Usage

After installation, you can use the vmx-aps command to protect your application:

$ vmx-aps --api-key-file "~~/Downloads/api-key.json " protect --file "~~/my-app.apk"

Replace the placeholders with your actual values:

• --api-key-file: Path to your api-key.json file
• --file: Path to your application file

For more detailed usage instructions and options, refer the vmx-aps PyPI page.