joern

Joern - L'établi du chasseur d'insectes

Joern est une plateforme d'analyse du code source, du bytecode et des exécutables binaires. Il génère des graphiques de propriétés de code (CPG), une représentation graphique du code pour l'analyse de code multilingue. Les graphiques de propriétés de code sont stockés dans une base de données de graphiques personnalisée. Cela permet d'extraire du code à l'aide de requêtes de recherche formulées dans un langage de requête spécifique à un domaine basé sur Scala. Joern est développé dans le but de fournir un outil utile pour la découverte de vulnérabilités et la recherche en analyse de programmes statiques.

Site Web : https://joern.io

Documentation : https://docs.joern.io/

Spécification : https://cpg.joern.io

Actualités / Journal des modifications

• Joern v4.0.0 migre de overflowdb vers flatgraph
• Joern v2.0.0 passe de Scala2 à Scala3
• Joern v1.2.0 supprime la classe overflowdb.traversal.Traversal . Ce changement n’est pas complètement rétrocompatible. Voir ici pour un article détaillé.

Exigences

• JDK 21 (d'autres versions peuvent fonctionner, mais n'ont pas été correctement testées)
• facultatif : gcc et g++ (pour la découverte automatique des fichiers d'en-tête système C/C++ s'ils sont inclus/utilisés dans votre code C/C++)

Exigences de développement

• mvn https://maven.apache.org/install.html

Installation rapide

 wget https://github.com/joernio/joern/releases/latest/download/joern-install.sh
chmod +x ./joern-install.sh
sudo ./joern-install.sh
joern

     ██╗ ██████╗ ███████╗██████╗ ███╗   ██╗
     ██║██╔═══██╗██╔════╝██╔══██╗████╗  ██║
     ██║██║   ██║█████╗  ██████╔╝██╔██╗ ██║
██   ██║██║   ██║██╔══╝  ██╔══██╗██║╚██╗██║
╚█████╔╝╚██████╔╝███████╗██║  ██║██║ ╚████║
 ╚════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝
Version: 2.0.1
Type `help` to begin

joern>

Si le script d'installation échoue pour une raison quelconque, essayez

 ./joern-install --interactive

Exécution basée sur Docker

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern

Pour exécuter Joern en mode serveur :

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern --server

Almalinux 9 nécessite que le processeur prenne en charge SSE4.2. Pour la VM kvm64, utilisez plutôt la version Almalinux 8.

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern-alma8 joern

Sorties

Une nouvelle version est créée automatiquement une fois par jour. Les contributeurs peuvent également exécuter manuellement le workflow de publication s'ils ont besoin de la version plus tôt.

Développeurs

Directives de contribution

Merci d'avoir pris le temps de contribuer à Joern ! Voici quelques directives pour garantir que votre pull request sera fusionnée dès que possible :

• Essayez d'utiliser les modèles autant que possible, mais ils peuvent ne pas répondre à tous les besoins. Le minimum que nous aimerions voir est :
  • Un titre qui décrit brièvement le changement et l'objectif du PR, de préférence avec le module concerné entre crochets, par exemple [javasrc2cpg] Addition Operator Fix .
  • Une brève description des changements dans le corps du PR. Cela peut être sous forme de puces ou de paragraphes.
  • Un lien ou une référence au problème associé, le cas échéant.
• Ne pas:
  • Immédiatement CC/@/e-mail spam d'autres contributeurs, l'équipe examinera le PR et désignera le contributeur le plus approprié pour examiner le PR. Joern est soutenu par des partenaires industriels et des chercheurs, pour la plupart avec leurs propres objectifs et priorités, et l'aide supplémentaire est en grande partie du travail bénévole. Si votre PR devient obsolète, contactez-nous dans des commentaires de suivi avec des @ pour demander une explication de la priorité ou une planification du moment où il peut être traité (le cas échéant, en fonction de la qualité).
  • Laissez le corps de la description vide, cela rend difficile la révision de l'objectif du PR.
• N'oubliez pas de :
  • N'oubliez pas de formater votre code, c'est-à-dire exécutez sbt scalafmt Test/scalafmt
  • Ajoutez un test unitaire pour vérifier votre modification.

Configuration de l'EDI

IDÉE Intellij

• Télécharger la communauté Intellij
• Installez-le et exécutez-le
• Installez le plugin Scala - recherchez et installez simplement depuis Intellij.
• Important : ouvrez sbt dans votre référentiel joern local, exécutez compile et gardez-le ouvert - cela nous permettra d'utiliser la version BSP à l'étape suivante
• Retour à Intellij : ouvrez le projet : sélectionnez votre clone joern local : sélectionnez pour l'ouvrir en tant que BSP project (c'est -à-dire pas sbt project !)
• Attendez la fin de l'importation et de l'indexation, puis vous pouvez démarrer, par exemple Build -> build project ou exécuter un test

VSCode

• Installer VSCode et Docker
• Installez le plugin ms-vscode-remote.remote-containers
• Ouvrez le dossier du projet Joern dans VSCode. Visual Studio Code détecte les nouveaux fichiers et ouvre une boîte de message indiquant : Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• Sélectionnez le bouton Reopen in Container pour rouvrir le dossier dans le conteneur créé par le fichier .devcontainer/Dockerfile
• Basculez vers la barre latérale scalameta.metals dans VSCode et sélectionnez import build dans BUILD COMMANDS
• Une fois import build réussie, vous êtes prêt à commencer à écrire du code pour Joern.

QueryDB (plugin de requêtes)

Un moyen rapide de développer et de tester QueryDB :

 sbt stage
./querydb-install.sh
./joern-scan --list-query-names

La dernière commande imprime toutes les requêtes disponibles - ajoutez la vôtre dans querydb, exécutez à nouveau les commandes ci-dessus pour voir que votre requête a été déployée. Plus de détails dans le fichier readme séparé de querydb