Build Automation - CI/CD Integration

Verimatrix Counterspy provides features for CI/CD integration. These allow protection to be integrated into any build pipeline. Integration features are available to customers on the Standard tier. You can upgrade your account from the Platform.

Access CI/CD integration by clicking Overview in the Counterspy left navigation area. The Overview panels in the main area are displayed.

Clicking Setup CI/CD opens detailed documentation on using the CI/CD capability.

A summary follows, but please also refer to the detailed live documentation on the system.

Integration Methods

Detailed documentation for CI/CD integration is available by clicking Setup CI/CD.

Rest APIs

Verimatrix Counterspy provides REST APIs for integration with external systems. Details of the API are documented here.

Github

If you are using Github, we provide a Github Action for Counterspy.

CLI tool

A command line tool (CLI) is available through Github and can be downloaded here.

The command to run is:

aps.py -v -c <API_KEY_GUID> -s <API_KEY_SECRET> protect --file <APP_FILE>
Where:

<API_KEY_GUID> and <API_KEY_SECRET> are taken from the key you create in the CI/CD Integration menu (see below).

<APP_FILE> is the APK, AAB or xcarchive you wish to protect.

This script installs the dependencies required by the CLI tool:

\# !/bin/sh -l

python -m pip install coloredlogs python -m pip install js2py python -m pip install dateutil python -m pip install python-dateutil --upgrade python -m pip install requests python -m pip install pyaxmlparser

Authentication

To use any of the integration methods, you require an API Key to authenticate the integration with Counterspy.

In the CI/CD integration panel, clickManage API Keys. This will open the API Key management window as shown below (note that the key values have been partially redacted).

Add generates a new key. The table will show the corresponding API Key GUID and API Key Secret.

This information can be used now by the CLI to create a protected application.

Clicking on the sub-menu button for any particular key opens a menu allowing deletion or easy copying of the values.