Dragodis

April 30, 2026 ยท View on GitHub

Dragodis is a Python framework which allows for the creation of universal disassembler scripts. Dragodis currently supports the following disassemblers:

The name Dragodis comes from the combination of Dragoman, a professional interpreter, and Disassembler.

Dragodis was created due to a need of the ability to run IDA scripts in Ghidra. Many scripts for automated analysis will work fine in most disassemblers. Eliminating the need to use disassemblers which require licenses for automated analysis is ideal.

There are other benefits of a universal disassembler API as well. Many reverse engineers have a preferred disassembler. Dragodis allows for simple transfers of scripts between users of different disassemblers. Dragodis also aims to provide a cleaner and easier to use API than those provided by other disassemblers.

Install

Use pip to install dragodis:

pip install dragodis

Then follow the instructions here to install a backend disassembler.

Usage

To use Dragodis, simply pass in the path to your input binary file into either the IDA or Ghidra class. This will create an instance of the disassembler with the given input file analyzed.

import dragodis

with dragodis.Ghidra(r"C:\strings.exe") as ghidra:
    print(ghidra.get_dword(0x401000))
import dragodis

with dragodis.IDA(r"C:\strings.exe") as ida:
    print(ida.get_dword(0x401000))

A disassembler can also be run without using a context manager using the start() and stop() functions.

import dragodis

ghidra = dragodis.Ghidra(r"C:\strings.exe")
ghidra.start()
ghidra.get_dword(0x401000)
ghidra.stop()

Alternatively, you can use open_program() to choose the disassembler more dynamically by providing the disassembler name in the disassembler parameter or by setting the DRAGODIS_DISASSEMBLER environment variable.

import dragodis

with dragodis.open_program(r"C:\strings.exe", disassembler="ida") as ida:
    print(ida.get_dword(0x401000))

It is highly recommended to use the DRAGODIS_DISASSEMBLER environment variable to ensure your scripts are cross compatible without any modification. As well, to give the user the power to choose which disassembler they would like to use.

A "NotInstalledError" will be thrown if the disassembler chosen is not properly installed.
import os
os.environ["DRAGODIS_DISASSEMBLER"] = "ida"

import dragodis

with dragodis.open_program(r"C:\strings.exe") as dis:
    print(f"Disassembler used: {dis.name}")
    print(dis.get_dword(0x401000))

If you are locally within the disassembler's interpreter (the output window for IDA or pyhidraw interpreter in Ghidra) then you can initialize a disassembler object by directly acccessing the object:

# If in IDA
import dragodis
dis = dragodis.IDA()

# If in Ghidra
import dragodis
dis = dragodis.Ghidra()

We can also directly call scripts using the open_program() function locally in the disassembler. When this happens, the input file path provided must match the detected input file path by the disassembler.

Specifying Processor Type

The processor type can be specified during initialization of the Disassembler object or through open_program(). This can be useful when loading shellcode.

When using open_program() with any backend disassembler supported, use a dragodis.PROCESSOR_* flag which will get converted to a sane default for the respective disassembler.

import dragodis
with dragodis.open_program(r"C:\input.exe", processor=dragodis.PROCESSOR_ARM) as dis:
    ...

If using a specific disassembler, any option that disassembler supports can be passed in. (Consult the documentation for the respective disassembler to know how to format the argument.)

# IDA
import dragodis
ida = dragodis.IDA(r"C:\input", processor="arm:ARMv7-M")

# Ghidra
import dragodis
ghidra = dragodis.Ghidra(r"C:\input", processor="ARM:LE:32:v7")

# Vivisect
import dragodis
vivisect = dragodis.Vivisect(r"C:\input", processor="arm")

Alternatively, we can automatically choose a processor for the disassembler with backend prefixed arguments.

import dragodis

# Override processor spec for specific disassembler.
# (e.g. pick "ARM:LE:32:v7" if using Ghidra backend.)
with dragodis.open_program(r"C:\input", processor=dragodis.PROCESSOR_ARM, ghidra_processor="ARM:LE:32:v7") as dis:
    ...


# Override processor spec for every disassembler.
processor = dict(
    ida_processor="arm:ARMv7-M",
    ghidra_processor="ARM:LE:32:v7",
    vivisect_processor="arm",
)

with dragodis.open_program(r"C:\input", **processor) as dis:
    ...

Specifying File Type

The file type can be specified during initialization of the Disassembler object or through open_program().

When using open_program() with any backend disassembler supported, use a dragodis.FILETYPE_* flag which will get converted to a sane default for the respective disassembler.

import dragodis
with dragodis.open_program(r"C:\input.exe", filetype=dragodis.FILETYPE_PE) as dis:
    ...

If using a specific disassembler, any option that disassembler supports can be passed in. (Consult the documentation for the respective disassembler to know how to format the argument.)

# IDA
import dragodis
ida = dragodis.IDA(r"C:\input", filetype="Portable")

# Ghidra
import dragodis
ghidra = dragodis.Ghidra(r"C:\input", filetype="ghidra.app.util.opinion.PeLoader")

# Vivisect
import dragodis
vivisect = dragodis.Vivisect(r"C:\input", filetype="pe")

Alternatively, we can automatically choose the correct filetype for the disassembler with backend prefixed arguments.

import dragodis

filetype = dict(
    ida_filetype="Portable",
    ghidra_filetype="ghidra.app.util.opinion.PeLoader",
    vivisect_filetype="pe",
)

with dragodis.open_program(r"C:\input", **filetype) as dis:
    ...

Skip AutoAnalysis

Analysis can be optionally skipped during startup of the underlying disassembler. This can be set during initialization of the Disassembler object or through open_program().

If analysis is disabled, it is up to the user to perform their own custom analysis or call analyze() explicitly.

import dragodis

with dragodis.open_program(r"C:\input", analyze=False) as dis:
    # do things before analysis
    dis.analyze()

Configuration

All options are configurable through a settings.toml file. This file can be modified to configure Dragodis and the underlying disassemblers.

Dragodis looks for a user defined configuration file at either ~/.config/dragodis/settings.toml or %LOCALAPPDATA%\dc3\dragodis\settings.toml to overwrite the default settings.

To view the current configuration run the following:

python -m dragodis.config list

To edit the configuration run the following to open the file in a text editor. (This will copy the default configuration into a user directory)

python -m dragodis.config edit

To create a new user configuration file without editing:

python -m dragodis.config create

We use Dynaconf which provides conveniences like setting configuration using environment variables prefixed with DRAGODIS_.

For example, to set the connection retry count to the IDA remote server:

export DRAGODIS_IDA__RETRY_COUNT=50  # '__' to access nested field.

NOTE: Most of these configurations can also be provided during the open_program() call. Options provided here will override the settings file.

Disassembler API Translation Map

As a reference, the following tables provide a rough mapping between the general equivalent API calls for Dragodis and each supported disassembler.

NOTE: These are rough translations between equivalent disassembler API functions to help you transition from using either IDA or Ghidra to using Dragodis. They are not always direct translations. For brevity, some details and differences in results get glossed over here. Please see the source code for more information.

Basics

Dragodis*IDAGhidraVivisect**
dis.processor_nameida_ida.inf_get_procname()currentProgram.getLanguage().getProcessor()vw.arch.getArchName()
dis.compiler_nameida_typeinf.get_compiler_name(ida_ida.inf_get_cc_id())currentProgram.getCompiler()N/A
dis.bit_sizeida_ida.inf_get_app_bitness()currentProgram.getDefaultPointerSize() * 8vw.workspace.getPointerSize() * 8
dis.is_big_endianida_ida.inf_is_be()currentProgram.getLanguage().isBigEndian()vw.bigend
dis.min_addressida_ida.inf_get_min_ea()currentProgram.getMinAddress()min(addr for addr, *_ in vw.getSegments())
dis.max_addressida_ida.inf_get_max_ea()currentProgram.getMaxAddress()max(addr + size for addr, size, *_ in vw.getSegments())
dis.base_addressida_nalt.get_imagebase()currentProgram.getImageBase()vw.getFileMeta(filename, "imagebase")
dis.get_virtual_address(file_offset)ida_loader.get_fileregion_ea(file_offset)currentProgram.getMemory().locateAddressesForFileOffset(file_offset)complex: see source code
dis.get_file_offset(address)ida_loader.get_fileregion_offset(address)currentProgram.getMemory().getAddressSourceInfo(toAddr(address)).getFileOffset()complex: see source code
dis.entry_pointida_ida.inf_get_start_ip()(export with name "entry" or "_start")vw.getEntryPoints()[0]

Data

Dragodis*IDAGhidraVivisect**
dis.get_byte(address)ida_bytes.get_wide_byte(address)getByte(toAddr(address))vw.readMemory(addr, 1)
dis.get_bytes(address, size)ida_bytes.get_bytes(address, size)getBytes(toAddr(address), size)vw.readMemory(addr, size)
dis.find_bytes(b"\xde\xad\xbe\xef", start)idc.find_binary(start, idc.SEARCH_DOWN, "DE AD BE EF")currentProgram.getMemory().findBytes(start, b"\xde\xad\xbe\xef", None, True, monitor)vw.searchMemory(b"\xde\xad\xbe\xef")
dis.find_bytes(b"\xde\xad\xbe\xef", start, reverse=True)idc.find_binary(start, idc.SEARCH_UP, "DE AD BE EF")currentProgram.getMemory().findBytes(start, b"\xde\xad\xbe\xef", None, False, monitor)Unsupported
dis.get_word(address)ida_bytes.get_wide_word(address)getShort(toAddr(address))N/A
dis.get_dword(address)ida_bytes.get_wide_dword(address)getInt(toAddr(address))N/A
dis.get_qword(address)ida_bytes.get_qword(address)getLong(toAddr(address))N/A
dis.get_string_bytes(address)idc.get_strlit_contents(address)complex: see source codevw.readMemString(address)
dis.lines(start_address, end_address)
dis.line_addresses(start_address, end_address)
idautils.Heads(start_address, end_address)currentProgram.getListing().getCodeUnits(address_set, True)N/A
line = dis.get_line(address)N/Acode_unit = currentProgram.getListing().getCodeUnitContaining(toAddr(address))vw.getLocation(address)
line.address
dis.get_line_address(address)
idc.get_item_head(address)code_unit.getAddress()vw.getLocation(address)[0]
line.name
dis.get_name(address)
ida_name.get_name(address)code_unit.getLabel()vw.getName(address)
line.name = "new_name"ida_name.set_name(address, "new_name")symbol = code_unit.getPrimarySymbol(); symbol.setName("new_name", symbol.getSource())vw.makeName(address, "new_name")
line.sizeida_bytes.get_item_size(address)code_unit.getLength()vw.getLocation(address)[1]
line.typeida_bytes.get_flags(address)code_unit.getClass()
code_unit.getDataType().getName()
vw.getLocation(address)[2]
line.type = LineType.dwordidc.create_dword(address)createDWord(address)vw.makeNumber(address, 4)
line.dataida_bytes.get_bytes(address, ida_bytes.get_item_size(address))code_unit.getBytes()vw.readMemory(*vw.getLocation(address)[:2])
line.data = b"new data"ida_bytes.patch_bytes(address, b"new data")setBytes(code_unit.getAddress(), b"new data")vw.writeMemory(address, b"new_data")
line.get_comment()
dis.get_comment(address)
ida_bytes.get_cmt(address, 0)code_unit.getComment(0)vw.getComment(address)
line.set_comment("new comment")ida_bytes.set_cmt(address, "new comment", 0)code_unit.setComment(0, "new comment")vw.setComment(address, "new comment")
line.next
dis.next_line_address(address)
idc.next_head(address)currentProgram.getListing().getCodeUnitAfter(code_unit.getAddress())N/A
line.prev
dis.prev_line_address(address)
idc.prev_head(address)currentProgram.getListing().getCodeUnitBefore(code_unit.getAddress())N/A
line.undefine()ida_bytes.del_items(address)clearListing(code_unit.getAddress())vw.delLocation(address)
line.valueida_bytes.get_wide_byte(address)
ida_bytes.get_wide_word(address)
etc.
code_unit.getValue()vw.readMemValue(address, size)
line.value = new_valueida_bytes.patch_byte(address, new_value)
ida_bytes.patch_word(address, new_value)
ida_bytes.patch_dword(address, new_value)
etc.
setByte(code_unit.getAddress(), new_value)
setShort(code_unit.getAddress(), new_value)
setInt(code_unit.getAddress(), new_value)
etc.
vw.writeMemValue(address, new_value, size)
data_type = dis.get_data_type("dword")data_type = ida_typeinf.tinfo_t(); data_type.get_named_type(ida_typeinf.get_idati(), "dword")data_type = DataTypeParser(None, DataTypeParser.AllowedDataTypes.valueOf("ALL")).parse("dword")N/A
data_type.nameN/Adata_type.getName()N/A
data_type.sizeida_bytes.get_data_elsize(address, ida_bytes.get_flags(address) & ida_bytes.DT_TYPE)data_type.getLength()N/A
dis.undefine(start, end)ida_bytes.del_items(start, ida_bytes.DELIT_SIMPLE, end - start)clearListing(toAddr(start), toAddr(end))N/A
dis.set_bytes(address, b"new data")ida_bytes.patch_bytes(address, b"new_data")currentProgram.getMemory().setBytes(address, b"new data")vw.writeMemory(address, b"new data")

Cross-References

Dragodis*IDAGhidraVivisect**
dis.references_from(address)
dis.get_line(address).references_from
dis.get_function(address).references_from()
idautils.XrefsFrom(address)getReferencesFrom(toAddr(address))vw.getXrefsFrom(address)
dis.references_to(address)
dis.get_line(address).references_to
dis.get_function(address).references_to()
idautils.XrefsTo(address)getReferencesTo(toAddr(address))vw.getXrefsTo(address)
ref.from_addressref.frmref.getFromAddress()ref[0]
ref.to_addressref.toref.getToAddress()ref[1]
ref.typeref.typeref.getReferenceType()ref[2]
ref.is_coderef.iscodenot ref.getReferenceType().isData()ref[2].rtype == REF_CODE
ref.is_datanot ref.iscoderef.getReferenceType().isData()ref[2].rtype == REF_DATA
dis.create_reference(from_address, to_address, dragodis.ReferenceType.*)ida_xref.add_cref(from_address, to_address, idc.fl_)
ida_xref.add_dref(from_address, to_address, idc.dr_
)
currentProgram.getReferenceManager().addMemoryReference(toAddr(from_address), toAddr(to_address), RefType.*, SourceType.USER_DEFINED, 0)vw.addXref(from_address, to_address, rtype, rflags)

Imports/Exports

Dragodis*IDAGhidraVivisect**
dis.imports()[ida_nalt.enum_import_names(i, callback) for i in range(ida_nalt.get_import_module_qty())]currentProgram.getSymbolTable().getExternalSymbols()vw.getImports()
dis.exports()[ida_entry.get_entry_ordinal(i) for i in range(ida_entry.get_entry_qty())]currentProgram.getSymbolTable().getExternalEntryPointIterator()vw.getExports()
import_.addressreturned in callbacksymbol.getAddress()import_[0]
import_.namereturned in callbacksymbol.getName()import_[3].partition(".")[-1]
import_.namespaceida_nalt.get_import_module_name(i)symbol.getParentSymbol().getName()import_[3].partition(".")[0]
import_.references_to()idautils.XrefsTo(address)symbol.getReferences()vw.getXrefsTo(import_[0])
export.addressida_entry.get_entry(ordinal)symbol.getAddress()export[0]
export.nameida_entry.get_entry_name(ordinal)symbol.getName()export[2]
export.references_to()idautils.XrefsTo(ida_entry.get_entry(ordinal))symbol.getReferences()vw.getXrefsTo(export[0])

Functions

Dragodis*IDAGhidraVivisect**
dis.functions()idautils.Functions()currentProgram.getListing().getFunctions(True)vw.getFunctions()
func = dis.get_function(address)func = ida_funcs.get_func(address)func = getFunctionContaining(toAddr(address))func_addr = vw.getFunction(address)
func.startfunc.start_eafunc.getEntryPoint()func_addr
func.endfunc.end_eafunc.getBody().getMaxAddress()func_addr + vw.getFunctionMeta(func_addr, "Size")
func.name
dis.get_name(address)
ida_funcs.get_func_name(address)func.getName()vw.getName(func_addr)
func.name = "new_name"ida_name.set_name(address, "new_name")func.setName("new_name", SourceType.USER_DEFINED)vw.makeName(func_addr, "new_name")
func.get_comment()ida_funcs.get_func_cmt(func, 0)func.getComment()vw.getComment(func_addr)
func.set_comment("new comment")ida_funcs.set_func_cmt(func, "new comment", 0)func.setComment("new comment")vw.setComment(func_addr, "new comment")
dis.get_flowchart(address)
func.flowchart
ida_gdl.FlowChart(func)BasicBlockModel(currentProgram).getCodeBlocksContaining(func.getBody(), monitor)vw.getFunctionGraph(func_addr)
func.stack_frameida_frame.get_frame(func)func.getStackFrame()vw.getFunctionLocals(func_addr)
dis.get_function_signature(address)
func.signature
tif = ida_typeinf.tinfo_t()
ida_nalt.get_tinfo(tif, address)
func_type_data = ida_typeinf.func_type_data_t()
tif.get_func_details(func_type_data)
func.getSignature()vw.getFunctionApi(func_addr)
func = dis.create_function(start, end)func = ida_funcs.add_func(start, end)func = currentProgram.getFunctionManager().createFunction(None, toAddr(start), AddressSet(toAddr(start), toAddr(end)), SourceType.USER_DEFINED)vw.makeFunction(start, meta={"Size": size})
func = dis.create_function(start)func = ida_funcs.add_func(start)func = CreateFunctionCmd(toAddr(start), True).applyTo(currentProgram).getFunction()vw.makeFunction(start)
func.undefine()ida_funcs.del_func(start)DeleteFunctionCmd(func.getEntryPoint(), True).applyTo(currentProgram)vw.delFunction(func_addr)

Instructions

Dragodis*IDAGhidraVivisect**
insn = dis.get_instruction(address)insn = ida_ua.insn_t(); ida_ua.decode_insn(insn, address)insn = currentProgram.getListing().getCodeUnitAt(toAddr(address))insn = vw.parseOpcode(address)
insn.is_callida_idp.is_call_insn(insn)insn.getFlowType().isCall()insn.iflags & envi.IF_CALL
insn.is_jumpcomplex: see source codeinsn.getFlowType().isJump()insn.iflags & envi.IF_BRANCH
insn.is_returnida_idp.is_ret_insn(insn)insn.getFlowType().isTerminal()insn.iflags & envi.IF_RET
insn.mnemonic
dis.get_mnemonic(address)
ida_ua.ua_mnem(address)insn.getMnemonicString()insn.mnem
insn.textidc.GetDisasm(address)str(insn)str(insn)
insn.operandsinsn.opsN/A: See operands sectioninsn.getOperands()
insn.stack_depthidc.get_spd(address)CallDepthChangeInfo(currentProgram.getListing().getFunctionContaining(insn.getAddress())).getDepth()complex: see source code
insn.stack_deltaidc.get_sp_delta(address)complex: see source codecomplex: see source code

Operands

insn pulled as described above

Dragodis*IDAGhidraVivisect**
operand = dis.get_operand(address, index)
operand = insn.operands[index]
operand = insn.ops[index]N/Aoperand = insn.getOperands()[index]
operand.type
dis.get_operand_type(address, index)
idc.get_operand_type(address, index)insn.getOperandType(index)operand.__class__
operand.widthida_ua.get_dtype_size(operand.dtype)complex: see source codeoperand.tsize
operand.value
dis.get_operand_value(address, index)
(depends on type)
operand.addr
operand.reg
operand.value
insn.getOpObjects(index)operand.getOperValue()
(phrase operand)
operand.value.base
operand.reg
ida_intel.x86_base_reg(insn, operand)
insn.getOpObjects(index)[0]operand.reg
(phrase operand)
operand.value.index
ida_intel.x86_index_reg(insn, operand)insn.getOpObjects(index)[1]operand.index
(phrase operand)
operand.value.scale
1 << ida_intel.sib_scale(operand)insn.getOpObjects(index)[2]operand.scale
(phrase operand)
operand.value.offset
operand.addr
idc.get_operand_value(address, index)
insn.getOpObjects(index)[3]operand.disp
(register operand)
operand.value
operand.reg
idc.get_operand_value(address, index)
insn.getOpObjects(index)[0]operand.reg.reg
(immediate operand)
operand.value
operand.value
idc.get_operand_value(address, index)
insn.getOpObjects(index)[0]operand.getOperValue()
(memory reference operand)
operand.value
operand.addr
idc.get_operand_value(address, index)
insn.getOpObjects(index)[0]operand.getOperValue()

Registers

Dragodis*IDAGhidraVivisect**
register = dis.get_register("eax")register = ida_idp.reg_info_t(); ida_idp.parse_reg_name(register, "eax")register = currentProgram.getRegister("eax")register = vw.arch.archGetRegCtx().getRegisterIndex("eax")
register.nameida_idp.get_reg_name(register.reg, register.size)register.getName()vw.arch.archGetRegCtx().getRegisterName(register)
register.bit_widthregister.size * 8register.getBitLength()vw.arch.archGetRegCtx().getRegisterWidth(register)

Segments

Dragodis*IDAGhidraVivisect**
dis.segments()[ida_segment.getnseg(n) for n in range(ida_segment.get_segm_qty())]currentProgram.getMemory().getBlocks()vw.getSegments()
segment = dis.get_segment(name)
segment = dis.get_segment(address)
segment = ida_segment.get_segm_by_name(name)
segment = ida_segment.getseg(address)
memory_block = currentProgram.getMemory().getBlock(name)
memory_block = currentProgram.getMemory().getBlock(toAddr(address))
addr, size, name, _ = vw.getSegment(address)
segment.nameida_segment.get_segm_name(segment)memory_block.getName()name
segment.startsegment.start_eamemory_block.getStart()addr
segment.endsegment.end_eamemory_block.getEnd()addr + size
segment.initializedida_bytes.is_loaded(segment.start_ea)memory_block.isInitialized()bool(vw.getMemoryMap(addr))
segment.bit_sizesegment.abits()memory_block.getStart().getSize()N/A
segment.permissionssegment.permmemory_block.isRead()
memory_block.isWrite()
memory_block.isExecute()
memory_block.isVolatile()
_, _, flags, _ = vw.getMemoryMap(addr)
dis.create_segment(".new_seg", 0x1234, 256)ida_segment.add_segm(0, 0x1234, 0x1334, ".new_seg", "XTRN")currentProgram.getMemory().createUninitializedBlock(".new_seg", toAddr(0x1234), 256, False)vw.addSegment(0x1234, 256, ".new_seg", filename)

Strings

Dragodis*IDAGhidraVivisect**
dis.strings(min_length=5)finder = idautils.Strings(); finder.setup(minlen=5); list(finder)findStrings(None, 5, 1, False, True)vw.getLocations(vivisect.LOC_STRINGS) + vw.getLocations(vivisect.LOC_UNI)

* dis in the dragodis column represents the open disassembler object retrieved from dragodis.open_program()

** vw in the Vivisect column represents the workspace created by vivisect.VivWorkspace()