remote-virtualbox

remote-virtualbox copied to clipboard

Remote VirtualBox

|Build Status| |Black Indicator|

About

This package is intended to be simple and useful abstraction based on Zeep <https://github.com/mvantellingen/python-zeep>__ SOAP client.

It doesn't depend on ancient VirtualBox Python SDK and even more ancient ZSI (last updated in 2006) and PyXML (thing from 2007) libraries.

The initial goal was to build an easy to use CuckooSandbox machinery <https://github.com/cuckoosandbox/cuckoo/pull/1998>__.

VirtualBox Webservice

There is an official manual how to start it:

https://www.virtualbox.org/manual/ch09.html#vboxwebsrv-daemon

Install

::

pip install remotevbox --user

Development version

`Pipenv <https://github.com/kennethreitz/pipenv>`__ is used here:

::

    pipenv install --dev --pre
    pipenv shell

Usage example
-------------

.. code:: python

        >>> import remotevbox
        >>> vbox = remotevbox.connect("http://127.0.0.1:18083", "vbox", "yourpassphrase")
        >>> vbox.get_version()
        '6.1.2'
        >>> machine = vbox.get_machine("Windows10")
        >>> machine.launch()
        >>> screenshot_data = machine.take_screenshot_to_bytes()
        >>> fp = open('screenshot.png', 'wb')
        >>> fp.write(screenshot_data)
        >>> fp.close()
        >>> machine.put_usagecode(0xE1, 7) # simulate shift key
        >>> machine.put_usagecode(6, 7) # simulate letter c
        >>> machine.put_usagecode(6, 7, True) # stop "pressing" c
        >>> machine.put_usagecode(0xE1, 7, True) # stop "pressing" shift
        >>> machine.put_mouse_event(0, 0, dz=5) # scroll with the mouse wheel
        >>> machine.absolute_mouse_pointer_supported() # does the gues OS supports absolute mouse pointer ?
        >>> machine.put_mouse_event_absolute(110, 40) # set absolute cursor position
        >>> machine.send_key_combination(["<ctrl>", "c"]) # send key combination
        >>> machine.send_character_string("Hello World!") # send a string from the keyboard
        >>> machine.save()
        >>> vbox.disconnect()

.. |Build Status| image:: https://travis-ci.org/ilyaglow/remote-virtualbox.svg?branch=master
   :target: https://travis-ci.org/ilyaglow/remote-virtualbox
.. |Black Indicator| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/ambv/black