joern

Joern - El banco de trabajo del cazador de insectos

Joern es una plataforma para analizar código fuente, código de bytes y ejecutables binarios. Genera gráficos de propiedades de código (CPG), una representación gráfica de código para el análisis de código en varios idiomas. Los gráficos de propiedades del código se almacenan en una base de datos de gráficos personalizada. Esto permite extraer código mediante consultas de búsqueda formuladas en un lenguaje de consulta específico de dominio basado en Scala. Joern se desarrolló con el objetivo de proporcionar una herramienta útil para el descubrimiento e investigación de vulnerabilidades en el análisis de programas estáticos.

Sitio web: https://joern.io

Documentación: https://docs.joern.io/

Especificación: https://cpg.joern.io

Noticias / Registro de cambios

• Joern v4.0.0 migra de overflowdb a flatgraph
• Joern v2.0.0 actualiza de Scala2 a Scala3
• Joern v1.2.0 elimina la clase overflowdb.traversal.Traversal . Este cambio no es completamente compatible con versiones anteriores. Consulte aquí para obtener un artículo detallado.

Requisitos

• JDK 21 ( es posible que otras versiones funcionen, pero no se han probado adecuadamente)
• opcional : gcc y g++ (para el descubrimiento automático de archivos de encabezado del sistema C/C++ si se incluyen/utilizan en su código C/C++)

Requisitos de desarrollo

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

Instalación rápida

 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 el script de instalación falla por algún motivo, intente

 ./joern-install --interactive

Ejecución basada en Docker

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

Para ejecutar joern en modo servidor:

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

Almalinux 9 requiere que la CPU sea compatible con SSE4.2. Para kvm64 VM, utilice la versión Almalinux 8.

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

Lanzamientos

Se crea una nueva versión automáticamente una vez al día. Los contribuyentes también pueden ejecutar manualmente el flujo de trabajo del lanzamiento si necesitan el lanzamiento antes.

Desarrolladores

Pautas de contribución

¡Gracias por tomarse el tiempo para contribuir con Joern! Aquí hay algunas pautas para garantizar que su solicitud de extracción se combine lo antes posible:

• Intente utilizar las plantillas en la medida de lo posible; sin embargo, es posible que no se adapten a todas las necesidades. El mínimo que nos gustaría ver es:
  • Un título que describa brevemente el cambio y el propósito del PR, preferiblemente con el módulo afectado entre corchetes, por ejemplo, [javasrc2cpg] Addition Operator Fix .
  • Una breve descripción de los cambios en el cuerpo del PR. Esto podría estar en viñetas o párrafos.
  • Un enlace o referencia al problema relacionado, si existe.
• No:
  • Inmediatamente CC/@/correo electrónico no deseado a otros contribuyentes, el equipo revisará el PR y asignará al colaborador más apropiado para revisar el PR. Joern es mantenido por socios de la industria e investigadores por igual, en su mayor parte con sus propios objetivos y prioridades, y la ayuda adicional es en gran medida trabajo voluntario. Si sus relaciones públicas se están volviendo obsoletas, comuníquese con nosotros en los comentarios de seguimiento con @ solicitando una explicación de la prioridad o la planificación de cuándo se puede abordar (si es que se aborda, dependiendo de la calidad).
  • Deje el cuerpo de la descripción vacío, esto dificulta la revisión del propósito del PR.
• Recuerde:
  • Recuerde formatear su código, es decir, ejecute sbt scalafmt Test/scalafmt
  • Agregue una prueba unitaria para verificar su cambio.

configuración IDE

INTELIGENCIA IDEA

• Descargar la comunidad Intellij
• Instalarlo y ejecutarlo
• Instale el complemento Scala: simplemente busque e instálelo desde Intellij.
• Importante: abra sbt en su repositorio de joern local, ejecute compile y manténgalo abierto; esto nos permitirá usar la compilación BSP en el siguiente paso.
• Volver a Intellij: abrir proyecto: seleccione su clon de joern local: seleccione abrir como BSP project (es decir, no como sbt project ).
• Espere a que se completen la importación y la indexación, luego podrá comenzar, por ejemplo, Build -> build project o ejecutar una prueba.

Código VS

• Instalar VSCode y Docker
• Instale el complemento ms-vscode-remote.remote-containers
• Abra la carpeta del proyecto Joern en VSCode Visual Studio Code detecta los archivos nuevos y abre un cuadro de mensaje que dice: Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• Seleccione el botón Reopen in Container para volver a abrir la carpeta en el contenedor creado por el archivo .devcontainer/Dockerfile
• Cambie a la barra lateral scalameta.metals en VSCode y seleccione import build en BUILD COMMANDS
• Una vez que import build se realice correctamente, estará listo para comenzar a escribir código para Joern.

QueryDB (complemento de consultas)

Manera rápida de desarrollar y probar QueryDB:

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

El último comando imprime todas las consultas disponibles: agregue la suya propia en querydb, ejecute los comandos anteriores nuevamente para ver que su consulta se haya implementado. Más detalles en el archivo Léame de querydb separado