/* Chrysalide - Outil d'analyse de fichiers binaires
* content.c - lecture de données binaires quelconques
*
* Copyright (C) 2015-2019 Cyrille Bagard
*
* This file is part of Chrysalide.
*
* Chrysalide 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.
*
* Chrysalide 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 Chrysalide. If not, see .
*/
#include "content.h"
#include
#include
#include
#include "content-int.h"
/* -------------------------- ENSEMBLE DE DONNEES BINAIRES -------------------------- */
/* Initialise la classe des contenus binaires à parcourir. */
static void g_binary_content_class_init(GBinContentClass *);
/* Initialise l'instance de contenu binaire à parcourir. */
static void g_binary_content_init(GBinContent *);
/* Procède à l'initialisation de l'interface de sérialisation. */
static void g_binary_content_serializable_interface_init(GSerializableObjectIface *);
/* Supprime toutes les références externes. */
static void g_binary_content_dispose(GBinContent *);
/* Procède à la libération totale de la mémoire. */
static void g_binary_content_finalize(GBinContent *);
/* -------------------- CONSERVATION ET RECHARGEMENT DES DONNEES -------------------- */
/* Charge un contenu depuis une mémoire tampon. */
static bool g_binary_content_load(GBinContent *, GObjectStorage *, packed_buffer_t *);
/* Sauvegarde un contenu dans une mémoire tampon. */
static bool g_binary_content_store(const GBinContent *, GObjectStorage *, packed_buffer_t *);
/* ---------------------------------------------------------------------------------- */
/* ENSEMBLE DE DONNEES BINAIRES */
/* ---------------------------------------------------------------------------------- */
/* Détermine le type d'un contenu binaire à parcourir. */
G_DEFINE_TYPE_WITH_CODE(GBinContent, g_binary_content, G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE(G_TYPE_SERIALIZABLE_OBJECT, g_binary_content_serializable_interface_init));
/******************************************************************************
* *
* Paramètres : klass = classe à initialiser. *
* *
* Description : Initialise la classe des contenus binaires à parcourir. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_binary_content_class_init(GBinContentClass *klass)
{
GObjectClass *object; /* Autre version de la classe */
object = G_OBJECT_CLASS(klass);
object->dispose = (GObjectFinalizeFunc/* ! */)g_binary_content_dispose;
object->finalize = (GObjectFinalizeFunc)g_binary_content_finalize;
}
/******************************************************************************
* *
* Paramètres : content = instance à initialiser. *
* *
* Description : Initialise l'instance de contenu binaire à parcourir. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_binary_content_init(GBinContent *content)
{
}
/******************************************************************************
* *
* Paramètres : iface = interface GLib à initialiser. *
* *
* Description : Procède à l'initialisation de l'interface de sérialisation. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_binary_content_serializable_interface_init(GSerializableObjectIface *iface)
{
iface->load = (load_serializable_object_cb)g_binary_content_load;
iface->store = (store_serializable_object_cb)g_binary_content_store;
}
/******************************************************************************
* *
* Paramètres : content = instance d'objet GLib à traiter. *
* *
* Description : Supprime toutes les références externes. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_binary_content_dispose(GBinContent *content)
{
G_OBJECT_CLASS(g_binary_content_parent_class)->dispose(G_OBJECT(content));
}
/******************************************************************************
* *
* Paramètres : content = instance d'objet GLib à traiter. *
* *
* Description : Procède à la libération totale de la mémoire. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void g_binary_content_finalize(GBinContent *content)
{
G_OBJECT_CLASS(g_binary_content_parent_class)->finalize(G_OBJECT(content));
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à actualiser. *
* attribs = jeu d'attributs à lier au contenu courant. *
* *
* Description : Associe un ensemble d'attributs au contenu binaire. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_binary_content_set_attributes(GBinContent *content, GContentAttributes *attribs)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
class->set_attribs(content, attribs);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à consulter. *
* *
* Description : Fournit l'ensemble des attributs associés à un contenu. *
* *
* Retour : Jeu d'attributs liés au contenu courant. *
* *
* Remarques : - *
* *
******************************************************************************/
GContentAttributes *g_binary_content_get_attributes(const GBinContent *content)
{
GContentAttributes *result; /* Instance à retourner */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->get_attribs(content);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à consulter. *
* *
* Description : Donne l'origine d'un contenu binaire. *
* *
* Retour : Contenu à l'origine du contenu courant. *
* *
* Remarques : - *
* *
******************************************************************************/
GBinContent *g_binary_content_get_root(GBinContent *content)
{
GBinContent *result; /* Contenu en place à renvoyer */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->get_root(content);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à consulter. *
* full = précise s'il s'agit d'une version longue ou non. *
* *
* Description : Fournit le nom associé au contenu binaire. *
* *
* Retour : Nom de fichier avec chemin absolu au besoin. *
* *
* Remarques : - *
* *
******************************************************************************/
char *g_binary_content_describe(const GBinContent *content, bool full)
{
char *result; /* Description à retourner */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->describe(content, full);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* *
* Description : Fournit une empreinte unique (SHA256) pour les données. *
* *
* Retour : Chaîne représentant l'empreinte du contenu binaire. *
* *
* Remarques : - *
* *
******************************************************************************/
const gchar *g_binary_content_get_checksum(GBinContent *content)
{
const gchar *result; /* Empreinte à retourner */
GChecksum *checksum; /* Calcul de l'empreinte */
GBinContentClass *class; /* Classe de l'instance */
checksum = g_object_get_data(G_OBJECT(content), "checksum");
if (checksum == NULL)
{
checksum = g_checksum_new(G_CHECKSUM_SHA256);
assert(checksum != NULL);
g_checksum_reset(checksum);
class = G_BIN_CONTENT_GET_CLASS(content);
class->compute_checksum(content, checksum);
g_object_set_data_full(G_OBJECT(content), "checksum", checksum, (GDestroyNotify)g_checksum_free);
}
result = g_checksum_get_string(checksum);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* *
* Description : Détermine le nombre d'octets lisibles. *
* *
* Retour : Quantité représentée. *
* *
* Remarques : - *
* *
******************************************************************************/
phys_t g_binary_content_compute_size(const GBinContent *content)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
return class->compute_size(content);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* pos = position initiale. [OUT] *
* *
* Description : Détermine la position initiale d'un contenu. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_binary_content_compute_start_pos(const GBinContent *content, vmpa2t *pos)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
return class->compute_start_pos(content, pos);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* pos = position finale (exclusive). [OUT] *
* *
* Description : Détermine la position finale d'un contenu. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void g_binary_content_compute_end_pos(const GBinContent *content, vmpa2t *pos)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
return class->compute_end_pos(content, pos);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* length = quantité d'octets à provisionner. *
* *
* Description : Avance la tête de lecture d'une certaine quantité de données.*
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_seek(const GBinContent *content, vmpa2t *addr, phys_t length)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
return class->seek(content, addr, length);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* length = quantité d'octets à lire. *
* *
* Description : Donne accès à une portion des données représentées. *
* *
* Retour : Pointeur vers les données à lire ou NULL en cas d'échec. *
* *
* Remarques : - *
* *
******************************************************************************/
const bin_t *g_binary_content_get_raw_access(const GBinContent *content, vmpa2t *addr, phys_t length)
{
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
return class->get_raw_access(content, addr, length);
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* length = quantité d'octets à lire. *
* out = réceptacle disponible pour ces données. [OUT] *
* *
* Description : Fournit une portion des données représentées. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_raw(const GBinContent *content, vmpa2t *addr, phys_t length, bin_t *out)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_raw(content, addr, length, out);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture complète. *
* size = quantité de bits à lire. *
* endian = ordre des bits dans la source. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur deux octets. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_bits(const GBinContent *content, ext_vmpa_t *addr, uint8_t size, SourceEndian endian, uint64_t *val)
{
bool result; /* Bilan de lecture à renvoyer */
vmpa2t pos; /* Tête de lecture courante */
uint8_t data; /* Données à parcourir */
uint8_t i; /* Boucle de parcours */
uint8_t remaining; /* Nombre de bits disponibles */
uint64_t bit; /* Nouveau bit à intégrer */
assert(addr->consumed_extra_bits < 8);
assert(size <= 64);
if (addr->consumed_extra_bits >= 8 || size > 64)
return false;
copy_vmpa(&pos, &addr->base);
result = g_binary_content_read_u8(content, &pos, &data);
if (!result) goto exit;
remaining = 8 - addr->consumed_extra_bits;
*val = 0;
for (i = 0; i < size; i++)
{
if (remaining == 0)
{
result = g_binary_content_read_u8(content, &pos, &data);
if (!result) goto exit;
remaining = 8;
}
bit = (data >> (remaining - 1)) & 0x1;
remaining--;
switch (endian)
{
case SRE_LITTLE:
*val |= (bit << i);
break;
case SRE_BIG:
*val |= (bit << (size - i - 1));
break;
default:
assert(false);
result = false;
break;
}
}
if (result)
{
advance_vmpa(&addr->base, get_phy_addr(&pos) - get_phy_addr(&addr->base) - 1);
addr->consumed_extra_bits = 8 - remaining;
}
exit:
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* low = position éventuelle des 4 bits visés. [OUT] *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur quatre bits. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_u4(const GBinContent *content, vmpa2t *addr, bool *low, uint8_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_u4(content, addr, low, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur un octet. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_u8(const GBinContent *content, vmpa2t *addr, uint8_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_u8(content, addr, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* endian = ordre des bits dans la source. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur deux octets. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_u16(const GBinContent *content, vmpa2t *addr, SourceEndian endian, uint16_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_u16(content, addr, endian, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* endian = ordre des bits dans la source. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur quatre octets. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_u32(const GBinContent *content, vmpa2t *addr, SourceEndian endian, uint32_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_u32(content, addr, endian, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* endian = ordre des bits dans la source. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé sur huit octets. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_u64(const GBinContent *content, vmpa2t *addr, SourceEndian endian, uint64_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_u64(content, addr, endian, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre non signé encodé au format LEB128. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_uleb128(const GBinContent *content, vmpa2t *addr, uleb128_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_uleb128(content, addr, val);
return result;
}
/******************************************************************************
* *
* Paramètres : content = contenu binaire à venir lire. *
* addr = position de la tête de lecture. *
* val = lieu d'enregistrement de la lecture. [OUT] *
* *
* Description : Lit un nombre signé encodé au format LEB128. *
* *
* Retour : Bilan de l'opération : true en cas de succès, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
bool g_binary_content_read_leb128(const GBinContent *content, vmpa2t *addr, leb128_t *val)
{
bool result; /* Bilan à remonter */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->read_leb128(content, addr, val);
return result;
}
/* ---------------------------------------------------------------------------------- */
/* CONSERVATION ET RECHARGEMENT DES DONNEES */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : content = élément GLib à constuire. *
* storage = conservateur de données à manipuler ou NULL. *
* pbuf = zone tampon à lire. *
* *
* Description : Charge un contenu depuis une mémoire tampon. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool g_binary_content_load(GBinContent *content, GObjectStorage *storage, packed_buffer_t *pbuf)
{
bool result; /* Bilan à retourner */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->load(content, storage, pbuf);
return result;
}
/******************************************************************************
* *
* Paramètres : content = élément GLib à consulter. *
* storage = conservateur de données à manipuler ou NULL. *
* pbuf = zone tampon à remplir. *
* *
* Description : Sauvegarde un contenu dans une mémoire tampon. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool g_binary_content_store(const GBinContent *content, GObjectStorage *storage, packed_buffer_t *pbuf)
{
bool result; /* Bilan à retourner */
GBinContentClass *class; /* Classe de l'instance */
class = G_BIN_CONTENT_GET_CLASS(content);
result = class->store(content, storage, pbuf);
return result;
}