summaryrefslogtreecommitdiff
path: root/src/analysis/scan/options.c
blob: ecff9f1613b9c21022a62deaf791af75b1bfdf7f (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * options.c - rassemblement des options d'analyse communiquées par le donneur d'ordre
 *
 * 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 "options.h"


#include <malloc.h>
#include <string.h>


#include "options-int.h"



/* Initialise la classe des ensembles d'options d'analyses. */
static void g_scan_options_class_init(GScanOptionsClass *);

/* Initialise une instance de groupe d'options d'analyse. */
static void g_scan_options_init(GScanOptions *);

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

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



/* Indique le type défini pour un ensemble d'options d'analyses. */
G_DEFINE_TYPE(GScanOptions, g_scan_options, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des ensembles d'options d'analyses.     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_options_class_init(GScanOptionsClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_scan_options_dispose;
    object->finalize = (GObjectFinalizeFunc)g_scan_options_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = instance à initialiser.                            *
*                                                                             *
*  Description : Initialise une instance de groupe d'options d'analyse.       *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_options_init(GScanOptions *options)
{
    options->data_backend = G_TYPE_INVALID;

    options->check_only = false;

    options->print_json = false;
    options->print_strings = false;
    options->print_stats = false;

    options->selected_tags = NULL;
    options->selected_count = 0;

}


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

static void g_scan_options_dispose(GScanOptions *options)
{
    G_OBJECT_CLASS(g_scan_options_parent_class)->dispose(G_OBJECT(options));

}


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

static void g_scan_options_finalize(GScanOptions *options)
{
    size_t i;                               /* Boucle de parcours          */

    for (i = 0; i < options->selected_count; i++)
        free(options->selected_tags[i]);

    if (options->selected_tags != NULL)
        free(options->selected_tags);

    G_OBJECT_CLASS(g_scan_options_parent_class)->finalize(G_OBJECT(options));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Crée un réceptacle pour diverses options d'analyse.          *
*                                                                             *
*  Retour      : Point de collecte mise en place.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanOptions *g_scan_options_new(void)
{
    GScanOptions *result;                   /* Instance à retourner        */

    result = g_object_new(G_TYPE_SCAN_OPTIONS, NULL);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Indique le type d'un moteur d'analyse de données sélectionné.*
*                                                                             *
*  Retour      : Type d'objet, idéalement valide.                             *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GType g_scan_options_get_backend_for_data(const GScanOptions *options)
{
    GType result;                           /* Type à retourner            */

    result = options->data_backend;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                backend = type du moteur sélectionné.                        *
*                                                                             *
*  Description : Sélectionne un type de moteur d'analyse pour données brutes. *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_backend_for_data(GScanOptions *options, GType backend)
{
    options->data_backend = backend;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Indique un besoin limité à une validation syntaxique.        *
*                                                                             *
*  Retour      : Etat de l'option visée à conservé.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_get_check_only(const GScanOptions *options)
{
    bool result;                            /* Statut à retourner          */

    result = options->check_only;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                state   = état de l'option visée à conserver.                *
*                                                                             *
*  Description : Mémorise un besoin de validation syntaxique uniquement.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_check_only(GScanOptions *options, bool state)
{
    options->check_only = state;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Impose le format JSON comme type de sortie.                  *
*                                                                             *
*  Retour      : Etat de l'option visée à conservé.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_get_print_json(const GScanOptions *options)
{
    bool result;                            /* Statut à retourner          */

    result = options->print_json;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                state   = état de l'option visée à conserver.                *
*                                                                             *
*  Description : Mémorise le format JSON comme type de sortie.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_print_json(GScanOptions *options, bool state)
{
    options->print_json = state;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Indique un besoin d'affichage des correspondances finales.   *
*                                                                             *
*  Retour      : Etat de l'option visée à conservé.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_get_print_strings(const GScanOptions *options)
{
    bool result;                            /* Statut à retourner          */

    result = options->print_strings;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                state   = état de l'option visée à conserver.                *
*                                                                             *
*  Description : Mémorise un besoin d'affichage des correspondances finales.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_print_strings(GScanOptions *options, bool state)
{
    options->print_strings = state;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Indique un besoin de statistiques en fin de compilation.     *
*                                                                             *
*  Retour      : Etat de l'option visée à conservé.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_get_print_stats(const GScanOptions *options)
{
    bool result;                            /* Statut à retourner          */

    result = options->print_stats;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                state   = état de l'option visée à conserver.                *
*                                                                             *
*  Description : Mémorise un besoin de statistiques en fin de compilation.    *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_print_stats(GScanOptions *options, bool state)
{
    options->print_stats = state;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à consulter.         *
*                                                                             *
*  Description : Indique un besoin d'affichage des étiquettes avec résultats. *
*                                                                             *
*  Retour      : Etat de l'option visée à conservé.                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_get_print_tags(const GScanOptions *options)
{
    bool result;                            /* Statut à retourner          */

    result = options->print_tags;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à modifier.          *
*                state   = état de l'option visée à conserver.                *
*                                                                             *
*  Description : Mémorise un besoin d'affichage des étiquettes avec résultats.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_set_print_tags(GScanOptions *options, bool state)
{
    options->print_tags = state;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à compléter.         *
*                tag     = étiquette de règle à sélectionner.                 *
*                                                                             *
*  Description : Inscrit une étiquette comme sélection de règles à afficher.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_options_select_tag(GScanOptions *options, const char *tag)
{
    options->selected_tags = realloc(options->selected_tags, ++options->selected_count * sizeof(char *));

    options->selected_tags[options->selected_count - 1] = strdup(tag);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à compléter.         *
*                tag     = étiquette de règle à auditionner.                  *
*                                                                             *
*  Description : Détermine si une étiquette donnée conduit à un affichage.    *
*                                                                             *
*  Retour      : true si une règle portant l'étiquette doit être affichée.    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_options_has_tag_as_selected(const GScanOptions *options, const char *tag)
{
    bool result;                            /* Bilan à retourner           */
    size_t i;                               /* Boucle de parcours          */

    if (tag == NULL)
        result = (options->selected_count == 0);

    else
    {
        result = false;

        for (i = 0; i < options->selected_count; i++)
            if (strcmp(options->selected_tags[i], tag) == 0)
            {
                result = true;
                break;
            }

    }

    return result;

}