Official Documentation — Viper 1.2 documentation

# Official Documentation

## What is Viper?

Viper is a binary analysis and management framework. Its fundamental objective is to provide a solution to easily organize your collection of malware and exploit samples as well as your collection of scripts you created or found over the time to facilitate your daily research. Think of it as a Metasploit for malware researchers: it provides a terminal interface that you can use to store, search and analyze arbitraty files with and a framework to easily create plugins of any sort.

Viper is released under BSD 3-Clause license and is copyrighted by Claudio Guarnieri. The source code is available on GitHub, where also all development efforts and contributions are coordinated. For questions and inquiries, you can find the author’s contact details here.

## Table of Content

- Installation
  - Core dependencies
  - Installation
  - Extra dependencies
  - First launch
  - Uninstall
- Usage
  - Concepts
    - Projects
    - Sessions
    - Commands & Modules
    - Database
    - Binaries
  - Commands
    - projects
    - open
    - sessions
    - export
    - close
    - store
    - find
    - info
    - notes
    - tags
    - delete
  - HTTP Interfaces
    - Security Considerations
    - API
      - /test
      - /file/add
      - /file/add_url
      - /file/get
      - /file/delete
      - /file/find
      - /file/tags/add
      - /tags/list
      - /file/notes/add
      - /file/notes/view
      - /file/notes/update
      - /file/notes/delete
      - /projects/list
      - /modules/run
    - Web Interface
      - Launch the web interface
      - Use viper in a (web) production environment
- Create new modules
  - First steps
  - Arguments
  - Using the Config File
  - Accessing the session
  - Accessing the database
  - Printing results
- Known issues
  - Various errors when using unicode characters
  - Error storing file names containing unicode characters in database
  - Problem importing certain modules
  - The API interface isn’t fully aware of projects
  - update.py from 1.1 to 1.2 IOError ‘data/web/’
  - PreprocessError: data/yara/index.yara:0:Invalid file extension ‘.yara’.Can only include .yar
- Final Remarks
  - Developers
  - Join Us