Configuration

View product v1.0.0

In-App Protection Shielder for Android requires a configuration file, set with --config. The configuration file uses the YAML data format. All features are disabled by default.

General structure of the configuration:

schema_version: 1

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

string_obfuscation:
  enabled: true | false
  exclude_default_packages: true | false
  exclude:
    packages:
      - <package>
    classes:
      - <class>

Rules:

schema_version: 1 is required.
Unknown keys are rejected.
Hashes should be quoted.

General Options

Option	Description
`schema_version`	Required. Must be `1`.

RASP Options

Option	Description
`rasp.<feature>.enabled`	Turns the feature on or off. Defaults to `false`.
`rasp.<feature>.response`	Required when the feature is enabled.
`rasp.<feature>.response.action`	`terminate` or `no_action`. See Recommended Responses.
`rasp.<feature>.response.exit_url`	URL opened when the application is terminated. Only with `terminate`.
`rasp.repackaging.response.certificate_hashes`	SHA-1 hashes of trusted signing certificates. Required for repackaging detection. See Repackaging Detection.

RASP Features

Feature	Description
`root`	Root Detection
`runtime_tampering`	Runtime Tampering Detection
`repackaging`	Repackaging Detection

String Obfuscation Options

Option	Description
`string_obfuscation.enabled`	Turns String Obfuscation on or off. Defaults to `false`.
`string_obfuscation.exclude_default_packages`	Excludes the default packages from obfuscation. Defaults to `true`. See String Obfuscation.
`string_obfuscation.exclude.packages`	Packages to exclude. Excluding a package also excludes its subpackages.
`string_obfuscation.exclude.classes`	Fully qualified names of classes to exclude.

Complete Example

schema_version: 1

rasp:
  root:
    enabled: true
    response:
      action: terminate
      exit_url: "https://example.com/security/root"
  runtime_tampering:
    enabled: true
    response:
      action: terminate
  repackaging:
    enabled: true
    response:
      action: terminate
      certificate_hashes:
        - "<SHA-1 of the app signing certificate>"

string_obfuscation:
  enabled: true
  exclude:
    packages:
      - com.example.thirdparty
    classes:
      - com.example.api.ApiConstants