Defender for iOS


Licensing

Defender for iOS must have a valid license to run. Defender for iOS must have access to the key when it runs and requires an internet connection to contact the licensing server.

An error message will be displayed if a license key is not specified or if the license key is expired or invalid. To obtain or renew a license, contact the PreEmptive team.

Register a License

To register the license key:

  1. Internet network should be reachable.

  2. For Build License run the following command:

    $ defenderForiOS --register <key>

  3. For User License, you must provide an email address:

    $ defenderForiOS --register <key>:email

    The license key should be registered, and a success message should be displayed as below:

Using a License

The Defender for iOS application can be run by providing a key at runtime, instead of using the register command. You can provide the license key in the following ways:

  • Command line: A license key can be provided through the command line using the –license argument. For this:

    1. Ensure the machine has internet access.

    2. Run Defender for iOS with the --license argument:

      $ defenderForiOS --license <key>:<email> <path to xcode-project> -s <scheme>

      Note: The use of the email address is optional, and depends on the license type you are using.

  • Config file: You can also store your license details in your config.yaml file. To provide a license key through the config file:

    1. Ensure the machine has Internet access.

    2. Add the license information to your config.yaml file:

      license:

      key : <value>:<email>

      Note: The use of the email address is optional, and depends on the license type you are using.

    3. Run Defender for iOS:

      $ defenderForiOS <path to xcode-project> -s <scheme>

    • Environment variable*: License key can be given through environment variable. For this:

      1. Ensure the machine has internet access.
      2. DEFENDER_FOR_IOS_LICENSE environment variable should be used to set the license key.

      3. Run Defender for iOS:

        $ defenderForiOS <path to xcode-project> -s <scheme>

  • To use your registered license, stored in the .license file:

    1. Ensure the machine has internet access.
    2. A License key should have been registered already. Refer to Register a License.

    3. Run Defender for iOS:

      $ defenderForiOS <path to xcode-project> -s <scheme>

Notes: 1. If you specify a license key in multiple ways, Defender For iOS prioritizes keys in this order: 1. Command line 2. Config file 3. Environment variable 4. .license file 2. For Subscription licenses, if the license key is provided using the .license file and has not expired, then Defender For iOS may not require internet access. In all other cases, if the internet is unreachable, Defender for iOS will retry after 30 seconds. If the internet is still unreachable, Defender for iOS will exit with the following error:
“Error: Unable to validate license. Please contact support. Server response: Error trying to contact licensing server.” 3. Retry attempts are configurable by using the IOSDEFENDER_RETRY_COUNT environment variable. 4. When using a .license file, it may be necessary to provide Keychain access. You may be prompted as follows:

Register/Validate license through Proxy Server

Defender For iOS can validate and register licenses through a proxy when a direct internet connection is disabled.

  1. Unauthenticated Proxy

    If your machine is connected to the internet through an unauthenticated proxy, you can set the proxy details using the following environment variables:

    • The IOSDEFENDER_PROXY_ADDRESS variable sets the address of the unauthenticated proxy.
    • The IOSDEFENDER_PROXY_PORT variable sets the port of the unauthenticated proxy.

    Now, run the following command:

    $ defenderForiOS --license <key>:<email> <path to xcode-project> -s <scheme>

  2. Authenticated Proxy

    If you need to connect to the internet through an authenticated proxy, you can set the proxy details using the following environment variables (refer to Using a License):

    • The IOSDEFENDER_PROXY_ADDRESS variable sets the address of the authenticated proxy.
    • The IOSDEFENDER_PROXY_PORT variable sets the port of the authenticated proxy.
    • The IOSDEFENDER_PROXY_USERNAME variable sets the username for connecting to the authenticated proxy.
    • The IOSDEFENDER_PROXY_PASSWORD variable sets the password for connecting to the authenticated proxy.

    Now, run Defender for iOS:

    defenderForiOS <path to xcode-project> -s <scheme>

    The following window is displayed:

    Now, click on System Preferences, and enter the Username and Password for the proxy:

    Click OK. You should see Defender for iOS run in your terminal window:

    Note: If there is any issue with the Proxy server (either the server is off or the entered credentials are incorrect), the following error is given: “Error: Unable to communicate licensing server via proxy server. Please check your proxy server settings and retry.” You may need to restart your system and try again when using an authenticated proxy.

Sharing License file with other Users/Systems

If you want to share a floating license file with other users/systems, you need to follow the below steps:

  1. Copy the .license file from the following path:

    /Library/Application Support/PreEmptive Solutions/Defender for iOS/defender.license

  2. Place the .license file on the new machine in the same path from Step 1.

  3. Retrieve the Keychain access details from the current system. To get these details, follow the below steps:

    1. Open "Keychain Access": Go to Applications > Utilities > Keychain Access.

    2. Right-click on the Defender For iOS Key and then Click on get info.

    3. Copy the Name, Account, and Password.

  4. Add the Keychain information to the other system:

    1. Open "Keychain Access": Go to Applications > Utilities > Keychain Access.

    2. Go to File > New Password item.

    3. Enter the shared Name, Account Name, and Password, and click on Add.

    Note: If the Keychain “Defender For iOS” already exists on the other system, delete this Keychain and create a new one.

HOME

INTRODUCTION