reven2.preview.project_manager.project

class documentation

class ProjectManager(object):

The project manager class exposes basic methods to manage scenarios, record them, replay them and start a Reven server to analyse them.

Method	`__init__`	Undocumented
Method	`auto_record_asm_stub`	Undocumented
Method	`auto_record_binary`	Undocumented
Method	`cancel_task`	Undocumented
Method	`close_server`	Disconnect and stop the remote Reven server.
Method	`commit_record`	Undocumented
Method	`connect`	Use this method in a `with` pattern to get a `RevenServer` instance connected to the specified scenario name.
Method	`create_scenario`	Undocumented
Method	`delete_file`	Undocumented
Method	`delete_qemu_session_record`	Undocumented
Method	`delete_scenario`	Undocumented
Method	`delete_scenario_record`	Undocumented
Method	`delete_scenario_resource`	Undocumented
Method	`delete_scenario_resources`	Undocumented
Method	`delete_session`	Undocumented
Method	`delete_task`	Undocumented
Method	`eject_cdrom_qemu_session`	Undocumented
Method	`export_scenario`	Undocumented
Method	`get_actions_list`	Undocumented
Method	`get_active_tasks_list`	Undocumented
Method	`get_files_list`	Undocumented
Method	`get_resources_list`	Undocumented
Method	`get_scenario`	Undocumented
Method	`get_scenario_action`	Undocumented
Method	`get_scenario_actions_list`	Undocumented
Method	`get_scenario_by_name`	Uses the new scenarios by_name API from Reven 2.12
Method	`get_scenario_by_uuid`	Uses the new scenarios by_uuid API from Reven 2.12
Method	`get_scenario_resource`	Undocumented
Method	`get_scenario_resources_list`	Undocumented
Method	`get_scenarios_list`	Undocumented
Method	`get_server_by`	Get a connection to the Reven server for the given scenario.
Method	`get_session`	Undocumented
Method	`get_session_log`	Undocumented
Method	`get_sessions_list`	Undocumented
Method	`get_snapshot`	Undocumented
Method	`get_task`	Undocumented
Method	`get_task_log`	Undocumented
Method	`get_tasks_list`	Undocumented
Method	`import_scenario`	Undocumented
Method	`insert_cdrom_qemu_session`	Undocumented
Method	`load_live_snapshot_qemu_session`	Undocumented
Method	`refresh_missing_pdbs`	Undocumented
Method	`replay_scenario`	Undocumented
Method	`save_live_snapshot_qemu_session`	Undocumented
Method	`start_qemu_snapshot_session`	Undocumented
Method	`start_record`	Undocumented
Method	`start_reven_session`	Undocumented
Method	`stop_record`	Undocumented
Method	`stop_session`	Undocumented
Method	`update_qemu_snapshot`	Undocumented
Method	`update_scenario`	Undocumented
Method	`upload_file`	Undocumented
Method	`upload_pdb`	Upload a scenario archive to the project manager.
Method	`upload_scenario`	Upload a scenario archive to the project manager.
Instance Variable	`client`	Undocumented
Instance Variable	`document`	Undocumented
Property	`hostname`	Property: The hostname of this project manager
Property	`port`	Property: The port of this project manager
Static Method	`_init_url`	Undocumented
Method	`_do_request`	Undocumented
Method	`_request`	Undocumented
Instance Variable	`_base_url`	Undocumented
Instance Variable	`_url`	Undocumented

def __init__(self, url):

Undocumented

Parameters
url:`str`	Undocumented

def auto_record_asm_stub(self, qemu_session_id, **kwargs):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def auto_record_binary(self, qemu_session_id, binary_name, **kwargs):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
binary_name:`str`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def cancel_task(self, task_id):

Undocumented

Parameters
task_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def close_server(self, server):

Disconnect and stop the remote Reven server.

Warning

Be careful when using this method, as it could stop servers to which other scripts are currently connected. Any active Axion session would prevent the server to be stoppped.

Parameters
server:`reven2.RevenServer`	`RevenServer` connected to the target server.
Raises
`ResponseError`	If the server cannot be stopped.
`Exception`	If the given `RevenServer` is not connected.

def commit_record(self, qemu_session_id, scenario_id, **kwargs):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
scenario_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def connect(self, name, ephemeral=True):

Use this method in a `with` pattern to get a `RevenServer` instance connected to the specified scenario name.

This avoids having to use port numbers to connect to a server.

A new server will be started if there is no server for this scenario. If ephemeral is set to True (the default) and a new server is started by this call, then disposing of the connection will stop the server.

Examples

>>> # Using the 'with' syntax
>>> with pm.connect("ddref") as server:
...     print(server.trace.transition_count)

>>> # From the command line, it can be easier to do:
>>> connection = Connection(pm, "ddref")
>>> server = connection.server
>>> print(server.trace.transition_count)
>>> connection.disconnect() # to stop the server if we started it

>>> # If you want to keep the server
>>> host = None
>>> port = None
>>> with pm.connect("ddref", ephemeral=False) as server:
...     # save the port for later use
...     host = server.host
...     port = server.port
... # The Reven server is still accessible here
... server = reven2.RevenServer(host, port)
... print(server.trace.transition_count)

Parameters
name:`str`	Undocumented
ephemeral:`bool`	Undocumented
Returns
`Connection`	Undocumented

def create_scenario(self, name, snapshot_id, **kwargs):

Undocumented

Parameters
name:`str`	Undocumented
snapshot_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_file(self, file_id):

Undocumented

Parameters
file_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_qemu_session_record(self, qemu_session_id, **kwargs):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_scenario(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_scenario_record(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_scenario_resource(self, scenario_id, resource_name):

Undocumented

Parameters
scenario_id:`int`	Undocumented
resource_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_scenario_resources(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_session(self, session_id):

Undocumented

Parameters
session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def delete_task(self, task_id):

Undocumented

Parameters
task_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def eject_cdrom_qemu_session(self, qemu_session_id):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def export_scenario(self, scenario_id, replay=False, light_ossi=True, light_pdb=False, user_data=True):

Undocumented

Parameters
scenario_id:`int`	Undocumented
replay:`bool`	Undocumented
light_ossi:`bool`	Undocumented
light_pdb:`bool`	Undocumented
user_data:`bool`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_actions_list(self):

Undocumented

Returns
`OrderedDict`	Undocumented

def get_active_tasks_list(self, limit=5, offset=0, **kwargs):

Undocumented

Parameters
limit:`int`	Undocumented
offset:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_files_list(self, limit=5, offset=0, **kwargs):

Undocumented

Parameters
limit:`int`	Undocumented
offset:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_resources_list(self):

Undocumented

Returns
`OrderedDict`	Undocumented

def get_scenario(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_action(self, scenario_id, action_name):

Undocumented

Parameters
scenario_id:`int`	Undocumented
action_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_actions_list(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_by_name(self, scenario_name):

Uses the new scenarios by_name API from Reven 2.12

Parameters
scenario_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_by_uuid(self, scenario_uuid):

Uses the new scenarios by_uuid API from Reven 2.12

Parameters
scenario_uuid:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_resource(self, scenario_id, resource_name):

Undocumented

Parameters
scenario_id:`int`	Undocumented
resource_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenario_resources_list(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_scenarios_list(self, limit=5, offset=0, **kwargs):

Undocumented

Parameters
limit:`int`	Undocumented
offset:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_server_by(self, *, uuid=None, name=None):

Get a connection to the Reven server for the given scenario.

The scenario can be defined either by its `uuid` or its `name`.
The server is started if not already running.
The Trace resource of the scenario must have been replayed to start a Reven server.

Parameters
uuid:`Optional[str]`	The uuid of the scenario.
name:`Optional[str]`	The name of the scenario.
Returns
`reven2.RevenServer`	A handle to the Reven server.
Raises
`ResponseError`	If the server cannot be started.
`ValueError`	If both parameters are `None`.

def get_session(self, session_id):

Undocumented

Parameters
session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_session_log(self, session_id, **kwargs):

Undocumented

Parameters
session_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_sessions_list(self, limit=5, offset=0, **kwargs):

Undocumented

Parameters
limit:`int`	Undocumented
offset:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_snapshot(self, snapshot_id):

Undocumented

Parameters
snapshot_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_task(self, task_id):

Undocumented

Parameters
task_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def get_task_log(self, task_id, **kwargs):

Undocumented

Parameters
task_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def get_tasks_list(self, limit=5, offset=0, **kwargs):

Undocumented

Parameters
limit:`int`	Undocumented
offset:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def import_scenario(self, archive_name):

Undocumented

Parameters
archive_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def insert_cdrom_qemu_session(self, qemu_session_id, **kwargs):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def load_live_snapshot_qemu_session(self, qemu_session_id, live_snapshot_name):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
live_snapshot_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def refresh_missing_pdbs(self):

Undocumented

Returns
`OrderedDict`	Undocumented

def replay_scenario(self, scenario_id, resources=None, actions=None, **kwargs):

Undocumented

Parameters
scenario_id:`int`	Undocumented
resources:`Optional[List[str]]`	Undocumented
actions:`Optional[List[str]]`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def save_live_snapshot_qemu_session(self, qemu_session_id, live_snapshot_name):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
live_snapshot_name:`str`	Undocumented
Returns
`OrderedDict`	Undocumented

def start_qemu_snapshot_session(self, qemu_snapshot_id, live_snapshot=None, **kwargs):

Undocumented

Parameters
qemu_snapshot_id:`int`	Undocumented
live_snapshot	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def start_record(self, qemu_session_id):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def start_reven_session(self, scenario_id):

Undocumented

Parameters
scenario_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def stop_record(self, qemu_session_id):

Undocumented

Parameters
qemu_session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def stop_session(self, session_id):

Undocumented

Parameters
session_id:`int`	Undocumented
Returns
`OrderedDict`	Undocumented

def update_qemu_snapshot(self, qemu_snapshot_id, **kwargs):

Undocumented

Parameters
qemu_snapshot_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def update_scenario(self, scenario_id, **kwargs):

Undocumented

Parameters
scenario_id:`int`	Undocumented
**kwargs	Undocumented
Returns
`OrderedDict`	Undocumented

def upload_file(self, filepath):

Undocumented

Parameters
filepath:`Union[str, Path]`	Undocumented
Returns
`OrderedDict`	Undocumented

def upload_pdb(self, pdb_path):

Upload a scenario archive to the project manager.

Parameters
pdb_path:`Union[str, Path]`	path to the PDB to upload
Returns
`int`	the uploaded PDB path on the server
Raises
`OSError`	if open file fails
`ChunkUploadError`	on network and upload error

def upload_scenario(self, archive_path, archive_name=None):

Upload a scenario archive to the project manager.

Parameters
archive_path:`Union[str, Path]`	path to the archive file to upload
archive_name:`Optional[str]`	optional new name for the archive file
Returns
final archive name suitable for `import_scenario`
Raises
`OSError`	if open file fails
`RuntimeError`	on network and upload error

client =

Undocumented

document =

Undocumented

@property
hostname: str =

Property: The hostname of this project manager

@property
port: int =

Property: The port of this project manager

@staticmethod
def _init_url(url):

Undocumented

def _do_request(self, actions, params=None):

Undocumented

def _request(self, actions, params=None):

Undocumented

_base_url =

Undocumented

_url =

Undocumented

reven2.preview.project_manager.project_manager.ProjectManager

Warning

Examples

`reven2.preview.project_manager.project_manager.ProjectManager`