/iris-velociraptorartifact-module

IRIS Module to Run Any Velociraptor Artifact

Primary LanguagePythonMIT LicenseMIT

Velociraptor Artifact Module Awesome

Run any Velociraptor Artifact on a Windows or Linux Endpoint

MIT License LinkedIn your-own-soc-free-for-life-tier youtube-channel


Logo

Velociraptor Artifact

SOCFortress provided DFIR-IRIS module.
Contact SOCFortress »

Intro

Remove artifact collection via Velociraptor

Get started with Velociraptor: Video Tutorial

The module is built for the below Asset types:

  • Windows
  • Linux

Configuration




Mount api.config.yaml

  1. Mount the api.config.yaml file in DFIR-IRIS docker-compose for both Worker and Web-App
    • cp api.config.yaml /opt/iris-web/docker/api.config.yaml
    • nano /opt/iris-web/docker-compose.yml

Web-App

app:
    build:
      context: .
      dockerfile: docker/webApp/Dockerfile
    image: iriswebapp_app:latest
    command: ['nohup', './iris-entrypoint.sh', 'iriswebapp']
    volumes:
      - iris-downloads:/home/iris/downloads
      - user_templates:/home/iris/user_templates
      - server_data:/home/iris/server_data
      - "./docker/api.config.yaml:/iriswebapp/api.config.yaml:ro"

Worker

worker:
    build:
      context: .
      dockerfile: docker/webApp/Dockerfile
    image: iriswebapp_app:latest
    command: ['./wait-for-iriswebapp.sh', 'app:8000', './iris-entrypoint.sh', 'iris-worker']
    volumes:
      - iris-downloads:/home/iris/downloads
      - user_templates:/home/iris/user_templates
      - server_data:/home/iris/server_data
      - "./docker/api.config.yaml:/iriswebapp/api.config.yaml:ro"
  1. Restart the DFIR-IRIS docker-compose
    • docker-compose down
    • docker-compose up -d

Install

Currently, the Velociraptor Artifact module can be ran as DFIR-IRIS Module.

Get started with DFIR-IRIS: Video Tutorial

The below steps assume you already have your own DFIR-IRIS application up and running.

  1. Fetch the Velociraptor Artifact Module Repo
    git clone https://github.com/socfortress/iris-velociraptorartifact-module
    cd iris-velociraptorartifact-module
    
  2. Install the module
    ./buildnpush2iris.sh -a
    

Configuration

Once installed, configure the module to include:

  • Path to api.config.yaml
  • Velociraptor Artifact to run
  1. Navigate to Advanced -> Modules

Advanced -> Modules




  1. Add a new module

Add a new module




  1. Input the Module name: iris_velociraptorartifact_module

Input Module




  1. Configure the module

Configure Module




  1. Configure artifact to run

Configure Artifact to Run




Running the Module

To run the module select Case -> Asset and select the dropdown menu.

Currently supports Asset of type: Windows, Linux

Asset




Run Module




Access Data Store




Download From Data Store




Artifact is collected

Issues?

If you are experiencing issues, please contact us at info@socfortress.co