Configuration

View product v1.0.0

In-App Protection Shielder for Apple reads an optional configuration file, set with --config. The configuration file uses the YAML data format. All features are enabled by default and terminate the application when they detect an issue.

General structure of the configuration:

schema_version: 1

runtime:
  artifact: <path>

defer_signing: true | false
expected_team_id: "<Team ID>"
trusted_certificate_sha256:
  - "<SHA-256 hash>"

rasp:
  <feature>:
    enabled: true | false
    response:
      action: terminate | no_action
      exit_url: <HTTPS URL>

Rules:

schema_version: 1 is required.
Unknown keys are rejected.
Booleans are lowercase true or false.
Hashes and Team IDs should be quoted.
Paths are relative to the configuration file.

General Options

Option	Description
`schema_version`	Required. Must be `1`.
`runtime.artifact`	Path to `IAPShielderRuntime.xcframework`. Overridden by `--runtime`.
`defer_signing`	`true` shields the application without signing it. Defaults to `false`. See Signing.
`expected_team_id`	Apple Team ID the application is signed with. Required for repackaging detection with deferred signing. See Repackaging Detection.
`trusted_certificate_sha256`	SHA-256 hashes of signing certificates used outside the App Store and TestFlight. See Repackaging Detection.

RASP Options

Option	Description
`rasp.<feature>.enabled`	Turns the feature on or off. Defaults to `true`.
`rasp.<feature>.response.action`	`terminate` (default) or `no_action`. See Recommended Responses.
`rasp.<feature>.response.exit_url`	HTTPS URL opened when the application is terminated. Only with `terminate`.

RASP Features

Feature	Description
`jailbreak`	Jailbreak Detection
`debugger`	Debugger Protection
`hooking`	Hooking Detection
`repackaging`	Repackaging Detection
`binary_integrity`	Binary Integrity Verification
`injection`	Injection Detection

Complete Example

schema_version: 1

runtime:
  artifact: IAPShielderRuntime.xcframework

expected_team_id: "ABCDE12345"
trusted_certificate_sha256:
  - "<SHA-256 of the signing certificate>"

rasp:
  jailbreak:
    response:
      action: terminate
      exit_url: https://example.com/security/jailbreak
  debugger:
    response:
      action: no_action # for example, internal builds that need debugging

Configuration

General Options

RASP Options

RASP Features

Complete Example

Read Next