viper-framework.sls

# Name: Viper
# Website: https://github.com/viper-framework/viper
# Description: Organize and query a collection of malware samples. (Temporarily excluded from the distro)
# Category: Gather and Analyze Data
# Author: Claudio Guarnieri: https://nex.sx
# License: BSD 3-Clause License: https://github.com/viper-framework/viper/blob/master/LICENSE
# Notes: Viper is temporarily excluded from the REMnux distro due to depdendency issues. Instead, use the remnux/viper Docker image: https://docs.remnux.org/run-tools-in-containers/remnux-containers#viper-binary-analysis-and-management-framework

{%- if grains['oscodename'] == "bionic" %}
  {%- set python3_version="python3.6" %}
{%- elif grains['oscodename'] == "focal" %}
  {%- set python3_version="python3.8" %}
{% endif %}
{%- set user = salt['pillar.get']('remnux_user', 'remnux') -%}

{%- if user == "root" -%}
  {%- set home = "/root" -%}
{%- else -%}
  {%- set home = "/home/" + user -%}
{% endif %}

include:
  - remnux.config.user
  - remnux.packages.libssl-dev
  - remnux.packages.swig
  - remnux.packages.libusb-1
  - remnux.packages.libfuzzy-dev
  - remnux.packages.git
  - remnux.packages.virtualenv
  - remnux.python3-packages.pip
  - remnux.packages.python3-virtualenv
  - remnux.packages.python3-venv
  - remnux.packages.build-essential
  - remnux.packages.libffi-dev
  - remnux.packages.unrar
  - remnux.packages.7zip
  - remnux.packages.tor
  - remnux.packages.clamav-daemon
  - remnux.packages.ssdeep
  - remnux.packages.libdpkg-perl
  - remnux.perl-packages.exiftool

remnux-python3-packages-viper-virtualenv:
  virtualenv.managed:
    - name: /opt/viper
    - venv_bin: /usr/bin/virtualenv
    - python: /usr/bin/python3
    - pip_pkgs:
      - pip
      - setuptools
      - wheel
    - require:
      - sls: remnux.python3-packages.pip
      - sls: remnux.packages.python3-virtualenv
      - sls: remnux.packages.python3-venv
      - sls: remnux.packages.virtualenv

remnux-python3-packages-viper-install:
  pip.installed:
    - name: viper-framework
    - bin_env: /opt/viper/bin/python3
    - require:
      - sls: remnux.packages.libssl-dev
      - sls: remnux.packages.swig
      - sls: remnux.packages.libusb-1
      - sls: remnux.packages.libfuzzy-dev
      - sls: remnux.packages.git
      - sls: remnux.python3-packages.pip
      - sls: remnux.packages.build-essential
      - sls: remnux.packages.libffi-dev
      - sls: remnux.packages.unrar
      - sls: remnux.packages.7zip
      - sls: remnux.packages.tor
      - sls: remnux.packages.clamav-daemon
      - sls: remnux.packages.ssdeep
      - sls: remnux.packages.libdpkg-perl
      - sls: remnux.perl-packages.exiftool
      - virtualenv: remnux-python3-packages-viper-virtualenv

remnux-python3-packages-viper-update-fix:
  file.replace:
    - name: /opt/viper/lib/{{ python3_version }}/site-packages/viper/core/ui/cmd/update-modules.py
    - pattern: '"pip3", "install"'
    - repl: '"/opt/viper/bin/pip3", "install"'
    - count: 1
    - prepend_if_not_found: False
    - require:
      - pip: remnux-python3-packages-viper-install

remnux-python3-packages-viper-directory:
  file.directory:
    - name: {{ home }}/.viper
    - makedirs: True
    - user: {{ user }}
    - group: {{ user }}
    - recurse:
      - user
      - group
    - require:
      - pip: remnux-python3-packages-viper-install
      - user: remnux-user-{{ user }}

remnux-python3-packages-viper-modules-git:
  git.latest:
    - name: https://github.com/viper-framework/viper-modules.git
    - target: {{ home }}/.viper/modules
    - user: {{ user }}
    - force_reset: True
    - force_checkout: True
    - force_fetch: True
    - require:
      - file: remnux-python3-packages-viper-directory

remnux-python3-packages-viper-modules-verify-sigs:
  file.replace:
    - name: {{ home }}/.viper/modules/requirements.txt
    - pattern: 'verify-sigs @ '
    - repl: ''
    - count: 1
    - prepend_if_not_found: False
    - require:
      - git: remnux-python3-packages-viper-modules-git

remnux-python3-packages-viper-modules-pymispgalaxies:
  file.replace:
    - name: {{ home }}/.viper/modules/requirements.txt
    - pattern: 'PyMISPGalaxies @ '
    - repl: ''
    - count: 1
    - prepend_if_not_found: False
    - require:
      - git: remnux-python3-packages-viper-modules-git

remnux-python3-packages-viper-modules-init:
  cmd.run:
    - name: git submodule init
    - cwd: {{ home }}/.viper/modules
    - require:
      - git: remnux-python3-packages-viper-modules-git

remnux-python3-packages-viper-modules-update:
  cmd.run:
    - name: git submodule update
    - cwd: {{ home }}/.viper/modules
    - require:
      - git: remnux-python3-packages-viper-modules-git

remnux-python3-packages-viper-modules-requirements:
  pip.installed:
    - requirements: {{ home }}/.viper/modules/requirements.txt
    - bin_env: /opt/viper/bin/pip3
    - require:
      - file: remnux-python3-packages-viper-modules-verify-sigs
      - file: remnux-python3-packages-viper-modules-pymispgalaxies

remnux-python3-packages-viper-symlink:
  file.symlink:
    - name: /usr/local/bin/viper
    - target: /opt/viper/bin/viper
    - force: true
    - require:
      - pip: remnux-python3-packages-viper-install

remnux-python3-packages-viper-venv-directory:
  file.directory:
    - name: /opt/viper
    - makedirs: False
    - user: {{ user }}
    - group: {{ user }}
    - recurse:
      - user
      - group
    - require:
      - pip: remnux-python3-packages-viper-install