vmx-aps 2.2.0__tar.gz

vmx_aps-2.2.0/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2025 Verimatrix
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vmx_aps-2.2.0/MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

vmx_aps-2.2.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.2
+Name: vmx-aps
+Version: 2.2.0
+Summary: APS command line wrapper
+Author: Verimatrix Inc.
+Author-email: blackhole@verimatrix.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: pyaxmlparser
+Requires-Dist: backoff
+Requires-Dist: coloredlogs
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: requires-dist
+Dynamic: summary
+
+APS command line wrapper

vmx_aps-2.2.0/README.md

@@ -0,0 +1,49 @@
+# APS API/CLI library
+
+Set up virtual environment:
+
+```
+$ pipenv install -d
+```
+
+Enter the venv
+
+```
+$ pipenv shell
+```
+
+Run all unit tests
+
+```
+$ pytest
+```
+
+Run all unit tests with extra logging
+
+```
+$ pytest -v
+```
+
+Run all unit tests and capture covarage
+
+```
+$ coverage run -m pytest
+```
+
+Display coverage report
+
+```
+$ coverage report
+```
+
+Install CLI in you virtual environment
+
+```
+$ pip install -e .
+```
+
+Run commands eg:
+
+```
+$ vmx-aps --api-key-file ~/Downloads/api-key.json get_version
+```

vmx_aps-2.2.0/apsapi/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (c) 2025. Verimatrix. All Rights Reserved.
+# All information in this file is Verimatrix Confidential and Proprietary.

vmx_aps-2.2.0/apsapi/aps.py

@@ -0,0 +1,524 @@
+#!/usr/bin/python
+# Copyright (c) 2025. Verimatrix. All Rights Reserved.
+# All information in this file is Verimatrix Confidential and Proprietary.
+'''Entrypoint for APS CLI'''
+import argparse
+import json
+import logging
+import os
+import sys
+import traceback
+
+from .aps_api import ApsApi
+import coloredlogs
+
+LOGGER = logging.getLogger(__name__)
+
+SUBSCRIPTION_TYPES=['APPSHIELD_PLATFORM',
+                    'COUNTERSPY_PLATFORM',
+                    'XTD_PLATFORM']
+
+# set environment variables that control coloredlog module output
+os.environ['COLOREDLOGS_LOG_FORMAT'] = '%(levelname)s: %(message)s'
+os.environ['COLOREDLOGS_FIELD_STYLES'] = ''
+os.environ['COLOREDLOGS_LEVEL_STYLES'] = 'debug=blue;info=green;warning=yellow;' +\
+                                      'error=red;critical=red,bold'
+
+def supported_commands():
+    '''Returns the list of supported commands'''
+    return ['protect',
+            'list-applications',
+            'add-application',
+            'update-application',
+            'delete-application',
+            'set-signing-certificate',
+            'set-mapping-file',
+            'list-builds',
+            'add-build',
+            'delete-build',
+            'protect-start',
+            'protect-get-status',
+            'protect-cancel',
+            'protect-download',
+            'get-account-info',
+            'display-application-package-id',
+            'get-sail-config',
+            'get-version' ]
+
+class Aps:
+    '''Class encapsulating all supported command line options'''
+    def __init__(self):
+
+        self.commands = None
+
+        parser = argparse.ArgumentParser(
+            description='APS command line tool',
+            usage='''vmx-aps [global-options] <command> [<command-options>]
+    The following commands are available
+
+      * protect
+
+      * list-applications
+      * add-application
+      * update-application
+      * delete-application
+      * set-signing-certificate
+      * set-mapping-file
+
+      * list-builds
+      * add-build
+      * delete-build
+
+      * protect-start
+      * protect-get-status
+      * protect-cancel
+      * protect-download
+
+      * get-account-info
+      * display-application-package-id
+      * get-sail-config
+      * get-version
+    
+    
+    Use vmx-aps <command> -h for information on a specific command.
+    Use vmx-aps -h for information on the global options.
+     ''')
+
+        parser.add_argument('command', help='Command to run')
+
+        group = parser.add_mutually_exclusive_group(required=True)
+
+        group.add_argument('-a', '--api-key', type=str, help='The value of "encodedKey" from api-key.json file.')
+
+        group.add_argument('--api-key-file', type=str, help='Path to api-key.json file')
+
+        parser.add_argument('-l', '--logging', type=str,
+                            help='Logging Level',
+                            choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])
+       
+        parser.add_argument('--api-gateway-url', type=str, required=False, help='Optional API gateway URL')
+        parser.add_argument('--access-token-url', type=str, required=False, help='Optional Access token URL')
+
+        # find the index of the command argument
+        self.command_pos = len(sys.argv)
+        i = 0
+        for arg in sys.argv[1:]:
+            i += 1
+            if arg in supported_commands():
+                self.command_pos = i + 1
+                break
+
+        # parse_args defaults to [1:] for args, but we exclude the command arguments
+        # Defer parsing and validation of the global args (initialize_from_global_args method)
+        # until we have parsed the command arguments. Otherwise this would prevent
+        # running aps.py COMMAND -h to get help on the COMMAND arguments unless
+        # all mandatory global args were to be supplied.
+        args = parser.parse_args(sys.argv[1:self.command_pos])
+
+        # python doesn't allow for hyphens in method names
+        mapped_command = args.command.replace('-', '_')
+
+        if not hasattr(self, mapped_command):
+            print('Unrecognized command')
+            parser.print_help()
+            sys.exit(1)
+
+        # invoke command
+        try:
+            response = getattr(self, mapped_command)(args)
+            if response is not None:
+                if isinstance(response, str):
+                    print(response)
+                else:
+                    print(json.dumps(response, indent=2, sort_keys=True))
+        except Exception:
+            traceback.print_exc()
+            sys.exit(1)
+
+    def initialize_from_global_args(self, args):
+        '''Parse global command line arguments'''
+        if args.logging:
+            coloredlogs.install(level=args.logging)
+
+        api_key = None
+        if args.api_key:
+            try:
+                # Attempt to parse the string as JSON
+                data = json.loads(args.api_key)
+                api_key = data.get("encodedKey")
+            except json.JSONDecodeError:
+                api_key = args.api_key
+        elif args.api_key_file:
+            try:
+                with open(args.api_key_file, 'r') as f:
+                    data = json.load(f)
+                    api_key = data.get("encodedKey")
+            except FileNotFoundError:
+                LOGGER.error(f"API key file not found: {args.api_key_file}")
+                sys.exit(1)
+            except json.JSONDecodeError:
+                LOGGER.error(f"Failed to parse JSON in API key file: {args.api_key_file}")
+                sys.exit(1)
+        else:
+            LOGGER.error('Missing API key. Provide API key with either -a/--api-key argument, or use --api_key_file argument to point to api-key.json file.')
+            sys.exit(1)
+       
+        self.commands = ApsApi(api_key=api_key, api_gateway_url=args.api_gateway_url, access_token_url=args.access_token_url)
+        
+        self.commands.ensure_authenticated()
+
+    def protect(self, global_args):
+        '''Perform APS protection from an input file.
+
+        This is a high level command that takes an input
+        binary to be protected, performs protection and outputs the protected
+        binary. This command may take many minutes to complete.'''
+
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps protect [<args>]',
+            description='Perform APS protection on the input file.')
+
+        parser.add_argument('--file', type=str, required=True,
+                            help='Build file (aab, apk or zipped xcarchive folder)')
+        parser.add_argument('--subscription-type', type=str, required=False,
+                            help='Subscription Type',
+                            choices=SUBSCRIPTION_TYPES)
+        parser.add_argument('--signing-certificate', type=str, required=False,
+                            help='PEM encoded certificate file.')
+        parser.add_argument('--mapping-file', type=str, required=False,
+                            help='R8/Proguard mapping file for android')
+
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+
+        return self.commands.protect(args.file,
+                                     signing_certificate=args.signing_certificate,
+                                     subscription_type=args.subscription_type,
+                                     mapping_file=args.mapping_file)
+
+    def get_account_info(self, global_args):
+        '''Get info about the user and organization'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps get-account-info [<args>]',
+            description='Returns information about the user and organization (customer)')
+
+        parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.get_account_info()
+
+    def add_application(self, global_args):
+        '''Add a new application'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps add-application [<args>]',
+            description='''Add a new application. By default the application is
+            accessible to other users within your organization. The --private, --no-upload,
+            --no-delete options can be used to restrict access to the application.
+            ''')
+        parser.add_argument('--os', type=str, required=True,
+                            choices=['ios', 'android'], help='Operating System.')
+        parser.add_argument('--name', type=str, required=True,
+            help='Friendly name for application.')
+        parser.add_argument('--package-id', type=str, required=True, help='Application package ID.')
+        parser.add_argument('--group', type=str, required=False, help='Optional group identifier.')
+        parser.add_argument('--subscription-type', type=str, required=False,
+                            help='Subscription Type',
+                            choices=SUBSCRIPTION_TYPES)
+        parser.add_argument('--private',
+                            help='''Prevent the application from being visible to other users.
+                            This option will automatically set each of --no-upload
+                            and --no-delete options.''',
+                            action='store_true', default=False)
+        parser.add_argument('--no-upload',
+                            help='Prevent other users from uploading new builds for this app.',
+                            action='store_true', default=False)
+        parser.add_argument('--no-delete',
+                            help='Prevent other users from deleting builds for this app.',
+                            action='store_true', default=False)
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+        permissions = {}
+        permissions['private'] = args.private
+        permissions['no_upload'] = args.no_upload
+        permissions['no_delete'] = args.no_delete
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.add_application(args.name,
+                                             args.package_id,
+                                             args.os,
+                                             permissions,
+                                             args.group,
+                                             args.subscription_type)
+
+    def update_application(self, global_args):
+        '''Update application properties'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps update-application [<args>]',
+            description='''Update application properties. The application name and
+            permission related properties can be modified''')
+        parser.add_argument('--application-id', type=str, required=True,
+                            help='''Application ID. This identifies the application whose
+                            properties should be updated, this property cannot itself be
+                            changed. The remaining arguments correspond to application
+                            properties that can be updated by this call.''')
+        parser.add_argument('--name', type=str, required=True, help='Friendly name for application')
+        parser.add_argument('--private',
+                            help='''Prevent the app from being visible to other users. This option
+                            will automatically set each of the --no-upload
+                            and --no-delete options.''',
+                            action='store_true', default=False)
+        parser.add_argument('--no-upload',
+                            help='Prevent other users from uploading new builds for this app.',
+                            action='store_true', default=False)
+        parser.add_argument('--no-delete',
+                            help='Prevent other users from deleting builds for this app.',
+                            action='store_true', default=False)
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+        permissions = {}
+        permissions['private'] = args.private
+        permissions['no_upload'] = args.no_upload
+        permissions['no_delete'] = args.no_delete
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.update_application(args.application_id, args.name, permissions)
+
+    def list_applications(self, global_args):
+        '''List applications'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps list-applications [<args>]',
+            description='''List applications.
+            Optional "application-id" or "group" parameters can be specified to restrict
+            the list of applications that are reported by this call.
+
+            When the "application-id" parameter is provided this operation returns the
+            specific application identified by "application-id".
+
+            When the "group" parameter is provided this operation returns all
+            applications belonging to the specified group.
+
+            When neither "application-id" or "group" are provided this operation returns the
+            list of all applications.''')
+        parser.add_argument('--application-id', type=str, required=False, help='Application ID')
+        parser.add_argument('--group', type=str, required=False,
+            help='Application group identifier')
+        parser.add_argument('--subscription-type', type=str, required=False,
+                            help='Subscription Type',
+                            choices=SUBSCRIPTION_TYPES)
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.list_applications(args.application_id,
+                                               args.group,
+                                               args.subscription_type)
+    def delete_application(self, global_args):
+        '''Delete an application'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps delete-application [<args>]',
+            description='''Delete application. This operation will also delete all builds
+            belonging to this application.''')
+        parser.add_argument('--application-id', type=str, required=True, help='Application ID')
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.delete_application(args.application_id)
+
+    def list_builds(self, global_args):
+        '''List builds'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps list-builds [<args>]',
+            description='''List builds.
+
+            Optional "application-id" or "build-id" parameters can be specified to restrict
+            the list of builds that are reported by this call.
+
+            When the "application-id" parameter is provided this operation returns the list
+            of builds for that particular application. When the "build-id" parameter is
+            provided this operation returns the specific build identified by "build-id".
+
+            When neither "application-id" or "build-id" are provided this operation returns
+            all builds.''')
+
+        parser.add_argument('--application-id', type=str, required=False, help='Application ID')
+        parser.add_argument('--build-id', type=str, required=False, help='Build ID')
+        parser.add_argument('--subscription-type', type=str, required=False,
+                            help='Subscription Type',
+                            choices=SUBSCRIPTION_TYPES)
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.list_builds(args.application_id, args.build_id, args.subscription_type)
+
+    def add_build(self, global_args):
+        '''Add a new build'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-add-build [<args>]',
+            description='Add a new build')
+
+        parser.add_argument('--application-id', type=str, required=True, help='Application ID')
+        parser.add_argument('--file', type=str, required=False,
+                            help='Build file (apk or xcarchive folder)')
+        parser.add_argument('--subscription-type', type=str, required=False,
+                            help='Subscription Type',
+                            choices=SUBSCRIPTION_TYPES)
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.add_build(args.file, application_id=args.application_id, subscription_type=args.subscription_type)
+
+    def delete_build(self, global_args):
+        '''Delete a build'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps delete-build [<args>]',
+            description='Delete build')
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.delete_build(args.build_id)
+
+    def protect_start(self, global_args):
+        '''Start build protection'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps protect-start [<args>]',
+            description='Initiate protection of a previously added build')
+
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.protect_start(args.build_id)
+
+    def protect_cancel(self, global_args):
+        '''Cancel protection of a build'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps protect-cancel [<args>]',
+            description='Cancel protection of a build.')
+
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.protect_cancel(args.build_id)
+
+    def protect_get_status(self, global_args):
+        '''Get the status of a build'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps protect-get-status [<args>]',
+            description='''Get the status of a build. This includes progress
+            information when a protection build is ongoing.''')
+
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.protect_get_status(args.build_id)
+
+    def protect_download(self, global_args):
+        '''Download a protected build'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps protect-download [<args>]',
+            description='Download a previously protected build.')
+
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.protect_download(args.build_id)
+
+    def display_application_package_id(self, global_args):
+        '''Utility to extract and display the application package id from a file.'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps display_application_package_id [<args>]',
+            description='''Display the application package id for a input file.
+            This can be used as input when calling add-application.
+            ''')
+
+        parser.add_argument('--file', type=str, required=True,
+                            help='Input file (apk or xcarchive folder)')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.display_application_package_id(args.file)
+
+    def set_signing_certificate(self, global_args):
+        '''Set signing certificate'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps set-signing-certificate [<args>]',
+            description='''Set signing certificate for an application.''')
+        parser.add_argument('--application-id', type=str, required=True, help='Application ID')
+        parser.add_argument('--file', type=str, required=False,
+            help='PEM encoded certificate file. If omitted, this unsets the current certificate')
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.set_signing_certificate(args.application_id, args.file)
+
+    def set_mapping_file(self, global_args):
+        '''Set mapping file'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps set-mapping-file [<args>]',
+            description='''Set r8/proguard mapping file for an Android build.''')
+        parser.add_argument('--build-id', type=str, required=True, help='Build ID')
+        parser.add_argument('--file', type=str, required=True,
+            help='R8/Proguard mapping file for android')
+
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.set_mapping_file(args.build_id, args.file)
+
+    def get_sail_config(self, global_args):
+        '''Get SAIL configuration'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps get-sail-config [<args>]',
+            description='Get SAIL configuration.')
+
+        parser.add_argument('--os', type=str, required=True, help='OS',
+                            choices=['ios', 'android'])
+        parser.add_argument('--version', type=str, required=False, help='Version')
+        # inside subcommands ignore the first command_pos argv's
+        args = parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.get_sail_config(args.os, args.version)
+
+    def get_version(self, global_args):
+        '''Get Version'''
+        parser = argparse.ArgumentParser(
+            usage='vmx-aps get-version [<args>]',
+            description='Get version.')
+
+        # inside subcommands ignore the first command_pos argv's
+        parser.parse_args(sys.argv[self.command_pos:])
+
+        self.initialize_from_global_args(global_args)
+        return self.commands.get_version()
+
+def main():
+    Aps()
+
+if __name__ == '__main__':
+    main()