APK scanner configuration file | Fluid Attacks Help

APK scanner configuration file

General configuration file keys

Here is a simple and recommended overview of the general configuration file keys. Remember that this applies to all of Fluid Attacks' scanners.

namespace: myapp
output:
  file_path: ./Fluid-Attacks-Results.csv
  format: CSV
working_dir: .
language: EN

Specific configuration file keys

The following key is available only for the APK scanner.


apk

This key has two configuration options:
  1. include (mandatory): Paths to files or directories to analyze
  2. exclude (optional): Files or directories to exclude from the analysis
For example:
    apk:
      include:
        - relative/path/to/directory/
      # Optional keys
      exclude:
        - glob(src/**/test*.apk)

    Specify paths in the include/exclude subsections

    You can specify your paths in two different ways:
    1. Using a path relative to the working directory, for example:

      2. namespace: namespace
      working_dir: /test/directory
      apk:
        include:
          - src/main/java/org/test/Test.apk
    1. Using Unix-style globs, relative to working_dir, for example:

      2. namespace: namespace
      working_dir: /test/directory
      apk:
        include:
          - .
        exclude:
          - glob(**.java)
          - glob(src/**/test*.py)

    Configuration file example

    Below is an example of a highly personalized configuration file:

    namespace: my_app
    working_dir: ./
    commit: e59607b9de3ef4c13d292705fg3da1ff0c67eb38
    language: EN
    output:
      file_path: /fluid-attacks-results.csv
      format: CSV
    apk:
      include:
        - glob(**/**.apk)
      exclude:
        - src/test/test_apk.apk

    Advice on scanner issuesHave a question about the scanner or encountered a problem? Read the scanner FAQ.
    Free trial message
    Free trial
    Search for vulnerabilities in your apps for free with Fluid Attacks' automated security testing! Start your 21-day free trial and discover the benefits of the Continuous Hacking Essential plan. If you prefer the Advanced plan, which includes the expertise of Fluid Attacks' hacking team, fill out this contact form.