Cartographer

Mapeando a Cobertura de Código

Desenvolvido por Austin Peavy - https://github.com/aus10pv

Lançado como código aberto pela NCC Group Plc - https://www.nccgroup.com/
Lançado sob a licença Apache 2.0 (consulte LICENSE para obter mais informações)

Descrição

Cartographer é um plugin de mapeamento de cobertura de código para Ghidra, permitindo que pesquisadores observem quais partes de um programa foram executadas sem exigir o código-fonte.

Sumário

• Principais Recursos
• Instalação
  • Carregando o Plugin
• Uso
  • Carregando Arquivos de Cobertura de Código
  • Detalhes da Cobertura de Código
  • Alternando Entre Coberturas
  • Analisador de Expressões
    • Sintaxe
    • Exemplos
• Contribuindo
  • Compilando a partir do Código-Fonte
  • Relatando Bugs
• Créditos

Principais Recursos

• Coloriza o código executado
  • Grafo de Funções
  • Visualização de Desmontagem (Listing)
  • Visualização do Decompilador
• Cores totalmente personalizáveis
• Suporta temas do Ghidra
• Carrega arquivos DRCOV e arquivos EZCOV personalizados
  • Consulte EZCOV.md para detalhes sobre o formato EZCOV
• Fornece uma visão geral detalhada da cobertura de funções
  • Inclui mapa de calor mostrando quanto de cada função foi executado
• Alterne facilmente entre arquivos de cobertura carregados
• Pesquise funções pelo nome
• Filtre resultados por quantidade de cobertura e mais
• Analisador de expressões poderoso
  • Execute operações lógicas em múltiplas coberturas carregadas
• Suporta cobertura em diferentes espaços de endereçamento

Instalação

A versão estável mais recente do Cartographer pode ser baixada na página de Releases.

Carregando o Plugin

1. Inicie o Ghidra.
2. Navegue até a janela Install Extensions.
   • File -> Install Extensions...
3. Clique no ícone verde "+" no canto superior direito.
4. Selecione o arquivo ZIP baixado para carregar o plugin no Ghidra.
5. Clique no botão "OK" para sair da janela Install Extensions.
6. Reinicie o Ghidra quando solicitado.

Uso

Quando o plugin estiver carregado, haverá controles adicionais na janela CodeBrowser para trabalhar com dados de cobertura de código.

Carregando Arquivos de Cobertura de Código

Os arquivos de cobertura de código podem ser carregados pelo menu Tools: Tools -> Code Coverage -> Load Code Coverage File(s)...

Quando um arquivo de cobertura de código é carregado, todos os dados de cobertura são imediatamente destacados na visualização Listing e na visualização Decompiler.

Detalhes da Cobertura de Código

Informações detalhadas sobre os dados de cobertura de cada função podem ser encontradas na janela Code Coverage.

A janela Code Coverage pode ser aberta navegando até Window -> Code Coverage, ou pressionando Ctrl-Shift-C no Windows (Cmd-Shift-C no Mac).

Esta janela mostra vários detalhes sobre cada função do programa:

• Cobertura %: Percentual da função que foi executada
• Nome: Nome da função
• Endereço: Endereço (ponto de entrada) da função
• Blocos Atingidos: Número de blocos básicos executados
• Instruções Atingidas Número de instruções executadas
• Tamanho da Função: Tamanho da função em bytes

Clicar em qualquer função navegará para a função especificada na visualização Listing e na visualização Decompiler.

Pesquisando e Filtrando

A caixa de entrada Filtro pode ser usada para pesquisar uma função pelo nome.

Qualquer um dos dados exibidos na tabela de cobertura pode ser usado como filtro de coluna.

Alternando Entre Coberturas

O menu suspenso no canto inferior direito da janela Code Coverage pode ser usado para alternar rápida e facilmente entre arquivos de cobertura de código carregados.

Analisador de Expressões

A caixa de texto na parte inferior da janela Code Coverage pode ser usada para realizar operações lógicas em arquivos de cobertura de código carregados.

Isso pode ser extremamente útil para examinar diferenças e semelhanças entre diferentes execuções de um programa.

Sintaxe

Abaixo estão os operadores lógicos que podem ser usados no analisador de expressões.

• &: Obtém apenas o código executado por ambas as coberturas
• |: Obtém qualquer código executado por qualquer uma das coberturas
• ^: Obtém apenas o código executado que difere entre as coberturas
• -: Obtém apenas o código executado que é exclusivo da cobertura à esquerda

As coberturas são referenciadas por seus IDs alfabéticos no menu suspenso, como A, B, XY, etc.

Cada operação lógica é agrupada usando parênteses, e as expressões podem ter qualquer tamanho ou complexidade.

Exemplos

1. Mostre o código que foi executado em ambas as coberturas A e B:

   root@kitploit:~

   A & B
   

2. Mostre o código executado que foi diferente entre as coberturas A e B:

   root@kitploit:~

   A ^ B
   

3. Mostre o código que foi apenas executado em B:

   root@kitploit:~

   B - A
   

4. Combine todos os dados de cobertura encontrados em A e B e, em seguida, encontre quaisquer diferenças em relação a C:

   root@kitploit:~

   (A | B) ^ C
   

Contribuindo

Compilando a partir do Código-Fonte

O Gradle pode ser usado para compilar o Cartographer a partir do seu código-fonte.

1. Clone o repositório do Cartographer no GitHub.

   root@kitploit:~

   $ git clone https://github.com/nccgroup/Cartographer.git
   

2. Entre no repositório e compile com gradle.

   root@kitploit:~

   $ cd Cartographer
   $ gradle -PGHIDRA_INSTALL_DIR=<ghidra_install_dir>
   

   • Substitua <ghidra_install_dir> pelo caminho da sua instalação local do Ghidra.

3. Após a compilação, o arquivo ZIP do plugin estará localizado na pasta dist/.

Relatando Bugs

Se você encontrou um bug no Cartographer, por favor abra uma issue via GitHub.

Créditos

Originalmente inspirado pelo Lighthouse - https://github.com/gaasedelen/lighthouse