joern

Joern – A bancada do caçador de insetos

Joern é uma plataforma para análise de código-fonte, bytecode e executáveis ​​binários. Ele gera gráficos de propriedades de código (CPGs), uma representação gráfica de código para análise de código entre idiomas. Os gráficos de propriedades de código são armazenados em um banco de dados de gráficos personalizado. Isso permite que o código seja extraído usando consultas de pesquisa formuladas em uma linguagem de consulta específica de domínio baseada em Scala. Joern foi desenvolvido com o objetivo de fornecer uma ferramenta útil para descoberta de vulnerabilidades e pesquisa em análise estática de programas.

Site: https://joern.io

Documentação: https://docs.joern.io/

Especificação: https://cpg.joern.io

Notícias / Registro de alterações

• Joern v4.0.0 migra de overflowdb para flatgraph
• Joern v2.0.0 atualiza de Scala2 para Scala3
• Joern v1.2.0 remove a classe overflowdb.traversal.Traversal . Esta mudança não é totalmente compatível com versões anteriores. Veja aqui um artigo detalhado.

Requisitos

• JDK 21 (outras versões podem funcionar, mas não foram testadas adequadamente)
• opcional : gcc e g++ (para descoberta automática de arquivos de cabeçalho do sistema C/C++ se incluídos/usados ​​em seu código C/C++)

Requisitos de desenvolvimento

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

Instalação 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>

Se o script de instalação falhar por algum motivo, tente

 ./joern-install --interactive

Execução baseada em Docker

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

Para executar joern no modo servidor:

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

Almalinux 9 requer que a CPU suporte SSE4.2. Para VM kvm64, use a versão Almalinux 8.

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

Lançamentos

Uma nova versão é criada automaticamente uma vez por dia. Os colaboradores também podem executar manualmente o fluxo de trabalho de lançamento se precisarem do lançamento mais cedo.

Desenvolvedores

Diretrizes de Contribuição

Obrigado por dedicar seu tempo para contribuir com Joern! Aqui estão algumas diretrizes para garantir que sua solicitação pull seja mesclada o mais rápido possível:

• Tente usar os modelos na medida do possível, porém eles podem não atender a todas as necessidades. O mínimo que gostaríamos de ver é:
  • Um título que descreve brevemente a alteração e o propósito do PR, de preferência com o módulo afetado entre colchetes, por exemplo, [javasrc2cpg] Addition Operator Fix .
  • Uma breve descrição das alterações no corpo do PR. Isso pode ser feito em marcadores ou parágrafos.
  • Um link ou referência ao problema relacionado, se existir.
• Não:
  • Imediatamente CC/@/e-mail enviar spam para outros contribuidores, a equipe analisará o PR e designará o contribuidor mais apropriado para revisá-lo. Joern é mantido por parceiros da indústria e pesquisadores, em sua maioria com seus próprios objetivos e prioridades, e a ajuda adicional é em grande parte trabalho voluntário. Se o seu PR estiver obsoleto, entre em contato conosco nos comentários de acompanhamento com @ pedindo uma explicação sobre a prioridade ou planejamento de quando ele poderá ser abordado (se for o caso, dependendo da qualidade).
  • Deixe o corpo da descrição vazio, isso dificulta a revisão do propósito do PR.
• Lembre-se de:
  • Lembre-se de formatar seu código, ou seja, execute sbt scalafmt Test/scalafmt
  • Adicione um teste de unidade para verificar sua alteração.

Configuração do ambiente de desenvolvimento integrado

IDEIA INTELIG

• Baixe a comunidade Intellij
• Instale e execute-o
• Instale o plug-in Scala - basta pesquisar e instalar no Intellij.
• Importante: abra sbt em seu repositório joern local, execute compile e mantenha-o aberto - isso nos permitirá usar o build BSP na próxima etapa
• De volta ao Intellij: abra o projeto: selecione seu clone joern local: selecione para abrir como BSP project (ou seja, não sbt project !)
• Aguarde a conclusão da importação e da indexação, então você pode começar, por exemplo, Build -> build project ou executar um teste

Código VSC

• Instale VSCode e Docker
• Instale o plugin ms-vscode-remote.remote-containers
• Abra a pasta do projeto Joern no VSCode O Visual Studio Code detecta os novos arquivos e abre uma caixa de mensagem dizendo: Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• Selecione o botão Reopen in Container para reabrir a pasta no contêiner criado pelo arquivo .devcontainer/Dockerfile
• Mude para a barra lateral scalameta.metals no VSCode e selecione import build em BUILD COMMANDS
• Depois que import build for bem-sucedida, você estará pronto para começar a escrever o código para Joern

QueryDB (plugin de consultas)

Maneira rápida de desenvolver e testar o QueryDB:

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

O último comando imprime todas as consultas disponíveis - adicione a sua própria no querydb, execute os comandos acima novamente para ver se sua consulta foi implantada. Mais detalhes no leia-me separado do querydb