> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# appdome/build-2secure

Easily secure and customize your mobile apps on CircleCI using the Appdome Build-2Secure Orb. No coding or technical expertise is required. Automate the process of adding security features such as encryption, biometric authentication, and more to your mobile apps. Additionally, sign your app with your own enterprise certificate for added flexibility and control. Get the flexibility and control you need to secure and customize your mobile apps with the Appdome Build-2Secure Orb.


## Commands

### appdome_android_auto_signing

Running Appdome Android auto signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `fusion-set-id-android` | env_var_name | FUSION_SET_ID_ANDROID | Fusion Set with the features you want to add to your android application. |
| `google-play-signing` | boolean | false | This application will be distributed via the Google Play App Signing program. |
| `keystore-alias` | env_var_name | KEYSTORE_ALIAS | The name you assigned to your keystore |
| `keystore-file` | env_var_name | KEYSTORE_FILE | This should be the same keystore file used to sign your Android app when distributing it via Google Play |
| `keystore-key-password` | env_var_name | KEYSTORE_KEY_PASSWORD | This is the specific password defined for your signing key. |
| `keystore-password` | env_var_name | KEYSTORE_PASSWORD | The password used to unlock your keystore. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `second-output` | boolean | false | Second_output_app_file. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `signing-fingerprint` | env_var_name | SIGN_FINGERPRINT | Your unique signing certificate fingerprint is required to tamper-proof Built applications. |
| `team-id` | string |  | your Team's ID. |

### appdome_android_autodev_private_signing

Running Appdome Auto-DEV Android private signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `fusion-set-id-android` | env_var_name | FUSION_SET_ID_ANDROID | Fusion Set with the features you want to add to your android application. |
| `google-play-signing` | boolean | false | This application will be distributed via the Google Play App Signing program. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `signing-fingerprint` | env_var_name | SIGN_FINGERPRINT | Your unique signing certificate fingerprint is required to tamper-proof Built applications. |
| `team-id` | string |  | your Team's ID. |

### appdome_android_private_signing

Running Appdome Android private signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `fusion-set-id-android` | env_var_name | FUSION_SET_ID_ANDROID | Fusion Set with the features you want to add to your android application. |
| `google-play-signing` | boolean | false | This application will be distributed via the Google Play App Signing program. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `second-output` | boolean | false | Second_output_app_file. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `signing-fingerprint` | env_var_name | SIGN_FINGERPRINT | Your unique signing certificate fingerprint is required to tamper-proof Built applications. |
| `team-id` | string |  | your Team's ID. |

### appdome_ios_auto_signing

Running Appdome iOS auto signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `P12-password` | env_var_name | P12_PASSWORD | The password used to unlock your P12/Ketstore certificate file. |
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `entitlements` | env_var_name | ENTITLEMENTS_FILE | A plist file with the entitlements used for the application. Can be obtained from the Derived Data folder in Xcode |
| `fusion-set-id-ios` | env_var_name | FUSION_SET_ID_IOS | Fusion Set with the features you want to add to your iOS application. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `p12-file` | env_var_name | KEYSTORE_P12_FILE | iOS: A P12 certificate file is a certificate and private key concatenated into a single file, protected by a password. |
| `provisioning-profiles` | env_var_name | MOBILE_PROVISION_PROFILE_FILE | A Provisioning Profile allows you to install apps onto your iOS device and includes the signing certificates, a list of supported device identifiers, entitlements, and an App ID. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `team-id` | string |  | your Team's ID. |

### appdome_ios_autodev_private_signing

Running Appdome iOS Auto-DEV private signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `entitlements` | env_var_name | ENTITLEMENTS_FILE | A plist file with the entitlements used for the application. Can be obtained from the Derived Data folder in Xcode |
| `fusion-set-id-ios` | env_var_name | FUSION_SET_ID_IOS | Fusion Set with the features you want to add to your iOS application. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `provisioning-profiles` | env_var_name | MOBILE_PROVISION_PROFILE_FILE | A Provisioning Profile allows you to install apps onto your iOS device and includes the signing certificates, a list of supported device identifiers, entitlements, and an App ID. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `team-id` | string |  | your Team's ID. |

### appdome_ios_private_signing

Running Appdome iOS private signing.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `fusion-set-id-ios` | env_var_name | FUSION_SET_ID_IOS | Fusion Set with the features you want to add to your iOS application. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `provisioning-profiles` | env_var_name | MOBILE_PROVISION_PROFILE_FILE | A Provisioning Profile allows you to install apps onto your iOS device and includes the signing certificates, a list of supported device identifiers, entitlements, and an App ID. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `team-id` | string |  | your Team's ID. |

## Jobs

### appdome_runner

Perform Appdome fusing with all types of Android and iOS signings.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `appFile` | string |  | Absolute path to your app |
| `appdome-api-token` | env_var_name | APPDOME_API_TOKEN | Appdome-provided API token |
| `build-to-test` | enum | NONE | Enter vendor name on which Build to Test will happen. |
| `build-with-logs` | boolean | false | Diagnostic logs are used for troubleshooting application errors. |
| `entitlements` | env_var_name | ENTITLEMENTS_FILE | A plist file with the entitlements used for the application. Can be obtained from the Derived Data folder in Xcode |
| `fusion-set-id-android` | env_var_name | FUSION_SET_ID_ANDROID | Fusion Set with the features you want to add to your android application. |
| `fusion-set-id-ios` | env_var_name | FUSION_SET_ID_IOS | Fusion Set with the features you want to add to your iOS application. |
| `google-play-signing` | boolean | false | This application will be distributed via the Google Play App Signing program. |
| `keystore-alias` | env_var_name | KEYSTORE_ALIAS | The name you assigned to your keystore |
| `keystore-file` | env_var_name | KEYSTORE_FILE | This should be the same keystore file used to sign your Android app when distributing it via Google Play. |
| `keystore-key-password` | env_var_name | KEYSTORE_KEY_PASSWORD | This is the specific password defined for your signing key. |
| `keystore-password` | env_var_name | KEYSTORE_PASSWORD | The password used to unlock your keystore. |
| `output` | string | Appdome_Secured_App | The name of the output fused app. |
| `p12-file` | env_var_name | KEYSTORE_P12_FILE | A P12 certificate file is a certificate and private key concatenated into a single file, protected by a password. |
| `p12-password` | env_var_name | P12_PASSWORD | The password used to unlock your keystore. |
| `provisioning-profiles` | env_var_name | MOBILE_PROVISION_PROFILE_FILE | A Provisioning Profile allows you to install apps onto your iOS device and includes the signing certificates, a list of supported device identifiers, entitlements, and an App ID. |
| `runner` | enum |  | Choose which fusing operation you want to perfom, on which paltform (iOS or Android) and type of sign.
 |
| `second-output` | boolean | false | Second_output_app_file. |
| `sign-overrides` | string |  | Optional parameter - json file overrides to pass arguments to overrides sign parameters. |
| `signing-fingerprint` | env_var_name | SIGN_FINGERPRINT | Your unique signing certificate fingerprint is required to tamper-proof Built applications. |
| `team-id` | string |  | your Team's ID. |

## Examples

### example_android_auto_sign

In this example we are fusing an android app with automatic signing. * The team-id parameter is optional,please remove this line when working on personal workspace. * Default value for google-play-signing parameter is false.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_apk_or_aab_file>
          build-to-test: BITBAR
          build-with-logs: true
          google-play-signing: <true_or_false>
          output: <output_apk_or_aab_or_leave_empty_for_Appdome_Secured_App>
          runner: ANDROID_AUTO_SIGNING
          second-output: true (only for aab input app)
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```

### example_android_autodev_private_sign

In this example we are fusing an android app with auto-DEV private signing. * The team-id parameter is optional,please remove this line when working on personal workspace. * Default value for google-play-signing parameter is false.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_apk_or_aab_file>
          build-to-test: SAUCELABS
          build-with-logs: false
          google-play-signing: <true_or_false>
          output: <output_apk_or_aab_or_leave_empty_for_Appdome_Secured_App>
          runner: ANDROID_AUTO_DEV_SIGNING
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```

### example_android_private_sign

In this example we are fusing an android app with private signing. * The team-id parameter is optional,please remove this line when working on personal workspace. * Default value for google-play-signing parameter is false.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_apk_or_aab_file>
          build-to-test: LAMBDATEST
          google-play-signing: <true_or_false>
          output: <output_apk_or_aab_or_leave_empty_for_Appdome_Secured_App>
          runner: ANDROID_PRIVATE_SIGNING
          second-output: false (only for aab input app)
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```

### example_ios_auto_sign

In this example we are fusing an iOS app with automatic signing. * The team-id parameter is optional,please remove this line when working on personal workspace.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_remote_ipa_download_file_location>
          build-to-test: SAUCELABS
          build-with-logs: false
          output: <output_ipa_or_leave_empty_for_Appdome_Secured_App>
          runner: IOS_AUTO_SIGNING
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```

### example_ios_autodev_private_sign

In this example we are fusing an iOS app with private signing. * The team-id parameter is optional,please remove this line when working on personal workspace.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_remote_ipa_download_file_location>
          build-with-logs: false
          output: <output_ipa_or_leave_empty_for_Appdome_Secured_App>
          runner: IOS_AUTO_DEV_SIGNING
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```

### example_ios_private_sign

In this example we are fusing an iOS app with private signing. * The team-id parameter is optional,please remove this line when working on personal workspace.


```yaml
version: '2.1'
orbs:
  build-2secure: appdome/build-2secure@1.1.1
workflows:
  Appdome fusion:
    jobs:
      - build-2secure/appdome_runner:
          appFile: <path_to_remote_ipa_download_file_location>
          build-with-logs: true
          output: <output_ipa_or_leave_empty_for_Appdome_Secured_App>
          runner: IOS_PRIVATE_SIGNING
          team-id: >-
            <your_team's_ID> - remove this line when working on personal
            workspace.
```