eptalights code analysis documentation

The Eptalights Code Analysis Library is a powerful Python package designed to help hackers, researchers, and developers effortlessly perform code analysis, discover bugs, conduct variant analysis, and more.

Effortlessly analyze program structures, functions, and call sites, and save time by quickly identifying complex variables with support for SSA variables, control flow graphs (CFGs), and more in a simple, Pythonic way. Think of it as Binary Ninja, but for source code.

Automate detailed code analysis rules, patterns, or variants more naturally with simple Python APIs, without needing to learn a custom DSL, in both small and large codebases.

Usage

Start with Quickstart.

For more details on setting up, see Getting Started.

Links

• Introducing Eptalights Code Analysis Technology Blog post

• Eptalights Code Analysis Product Page

• Eptalights Website

Table of Contents

• Quickstart
  • 1. Setting up Locally
  • 2. Testing our Local Setup
• Getting Started
  • 1. Extract ByteCode or IR Data from Your Source Code
  • 2. Transform And Lift Code to SophiaIR models
  • 3. Flexible Database Access
• Working with Functions
  • 1. get total functions
  • 2. listing functions
  • 3. get function by id
  • 4. get functions by file path
  • 5. search functions
  • 6. dumping function Pseudo-C code
• Working with Steps or Instructions
  • 1. print OP type and Pseudo-C code of steps
  • 2. print steps of a basicblock
• Working with Callsites
  • 1. searching callsites globally across all functions
  • 2. searching callsites within a single all functions
  • 3. get callsite by id
  • 4. print callsite’s step
  • 5. get total callsites
• Working with Control Flow Graph (CFG)
  • 1. print Control Flow Graph (CFG) structure
  • 2. get basic block index of a step
• Working with Variables
  • 1. print variable names in a function
  • 2. print all variable objects of a function
  • 3. print local variable objects of a function
  • 4. get variables defined or used at a specific step
  • 5. get specific variable object by name
  • 6. searching variables globally across all functions
  • 7. searching variables within a single function
  • 6. get total variables
• Working with Tokenized Operands
  • 1. Basics of Tokenized Operands
  • 2. Inspecting Tokens within Tokenized Operands
  • 3. Analyzing Constant Tokenized Operands
  • 4. Token Structure and Key Attributes
  • 5. More Docs on How to use Tokenized Operands
• Working with Arrays
  • 1. Array Basics
  • 2. Accessing a Specific Array Index
• Working with Structs
  • 1. Struct Basics
  • 2. Handling Deeply Nested Attributes
• Working with C++
  • 1. Hello World in C++
  • 2. Working with operator overloading in C++
  • 3. Working with vectors
  • 4. Working with maps
  • 5. Working with function overloading in C++
• Working with PHP
  • 1. Hello World in PHP
  • 2. Working with Classes
  • 3. Working with Obfuscated PHP Code
  • 4. Working with Encoded PHP Code
  • 5. Conclusion
• Working with Java
• Working with Dataflow
• Working with File Metadata / File Data
• Working with Raw IR/Bytecode
• Configuration
• API Reference
  • Function
    • FunctionModel
  • Step or Instruction
    • SophiaIRNopModel
    • SophiaIRAssignModel
    • SophiaIRCallModel
    • SophiaIRCondModel
    • SophiaIRReturnModel
    • SophiaIRGotoModel
    • SophiaIRSwitchModel
    • ExprModel
  • Callsite
    • CallsiteModel
    • CallsiteManagerModel
  • CFG
    • ControlFlowGraphModel
  • Config
    • ConfigModel
  • Variable
    • SSAVariableModel
    • VariableModel
    • VariableManagerModel
  • Tokenized Operands
    • TokenizedOperandModel
    • TokenModel
  • Enum Types
    • VarType
    • TokenType
    • OpType
    • ExprType
    • ClassMetadataModel
    • FileMetadataModel
    • ClassDataModel
    • FileDataModel
  • Dataflow
    • SinkResultType
    • DataflowEventModel
    • DataflowStateModel
    • DataflowPathModel
    • DataflowRequestModel
    • DataflowResponseModel
    • DataflowActionModel