/* OpenIDA - Outil d'analyse de fichiers binaires
* binary.c - traitement des flots de code binaire
*
* Copyright (C) 2008 Cyrille Bagard
*
* This file is part of OpenIDA.
*
* OpenIDA is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* OpenIDA is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Foobar. If not, see .
*/
#include "binary.h"
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "line_code.h"
#include "line_comment.h"
#include "line_prologue.h"
#include "prototype.h"
#include "../common/extstr.h"
#include "../panel/log.h"
#include "../plugins/pglist.h"
#include "../format/dbg_format.h"
#ifndef _
# define _(str) str
#endif
extern bool find_line_info(const uint8_t *content, off_t *size);
/* Description d'un fichier binaire */
struct _openida_binary
{
char *filename; /* Fichier chargé en mémoire */
off_t bin_length; /* Taille des données brutes */
uint8_t *bin_data; /* Données binaires brutes */
exe_format *format; /* Format du binaire */
GArchProcessor *proc; /* Architecture du binaire */
GRenderingLine *lines; /* Lignes de rendu en place */
GRenderingOptions *options; /* Options de désassemblage */
};
/* Charge en mémoire le contenu d'un fichier à partir d'XML. */
openida_binary *load_binary_file_from_xml(xmlXPathObjectPtr);
/* Charge en mémoire le contenu d'un fichier. */
uint8_t *map_binary_file(const char *, off_t *);
/* Construit la description d'introduction du désassemblage. */
GRenderingLine *build_binary_prologue(const char *, const uint8_t *, off_t);
/* Procède au désassemblage basique d'un contenu binaire. */
void disassemble_openida_binary(openida_binary *);
/* Etablit les liens entres les différentes lignes de code. */
void establish_links_in_openida_binary(const openida_binary *);
/* S'assure que toutes les routines ont une taille définie. */
void limit_all_routines_in_openida_binary(const openida_binary *);
/* Cherche l'adresse de fin d'une routine. */
vmpa_t find_best_ending_address_for_routine(GRenderingLine *, size_t, const vmpa_t *, const off_t *, size_t);
/******************************************************************************
* *
* Paramètres : filename = nom du fichier à charger. *
* *
* Description : Charge en mémoire le contenu d'un fichier. *
* *
* Retour : Adresse de la représentation ou NULL en cas d'échec. *
* *
* Remarques : - *
* *
******************************************************************************/
openida_binary *load_binary_file(const char *filename)
{
openida_binary *result; /* Adresse à retourner */
result = (openida_binary *)calloc(1, sizeof(openida_binary));
result->filename = strdup(filename);
result->bin_data = map_binary_file(filename, &result->bin_length);
if (result->bin_data == NULL) goto lbf_error;
result->format = load_new_exe_format(result->bin_data, result->bin_length);
if (result->format == NULL) goto lbf_error;
switch (get_exe_target_machine(result->format))
{
case FTM_JVM:
log_simple_message(LMT_INFO, _("Detected architecture: Java Virtual Machine"));
break;
case FTM_MIPS:
log_simple_message(LMT_INFO, _("Detected architecture: Microprocessor without Interlocked Pipeline Stages"));
break;
case FTM_386:
log_simple_message(LMT_INFO, _("Detected architecture: i386"));
break;
default:
log_simple_message(LMT_INFO, _("Unknown architecture"));
goto lbf_error;
break;
}
result->proc = get_arch_processor_from_format(result->format);
result->options = g_rendering_options_new(result->format, result->proc);
g_rendering_options_show_address(result->options, MRD_BLOCK, true);
g_rendering_options_show_code(result->options, MRD_BLOCK, true);
g_rendering_options_show_address(result->options, MRD_GRAPH, true);
g_rendering_options_show_code(result->options, MRD_GRAPH, false);
disassemble_openida_binary(result);
return result;
lbf_error:
unload_binary_file(result);
return NULL;
}
/******************************************************************************
* *
* Paramètres : context = contexte pour les recherches XPath. *
* path = chemin d'accès au noeud XML à lire. *
* *
* Description : Charge en mémoire le contenu d'un fichier à partir d'XML. *
* *
* Retour : Adresse de la représentation ou NULL en cas d'échec. *
* *
* Remarques : - *
* *
******************************************************************************/
openida_binary *g_binary_file_new_from_xml(xmlXPathContextPtr context, const char *path)
{
openida_binary *result; /* Adresse à retourner */
size_t access_len; /* Taille d'un chemin interne */
char *access; /* Chemin pour une sous-config.*/
char *filename; /* Chemin du binaire à charger */
result = NULL;
/* Chemin du fichier à retrouver */
access_len = strlen(path) + strlen("/Filename") + 1;
access = calloc(access_len, sizeof(char));
snprintf(access, access_len, "%s/Filename", path);
filename = get_node_text_value(context, access);
free(access);
/* Chargement */
if (filename != NULL)
{
result = load_binary_file(filename);
free(filename);
}
return result;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à traiter. *
* xdoc = structure XML en cours d'édition. *
* context = contexte à utiliser pour les recherches. *
* path = chemin d'accès réservé au binaire. *
* *
* Description : Ecrit une sauvegarde du binaire dans un fichier XML. *
* *
* Retour : true si l'opération a bien tourné, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_openida_binary_save(const openida_binary *binary, xmlDocPtr xdoc, xmlXPathContextPtr context, const char *path)
{
bool result; /* Bilan à faire remonter */
char *access; /* Chemin d'accès à un élément */
result = true;
/* Nom du fichier associé */
access = strdup(path);
access = stradd(access, "/Filename");
result &= add_content_to_node(xdoc, context, access, binary->filename);
free(access);
return result;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à supprimer de la mémoire. *
* *
* Description : Décharge de la mémoire le contenu d'un fichier. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void unload_binary_file(openida_binary *binary)
{
free(binary->filename);
free(binary);
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* *
* Description : Fournit le fichier correspondant à l'élément binaire. *
* *
* Retour : Nom de fichier avec chemin absolu. *
* *
* Remarques : - *
* *
******************************************************************************/
const char *openida_binary_get_filename(const openida_binary *binary)
{
return binary->filename;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* *
* Description : Fournit une description humaine d'un élément binaire. *
* *
* Retour : Chaîne de caractères humainenement lisible de représentation.*
* *
* Remarques : - *
* *
******************************************************************************/
const char *openida_binary_to_string(const openida_binary *binary)
{
return binary->filename;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* length = taille en octets des données chargées. [OUT] *
* *
* Description : Fournit les détails du contenu binaire chargé en mémoire. *
* *
* Retour : Pointeur vers le début des données. *
* *
* Remarques : - *
* *
******************************************************************************/
uint8_t *get_openida_binary_data(const openida_binary *binary, off_t *length)
{
*length = binary->bin_length;
return binary->bin_data;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* *
* Description : Fournit le format de fichier reconnu dans le contenu binaire.*
* *
* Retour : Adresse du format reconnu. *
* *
* Remarques : - *
* *
******************************************************************************/
exe_format *get_openida_binary_format(const openida_binary *binary)
{
return binary->format;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* *
* Description : Fournit les options d'affichage définies pour le binaire. *
* *
* Retour : Adresse des options d'affichage. *
* *
* Remarques : - *
* *
******************************************************************************/
GRenderingOptions *get_openida_binary_options(const openida_binary *binary)
{
return binary->options;
}
/******************************************************************************
* *
* Paramètres : binary = élément binaire à consulter. *
* *
* Description : Fournit les lignes de rendu issues du désassemblage. *
* *
* Retour : Lignes issues du désassemblage. *
* *
* Remarques : - *
* *
******************************************************************************/
GRenderingLine *get_openida_binary_lines(const openida_binary *binary)
{
return binary->lines;
}
/******************************************************************************
* *
* Paramètres : filename = nom du fichier à charger. *
* length = taille des données mises en mémoire. [OUT] *
* *
* Description : Charge en mémoire le contenu d'un fichier. *
* *
* Retour : Adresse du contenu binaire ou NULL en cas d'échec. *
* *
* Remarques : - *
* *
******************************************************************************/
uint8_t *map_binary_file(const char *filename, off_t *length)
{
uint8_t *result; /* Données à retourner */
int fd; /* Fichier ouvert en lecture */
struct stat info; /* Informations sur le fichier */
int ret; /* Bilan d'un appel */
fd = open(filename, 0, O_RDONLY);
if (fd == -1)
{
perror("open()");
return NULL;
}
ret = fstat(fd, &info);
if (ret == -1)
{
perror("fstat()");
close(fd);
return NULL;
}
*length = info.st_size;
result = (uint8_t *)mmap(NULL, *length, PROT_READ, MAP_PRIVATE, fd, 0);
if (result == MAP_FAILED)
{
perror("mmap()");
result = NULL;
}
ret = close(fd);
if (ret == -1)
perror("close()");
return result;
}
/******************************************************************************
* *
* Paramètres : filename = nom du fichier chargé. *
* data = données en mémoire pour l'empreinte. *
* length = quantité de données à prendre en compte. *
* *
* Description : Construit la description d'introduction du désassemblage. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
GRenderingLine *build_binary_prologue(const char *filename, const uint8_t *data, off_t length)
{
GRenderingLine *result; /* Contenu à renvoyer */
size_t len; /* Taille du texte */
char *content; /* Contenu textuel d'une ligne */
GRenderingLine *line; /* Représentation à ajouter */
GChecksum *checksum; /* Calcul de l'empreinte */
const gchar *hex; /* Valeur hexadécimale du SHA */
result = NULL;/* FIXME DL_LIST_HEAD_INIT( **/
line = g_prologue_line_new("Disassembly generated by OpenIDA");
g_rendering_line_add_to_lines(&result, line);
line = g_prologue_line_new("OpenIDA is free software - © 2008-2009 Cyrille Bagard");
g_rendering_line_add_to_lines(&result, line);
line = g_prologue_line_new("");
g_rendering_line_add_to_lines(&result, line);
/* Fichier */
len = strlen(_("File: ")) + strlen(filename);
content = (char *)calloc(len + 1, sizeof(char));
snprintf(content, len + 1, "%s%s", _("File: "), filename);
line = g_prologue_line_new(content);
g_rendering_line_add_to_lines(&result, line);
free(content);
/* Checksum SHA256 */
checksum = g_checksum_new(G_CHECKSUM_SHA256);
g_checksum_update(checksum, data, length);
hex = g_checksum_get_string(checksum);
len = strlen(_("Sha256: ")) + strlen(hex);
content = (char *)calloc(len + 1, sizeof(char));
snprintf(content, len + 1, "%s%s", _("Sha256: "), hex);
g_checksum_free(checksum);
line = g_prologue_line_new(content);
g_rendering_line_add_to_lines(&result, line);
free(content);
line = g_prologue_line_new("");
g_rendering_line_add_to_lines(&result, line);
line = g_prologue_line_new("");
g_rendering_line_add_to_lines(&result, line);
return result;
}
/******************************************************************************
* *
* Paramètres : binary = binaire dont le contenu est à analyser. *
* *
* Description : Procède au désassemblage basique d'un contenu binaire. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void disassemble_openida_binary(openida_binary *binary)
{
GArchInstruction *instr;
GBinRoutine **routines; /* Liste des routines trouvées */
size_t routines_count; /* Nombre de ces routines */
bin_part **parts;
size_t parts_count;
GRenderingLine *line;
off_t start;
off_t pos;
off_t len;
uint64_t base = 0;
vmpa_t addr = 0;
size_t i;
size_t k;
uint64_t routine_offset; /* Point de départ de routine */
char *routine_desc; /* Prototype d'une routine */
GPluginModule *disass; /* Eventuel greffon de désass. */
binary->lines = build_binary_prologue(binary->filename, binary->bin_data, binary->bin_length);
routines = get_all_exe_routines(binary->format, &routines_count);
disass = get_one_plugin_for_action(PGA_DISASSEMBLE);
if (0 && disass != NULL)
binary->lines = g_plugin_module_disassemble_binary_parts(disass, binary);
else
{
parts = /* !!! */get_elf_default_code_parts(binary->format, &parts_count);
qsort(parts, parts_count, sizeof(bin_part *), compare_bin_parts);
printf("PARTS COUNT :: %d\n", parts_count);
for (i = 0; i < parts_count; i++)
{
get_bin_part_values(parts[i], &pos, &len, &base);
/* Décodage des instructions */
start = pos;
pos = 0;
while (pos < len)
{
addr = base + pos;
instr = g_arch_processor_decode_instruction(binary->proc, &binary->bin_data[start], &pos, len, start, addr);
line = g_code_line_new(addr, instr, binary->options);
g_rendering_line_add_to_lines(&binary->lines, line);
}
/* Ajout des prototypes de fonctions */
for (k = 0; k < routines_count; k++)
{
routine_offset = g_binary_routine_get_address(routines[k]);
if (!(base <= routine_offset && routine_offset < (base + len))) continue;
routine_desc = g_binary_routine_to_string(routines[k]);
line = g_comment_line_new(routine_offset, routine_desc, binary->options);
g_rendering_line_insert_into_lines(&binary->lines, line, true);
free(routine_desc);
}
}
}
establish_links_in_openida_binary(binary);
limit_all_routines_in_openida_binary(binary);
line = g_rendering_line_find_by_address(binary->lines, NULL, get_exe_entry_point(binary->format));
if (line != NULL) g_rendering_line_add_flag(line, RLF_ENTRY_POINT);
}
/******************************************************************************
* *
* Paramètres : binary = binaire dont le contenu est à lier. *
* *
* Description : Etablit les liens entres les différentes lignes de code. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void establish_links_in_openida_binary(const openida_binary *binary)
{
GBinRoutine **routines; /* Liste des routines trouvées */
size_t routines_count; /* Nombre de ces routines */
size_t i; /* Boucle de parcours */
vmpa_t start; /* Adresse de départ */
vmpa_t end; /* Adresse de fin */
GRenderingLine *iter; /* Boucle de parcours */
GArchInstruction *instr; /* Instruction à ausculter */
vmpa_t addr; /* Adresse référencée */
InstructionLinkType type; /* Type de référence */
GRenderingLine *target; /* Ligne visée par la référence*/
routines = get_all_exe_routines(binary->format, &routines_count);
for (i = 0; i < routines_count; i++)
{
start = g_binary_routine_get_address(routines[i]);
end = start + g_binary_routine_get_size(routines[i]);
for (iter = g_rendering_line_find_by_address(binary->lines, NULL, start);
iter != NULL;
iter = g_rendering_line_get_next_iter(binary->lines, iter, NULL))
{
/* Si on sort de la zone... */
if (get_rendering_line_address(iter) >= end) break;
/* On ne traite que du code ici ! */
if (!G_IS_CODE_LINE(iter)) continue;
instr = g_code_line_get_instruction(G_CODE_LINE(iter));
type = g_arch_instruction_get_link(instr, &addr);
switch (type)
{
case ILT_NONE:
break;
case ILT_JUMP:
target = g_rendering_line_find_by_address(binary->lines, NULL, addr);
if (target != NULL)
g_rendering_line_link_with(iter, target, type);
break;
case ILT_JUMP_IF_FALSE:
break;
case ILT_JUMP_IF_TRUE:
target = g_rendering_line_find_by_address(binary->lines, NULL, addr);
if (target != NULL)
{
g_rendering_line_link_with(iter, target, type);
target = g_rendering_line_get_next_iter(binary->lines, iter, NULL);
if (target != NULL)
g_rendering_line_link_with(iter, target, ILT_JUMP_IF_FALSE);
}
break;
case ILT_CALL:
target = g_rendering_line_find_by_address(binary->lines, NULL, addr);
if (target != NULL)
g_rendering_line_link_with(iter, target, type);
break;
}
}
}
}
/******************************************************************************
* *
* Paramètres : binary = binaire dont le contenu est à lier. *
* *
* Description : S'assure que toutes les routines ont une taille définie. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void limit_all_routines_in_openida_binary(const openida_binary *binary)
{
GBinRoutine **routines; /* Liste des routines trouvées */
size_t routines_count; /* Nombre de ces routines */
size_t i; /* Boucle de parcours */
vmpa_t *starts; /* Adresses de départ */
off_t *lengths; /* Tailles des routines */
GRenderingLine *line; /* Ligne de départ / d'arrivée */
vmpa_t start; /* Adresse de début de routine */
vmpa_t last; /* Meilleur dernière adresse */
GArchInstruction *instr; /* Instruction à ausculter */
off_t length; /* Taille du code */
routines = get_all_exe_routines(binary->format, &routines_count);
if (routines_count == 0) return;
qsort(routines, routines_count, sizeof(GBinRoutine *), g_binary_routine_rcompare);
starts = (vmpa_t *)calloc(routines_count, sizeof(vmpa_t));
lengths = (off_t *)calloc(routines_count, sizeof(off_t));
for (i = 0; i < routines_count; i++)
{
starts[i] = g_binary_routine_get_address(routines[i]);
lengths[i] = g_binary_routine_get_size(routines[i]);
}
for (i = 0; i < routines_count; i++)
{
if (lengths[i] > 0) continue;
start = g_binary_routine_get_address(routines[i]);
line = g_rendering_line_find_by_address(binary->lines, NULL, start);
last = find_best_ending_address_for_routine(line, i, starts, lengths, routines_count);
line = g_rendering_line_find_by_address(binary->lines, NULL, last);
line = g_rendering_line_loop_for_code(line, NULL);
instr = g_code_line_get_instruction(G_CODE_LINE(line));
g_arch_instruction_get_location(instr, NULL, &length, NULL);
lengths[i] = last - start + length;
g_binary_routine_set_size(routines[i], lengths[i]);
}
free(starts);
free(lengths);
}
/******************************************************************************
* *
* Paramètres : line = ligne de départ du parcours. *
* index = indice de la routine traitée dans la liste. *
* starts = adresse de départ des autres routines. *
* lengths = taille des différentes routines, valides ou nulles.*
* count = quantité de routines présentes. *
* *
* Description : Cherche l'adresse de fin d'une routine. *
* *
* Retour : Plus grande adresse de dernière instruction de routine. *
* *
* Remarques : - *
* *
******************************************************************************/
vmpa_t find_best_ending_address_for_routine(GRenderingLine *line, size_t index, const vmpa_t *starts, const off_t *lengths, size_t count)
{
vmpa_t result; /* Haute adresse à remonter */
GRenderingLine *iter; /* Boucle de parcours #1 */
vmpa_t candidate; /* Candidat potentiel */
size_t i; /* Boucle de parcours #2 */
GArchInstruction *instr; /* Instruction à ausculter */
result = starts[index];
for (iter = line; iter != NULL; iter = g_rendering_line_get_next_iter(line, iter, NULL))
{
if (!G_IS_CODE_LINE(iter)) continue;
candidate = get_rendering_line_address(iter);
/* Regarde si on n'empiète pas sur une autre routine */
for (i = 0; i < count; i++)
{
if (i == index) continue;
if (starts[i] <= candidate && candidate < (starts[i] + lengths[i]))
break;
}
if (i != count) break;
else result = candidate;
/* Retour de fonction ? */
instr = g_code_line_get_instruction(G_CODE_LINE(iter));
if (g_arch_instruction_is_return(instr)) break;
}
return result;
}