Skip to content

Latest commit

 

History

History
203 lines (155 loc) · 6.22 KB

docker_options.md

File metadata and controls

203 lines (155 loc) · 6.22 KB

Docker Options

Docker

Prebuilt Docker image from DockerHub

docker pull opensecurity/mobile-security-framework-mobsf:latest
docker run -it --rm -p 8000:8000 opensecurity/mobile-security-framework-mobsf:latest

For persistence

# On Linux
mkdir <your_local_dir>
sudo chown -R 9901:9901 <your_local_dir>

docker run -it --rm --name mobsf -p 8000:8000 -v <your_local_dir>:/home/mobsf/.MobSF opensecurity/mobile-security-framework-mobsf:latest

Updating MobSF version when volume mount is used

# On Linux
docker pull opensecurity/mobile-security-framework-mobsf:latest
# Apply database migrations
docker run --rm -v <your_local_dir>:/home/mobsf/.MobSF opensecurity/mobile-security-framework-mobsf:latest scripts/migrate.sh

Configuring Asynchronous Scan Queues

Asynchronous scan queues require a shared volume mount to enable data sharing between MobSF and the scan queue orchestrator, DjangoQ2.

# Run MobSF container with Asynchronous scan support.
docker run -it --rm --name mobsf -v ~/.MobSF:/home/mobsf/.MobSF -e MOBSF_ASYNC_ANALYSIS=1 -p 8000:8000 opensecurity/mobile-security-framework-mobsf:latest

# Run DjangoQ2 cluster to accept scan jobs.
docker run -it --rm --name djangoq -v ~/.MobSF:/home/mobsf/.MobSF opensecurity/mobile-security-framework-mobsf:latest scripts/qcluster.sh

Building Image from Dockerfile

git clone https://github.com/MobSF/Mobile-Security-Framework-MobSF.git
cd Mobile-Security-Framework-MobSF
docker build -t mobsf .
docker run -it --rm -p 8000:8000 mobsf

Building Image behind a proxy from Dockerfile

docker build --build-arg https_proxy="https://${PROXY_IP}:${PROXY_PORT}" --build-arg http_proxy="${PROXY_IP}:${PROXY_PORT}" --build-arg NO_PROXY="127.0.0.1" -t mobsf .

Set the environment variable PROXY_IP with the value of your proxy ip address and PROXY_PORT with the proxy port used.

Rebuilding Image from Dockerfile from Scratch

docker build --no-cache --rm -t mobsf .

To see the mobsf container logs

docker logs -f --tail 100 mobsf

Docker Compose

For Postgres database, DjangoQ2 task queue, and Nginx reverse proxy support

# On Linux
mkdir -p $HOME/MobSF/mobsf_data
sudo chown -R 9901:9901 $HOME/MobSF/mobsf_data

cd docker

# Download the latest images 
docker compose pull

# Launch the services
docker compose up

# or run in the background
docker compose up -d

# See logs from mobsf container
docker compose logs -f mobsf 

# See scan logs from the djangoq container
docker compose logs -f djangoq

# Stop the containers
docker compose down

# Updating MobSF
docker compose pull
docker compose run mobsf scripts/migrate.sh

Architecture

graph TB
    %% Define the Docker Network
    subgraph DockerNetwork ["Docker Network"]
        direction LR
        postgres[(Postgres DB)]
        nginx[/Nginx Server/]
        mobsf{{MobSF Framework}}
        djangoq[/DjangoQ Worker/]
    end

    %% Define the Host Machine
    host[/Host Machine/]

    %% Host Volume Mappings
    host --> |"Volume:<br/>$HOME/MobSF/postgresql_data<br/>to<br/>/var/lib/postgresql/data"| postgres
    host --> |"Volume:<br/>./nginx.conf<br/>to<br/>/etc/nginx/nginx.conf:ro"| nginx
    host --> |"Volume:<br/>$HOME/MobSF/mobsf_data<br/>to<br/>/home/mobsf/.MobSF"| mobsf
    host --> |"Volume:<br/>$HOME/MobSF/mobsf_data<br/>to<br/>/home/mobsf/.MobSF"| djangoq

    %% Dependencies
    nginx -.- |"Depends on"| mobsf
    mobsf -.- |"Depends on"| postgres
    mobsf -.- |"Depends on"| djangoq
    djangoq -.- |"Depends on"| postgres

    %% Ports and Connections
    nginx === |"Exposes Ports:<br/>80:4000<br/>1337:4001"| host
    mobsf -.- |"Extra Host:<br/>host.docker.internal"| host

    %% Styling Definitions
    classDef container fill:#e0f7fa,stroke:#006064,stroke-width:2px,rx:5,ry:5;
    classDef network fill:#e8f5e9,stroke:#1b5e20,stroke-width:2px,rx:10,ry:10;
    classDef host fill:#fff3e0,stroke:#e65100,stroke-width:2px,rx:10,ry:10;
    classDef dashed stroke-dasharray: 5 5;

    %% Assign Styles
    class postgres,nginx,mobsf,djangoq container;
    class DockerNetwork network;
    class host host;

    %% Link Styles
    linkStyle 0 stroke:#1565c0,stroke-width:2px;
    linkStyle 1 stroke:#1565c0,stroke-width:2px;
    linkStyle 2 stroke:#1565c0,stroke-width:2px;
    linkStyle 3 stroke:#1565c0,stroke-width:2px;
    linkStyle 4 stroke:#7b1fa2,stroke-width:2px,stroke-dasharray: 5 5;
    linkStyle 5 stroke:#c62828,stroke-width:3px;
    linkStyle 6 stroke:#2e7d32,stroke-width:2px,stroke-dasharray: 5 5;
Loading

Docker Compose Configuration for MobSF

This configuration runs MobSF with PostgreSQL as the database, Nginx as the reverse proxy, and supports asynchronous scans using DjangoQ2.

Services:

  1. postgres

    • Image: PostgreSQL 13 image
    • Purpose: Provides the database backend for MobSF
    • Configuration:
      • Persistent volume for data storage
      • Environment variables for database credentials
      • Connected to mobsf_network

  2. nginx

    • Image: Latest Nginx image
    • Purpose: Acts as a reverse proxy and web server
    • Configuration:
      • Exposes ports 80 and 1337
      • Custom Nginx configuration file mounted
      • Depends on mobsf service
      • Connected to mobsf_network

  3. mobsf

    • Image: Latest MobSF image
    • Purpose: Runs the Mobile Security Framework application
    • Configuration:
      • Volume mounted for MobSF data persistence at /home/mobsf/.MobSF
      • Environment variables for PostgreSQL connection
      • Depends on postgres service
      • Extra host configuration for Docker host access required for adb connectivity
      • Connected to mobsf_network

  4. djangoq

    • Image: Latest MobSF image
    • Purpose: Runs DjangoQ2 to manage asynchronous task queues for MobSF
    • Configuration:
      • Command: Runs qcluster.sh to start DjangoQ2 clusters
      • Volume mounted for MobSF data persistence at /home/mobsf/.MobSF
      • Environment variables for PostgreSQL connection
      • Depends on the postgres service.
      • Connected to mobsf_network.

Network:

  • A custom bridge network 'mobsf_network' is created for inter-service communication

Note: All services are set to restart automatically in case of failures, except DjangoQ, which is configured to restart unless stopped.