Sign inSign up

devrvk/secureapk

By devrvk

•Updated over 1 year ago

Image
0

148

devrvk/secureapk repository overview

⁠secureApk Docker Image Usage Guide

The secureApk tool analyzes Android APK files for security vulnerabilities, such as cryptographic weaknesses, data leakage, and insecure storage. This README explains how to use the provided Docker images to run the tool on your system.


⁠Prerequisites

Before starting, ensure the following:

  • Docker is installed on your system.
  • You have an input directory containing exactly one APK file.
  • You have an output directory to store the analysis results.

⁠Pulling the Docker Image

The secureApk tool is available as Docker images for both ARM64 and AMD64 architectures. Use the appropriate docker pull command based on your system:

  • For ARM64 systems:

    docker pull devrvk/secureapk:arm64
    
  • For AMD64 systems:

    docker pull devrvk/secureapk:amd64
    

⁠Setting Up the Input Directory

  1. Create a directory named input in your current working directory:
    mkdir input
    
  2. Place exactly one APK file in the input directory. For example:
    input/
    └── your-app.apk
    

Note: The tool requires exactly one APK file in the input directory. Multiple or no APK files will cause the analysis to fail.


⁠Setting Up the Output Directory

  1. Create an empty directory named output in your current working directory:
    mkdir output
    
  2. Ensure the directory exists and is writable. This is where the analysis results will be stored.

⁠Running the Docker Container

Run the Docker container with the following command, replacing <image-tag> with either arm64 or amd64 depending on your system’s architecture:

docker run -v $(pwd)/input:/input -v $(pwd)/output:/output devrvk/secureapk:<image-tag>

This command:

  • Mounts the input directory from your current working directory to /input inside the container.
  • Mounts the output directory to /output inside the container.
  • Executes the secureApk tool to analyze the APK file and save the results.

⁠Viewing the Results

After the analysis completes, check the output directory on your host machine. The results will be stored there, along with a log file named analysis.log containing the terminal output from the analysis.

For example:

output/
├── vulnerabilities.txt
└── [other result files of decompiled apk]

⁠Additional Notes

  • Ensure the output directory is writable by the Docker container (e.g., the container runs as root, so the directory must allow root write access).
  • Each run of the container will overwrite the contents of the output directory. To save previous results, use a different output directory for each analysis (e.g., output1, output2).

Tag summary

Content type

Image

Digest

sha256:eb9d05a4a…

Size

371.8 MB

Last updated

over 1 year ago

docker pull devrvk/secureapk:amd64