reven2 API Documentation

Module Index

  • reven2 - The REVEN2 python API.
    • reven2.address - Defines memory address classes
    • reven2.arch - Contains classes and instances related to the description of the machine architecture.
      • reven2.arch.helpers - Contains useful functions about registers.
      • reven2.arch.msr - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.msr)`
      • reven2.arch.register - Defines the Register class and related classes.
      • reven2.arch.sse2 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.sse2)`
      • reven2.arch.x64 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.x64)`
      • reven2.arch.x87 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.x87)`
    • reven2.bookmark - No module docstring; 2/3 classes documented
    • reven2.filter - Module related to trace filter. See the Filter object.
    • reven2.memhist - No module docstring; 3/3 classes, 0/10 functions, 0/1 variables documented
    • reven2.ossi - Package related to OSSI information. See the OssiContext object.
      • reven2.ossi._data_source - Undocumented
      • reven2.ossi.ossi - Module related to the public OSSI objects.
      • reven2.ossi.process - No module docstring; 1/1 classes documented
    • reven2.prelude - This is the prelude module of the Reven2 python API
    • reven2.preview - Contains subpackages and modules whose API is not considered stable yet.
      • reven2.preview.project_manager - Package related to REVEN project manager. This is a low-level REST API binding, which is incomplete and unstable
        • reven2.preview.project_manager._connect - No module docstring; 1/3 classes, 0/5 functions, 0/7 variables documented
        • reven2.preview.project_manager.project_manager - Wrapper to communicate with the REVEN project manager This is a work in progress This is a low-level REST API binding, which is incomplete and unstable
      • reven2.preview.prototypes - Package related to function prototypes parsing.
        • reven2.preview.prototypes.callconv_helper - Implementation details of a helper to use calling convention implementations.
        • reven2.preview.prototypes.calling_conventions - Implementation details for each calling convention.
          • reven2.preview.prototypes.calling_conventions.cdecl - Implementation of the cdecl calling convention used by 32bit systems
          • reven2.preview.prototypes.calling_conventions.chunks - Types returned by calling conventions to define argument chunks.
          • reven2.preview.prototypes.calling_conventions.fastcall - Implementation of the fastcall calling convention used by Windows 32bit
          • reven2.preview.prototypes.calling_conventions.ms64 - Implementation of the Microsoft x64 calling convention used by Windows 64bit
          • reven2.preview.prototypes.calling_conventions.sysv64 - Implementation of the System V ABI AMD64 calling convention used by Linux 64bit
        • reven2.preview.prototypes.parsing_types - Binding of the reven low level parsing API types
        • reven2.preview.prototypes.prototype - Prototype: a function and a calling convention Get arguments and return values at given points in the trace.
        • reven2.preview.prototypes.reven_prototypes - C and C++ prototypes parsing.
      • reven2.preview.taint - Package related to data tainting.
        • reven2.preview.taint.helpers - Undocumented
    • reven2.search - Module related to trace search. See the Search object.
    • reven2.search_in_memory - No module docstring; 7/8 classes documented
    • reven2.session - Module related to sessions, that allow to publish information to various other connected clients (e.g., Axion).
    • reven2.stack - Module related to stack. See the Stack object.
    • reven2.string - Module related to strings in trace. See the String object.
    • reven2.trace - Module related to the execution trace. See the Trace object.
      • reven2.trace._data_source - Undocumented
      • reven2.trace._find_inverse - No module docstring; 11/18 functions documented
    • reven2.types - Contains classes and instances related to the description of data types.
      • reven2.types._array - No module docstring; 2/2 classes documented
      • reven2.types._integer - No module docstring; 7/7 classes, 0/2 functions documented
      • reven2.types._pointer - No module docstring; 1/1 classes, 0/1 functions documented
      • reven2.types._primitive - Undocumented
      • reven2.types._string - No module docstring; 2/2 classes, 0/2 variables documented
      • reven2.types._type - No module docstring; 1/1 classes documented
    • reven2.util - Module that provide util functions