How to Use Secure Android & iOS Apps in GitHub CI/CD

Prerequisites

• An Appdome SRM account
  • Appdome’s token
  • Fusion-Set ID
• A GitHub Account.
  If you do not have an existing account, you can create one on GitHub website.
• On GitHub:
  • A repository (created automatically when creating a GitHub account).
  • .YML file, located on the path repository/.github/workflows/*.yml
    Note
    If you do not yet have a workflow, refer to Appendix A: Creating a Workflow File.

How does Appdome Implement GitHub Actions?

Now you can easily secure and customize your mobile apps on GitHub using the Appdome GitHub Actions. 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 GitHub action.

What are Actions?

Actions are reusable snippets of code that help automate repeated processes, speed up project setup, and make it easy to integrate with third-party tools.

What are Secrets?

Secrets are encrypted variables that you create in an organization, repository, or repository environment. The secrets that you create are available to use in GitHub Actions workflows.

Step 1: Building Your YML Workflow with Appdome Build-2Secure Action.

To build your YML:

1. Go to your workflow *.yml file.
   This file is composed of the following blocks:
   • on – Controls when the workflow will run.
   • jobs – A workflow run is made up of one or more jobs that can run sequentially or in parallel.
     • build: This workflow contains a single job called build.
       • run-on: The type of runner that the job will run on, run-on info.
       • steps: Represent a sequence of tasks that will be executed as part of the job.
         • name – Name of the step.
         • run – Run commands using the runner shell.
2. Click on Edit file .
3. Click on Search on the search bar at the left side for Appdome Build-2Secure and click on it.
   
4. Add the Appdome’s action snipped code into the steps block on your YML file.
   This snipped code contains all action inputs, some of which might be not relevant for your run.
   • Inputs – See Appendix B, Appdome Build-2Secure Inputs.
   • Blocks for each run type:
     • Sign on Appdome – see Appendix C: SIGN_ON_APPDOME –Android and iOS.
     • Private Signing – see Appendix D: Private Signing – ANDROID and iOS.
     • Auto Dev Signing – see Appendix E: Auto Dev Signing – ANDROID and iOS
5. Optionally, store all your sensitive variables on GitHub encrypted secrets for repository.
   This measure, while optional, is highly recommended. For details see Github Documentation.
6. Define the variables of secrets as follows:
   1. Create a secret name SECRET_EXAMPLE.
   2. On the secret field, enter the value of SECRET_EXAMPLE.
      Now it can be encrypted called as ${{ secrets.SECRET_EXAMPLE }}
7. Optionally, store KEYSTORE_FILE as base64 value on secrets, by following these steps:
   1. Create a secret name KEYSTORE_BASE64 by entering the following command on Terminal:

      base64 -i your_keystore.keystore -o keystore_base64.txt

   2. Copy the content of the text file to the secret field.
      The text file can now be referred to as ${{ secrets.KEYSTORE_BASE64 }}; similarly, you can repeat the above process for all file fields in the yml file.
   3. After the workflow file is ready click on start commit, then commit new file.
   4. Repeat the above process for all file fields in the yml file.

Step 2: Running Appdome Build-2Secure Action

To run Appdome Build-2Secure action:

1. Go to the Actions tab.
2. Select your workflow from the Actions list.
   
3. Expand the Run workflow list and click Run workflow.
   
   After the build is complete, you can download the secured app from the Artifacts tab.

Summary

This guide provides instructions for using the Appdome action to secure and customize mobile apps on GitHub. Following the steps outlined above allows you to automate the process of adding security features to your mobile apps, as well as sign your app with your own enterprise certificate. Appdome action provides the flexibility and the control required to ensure that your mobile apps are secure and customized to meet your specific needs.

Appendix A: Creating a Workflow File

If the workflow file does not exist:

1. 1. On your repository, click the Actions tab.
   2. Click the New workflow button.
   3. Click on set up a workflow yourself”.
   4. Paste this workflow .yml template

      # A simple .yml template locate on <repository/.github/workflows/appdoem_ci.yml>
      name: APPDOME_CI_EXAMPLE
      
      # Controls when the workflow will run
      on:
        # Triggers the workflow on push or pull request events but only for the "main" branch
        push:
          branches: [ "main" ]
        pull_request:
          branches: [ "main" ]
      
        # Allows you to run this workflow manually from the Actions tab
        workflow_dispatch:
      
      # A workflow run is made up of one or more jobs that can run sequentially or in parallel
      jobs:
        # This workflow contains a single job called "build"
        build:
          # The type of runner that the job will run on
          runs-on: ubuntu-latest
      
          # Steps represent a sequence of tasks that will be executed as part of the job
          steps:
          # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
          - uses: actions/checkout@v3
          - name: Appdome build-2secure
            uses: Appdome/github_build-2secure@1.0
            with:
              APP_FILE: ""
              FUSION_SET_ID: ""
              SIGN_OPTIONS: ""
              APPDOME_API_TOKEN: ""
      

Appendix B: Appdome Build-2Secure Inputs

# Appdome build-2secure inputs
steps:
  - name: Appdome buid-2secure
    uses: nirappdome/appdome_android_action@version
    with:
      # -Mandatory inputs-
      APPDOME_API_TOKEN: # Appdome API KEY, ${{secrets.APPDOME_API_KEY}}

      APP_FILE: # none_protected_application can be pass as path/on/repository
                # OR https://download_link

      FUSION_SET_ID: # Appdome Fusion Set_Id Android/iOS

      SIGN_OPTIONS: # “SIGN_ON_APPDOME” OR “PRIVATE_SIGNING” OR “AUTO_DEV_SIGNING”
      # -Mandatory inputs-#

      # -Optional inputs, depends on: "SIGN_OPTIONS", Android/iOS #
      KEYSTORE_FILE: # Sign keystore file, ${{secrets.KEYSTORE_BASE64}}
                     # OR path/on/repository path/on/repository ...
                     # OR https://download_link https://download_link ...
      MOBILE_PROVISION_PROFILE_FILE: # iOS only, ${{secrets.PROVISION_PROFILE_BASE64}}
                                     # OR path/on/repository
                                     # OR https://download_link https://download_link ...
      ENTITLEMENTS_FILE: "path/on/repository" "path/on/repository" ...
                          OR “https download link” “https download link” ....
                          OR ${{secrets.ENTITLEMENTS_BASE64}}

Appendix C: SIGN_ON_APPDOME –Android and iOS

Android

# Appome build-2secure, "SIGN_ON_APPDOME" - Android
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set Android"
      SIGN_OPTIONS: "SIGN_ON_APPDOME"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      KEYSTORE_FILE: ${{secrets.KEYSTORE_BASE64}}
      KEYSTORE_PASSWORD: ${{secrets.KEYSTORE_PASSWORD}}
      KEYSTORE_ALIAS: ${{secrets.KEYSTORE_ALIAS}}
      KEYSTORE_KEY_PASSWORD: ${{secrets.KEYSTORE_KEY_PASS}}

iOS

# Appome build-2secure, "SIGN_ON_APPDOME" - iOS
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set iOS"
      SIGN_OPTIONS: "SIGN_ON_APPDOME"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      KEYSTORE_FILE: ${{secrets.KEYSTORE_BASE64}}
                     OR "path/on/repository"
      KEYSTORE_PASSWORD: ${{secrets.KEYSTORE_PASSWORD}}
      ENTITLEMENTS_FILE: "path/on/repository" "path/on/repository" ...
                          OR “https download link” “https download link” ....
                          OR ${{secrets.ENTITLEMENTS_BASE64}}
      MOBILE_PROVISION_PROFILE_FILE: "path/on/repository" "path/on/repository" ...
                                      OR “https download link” “https download link” ....
                                      OR ${{secrets.PROVISION_PROFILE_BASE64}}

Appendix D: Private Signing. ANDROID and iOS

Android

# Appome build-2secure, "PRIVATE_SIGNING" - Android
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set Android"
      SIGN_OPTIONS: "PRIVATE_SIGNING"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      SIGN_FINGERPRINT: ${{secrets.APPDOME_SIGN_FINGERPRINT}}
      GOOGLE-PLAY-SIGNING: "true" -Optional

iOS

# Appome build-2secure, "PRIVATE_SIGNING" - iOS
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set iOS"
      SIGN_OPTIONS: "PRIVATE_SIGNING"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      MOBILE_PROVISION_PROFILE_FILE: "path/on/repository" "path/on/repository" ...
                                      OR “https download link” “https download link” ....
                                      OR ${{secrets.PROVISION_PROFILE_BASE64}}

Appendix E: Auto Dev Signing – ANDROID and iOS

Android

# Appome build-2secure, "AUTO_DEV_SIGNING" - Android
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set"
      SIGN_OPTIONS: "AUTO_DEV_SIGNING"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      SIGN_FINGERPRINT: ${{secrets.APPDOME_SIGN_FINGERPRINT}}
      GOOGLE-PLAY-SIGNING: "true" -Optional

iOS

# Appome build-2secure, "AUTO_DEV_SIGNING" - iOS
steps:
  # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
  - uses: actions/checkout@v3
  - name: Appdome build-2secure
    uses: Appdome/github_build-2secure@1.0
    with:
      APP_FILE: "path/on/repository" OR “https download link”
      FUSION_SET_ID: "Appdome fusion set iOS"
      sign_options: "AUTO_DEV_SIGNING"
      APPDOME_API_TOKEN: ${{secrets.APPDOME_API_KEY}}
      MOBILE_PROVISION_PROFILE_FILE: "path/on/repository" "path/on/repository" ...
                                      OR “https download link” “https download link” ....
                                      OR ${{secrets.PROVISION_PROFILE_BASE64}}
      ENTITLEMENTS_FILE: "path/on/repository" "path/on/repository" ...
                          OR “https download link” “https download link” ....
                          OR ${{secrets.ENTITLEMENTS_BASE64}}

Related Articles

• How to Secure Android & iOS Apps in Jenkins CI/CD pipelines
• How to Secure Android & iOS Apps in GitLab CI/CD Pipelines
• How to Secure Android &iOS Apps in Bitrise CI/CD Pipelines

Conclusion

Need Additional Help?

The description above is designed to help you secure Android & IOS apps in Bitrise CI/CD pipelines. If you have questions about using this Build-2Secure step for Bitrise. If you have any questions, please send them our way at support.appdome.com or via the chat window on the Appdome platform. 

Thank you!

Thanks for visiting Appdome! Our mission is to secure every app on the planet by making mobile app security easy. We hope we’re living up to the mission with your project.