Pour plus d'informations, consultez :

• Wiki (en cours)
• Conférence Botconf 2017 : diapositives, vidéo
• Conférence REcon Montreal 2018 : diapositives
• Publications

Installation

Il existe deux façons d'obtenir et d'installer RetDec :

1. Téléchargez et décompressez un package pré-construit stable ou bleeding-edge et suivez les instructions dans la section Utilisation de son fichier retdec/share/retdec/README.md après décompression.
2. Construisez RetDec vous-même à partir des sources en suivant la section Build and Installation. Après l'installation, suivez les instructions ci-dessous.

Nous supportons actuellement Windows (7 ou ultérieur), Linux, macOS et (expérimentalement) FreeBSD. Une version installée de RetDec nécessite environ 5 à 6 Go d'espace disque libre.

Utilisation

Assurez-vous de lire les instructions correspondant à la version de RetDec utilisée. En cas de doute, reportez-vous au fichier retdec/share/retdec/README.md dans l'installation.

Windows

1. Après installation de RetDec, installez Microsoft Visual C++ Redistributable for Visual Studio 2017.

2. Installez les programmes suivants :

   • UPX (Optionnel : si vous souhaitez utiliser le décompresseur UPX lors de l'étape de prétraitement)
   • Graphviz (Optionnel : si vous souhaitez générer des graphes d'appels ou de flot de contrôle)

3. Pour décompiler un fichier binaire nommé test.exe, exécutez

   root@kitploit:~

   $RETDEC_INSTALL_DIR\bin\retdec-decompiler.exe test.exe
   

   Pour plus d'informations, exécutez retdec-decompiler.exe avec --help.

Linux

1. Après installation de RetDec, installez les paquets suivants via le gestionnaire de paquets de votre distribution :

   • UPX (Optionnel : si vous souhaitez utiliser le décompresseur UPX lors de l'étape de prétraitement)
   • Graphviz (Optionnel : si vous souhaitez générer des graphes d'appels ou de flot de contrôle)

2. Pour décompiler un fichier binaire nommé test.exe, exécutez

   root@kitploit:~

   $RETDEC_INSTALL_DIR/bin/retdec-decompiler test.exe
   

   Pour plus d'informations, exécutez retdec-decompiler avec --help.

macOS

1. Après installation de RetDec, installez les paquets suivants :

   • UPX (Optionnel : si vous souhaitez utiliser le décompresseur UPX lors de l'étape de prétraitement)
   • Graphviz (Optionnel : si vous souhaitez générer des graphes d'appels ou de flot de contrôle)

2. Pour décompiler un fichier binaire nommé test.exe, exécutez

   root@kitploit:~

   $RETDEC_INSTALL_DIR/bin/retdec-decompiler test.exe
   

   Pour plus d'informations, exécutez retdec-decompiler avec --help.

FreeBSD (expérimental)

1. Il n'existe actuellement aucun paquet ports pré-construit pour FreeBSD. Vous devrez construire et installer le désassembleur vous-même. Le processus est décrit ci-dessous.

2. Pour décompiler un fichier binaire nommé test.exe, exécutez

   root@kitploit:~

   $RETDEC_INSTALL_DIR/bin/retdec-decompiler test.exe
   

   Pour plus d'informations, exécutez retdec-decompiler avec --help.

Utilisation des bibliothèques RetDec

Vous pouvez facilement utiliser diverses bibliothèques RetDec dans vos projets - s'ils sont construits avec CMake. L'installation de RetDec contient tous les en-têtes, bibliothèques et scripts CMake nécessaires.

Si vous avez installé RetDec dans un emplacement d'installation standard de votre système (par exemple /usr, /usr/local), tout ce que vous devez faire pour utiliser ses composants est :```cmake find_package(retdec 5.0 REQUIRED COMPONENTS [...] ) target_link_libraries(your-project PUBLIC retdec:: [...] )

Sur les distributions basées sur RPM (par exemple Fedora), les paquets requis peuvent être installés avec dnf:```sh sudo dnf install gcc gcc-c++ cmake make git openssl openssl-devel python3 autoconf automake libtool pkg-config m4 zlib-devel upx doxygen graphviz

Windows

• Microsoft Visual C++ (version >= Visual Studio 2017 version 15.7)
• CMake (version >= 3.6)
• Git
• OpenSSL (version >= 1.1.1)
• Python (version >= 3.4)
• Optionnel : Doxygen et Graphviz pour générer la documentation de l'API

macOS

Les paquets devraient de préférence être installés via Homebrew.

• macOS >= 10.15
• Installation complète de Xcode (y compris les outils en ligne de commande, voir #425 et #433)
• CMake (version >= 3.6)
• Git
• OpenSSL (version >= 1.1.1)
• Python (version >= 3.4)
• autotools (autoconf, automake et libtool)
• Optionnel : Doxygen et Graphviz pour générer la documentation de l'API

FreeBSD (Expérimental)

Les paquets doivent être installés via le dépôt de paquets précompilés de FreeBSD à l'aide de la commande pkg ou construits à partir des sources en utilisant la méthode de la base de données ports.

• Instructions complètes pour l'outil « pkg » : handbook pkg method
  • pkg install cmake python37 git autotools OU
• Instructions complètes pour « ports » : handbook ports method
  • portsnap fetch
  • portsnap extract
• Par exemple, cmake serait
  • whereis cmake
  • cd /usr/ports/devel/cmake
  • make install clean

Processus

Remarque : Bien que RetDec prenne désormais en charge une installation à l'échelle du système (#94), sauf si vous utilisez le gestionnaire de paquets de votre distribution pour l'installer, nous vous recommandons d'installer RetDec localement dans un répertoire désigné. La raison en est que la désinstallation sera plus facile car vous n'aurez qu'à supprimer un seul répertoire. Pour effectuer une installation locale, exécutez cmake avec le paramètre -DCMAKE_INSTALL_PREFIX=<path>, où <path> est le répertoire dans lequel RetDec sera installé (p. ex. $HOME/projects/retdec-install sous Linux et macOS, et C:\projects\retdec-install sous Windows).

• Cloner le dépôt :
  • git clone https://github.com/avast/retdec
• Linux :
  • cd retdec
  • mkdir build && cd build
  • cmake .. -DCMAKE_INSTALL_PREFIX=<path>
  • make -jN (N est le nombre de processus à utiliser pour la compilation parallèle, généralement le nombre de cœurs + 1 donne le temps de compilation le plus rapide)
  • make install
• Windows :
  • Ouvrez une invite de commande (p. ex. cmd.exe)
  • cd retdec
  • mkdir build && cd build
  • cmake .. -DCMAKE_INSTALL_PREFIX=<path> -G<generator>
  • cmake --build . --config Release -- -m
  • cmake --build . --config Release --target install
  • Alternativement, vous pouvez ouvrir retdec.sln généré par cmake dans l'IDE Visual Studio
• macOS :
  • cd retdec
  • mkdir build && cd build
  • cmake .. -DCMAKE_INSTALL_PREFIX=<path>
  • make -jN (N est le nombre de processus à utiliser pour la compilation parallèle, généralement le nombre de cœurs + 1 donne le temps de compilation le plus rapide)
  • make install
• FreeBSD :
  • sudo pkg install git cmake
  • git clone https://github.com/avast/retdec
  • cd retdec
  • mkdir build && cd build
  • root@kitploit:~

    # FreeBSD (and other BSDs) do need cmake, python3, git, autotools. OpenSSL is pre-installed in the OS but check its version.
    # Later versions may be available for each of the packages.
    # See what is installed:
    sudo pkg info cmake python37 autotools
    # Install/upgrade them:
    sudo pkg install cmake python37 autotools
    

  • cmake .. -DCMAKE_INSTALL_PREFIX=<path>
  • make -jN (N est le nombre de processus à utiliser pour la compilation parallèle, généralement le nombre de cœurs + 1 donne le temps de compilation le plus rapide)
  • make install

Vous devez passer les paramètres suivants à cmake :

• -DCMAKE_INSTALL_PREFIX=<path> pour définir le chemin d'installation sur <path>. Mettez le chemin entre guillemets si vous utilisez des antislashs sous Windows (p. ex. -DCMAKE_INSTALL_PREFIX="C:\retdec").
• (Windows uniquement) -G<generator> est -G"Visual Studio 15 2017" pour une compilation 32 bits avec Visual Studio 2017, ou -G"Visual Studio 15 2017 Win64" pour une compilation 64 bits avec Visual Studio 2017. Des versions ultérieures de Visual Studio peuvent être utilisées.

Vous pouvez passer les paramètres supplémentaires suivants à cmake :

• -DRETDEC_DOC=ON pour compiler avec la documentation de l'API (nécessite Doxygen et Graphviz, désactivé par défaut).
• -DRETDEC_TESTS=ON pour compiler avec les tests (désactivé par défaut).
• -DRETDEC_DEV_TOOLS=ON pour compiler avec les outils de développement (désactivé par défaut).
• -DRETDEC_COMPILE_YARA=OFF pour désactiver la compilation des règles YARA lors de l'installation (activé par défaut).
• -DCMAKE_BUILD_TYPE=Debug pour compiler avec les informations de débogage, ce qui est utile pendant le développement. Par défaut, le projet est compilé en mode Release. Cela n'a aucun effet sous Windows, mais on peut obtenir la même chose en exécutant cmake --build . avec le paramètre --config Debug.
• -D<dep>_LOCAL_DIR=<path> où <dep> fait partie de {CAPSTONE, GOOGLETEST, KEYSTONE, LLVM, YARA, YARAMOD} (p. ex. -DCAPSTONE_LOCAL_DIR=<path>), pour utiliser un clone local du dépôt à <path> comme dépendance RetDec au lieu de télécharger une copie fraîche au moment de la compilation. Plusieurs options de ce type peuvent être utilisées en même temps.
• -DRETDEC_ENABLE_<component>=ON pour ne compiler que le(s) composant(s) spécifié(s) (plusieurs options de ce type peuvent être utilisées à la fois), ainsi que ses (leurs) dépendances. Par défaut, tous les composants sont compilés. Si au moins un composant est activé via ce mécanisme, tous les autres composants qui n'ont pas été explicitement activés (et qui ne sont pas nécessaires comme dépendances des composants activés) ne sont pas compilés. Voir cmake/options.cmake pour toutes les options de composants disponibles.
  • -DRETDEC_ENABLE_ALL=ON peut être utilisé pour (ré-)activer tous les composants.
  • -DRETDEC_ENABLE=<liste de composants séparés par des virgules> peut être utilisé à la place de -DRETDEC_ENABLE_<component>=ON (p. ex. -DRETDEC_ENABLE=fileformat,loader,ctypesparser équivaut à -DRETDEC_ENABLE_FILEFORMAT=ON -DRETDEC_ENABLE_LOADER=ON -DRETDEC_ENABLE_CTYPESPARSER=ON).

Compilation dans Docker

Le support Docker est maintenu par la communauté. Si quelque chose ne fonctionne pas pour vous ou si vous avez des suggestions d'amélioration, ouvrez un issue ou une PR.

Création de l'image

La compilation dans Docker ne nécessite pas d'installation locale des bibliothèques requises. C'est une bonne option pour essayer RetDec sans configurer toute la chaîne d'outils de compilation.

Pour créer l'image Docker RetDec, exécutez``` docker build -t retdec - < Dockerfile

Exécuter le conteneur

Si votre uid n'est pas 1000, assurez-vous que le répertoire contenant vos fichiers binaires d'entrée est accessible pour RetDec :``` chmod 0777 /path/to/local/directory

Note : Ne modifiez pas la partie /destination. Vous devez seulement changer /path/to/local/directory. Les fichiers de sortie seront alors générés vers /path/to/local/directory.

Compilations nocturnes

Nous générons des paquets RetDec à jour à partir du dernier commit dans la branche master de deux manières :

• En utilisant nos serveurs TeamCity
• En utilisant Github Actions.

Ces compilations sont principalement destinées aux développeurs de RetDec, aux contributeurs et aux autres personnes expérimentant le produit (par exemple, pour tester si un problème présent dans la version officielle existe toujours dans le master actuel).

Vous pouvez les utiliser comme vous le souhaitez, mais gardez à l'esprit qu'il n'y a aucune garantie qu'elles fonctionneront sur votre système (en particulier la version Linux) et que des régressions sont possibles. Pour obtenir une version stable de RetDec, téléchargez le dernier paquet préconstruit officiel ou construisez la dernière étiquette de version de RetDec.

TeamCity

• Windows Server 2016, version 10.0
• Ubuntu Bionic Linux, version 18.04
• Mac OS X, version 10.14.6

Github Actions

Vous pouvez trouver des compilations pour macOS, Linux et Windows dans le dernier exécution du workflow CI de RetDec.

Documentation du projet

Voir la documentation du projet pour une référence logicielle générée par Doxygen, mise à jour et correspondant au dernier commit dans la branche master.

Dépôts connexes

• retdec-idaplugin -- Intègre RetDec dans IDA (Interactive Disassembler) et rend son utilisation beaucoup plus facile.
• retdec-r2plugin -- Intègre RetDec dans Radare2 et rend son utilisation beaucoup plus facile.
• retdec-regression-tests-framework -- Un cadre pour écrire et exécuter des tests de régression pour RetDec et les outils associés. C'est un incontournable si vous prévoyez de contribuer au projet RetDec.
• retdec-regression-tests -- Une suite de tests de régression pour RetDec et les outils associés.
• retdec-build-system-tests -- Une suite de tests pour le système de construction de RetDec. Cela peut également servir de collection de démos sur la façon d'utiliser les bibliothèques RetDec.
• vim-syntax-retdecdsm -- Fichier de coloration syntaxique Vim pour la sortie du désassembleur de RetDec (fichiers .dsm).

Licence

Copyright (c) 2017 Avast Software, sous licence MIT. Voir le fichier LICENSE pour plus de détails.

RetDec intègre une bibliothèque PeLib modifiée. Les nouveaux modules ajoutés par Avast Software sont sous licence MIT. Les sources originales sont sous la licence suivante :

• Copyright (c) 2004 - 2005 Sebastian Porst ([email protected]), sous licence zlib/libpng. Voir le fichier LICENSE-PELIB pour plus de détails.

RetDec utilise des bibliothèques tierces ou d'autres ressources listées, avec leurs licences, dans le fichier LICENSE-THIRD-PARTY.

Contribution

Voir les directives de contribution de RetDec.

Remerciements

Ce logiciel a été soutenu par le financement de la recherche TACR (Technology Agency of the Czech Republic), programme ALFA n° TA01010667.