step.yml

title: Install iXGuard
summary: Download and install Guardsquare and iXGuard.
description: |-
  Downloads and installs guardsquare and ixguard in order to process and protect an archive. If the correct version of iXGuard is already detected, the download will be skipped.

  ### Configuring the Step

  To be able to use the Step, you need to create and register an ssh key to grant permission to Guardsquare.

  1. Create key pair using `ssh-keygen`.
  2. Create a secure passphrase for your private key.
  3. Upload the public key `.pub` to your Guardsquare account.
  4. Upload the private key file to the **Files** secion of your Bitrise project.
  5. Create a **Secret Env Variable** for the private key passphrase (make sure to escape any special characters with a `\` before saving).
  6. If your file download URL or Secret Env Variable does not correspond with the defaults, make sure you list them as inputs to the Step.
website: https://github.com/petalmd/bitrise-step-install-ixguard
source_code_url: https://github.com/petalmd/bitrise-step-install-ixguard
support_url: https://github.com/petalmd/bitrise-step-install-ixguard/issues
project_type_tags:
  - ios
  - react-native
type_tags:
  - installer
is_always_run: false
is_skippable: false
deps:
  brew:
  - name: expect
toolkit:
  bash:
    entry_file: step.sh
inputs:
  - version: $IXGUARD_VERSION
    opts:
      title: Version
      summary: Specify which version of iXGuard you'd like to download and install.
      description: Default is 4.12.6. If a different version is detected, the Step will install the correct version.
      is_expand: true
      is_required: true
      value_options: []
  - ssh_key_file: $BITRISEIO_GUARDSQUARE_SSH_KEY_FILE_URL
    opts:
      title: SSH Private Key Url
      summary: Private key download link to grant access to Guardsquare.
      description: |- 
        After generating the key-pair, make sure that you upload the public key to Guardsquare and add the
        private key file to the *Files* section of Bitrise found under *Project Settings*.
      is_expand: true
      is_required: true
      value_options: []
  - ssh_key_passphrase: $GUARDSQUARE_SSH_KEY_PASSPHRASE
    opts:
      title: SSH Private Key Passphrase
      summary: Passphrase used to decrypt the ssh private key.
      description: This should be stored in your bitrise secrets. Make sure special symbols have been escaped.
      is_expand: true
      is_required: true
      value_options: []