[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/bannsec/retdec/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","bannsec","reponame","retdec","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2018-07-08T23:28:40.647411Z","description","Avast retdec as a container","is_private","last_updated","2020-07-24T04:38:12.191415Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",4947,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Oneliner\nHere's a useful bash function that will simplify using retdec.\n\n```bash\nfunction retdec() { sudo docker run -it --rm -v $PWD:/mount bannsec/retdec bash -c \"cd /mount; retdec-decompiler.sh $@\";}\n```\n\nJust source the function then call it like you were calling retdec directly:\n\n```bash\nretdec myfile.exe\n```\n\n# RetDec\n\n[![Travis CI build status](https://travis-ci.org/avast-tl/retdec.svg?branch=master)](https://travis-ci.org/avast-tl/retdec)\n[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/avast-tl/retdec?branch=master&svg=true)](https://ci.appveyor.com/project/avast-tl/retdec?branch=master)\n[![TeamCity build status](https://retdec-tc.avast.com/app/rest/builds/aggregated/strob:(buildType:(project:(id:Retdec)))/statusIcon)](https://retdec-tc.avast.com/project.html?projectId=Retdec&guest=1)\n\n[RetDec](https://retdec.com/) is a retargetable machine-code decompiler based on [LLVM](https://llvm.org/).\n\nThe decompiler is not limited to any particular target architecture, operating system, or executable file format:\n* Supported file formats: ELF, PE, Mach-O, COFF, AR (archive), Intel HEX, and raw machine code.\n* Supported architectures (32b only): Intel x86, ARM, MIPS, PIC32, and PowerPC.\n\nFeatures:\n* Static analysis of executable files with detailed information.\n* Compiler and packer detection.\n* Loading and instruction decoding.\n* Signature-based removal of statically linked library code.\n* Extraction and utilization of debugging information (DWARF, PDB).\n* Reconstruction of instruction idioms.\n* Detection and reconstruction of C++ class hierarchies (RTTI, vtables).\n* Demangling of symbols from C++ binaries (GCC, MSVC, Borland).\n* Reconstruction of functions, types, and high-level constructs.\n* Integrated disassembler.\n* Output in two high-level languages: C and a Python-like language.\n* Generation of call graphs, control-flow graphs, and various statistics.\n\nFor more information, check out our\n* [Wiki](https://github.com/avast-tl/retdec/wiki) (in progress)\n* Botconf 2017 talk: [slides](https://retdec.com/web/files/publications/retdec-slides-botconf-2017.pdf), [video](https://www.youtube.com/watch?v=HHFvtt5b6yY)\n* REcon Montreal 2018 talk: [slides](https://retdec.com/web/files/publications/retdec-slides-recon-2018.pdf)\n* [Publications](https://retdec.com/publications/)\n\n## Installation and Use\n\nCurrently, we support only Windows (7 or later), Linux, and unofficially macOS.\n\n### Windows\n\n1. Either download and unpack a [pre-built package](https://github.com/avast-tl/retdec/releases), or build and install the decompiler by yourself (the process is described below):\n\n2. Install [Microsoft Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145).\n\n3. Install [MSYS2](http://www.msys2.org/) and other needed applications by following RetDec's [Windows environment setup guide](https://github.com/avast-tl/retdec/wiki/Windows-Environment).\n\n3. Now, you are all set to run the decompiler. To decompile a binary file named `test.exe`, run\n\n ```sh\n bash $RETDEC_INSTALL_DIR/bin/retdec-decompiler.sh test.exe\n ```\n\n For more information, run `retdec-decompiler.sh` with `--help`.\n\n### Linux\n\n1. There are currently no pre-built packages for Linux. You will have to build and install the decompiler by yourself. The process is described below.\n\n2. After you have built the decompiler, you will need to install the following packages via your distribution's package manager:\n\n * [Bash](https://www.gnu.org/software/bash/) (version >= 4)\n * [UPX](https://upx.github.io/)\n * [bc](https://www.gnu.org/software/bc/)\n * [Graphviz](http://www.graphviz.org/)\n\n3. Now, you are all set to run the decompiler. To decompile a binary file named `test.exe`, run\n\n ```sh\n $RETDEC_INSTALL_DIR/bin/retdec-decompiler.sh test.exe\n ```\n\n For more information, run `retdec-decompiler.sh` with `--help`.\n\n### macOS\n\n**Warning: macOS build was added based on community feedback and is not directly supported by the RetDec team. We do not guarantee you that these instructions will work for you. If you encounter any problem with your build, submit an issue so the macOS community can help you out.**\n\n1. There are currently no pre-built packages for macOS. You will have to build and install the decompiler by yourself. The process is described below.\n\n2. After you have built the decompiler, you will need to install the following packages:\n\n * [Bash](https://www.gnu.org/software/bash/) (version >= 4; has to be before the default `bash` 3.2 in your `PATH`)\n * [UPX](https://upx.github.io/)\n * [Graphviz](http://www.graphviz.org/)\n * [GNU coreutils](https://www.gnu.org/software/coreutils) (ensure that you have `$(brew --prefix coreutils)/libexec/gnubin` in your `PATH`)\n * [GNU getopt](https://www.gnu.org/software/libc/manual/html_node/Getopt.html) (has to be before the default `getopt` in your `PATH`)\n\n3. Now, you are all set to run the decompiler. To decompile a binary file named `test.exe`, run\n\n ```\n $RETDEC_INSTALL_DIR/bin/retdec-decompiler.sh test.exe\n ```\n\n For more information, run `retdec-decompiler.sh` with `--help`.\n\n## Build and Installation\n\nThis section describes a local build and installation of RetDec. Instructions for Docker are given in the next section.\n\n### Requirements\n\n#### Linux\n\n* A C++ compiler and standard C++ library supporting C++14 (e.g. GCC >= 4.9)\n* [CMake](https://cmake.org/) (version >= 3.6)\n* [Git](https://git-scm.com/)\n* [Perl](https://www.perl.org/)\n* [Python](https://www.python.org/) (version >= 3.4)\n* [Bison](https://www.gnu.org/software/bison/) (version >= 3.0)\n* [Flex](https://www.gnu.org/software/flex/) (version >= 2.6)\n* [autotools](https://en.wikipedia.org/wiki/GNU_Build_System) ([autoconf](https://www.gnu.org/software/autoconf/autoconf.html), [automake](https://www.gnu.org/software/automake/), and [libtool](https://www.gnu.org/software/libtool/))\n* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)\n* [m4](https://www.gnu.org/software/m4/m4.html)\n* [coreutils](https://www.gnu.org/software/coreutils)\n* [wget](https://www.gnu.org/software/wget/)\n* [ncurses](http://invisible-island.net/ncurses/) (for `libtinfo`)\n* [zlib](http://zlib.net/)\n* Optional: [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and [Graphviz](http://www.graphviz.org/) for generating API documentation\n\nOn Debian-based distributions (e.g. Ubuntu), the required packages can be installed with `apt-get`:\n\n```sh\nsudo apt-get install build-essential cmake git perl python3 bash bison flex autoconf automake libtool pkg-config m4 coreutils zlib1g-dev libtinfo-dev wget bc upx doxygen graphviz\n```\n\nOn RPM-based distributions (e.g. Fedora), the required packages can be installed with `dnf`:\n\n```sh\nsudo dnf install gcc gcc-c++ cmake make git perl python3 bash bison flex autoconf automake libtool pkg-config m4 coreutils zlib-devel ncurses-devel wget bc upx doxygen graphviz\n```\n\nOn Arch Linux, the required packages can be installed with `pacman`:\n\n```sh\nsudo pacman -S base-devel cmake git perl python3 bash bison flex autoconf automake libtool pkg-config m4 coreutils zlib ncurses wget bc upx doxygen graphviz\n```\n\n#### Windows\n\n* Microsoft Visual C++ (version >= Visual Studio 2015 Update 2)\n* [Git](https://git-scm.com/)\n* [MSYS2](http://www.msys2.org/) and some other applications. Follow RetDec's [Windows environment setup guide](https://github.com/avast-tl/retdec/wiki/Windows-Environment) to get everything you need on Windows.\n* [Active Perl](https://www.activestate.com/activeperl). It needs to be the first Perl in `PATH`, or it has to be provided to CMake using `CMAKE_PROGRAM_PATH` variable, e.g. `-DCMAKE_PROGRAM_PATH=/c/perl/bin`.\n* [Python](https://www.python.org/) (version >= 3.4)\n\n#### macOS\n\nPackages should be preferably installed via [Homebrew](https://brew.sh).\n\n* Full Xcode installation (Command Line Tools are untested)\n* [CMake](https://cmake.org/) (version >= 3.6)\n* [Git](https://git-scm.com/)\n* [Perl](https://www.perl.org/)\n* [Python](https://www.python.org/) (version >= 3.4)\n* [Bison](https://www.gnu.org/software/bison/) (version >= 3.0)\n* [Flex](https://www.gnu.org/software/flex/) (version >= 2.6)\n* [autotools](https://en.wikipedia.org/wiki/GNU_Build_System) ([autoconf](https://www.gnu.org/software/autoconf/autoconf.html), [automake](https://www.gnu.org/software/automake/), and [libtool](https://www.gnu.org/software/libtool/))\n* [wget](https://www.gnu.org/software/wget/)\n* Optional: [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and [Graphviz](http://www.graphviz.org/) for generating API documentation\n\n### Process\n\nNote: Although RetDec now supports a system-wide installation ([#94](https://github.com/avast-tl/retdec/issues/94)), unless you use your distribution's package manager to install it, we recommend installing RetDec locally into a designated directory. The reason for this is that uninstallation will be easier as you will only need to remove a single directory. To perform a local installation, run `cmake` with the `-DCMAKE_INSTALL_PREFIX=` parameter, where `` is directory into which RetDec will be installed (e.g. `$HOME/projects/retdec-install` on Linux and macOS, and `C:\\projects\\retdec-install` on Windows).\n\n* Clone the repository:\n * `git clone https://github.com/avast-tl/retdec`\n* Linux:\n * `cd retdec`\n * `mkdir build && cd build`\n * `cmake .. -DCMAKE_INSTALL_PREFIX=`\n * `make -jN` (`N` is the number of CPU cores to use for parallel build)\n * `make install`\n* Windows:\n * Open a command prompt (e.g. `C:\\msys64\\msys2_shell.cmd` from [MSYS2](https://github.com/avast-tl/retdec/wiki/Windows-Environment))\n * `cd retdec`\n * `mkdir build && cd build`\n * `cmake .. -DCMAKE_INSTALL_PREFIX= -G`\n * `cmake --build . --config Release -- -m`\n * `cmake --build . --config Release --target install`\n * Alternatively, you can open `retdec.sln` generated by `cmake` in Visual Studio IDE.\n* macOS:\n * `cd retdec`\n * `mkdir build && cd build`\n * ```sh\n # Apple ships old Flex & Bison, so Homebrew versions should be used.\n export CMAKE_INCLUDE_PATH=\"/usr/local/opt/flex/include\"\n export CMAKE_LIBRARY_PATH=\"/usr/local/opt/flex/lib;/usr/local/opt/bison/lib\"\n export PATH=\"/usr/local/opt/flex/bin:/usr/local/opt/bison/bin:$PATH\"\n ```\n * `cmake .. -DCMAKE_INSTALL_PREFIX=`\n * `make -jN` (`N` is the number of CPU cores to use for parallel build)\n * `make install`\n\nYou have to pass the following parameters to `cmake`:\n* `-DCMAKE_INSTALL_PREFIX=` to set the installation path to ``. Quote the path if you are using backslashes on Windows (e.g. `-DCMAKE_INSTALL_PREFIX=\"C:\\retdec\"`).\n* (Windows only) `-G` is `-G\"Visual Studio 14 2015\"` for 32-bit build using Visual Studio 2015, or `-G\"Visual Studio 14 2015 Win64\"` for 64-bit build using Visual Studio 2015. Later versions of Visual Studio may be used.\n\nYou can pass the following additional parameters to `cmake`:\n* `-DRETDEC_DOC=ON` to build with API documentation (requires Doxygen and Graphviz, disabled by default).\n* `-DRETDEC_TESTS=ON` to build with tests (disabled by default).\n* `-DRETDEC_DEV_TOOLS=ON` to build with development tools (disabled by default).\n* `-DCMAKE_BUILD_TYPE=Debug` to build with debugging information, which is useful during development. By default, the project is built in the `Release` mode. This has no effect on Windows, but the same thing can be achieved by running `cmake --build .` with the `--config Debug` parameter.\n* `-DCMAKE_PROGRAM_PATH=` to use Perl at `` (probably useful only on Windows).\n\n## Build in Docker\n\nDocker support is maintained by community. If something does not work for you or if you have suggestions for improvements, open an issue or PR.\n\n### Build Image\n\nBuilding in Docker does not require installation of the required libraries locally. This is a good option for trying out RetDec without setting up the whole build toolchain.\n\nTo build the RetDec Docker image, run\n```\ndocker build -t retdec .\n```\n\nThis builds the image from the master branch of this repository.\n\nTo build the image using the local copy of the repository, use the development Dockerfile, `Dockerfile.dev`:\n```\ndocker build -t retdec:dev . -f Dockerfile.dev\n```\n\n### Run Container\n\nIf your `uid` is not 1000, make sure that the directory containing your input binary files is accessible for RetDec:\n```\nchmod 0777 /path/to/local/directory\n```\nNow, you can run the decompiler inside a container:\n```\ndocker run --rm -v /path/to/local/directory:/destination retdec retdec-decompiler.sh /destination/binary\n```\nOutput files will be generated to the same directory (e.g. `/path/to/local/directory`).\n\n## Repository Overview\n\nThis repository contains the following libraries:\n* `ar-extractor` - library for extracting object files from archives (based on LLVM).\n* `bin2llvmir` - library of LLVM passes for translating binaries into LLVM IR modules.\n* `capstone2llvmir` - binary instructions to LLVM IR translation library.\n* `config` - library for representing and managing RetDec configuration databases.\n* `cpdetect` - library for compiler and packer detection in binaries.\n* `crypto` - collection of cryptographic functions.\n* `ctypes` - C++ library for representing C function data types.\n* `debugformat` - library for uniform representation of DWARF and PDB debugging information.\n* `demangler` - demangling library capable to handle names generated by the GCC/Clang, Microsoft Visual C++, and Borland C++ compilers.\n* `dwarfparser` - library for high-level representation of DWARF debugging information.\n* `fileformat` - library for parsing and uniform representation of various object file formats. Currently supporting the following formats: COFF, ELF, Intel HEX, Mach-O, PE, raw data.\n* `llvm-support` - set of LLVM related utility functions.\n* `llvmir-emul` - LLVM IR emulation library used for unit testing.\n* `llvmir2hll` - library for translating LLVM IR modules to high-level source codes (C, Python-like language).\n* `loader` - library for uniform representation of binaries loaded to memory. Supports the same formats as fileformat.\n* `macho-extractor` - library for extracting regular Mach-O binaries from fat Mach-O binaries (based on LLVM).\n* `patterngen` - binary pattern extractor library.\n* `pdbparser` - Microsoft PDB files parser library.\n* `stacofin` - static code finder library.\n* `unpacker` - collection of unpacking functions.\n* `utils` - general C++ utility library.\n\nThis repository contains the following tools:\n* `ar-extractortool` - frontend for the ar-extractor library (installed as `retdec-ar-extractor`).\n* `bin2llvmirtool` - frontend for the `bin2llvmir` library (installed as `retdec-bin2llvmir`).\n* `bin2pat` - tool for generating patterns from binaries (installed as `retdec-bin2pat`).\n* `capstone2llvmirtool` - frontend for the `capstone2llvmir` library (installed as `retdec-capstone2llvmir`).\n* `configtool` - frontend for the `config` library (installed as `retdec-config`).\n* `ctypesparser` - C++ library for parsing C function data types from JSON files into `ctypes` representation (installed as `retdec-ctypesparser`).\n* `demangler_grammar_gen` -- tool for generating new grammars for the `demangler` library (installed as `retdec-demangler-grammar-gen`).\n* `demanglertool` -- frontend for the `demangler` library (installed as `retdec-demangler`).\n* `fileinfo` - binary analysis tool. Supports the same formats as `fileformat` (installed as `retdec-fileinfo`).\n* `idr2pat` - tool for extracting patterns from IDR knowledge bases (installed as `retdec-idr2pat`).\n* `llvmir2hlltool` - frontend for the `llvmir2hll` library (installed as `retdec-llvmir2hll`).\n* `macho-extractortool` - frontend for the `macho-extractor` library (installed as `retdec-macho-extractor`).\n* `pat2yara` - tool for processing patterns to YARA signatures (installed as `retdec-pat2yara`).\n* `stacofintool` - frontend for the `stacofin` library (installed as `retdec-stacofin`).\n* `unpackertool` - plugin-based unpacker (installed as `retdec-unpacker`).\n\nThis repository contains the following scripts:\n* `retdec-decompiler.sh` - the main decompilation script binding it all together. This is the tool to use for full binary-to-C decompilations.\n* Support scripts used by `retdec-decompiler.sh`:\n * `retdec-color-c.py` - decorates output C sources with IDA color tags - syntax highlighting for IDA.\n * `retdec-config.sh` - decompiler's configuration file.\n * `retdec-archive-decompiler.sh` - decompiles objects in the given AR archive.\n * `retdec-fileinfo.sh` - a Fileinfo tool wrapper.\n * `retdec-signature-from-library-creator.sh` - extracts function signatures from the given library.\n * `retdec-unpacker.sh` - tries to unpack the given executable file by using any of the supported unpackers.\n * `retdec-utils.sh` - a collection of bash utilities.\n* `retdec-tests-runner.sh` - run all tests in the unit test directory.\n* `type_extractor`\n\n## Related Repositories\n\n* [retdec-idaplugin](https://github.com/avast-tl/retdec-idaplugin) -- Embeds RetDec into IDA (Interactive Disassembler) and makes its use much easier.\n* [retdec-regression-tests-framework](https://github.com/avast-tl/retdec-regression-tests-framework) -- Provides means to run and create regression tests for RetDec and related tools. This is a must if you plan to contribute to the RetDec project.\n* [vim-syntax-retdecdsm](https://github.com/s3rvac/vim-syntax-retdecdsm) -- Vim syntax-highlighting file for the output from the RetDec's disassembler (`.dsm` files).\n\n## License\n\nCopyright (c) 2017 Avast Software, licensed under the MIT license. See the [`LICENSE`](https://github.com/avast-tl/retdec/blob/master/LICENSE) file for more details.\n\nRetDec uses third-party libraries or other resources listed, along with their licenses, in the [`LICENSE-THIRD-PARTY`](https://github.com/avast-tl/retdec/blob/master/LICENSE-THIRD-PARTY) file.\n\n## Contributing\n\nSee [RetDec contribution guidelines](https://github.com/avast-tl/retdec/wiki/Contribution-Guidelines).\n\n## Acknowledgements\n\nThis software was supported by the research funding TACR (Technology Agency of the Czech Republic), ALFA Programme No. TA01010667.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",13878566626,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",1873339,"full_size",969305973,"id",30604051,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:dcd9c5344879f071c23c8ee23cfe2e5238e8781912820ade9befa52a553b479c","features","","last_pulled","2026-10-02T04:02:02.151424549Z","last_pushed","2020-07-07T06:27:13Z","os","linux","os_features","os_version","size","variant","2020-07-24T04:38:11.783203Z","last_updater","last_updater_username","media_type","latest","repository",5708633,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

bannsec/retdec

Tags for bannsec/retdec