reven2 API Documentation

Class Hierarchy

  • enum.Enum
    • reven2.memhist.Direction - Enum describing the temporal direction.
    • reven2.memhist.MemoryAccessOperation - Enum describing the various kinds of memory accesses.
    • reven2.preview.taint.ProgressStatus - No summary
    • reven2.preview.taint.PropagationDirection - Enum describing the taint direction - Forward: Forward taint - Backward: Backward taint
    • reven2.preview.taint.ResultGranularity - No summary
    • reven2.preview.taint.TaintResultStatus - Enum describing the various statuses of a TaintResultView.
    • reven2.stack.StackFrameType - Enum describing the various type of stack frame.
    • reven2.trace.TransitionType - Enum Type of a transition.
    • reven2.types._integer.Endianness - Endianness of an Integer type.
    • reven2.types._integer.Signedness - Signedness of an Integer type.
    • reven2.types._string.Encoding - A supported string encoding. Possible values:
  • object
    • reven2.address._AbstractAddress - The abstract class from which any address representation is derived.
      • reven2.address.LinearAddress - Representation of a linear address.
      • reven2.address.LogicalAddress - Representation of a logical address based on a segment register.
      • reven2.address.LogicalAddressSegmentIndex - Representation of a logical address based on a segment index.
      • reven2.address.PhysicalAddress - Representation of a physical address.
    • reven2.arch.register.Category - Category of a register.
    • reven2.arch.register.Register - Models an architecture register that can serve as key to designate that register.
    • reven2.memhist.MemoryAccess - Represents an access performed to the memory at some point.
    • reven2.ossi._data_source.DataSource - Undocumented
    • reven2.ossi.ossi.Binary - Light modelisation of a binary file.
    • reven2.ossi.ossi.Location - Useful OSSI information related to an address, such as the nearest symbol or the base address.
    • reven2.ossi.ossi.Ossi - Root object for OSSI information
    • reven2.ossi.ossi.OssiContext - Object that provide useful OSSI information for a particular context.
    • reven2.ossi.ossi.Symbol - A modelisation of a static symbol.
    • reven2.prelude.RevenServer - A reven server. This is the root api object.
    • reven2.preview.project_manager._connect.Connection - No class docstring; 10/10 methods documented
    • reven2.preview.project_manager._connect.PaginedList - Undocumented
      • reven2.preview.project_manager._connect.ScenarioExactNameList - Undocumented
    • reven2.preview.project_manager.project_manager.ProjectManager - The project manager class exposes basic methods to manage scenarios, record them, replay them and start a REVEN server to analyse them.
    • reven2.preview.taint._TaintData - Undocumented
    • reven2.preview.taint.ChangeMarkers - Models gained and lost markers for a TaintChange entry.
    • reven2.preview.taint.MarkerIterator - Models an iterator over taint markers.
    • reven2.preview.taint.MarkerManager - Manages the taint markers defined in a taint.
    • reven2.preview.taint.Progress - Represent the status of the taint at the point where it was requested.
    • reven2.preview.taint.Taint - Represent a started taint in the backend, allowing to retrieve the taint results.
    • reven2.preview.taint.TaintAccess - Containing information about the accessed data.
    • reven2.preview.taint.TaintChange - A change between two taint states, containing information about which data became tainted or lost the taint.
    • reven2.preview.taint.TaintedData - Undocumented
      • reven2.preview.taint.TaintedMemories - Models a range of memory
      • reven2.preview.taint.TaintedRegisterSlice - Models a slice of an architecture register, e.g. rax[0..4]
    • reven2.preview.taint.Tainter - Entry point object for tainting data.
    • reven2.preview.taint.TaintResultView - TThe abstract class from which any result view is derived.
      • reven2.preview.taint.TaintAccessView - A view of the TaintAccesss that occurred in a taint.
      • reven2.preview.taint.TaintChangeView - A view of the TaintChanges that occurred in a taint.
      • reven2.preview.taint.TaintStateView - A view of the TaintStates that occurred in a taint.
      • reven2.preview.taint.TaintWarningView - A view of the TaintWarnings that occurred in a taint.
    • reven2.preview.taint.TaintState - A taint state lists all data that is currently tainted at a given Context.
    • reven2.preview.taint.TaintWarning - A taint warning is a collection of warning messages that occurred during the taint.
    • reven2.search.Search - Entry point object to find interesting points in a trace.
    • reven2.search_in_memory._SearchState - Undocumented
    • reven2.search_in_memory.Event - An event encountered during a search in memory, obtained by iterating on Search.events().
      • reven2.search_in_memory.AccessEvent - Event that occurs when an existing slice that matches the pattern is read in the trace.
      • reven2.search_in_memory.DelEvent - Event that occurs when an existing slice that matches the pattern is overwritten in the trace.
      • reven2.search_in_memory.FirstSeenEvent - Event that occurs when a slice matching a pattern is discovered for the first time in the trace, and this slice was not created by a NewEvent.
      • reven2.search_in_memory.NewEvent - Event that occurs when a slice starts matching a pattern.
    • reven2.search_in_memory.Match - Represents a slice of memory that matches a specific pattern during some portion of the trace.
    • reven2.search_in_memory.Search - Search which slices of memory match a specified pattern.
    • reven2.session.Session - A session and the number of clients connected to it, as returned by the server.
    • reven2.session.Sessions - A list of the sessions that a REVEN server tracks.
    • reven2.session.TrackedSessions - A list facade that converts appended strings to full-fledged Sessions, and refreshes the number of subscribers of a session whenever it is are accessed.
    • reven2.stack.Stack - Representation of a stack
    • reven2.stack.StackFrame - Representation of a part (frame) of a stack.
    • reven2.string.String - Represents a string that is read and/or write during the trace.
    • reven2.trace._data_source.DataSource - Undocumented
    • reven2.trace.Context - Entry point object for data related to a context.
    • reven2.trace.CPUException - Basic representation of an exception that occurred in the trace
    • reven2.trace.Instruction - Basic representation of a disassembled instruction.
    • reven2.trace.Trace - Entry point object for information related to a trace, mostly transitions & contexts.
    • reven2.trace.Transition - Entry point object for data related to a transition.
    • reven2.types._type.Type - An abstract class whose instances represent a type. Refer to the module documentation for details.
      • reven2.types._array.Array - A type constructor for contiguous homogeneous arrays ([T; n]).
        • reven2.types._array.RawBuffer - A specialized Array containing U8 ([U8; n]).
      • reven2.types._integer.Integer - An abstract class whose instances represent the types of integer.
        • reven2.types._integer.ArchDependentInteger - An integer type whose size depends on whether the current context is 32 or 64 bits.
        • reven2.types._integer.BigEndian - An integer type that wraps an inner integer type and forces its endianness to big-endian.
        • reven2.types._integer.FixedWidthInteger - An integer type of a fixed size.
        • reven2.types._integer.LittleEndian - An integer type that wraps an inner integer type and forces its endianness to little-endian.
      • reven2.types._pointer.Pointer - A type constructor that accepts a type T as parameter and builds the type representing "a pointer to T" (T*).
      • reven2.types._primitive.Primitive - Undocumented
      • reven2.types._primitive.PrimitiveBool - Undocumented
      • reven2.types._string.CString - A type constructor for NUL-terminated strings ("C-like" strings).
    • reven2.util.Peekable - Undocumented
  • reven2.bookmark._DataSource - Undocumented
  • reven2.bookmark.Bookmark - A Bookmark saved on the REVEN server for this project.
  • reven2.bookmark.Bookmarks - A list of the bookmarks saved on the REVEN server for this project.
  • reven2.ossi.process.Process - Represents some basic information about a process.
  • RuntimeError
    • reven2.preview.LicenseError - Undocumented
    • reven2.preview.project_manager.project_manager.ProjectManagerError - Undocumented
      • reven2.preview.project_manager.project_manager.ConnectionError - Undocumented
      • reven2.preview.project_manager.project_manager.RequestError - Undocumented
      • reven2.preview.project_manager.project_manager.ResponseError - Undocumented