summaryrefslogtreecommitdiff
path: root/src/analysis/scan/exprs/handler.c
blob: 8aab9e5a74ce996e288bfeec7aa2a24e49cb767a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520

/* Chrysalide - Outil d'analyse de fichiers binaires
 * handler.c - manipulation des correspondances établies lors d'un scan
 *
 * Copyright (C) 2023 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "handler.h"


#include <assert.h>


#include "literal.h"
#include "handler-int.h"
#include "../matches/bytes.h"



/* --------------------- INTRODUCTION D'UNE NOUVELLE EXPRESSION --------------------- */


/* Initialise la classe des manipulations de correspondances. */
static void g_scan_pattern_handler_class_init(GScanPatternHandlerClass *);

/* Initialise une instance de manipulation de correspondances. */
static void g_scan_pattern_handler_init(GScanPatternHandler *);

/* Supprime toutes les références externes. */
static void g_scan_pattern_handler_dispose(GScanPatternHandler *);

/* Procède à la libération totale de la mémoire. */
static void g_scan_pattern_handler_finalize(GScanPatternHandler *);



/* --------------------- IMPLEMENTATION DES FONCTIONS DE CLASSE --------------------- */


/* Réduit une expression à une forme plus simple. */
static ScanReductionState g_scan_pattern_handler_reduce(const GScanPatternHandler *, GScanContext *, GScanScope *, GScanExpression **);

/* Réduit une expression à une forme booléenne. */
static bool g_scan_pattern_handler_reduce_to_boolean(const GScanPatternHandler *, GScanContext *, GScanScope *, GScanExpression **);

/* Dénombre les éléments portés par une expression. */
static bool g_scan_pattern_handler_count_items(const GScanPatternHandler *, GScanContext *, size_t *);

/* Fournit un élément donné issu d'un ensemble constitué. */
static bool g_scan_pattern_handler_get_item(const GScanPatternHandler *, size_t, GScanContext *, GScanExpression **);



/* ---------------------------------------------------------------------------------- */
/*                       INTRODUCTION D'UNE NOUVELLE EXPRESSION                       */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour une manipulation de correspondances établies lors d'un scan. */
G_DEFINE_TYPE(GScanPatternHandler, g_scan_pattern_handler, G_TYPE_SCAN_EXPRESSION);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des manipulations de correspondances.   *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_pattern_handler_class_init(GScanPatternHandlerClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */
    GScanExpressionClass *expr;             /* Version de classe parente   */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_scan_pattern_handler_dispose;
    object->finalize = (GObjectFinalizeFunc)g_scan_pattern_handler_finalize;

    expr = G_SCAN_EXPRESSION_CLASS(klass);

    expr->reduce = (reduce_expr_fc)g_scan_pattern_handler_reduce;
    expr->reduce_to_bool = (reduce_expr_to_bool_fc)g_scan_pattern_handler_reduce_to_boolean;
    expr->count = (count_scan_expr_fc)g_scan_pattern_handler_count_items;
    expr->get = (get_scan_expr_fc)g_scan_pattern_handler_get_item;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : handler = instance à initialiser.                            *
*                                                                             *
*  Description : Initialise une instance de manipulation de correspondances.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_pattern_handler_init(GScanPatternHandler *handler)
{
    handler->patterns = NULL;
    handler->count = 0;

    handler->type = SHT_RAW;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : handler = instance d'objet GLib à traiter.                   *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_pattern_handler_dispose(GScanPatternHandler *handler)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < handler->count; i++)
         g_clear_object(&handler->patterns[i]);

    G_OBJECT_CLASS(g_scan_pattern_handler_parent_class)->dispose(G_OBJECT(handler));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : handler = instance d'objet GLib à traiter.                   *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_pattern_handler_finalize(GScanPatternHandler *handler)
{
    G_OBJECT_CLASS(g_scan_pattern_handler_parent_class)->finalize(G_OBJECT(handler));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : patterns = motifs à impliquer.                               *
*                count    = quantité de ces motifs.                           *
*                type     = type de manipulation attendue.                    *
*                                                                             *
*  Description : Met en place une manipulation de correspondances établies.   *
*                                                                             *
*  Retour      : Expression mise en place.                                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanExpression *g_scan_pattern_handler_new(GSearchPattern ** const patterns, size_t count, ScanHandlerType type)
{
    GScanExpression *result;                /* Structure à retourner       */

    result = g_object_new(G_TYPE_SCAN_PATTERN_HANDLER, NULL);

    if (!g_scan_pattern_handler_create(G_SCAN_PATTERN_HANDLER(result), patterns, count, type))
        g_clear_object(&result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : handler  = instance à initialiser pleinement.                *
*                patterns = motifs à impliquer.                               *
*                count    = quantité de ces motifs.                           *
*                type     = type de manipulation attendue.                    *
*                                                                             *
*  Description : Met en place une manipulation de correspondances établies.   *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_pattern_handler_create(GScanPatternHandler *handler, GSearchPattern ** const patterns, size_t count, ScanHandlerType type)
{
    bool result;                            /* Bilan à retourner           */
    size_t i;                               /* Boucle de parcours          */

    result = g_scan_expression_create(G_SCAN_EXPRESSION(handler), SRS_WAIT_FOR_SCAN);
    if (!result) goto exit;

    handler->patterns = malloc(count * sizeof(GSearchPattern *));
    handler->count = count;

    for (i = 0; i < count; i++)
    {
        handler->patterns[i] = patterns[i];
        g_object_ref(G_OBJECT(patterns[i]));
    }

    handler->type = type;

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : handler = instance à initialiser pleinement.                 *
*                ctx     = contexte de suivi de l'analyse courante.           *
*                count   = quantité de correspondances enregistrées. [OUT]    *
*                                                                             *
*  Description : Fournit la liste de toutes les correspondances représentées. *
*                                                                             *
*  Retour      : Liste courante de correspondances établies.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanMatch **g_scan_pattern_handler_get_all_matches(const GScanPatternHandler *handler, GScanContext *ctx, size_t *count)
{
    GScanMatch **result;                    /* Liste à retourner           */
    size_t used;                            /* Indice pour le stockage     */
    size_t i;                               /* Boucle de parcours #1       */
    size_t partial;                         /* Décompte partiel            */
    const GScanMatch **matches;             /* Correspondances en place    */
    size_t k;                               /* Boucle de parcours #2       */

    result = NULL;

    if (!g_scan_pattern_handler_count_items(handler, ctx, count))
    {
        *count = 0;
        goto exit;
    }

    if (*count == 0)
        goto exit;

    result = malloc(*count * sizeof(GScanMatch *));

    used = 0;

    for (i = 0; i < handler->count; i++)
    {
        matches = g_scan_context_get_full_matches(ctx, handler->patterns[i], &partial);

        for (k = 0; k < partial; k++)
        {
            result[used++] = matches[k];
            g_object_ref(G_OBJECT(matches[k]));
        }

    }

 exit:

    return result;

}



/* ---------------------------------------------------------------------------------- */
/*                       IMPLEMENTATION DES FONCTIONS DE CLASSE                       */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : expr  = expression à consulter.                              *
*                ctx   = contexte de suivi de l'analyse courante.             *
*                scope = portée courante des variables locales.               *
*                out   = zone d'enregistrement de la réduction opérée. [OUT]  *
*                                                                             *
*  Description : Réduit une expression à une forme plus simple.               *
*                                                                             *
*  Retour      : Bilan de l'opération : false en cas d'erreur irrécupérable.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static ScanReductionState g_scan_pattern_handler_reduce(const GScanPatternHandler *expr, GScanContext *ctx, GScanScope *scope, GScanExpression **out)
{
    ScanReductionState result;              /* Etat synthétisé à retourner */
    size_t count;                           /* Quantité de correspondances */

    if (g_scan_context_is_scan_done(ctx))
    {
        if (expr->type == SHT_COUNTER)
        {
            if (!g_scan_pattern_handler_count_items(expr, ctx, &count))
                result = SRS_UNRESOLVABLE;

            else
            {
                result = SRS_REDUCED;
                *out = g_scan_literal_expression_new(LVT_UNSIGNED_INTEGER, (unsigned long long []){ count });
            }

        }

        else
            result = SRS_REDUCED;

    }

    else
        result = SRS_WAIT_FOR_SCAN;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : expr  = expression à consulter.                              *
*                ctx   = contexte de suivi de l'analyse courante.             *
*                scope = portée courante des variables locales.               *
*                out   = zone d'enregistrement de la réduction opérée. [OUT]  *
*                                                                             *
*  Description : Réduit une expression à une forme booléenne.                 *
*                                                                             *
*  Retour      : Bilan de l'opération : false en cas d'erreur irrécupérable.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_scan_pattern_handler_reduce_to_boolean(const GScanPatternHandler *expr, GScanContext *ctx, GScanScope *scope, GScanExpression **out)
{
    bool result;                            /* Bilan à retourner           */
    size_t count;                           /* Quantité de correspondances */

    result = g_scan_pattern_handler_count_items(expr, ctx, &count);

    *out = g_scan_literal_expression_new(LVT_BOOLEAN, (bool []){ count > 0 });

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : expr  = expression à consulter.                              *
*                ctx   = contexte de suivi de l'analyse courante.             *
*                count = quantité d'éléments déterminée. [OUT]                *
*                                                                             *
*  Description : Dénombre les éléments portés par une expression.             *
*                                                                             *
*  Retour      : Bilan de l'opération : false en cas d'erreur irrécupérable.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_scan_pattern_handler_count_items(const GScanPatternHandler *expr, GScanContext *ctx, size_t *count)
{
    bool result;                            /* Bilan à retourner           */
    size_t partial;                         /* Décompte partiel            */
    size_t i;                               /* Boucle de parcours          */

    result = true;

    assert(g_scan_context_is_scan_done(ctx));

    *count = 0;

    for (i = 0; i < expr->count; i++)
    {
        g_scan_context_get_full_matches(ctx, expr->patterns[i], &partial);
        *count += partial;
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : expr  = expression à consulter.                              *
*                index = indice de l'élément à transférer.                    *
*                ctx   = contexte de suivi de l'analyse courante.             *
*                out   = zone d'enregistrement de la réduction opérée. [OUT]  *
*                                                                             *
*  Description : Fournit un élément donné issu d'un ensemble constitué.       *
*                                                                             *
*  Retour      : Bilan de l'opération : false en cas d'erreur irrécupérable.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool g_scan_pattern_handler_get_item(const GScanPatternHandler *expr, size_t index, GScanContext *ctx, GScanExpression **out)
{
    bool result;                            /* Bilan à retourner           */
    size_t i;                               /* Boucle de parcours          */
    size_t count;                           /* Quantité de correspondances */
    const GScanMatch **matches;             /* Correspondances en place    */
    const GScanBytesMatch *match;           /* Correspondance ciblée       */
    phys_t start;                           /* Point de départ du motif    */
    phys_t end;                             /* Point d'arrivée du motif    */
    phys_t len;                             /* Taille du motif             */
    GBinContent *content;                   /* Contenu binaire à relire    */
    vmpa2t pos;                             /* Tête de lecture             */
    const bin_t *data;                      /* Accès aux données brutes    */
    sized_string_t binary;                  /* Conversion de formats       */

    result = false;

    assert(g_scan_context_is_scan_done(ctx));

    /* Identification du motif concerné */

    for (i = 0; i < expr->count; i++)
    {
        matches = g_scan_context_get_full_matches(ctx, expr->patterns[i], &count);

        if (index < count)
            break;
        else
            index -= count;

    }

    if (i == expr->count) goto done;

    result = G_IS_SCAN_BYTES_MATCH(matches[index]);
    if (!result) goto done;

    match = G_SCAN_BYTES_MATCH(matches[index]);

    /* Traitement adapté de la requête */

    len = g_scan_bytes_match_get_location(match, &start, &end);

    switch (expr->type)
    {
        case SHT_RAW:
            content = g_scan_bytes_match_get_content(match);

            init_vmpa(&pos, start, VMPA_NO_VIRTUAL);

            data = g_binary_content_get_raw_access(content, &pos, len);

            binary.static_bin_data = data;
            binary.len = len;

            *out = g_scan_literal_expression_new(LVT_STRING, &binary);

            g_object_unref(G_OBJECT(content));
            break;

        case SHT_COUNTER:
            assert(false);
            result = false;
            break;

        case SHT_START:
            *out = g_scan_literal_expression_new(LVT_UNSIGNED_INTEGER, (unsigned long long []){ start });
            break;

        case SHT_LENGTH:
            *out = g_scan_literal_expression_new(LVT_UNSIGNED_INTEGER, (unsigned long long []){ len });
            break;

        case SHT_END:
            *out = g_scan_literal_expression_new(LVT_UNSIGNED_INTEGER, (unsigned long long []){ end });
            break;

    }

 done:

    return result;

}