Class R2Papi

constructor

• new R2Papi(r2): R2Papi

• Create a new instance of the R2Papi class, taking an r2pipe interface as reference.

     *
  Copy

  Parameters

  • r2: R2Pipe

  Returns R2Papi

  instance

r2

analyzeFunctionsFromCalls

• analyzeFunctionsFromCalls(): R2Papi

• Returns R2Papi

analyzeFunctionsWithEsil

• analyzeFunctionsWithEsil(depth?): void

• Parameters

  • Optional depth: number

  Returns void

analyzeFunctionsWithPreludes

• analyzeFunctionsWithPreludes(): R2Papi

• Returns R2Papi

analyzeImports

• analyzeImports(): R2Papi

• Returns R2Papi

analyzeObjCReferences

• analyzeObjCReferences(): R2Papi

• Returns R2Papi

analyzeProgram

• analyzeProgram(depth?): R2Papi

• Parameters

  • Optional depth: number

  Returns R2Papi

analyzeProgramWithEsil

• analyzeProgramWithEsil(depth?): void

• Parameters

  • Optional depth: number

  Returns void

arch

• arch(): string

• Returns string

ascii

• ascii(msg): void

• Parameters

  • msg: string

  Returns void

at

• at(a): NativePointer

• Parameters

  • a: string

  Returns NativePointer

binInfo

• binInfo(): BinFile

• Returns BinFile

bits

• bits(): string

• Returns string

call

• call(s): string

• Parameters

  • s: string

  Returns string

callj

• callj(s): any

• Parameters

  • s: string

  Returns any

clearScreen

• clearScreen(): R2Papi

• Returns R2Papi

clippy

• clippy(msg): void

• Parameters

  • msg: string

  Returns void

cmd

• cmd(s): string

• Parameters

  • s: string

  Returns string

cmdj

• cmdj(s): any

• Parameters

  • s: string

  Returns any

countFlags

• countFlags(): number

• Returns number

countFunctions

• countFunctions(): number

• Returns number

currentFile

• currentFile(name): string

• Parameters

  • name: string

  Returns string

currentSeek

• currentSeek(): NativePointer

• Returns NativePointer

currentThreadId

• currentThreadId(): number

• Returns number

enumerateBinaries

• enumerateBinaries(): any

• Returns any

enumerateClasses

• enumerateClasses(): any

• Returns any

enumerateEntrypoints

• enumerateEntrypoints(): any

• Returns any

enumerateExports

• enumerateExports(): any

• Returns any

enumerateFiles

• enumerateFiles(): any

• Returns any

enumerateFlags

• enumerateFlags(): Flag[]

• Returns Flag[]

enumerateFunctions

• enumerateFunctions(): Function[]

• Returns Function[]

enumerateImports

• enumerateImports(): any

• Returns any

enumerateLibraries

• enumerateLibraries(): string[]

• Returns string[]

enumerateMaps

• enumerateMaps(): any

• Returns any

enumerateModules

• enumerateModules(): DebugModule[]

• Returns DebugModule[]

enumeratePlugins

• enumeratePlugins(type): any

• Parameters

  • type: PluginFamily

  Returns any

enumerateRelocations

• enumerateRelocations(): any

• Returns any

enumerateSections

• enumerateSections(): any

• Returns any

enumerateSegments

• enumerateSegments(): any

• Returns any

enumerateSymbols

• enumerateSymbols(): any

• Returns any

enumerateThreads

• enumerateThreads(): ThreadContext[]

• Returns ThreadContext[]

enumerateXrefsTo

• enumerateXrefsTo(s): string[]

• Parameters

  • s: string

  Returns string[]

findXrefsTo

• findXrefsTo(s, use_esil): void

• Parameters

  • s: string

  • use_esil: boolean

  Returns void

getArch

• getArch(): string

• Returns string

getBaseAddress

• getBaseAddress(): NativePointer

• Returns NativePointer

getBits

• getBits(): string

• Returns string

getBlockSize

• getBlockSize(): number

• Returns number

getConfig

• getConfig(key): string | Error

• Parameters

  • key: string

  Returns string | Error

getCpu

• getCpu(): string

• Returns string

getRegisterStateForEsil

• getRegisterStateForEsil(): string

• Returns string

getRegisters

• getRegisters(): any

• Returns any

getShell

• getShell(): R2Shell

• Returns R2Shell

hex

• hex(s): string

• Parameters

  • s: string | number

  Returns string

id

• id(): number

• Returns number

insertNullBytes

• insertNullBytes(newSize, at?): R2Papi

• Parameters

  • newSize: number

  • Optional at: string | number | NativePointer

  Returns R2Papi

jsonToTypescript

• jsonToTypescript(name, a): string

• Parameters

  • name: string

  • a: any

  Returns string

log

• log(s): string

• Parameters

  • s: string

  Returns string

math

• math(expr): number

• Parameters

  • expr: string | number

  Returns number

newMap

• newMap(fd, vaddr, size, paddr, perm, name?): void

• should return the id for the new map using the given file descriptor

  Parameters

  • fd: number

  • vaddr: NativePointer

  • size: number

  • paddr: NativePointer

  • perm: Permission

  • name: string = ""

  Returns void

openFile

• openFile(name): number | Error

• Parameters

  • name: string

  Returns number | Error

openFileNomap

• openFileNomap(name): number | Error

• Parameters

  • name: string

  Returns number | Error

platform

• platform(): string

• Returns string

printAt

• printAt(msg, x, y): void

• Parameters

  • msg: string

  • x: number

  • y: number

  Returns void

ptr

• ptr(s): NativePointer

• Parameters

  • s: string | number

  Returns NativePointer

removeBytes

• removeBytes(newSize, at?): R2Papi

• Parameters

  • newSize: number

  • Optional at: string | number | NativePointer

  Returns R2Papi

resizeFile

• resizeFile(newSize): R2Papi

• Parameters

  • newSize: number

  Returns R2Papi

searchBytes

• searchBytes(data): SearchResult[]

• Parameters

  • data: number[]

  Returns SearchResult[]

searchDisasm

• searchDisasm(s): SearchResult[]

• Parameters

  • s: string

  Returns SearchResult[]

searchString

• searchString(s): SearchResult[]

• Parameters

  • s: string

  Returns SearchResult[]

seek

• seek(addr): R2Papi

• Parameters

  • addr: number

  Returns R2Papi

seekToRelativeOpcode

• seekToRelativeOpcode(nth): NativePointer

• Parameters

  • nth: number

  Returns NativePointer

selectBinary

• selectBinary(id): void

• Parameters

  • id: number

  Returns void

setArch

• setArch(arch, bits): void

• Parameters

  • arch: string

  • bits: undefined | number

  Returns void

setBlockSize

• setBlockSize(a): R2Papi

• Parameters

  • a: number

  Returns R2Papi

setConfig

• setConfig(key, val): R2Papi

• Parameters

  • key: string

  • val: string

  Returns R2Papi

setFlagSpace

• setFlagSpace(name): void

• Parameters

  • name: string

  Returns void

setLogLevel

• setLogLevel(level): R2Papi

• Parameters

  • level: number

  Returns R2Papi

setRegisters

• setRegisters(obj): void

• Parameters

  • obj: any

  Returns void

skip

• skip(): void

• Returns void

step

• step(): R2Papi

• Returns R2Papi

stepOver

• stepOver(): R2Papi

• Returns R2Papi

stepUntil

• stepUntil(dst): void

• Parameters

  • dst: string | number | NativePointer

  Returns void

toJSON

• toJSON(): string

• Returns string

toString

• toString(): string

• Returns string

version

• version(): string

• Returns string