Octopus

Muchas gracias a QuoScient por patrocinar este proyecto.

Octopus es un marco de análisis de seguridad para módulos WebAssembly y contratos inteligentes de Blockchain.

El propósito de Octopus es proporcionar una manera fácil de analizar módulos WebAssembly de código cerrado y bytecode de contratos inteligentes para comprender más a fondo sus comportamientos internos.

Características

• Explorer: Implementación del cliente JSON-RPC de Octopus para comunicarse con plataformas blockchain
• Disassembler: Octopus puede traducir bytecode a representación ensamblador
• Control Flow Analysis: Octopus puede generar un Gráfico de Flujo de Control (CFG)
• Call Flow Analysis: Octopus puede generar un Gráfico de Flujo de Llamadas (a nivel de funciones)
• IR conversion (SSA): Octopus puede simplificar el ensamblado en representación de Asignación Única Estática (SSA)
• Symbolic Execution: Octopus utiliza ejecución simbólica para encontrar nuevos caminos en un programa

Plataformas / Arquitecturas

Octopus soporta los siguientes tipos de programas/contratos inteligentes:

• Módulo WebAssembly (WASM)
• Script de Bitcoin (BTC script)
• Contratos inteligentes de Ethereum (bytecode EVM & Ewasm)
• Contratos inteligentes de EOS (WASM)
• Contratos inteligentes de NEO (bytecode AVM)

	BTC	ETH (EVM)	ETH (WASM)	EOS	NEO		WASM
Explorer	✔️	✔️	✔️	✔️	✔️		⭕
Disassembler	✔️	✔️	✔️	✔️	✔️		✔️
Control Flow Analysis	✖️	✔️	✔️	✔️	✔️		✔️
Call Flow Analysis	✖️	➕	✔️	✔️	➕		✔️
IR conversion (SSA)	✖️	✔️	➕	➕	✖️		✔️
Symbolic Execution	✖️	➕	➕	➕	✖️		➕

• PyPI package ✔️
• Docker ✔️

✔️ HECHO / ➕ EN PROGRESO / ✖️ POR HACER / ⭕ N/A

Requisitos

Octopus es compatible con Linux (idealmente Ubuntu 16.04) y requiere Python >=3.5 (idealmente 3.6).

Dependencias:

• Generación de gráficos: graphviz
• Explorer: requests
• Ejecución simbólica: z3-solver
• Wasm: wasm

Inicio Rápido

• Instalar dependencias del sistema```

Install system dependencies

sudo apt-get update && sudo apt-get install python-pip graphviz xdg-utils -y

- Instalar Octopus:```
# Download Octopus
git clone https://github.com/pventuzelo/octopus
cd octopus

# Install Octopus library/CLI and its dependencies
python3 setup.py install

o```

but prefer the first way to install if possible

pip3 install octopus

- Ejecutar pruebas```
# Run tests for all platforms (disassembly, CFG, ...)
./run_tests.sh
# Run tests that require internet access (explorer tests)
./run_explorer_tests.sh

# Run tests for only one platforms
# {btc, eth, eos, neo, wasm}_run_tests.sh
cd octopus/tests/
./wasm_run_tests.sh

Contenedor Docker

Un contenedor Docker que proporciona el conjunto de herramientas está disponible en docker hub. En una terminal, ejecuta los siguientes comandos:``` docker pull smartbugs/octopus docker run -it smartbugs/octopus cd octopus python3 octopus_eth_evm.py -s -f examples/ETH/evm_bytecode/61EDCDf5bb737ADffE5043706e7C5bb1f1a56eEA.bytecode

## Herramientas de línea de comandos

* WebAssembly: [octopus_wasm.py](https://github.com/fuzzinglabs/octopus/blob/master/octopus_wasm.py)
* Ethereum (EVM): [octopus_eth_evm.py](https://github.com/fuzzinglabs/octopus/blob/master/octopus_eth_evm.py)

## Ejemplos detallados usando APIs

<details><summary>WebAssembly</summary>
<p>

#### Desensamblador

Desensamblado de un módulo Wasm:```python
from octopus.arch.wasm.disassembler import WasmDisassembler

FILE = "examples/wasm/samples/helloworld.wasm"

with open(FILE, 'rb') as f:
    module_bytecode = f.read()

disasm = WasmDisassembler()
# return list of functions instructions (list)
print(disasm.disassemble_module(module_bytecode))
#[[<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904278>,<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904f60>,<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904ef0>]]

print()
# return text of functions code
print(disasm.disassemble_module(module_bytecode, r_format='text'))
# func 0
# i32.const 0
# call 0
# end

Desensamblaje del código de bytes de wasm:```python from octopus.arch.wasm.disassembler import WasmDisassembler

bytecode in WebAssembly is the function code (i.e. function body)

bytecode = b'\x02\x7fA\x18\x10\x1cA\x00\x0f\x0b'

create a WasmDisassembler object

disasm = WasmDisassembler(bytecode)

disassemble bytecode into a list of WasmInstruction

attributes r_format='list' by default

print(disasm.disassemble())

#[<octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904eb8>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>] print() print(disasm.disassemble(r_format='reverse'))

#{0: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>, 1: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904240>, 2: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, 3: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, 4: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, 5: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>} print() print(disasm.disassemble(r_format='text'))

block -1

i32.const 24

call 28

i32.const 0

return

end

#### ModuleAnalyzer```python
from octopus.arch.wasm.analyzer import WasmModuleAnalyzer

FILE = "examples/wasm/samples/hello_wasm_studio.wasm"

with open(FILE, 'rb') as f:
    module_bytecode = f.read()

# return list of functions instructions (list)
# attributes analysis=True by default
analyzer = WasmModuleAnalyzer(module_bytecode)