Clone wiki

virusbattle-sdk / Setting Up

INSTALLATION REQUIREMENT

vbSDK is written in Python and needs the following:

    python 2.6/2.7
    python packages: requests, json

While we expect the system to work on any machine/OS that supports the above, we wish to add the following caveat.

CAUTION: vbSDK been tested only on Ubuntu Linux. 
Use on other environments depends on the portability of 
python packages used.

INSTALL vbSDK

vbSDK does not require any specific installation. Just clone the repository or download the code in a directory, and you are ready to use the CLI rightaway. For ease of access though, you may also wish to setup the PATH variable to point to the python installation directory and the virustbattle-sdk directory.

For integrating with your own code the effort is just slightly more, and will be addressed in another document.

REGISTERED USER

  1. Update vbSDK

    git pull http://bitbucket.org/srl/virusbattle-sdk.git
    

NEW USER

  1. Download the git repo from bitbucket.org

    git clone http://bitbucket.org/srl/virusbattle-sdk.git
    
  2. Request VIRUSBATTLE_KEY (Skip to 4, if you already have a key)

    cd virusbattle-sdk
    python vbregister.py  --email="youremail@domain.com" --name="Firsname Lastname"
    
  3. Wait to receive the key by email.

  4. Setup environment variable with the key received by email.

    export VIRUSBATTLE_KEY="keysentbyemail"
    
  5. *Setup environment variable VIRUSBATTLE_SERVICE_FILTER to null/empty

    export VIRUSBATTLE_SERVICE_FILTER=
    

    On Unix environment, it is recommended that the above commands be placed in the .bashrc file.

    On Windows you may use the System Property editor to add a new environment variables and set the value.

TROUBLESHOOTING

CAUTION: VIRUSBATTLE ACCESS KEY

Access to VirusBattle Automated Malware Analysis Webservice is enabled by a key, which may be requested using the command provided above.

As part of our minimal verification of identities, we do not provide keys to email addresses pointing to open email services, such as, gmail.com, yahoo.com, aol.com, and many others. Please register using your business or university email address. You may also use your FaceBook email address.

Updated