summaryrefslogtreecommitdiff
path: root/src/rost.c
blob: 1d4929f63b62dc0fb057cac2f32d3e946f0c86e3 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * rost.c - fichier d'entrée du centre de collecte
 *
 * 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include <assert.h>
#include <getopt.h>
#include <libgen.h>
#include <locale.h>
#include <malloc.h>
#include <stdlib.h>
#include <string.h>


#include <i18n.h>



#include "gleak.h"
#include "analysis/contents/file.h"
#include "analysis/scan/options.h"
#include "analysis/scan/scanner.h"
#include "analysis/scan/patterns/backends/bitap.h"
#include "analysis/scan/patterns/backends/acism.h"
#include "core/core.h"
#include "core/global.h"
#include "core/logs.h"
#include "core/paths.h"



/* Affiche des indications quant à l'utilisation du programme. */
static void show_rost_help(const char *);

/* Affiche des indications sur la version courante du programme. */
static void show_rost_version(void);

/* Récupère un contenu à traiter depuis l'entrée standard. */
static void *get_input_data_from_stdin(void);



/******************************************************************************
*                                                                             *
*  Paramètres  : name = nom du programme en question.                         *
*                                                                             *
*  Description : Affiche des indications quant à l'utilisation du programme.  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void show_rost_help(const char *name)
{
    char *tmp;                              /* Conservation modifiable     */
    char *base;                             /* Version courte du nom       */

    tmp = strdup(name);

    base = basename(tmp);

    printf("\n");

    printf("Usage: %s [--help] [--version] [--verbosity] [options] <rules file> <file | dir>\n", base);

    printf("\n");

    printf("\t-h --help\t\tShow this help message.\n");
    printf("\t-v --version\t\tDisplay the program version.\n");

    printf("\n");

    printf("\t-A --algorithm=NAME\tSelect one of the available algorithms for data: bitmap, acism (default: acsim).\n");
    printf("\t-C --check-only\t\tValidate the rule syntax without performing a scan (discard the file/dir argument).\n");
    printf("\t-j --print-json\t\tPrint matching strings in JSON format instead of simple text.\n");
    printf("\t-s --print-strings\tPrint matching strings (default text format only).\n");
    printf("\t-S --print-stats\tPrint rules' statistics.\n");
    printf("\t-g --print-tags\t\tPrint tags linked to rules on match (default text format only).\n");
    printf("\t-t --tag=TAG\t\tPrint only matching rules tagged as TAG (default text format only).\n");
    printf("\t-V --verbosity=level\tSet the log level (0 for all messages, %u for none).\n", LMT_COUNT);

    printf("\n");

    free(tmp);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Affiche des indications sur la version courante du programme.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void show_rost_version(void)
{
    char *edir;                             /* Répertoire de base effectif */

    printf("\n");

    printf("-o-  Chrysalide ROST r%u  -o-\n", REVISION);
    printf(_("Last compiled on %s at %s\n"), __DATE__, __TIME__);

    printf("\n");

    edir = get_effective_directory(PLUGINS_LIB_DIR);
    printf(_("Plugins library directory: %s\n"), edir);
    free(edir);

    edir = get_effective_directory(PLUGINS_DATA_DIR);
    printf(_("Plugins data directory: %s\n"), edir);
    free(edir);

    edir = get_effective_directory(LOCALE_DIR);
    printf(_("Locale directory: %s\n"), edir);
    free(edir);

    printf("\n");

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Récupère un contenu à traiter depuis l'entrée standard.      *
*                                                                             *
*  Retour      : Adresse valide ou NULL en cas d'échec.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void *get_input_data_from_stdin(void)
{
    char *result;                           /* Espace mémoire à retourner  */
    size_t length;                          /* Taille de ce contenu        */
    ssize_t got;                            /* Quantité d'octets lus       */

    result = NULL;

    length = 0;

#define ALLOC_SIZE 2048

    while (true)
    {
        result = realloc(result, (length + ALLOC_SIZE) * sizeof(char));

        got = read(STDIN_FILENO, result + length, ALLOC_SIZE);

        if (got == -1)
        {
            LOG_ERROR_N("read");
            goto exit_with_error;
        }

        length += got;

        if (got < ALLOC_SIZE)
            break;

    }

    return result;

 exit_with_error:

    free(result);

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : argc = nombre d'arguments dans la ligne de commande.         *
*                argv = arguments de la ligne de commande.                    *
*                                                                             *
*  Description : Point d'entrée du programme.                                 *
*                                                                             *
*  Retour      : EXIT_SUCCESS si le prgm s'est déroulé sans encombres.        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int main(int argc, char **argv)
{
    int result;                             /* Bilan de l'exécution        */
    bool show_help;                         /* Affichage de l'aide ?       */
    bool show_version;                      /* Affichage de la version ?   */
    bool check_only;                        /* Validation uniquement       */
    LogMessageType verbosity;               /* Niveau de filtre de message */
    GScanOptions *options;                  /* Options d'analyses          */
    int index;                              /* Indice d'argument           */
    int ret;                                /* Bilan d'un appel            */
    char *edir;                             /* Répertoire de base effectif */
    char *rules;                            /* Définition de règles        */
    char *target;                           /* Cible communiquée           */
    void *rule_content;                     /* Contenu à traduire          */
    GContentScanner *scanner;               /* Encadrement d'une recherche */
    GBinContent *content;                   /* Contenu à analyser          */
    GScanContext *context;                  /* Contexte des trouvailles    */
    sized_string_t padding;                 /* Bourrage pour le JSON       */
    bool full;                              /* Détailler l'affichage ?     */

    static struct option long_options[] = {
        { "help",           no_argument,        NULL,   'h' },
        { "version",        no_argument,        NULL,   'v' },
        { "algorithm",      required_argument,  NULL,   'A' },
        { "check-only",     no_argument,        NULL,   'C' },
        { "print-json",     no_argument,        NULL,   'j' },
        { "print-strings",  no_argument,        NULL,   's' },
        { "print-stats",    no_argument,        NULL,   'S' },
        { "print-tags",     no_argument,        NULL,   'g' },
        { "tag",            required_argument,  NULL,   't' },
        { "verbosity",      required_argument,  NULL,   'V' },
        { NULL,             0,                  NULL,   0 }
    };

    result = EXIT_FAILURE;

    /* Décodage des options */

    show_help = false;
    show_version = false;

    check_only = false;
    verbosity = LMT_INFO;

    options = g_scan_options_new();

    g_scan_options_set_backend_for_data(options, G_TYPE_ACISM_BACKEND);

    while (true)
    {
        ret = getopt_long(argc, argv, "hvA:CjsSgt:V:", long_options, &index);
        if (ret == -1) break;

        switch (ret)
        {
            case 'h':
                show_help = true;
                break;

            case 'v':
                show_version = true;
                break;

            case 'A':
                if (strcmp(optarg, "bitmap") == 0)
                    g_scan_options_set_backend_for_data(options, G_TYPE_BITAP_BACKEND);
                else if (strcmp(optarg, "acism") == 0)
                    g_scan_options_set_backend_for_data(options, G_TYPE_ACISM_BACKEND);
                else
                    g_scan_options_set_backend_for_data(options, G_TYPE_INVALID);
                break;

            case 'C':
                check_only = true;
                g_scan_options_set_check_only(options, true);
                break;

            case 'j':
                g_scan_options_set_print_json(options, true);
                break;

            case 's':
                g_scan_options_set_print_strings(options, true);
                break;

            case 'S':
                g_scan_options_set_print_stats(options, true);
                break;

            case 'g':
                g_scan_options_set_print_tags(options, true);
                break;

            case 't':
                g_scan_options_select_tag(options, optarg);
                break;

            case 'V':
                verbosity = strtoul(optarg, NULL, 10);
                break;

        }

    }

    if ((check_only && (optind + 0) != argc && (optind + 1) != argc)
        || (!check_only && (optind + 1) != argc && (optind + 2) != argc))
    {
        show_rost_help(argv[0]);
        goto done;
    }

    /* Actions de base */

    if (show_help)
    {
        show_rost_help(argv[0]);
        result = EXIT_SUCCESS;
        goto done;
    }

    if (show_version)
    {
        show_rost_version();
        result = EXIT_SUCCESS;
        goto done;
    }

    if (g_scan_options_get_backend_for_data(options) == G_TYPE_INVALID)
    {
        show_rost_help(argv[0]);
        goto done;
    }

    /* Lancement des choses sérieuses */

    setlocale(LC_ALL, "");
    edir = get_effective_directory(LOCALE_DIR);
    bindtextdomain(PACKAGE, edir);
    free(edir);
    textdomain(PACKAGE);

    /* Initialisation de GTK */
    g_set_prgname("ROST");
    //gtk_init(&argc, &argv);

    /* Initialisation du programme */

    set_batch_mode();

    set_log_verbosity(verbosity);

    if (!load_all_core_components(true))
        goto done;

    /* Traitement des recherches */

    if ((optind + 0) == argc)
    {
        assert(check_only);

        rules = NULL;
        target = NULL;

    }
    else if ((optind + 1) == argc)
    {
        if (check_only)
        {
            rules = argv[optind];
            target = NULL;
        }
        else
        {
            rules = NULL;
            target = argv[optind];
        }
    }
    else
    {
        rules = argv[optind];
        target = argv[optind + 1];

        if (strcmp(rules, "-") == 0 || strcmp(rules, "/dev/stdin") == 0)
            rules = NULL;

    }

    if (rules == NULL)
    {
        rule_content = get_input_data_from_stdin();

        if (rule_content != NULL)
        {
            scanner = g_content_scanner_new_from_text(rule_content);
            free(rule_content);
        }
        else
            scanner = NULL;

    }
    else
        scanner = g_content_scanner_new_from_file(rules);

    if (scanner != NULL)
        result = EXIT_SUCCESS;

    if (scanner != NULL && !check_only)
    {
        content = g_file_content_new(target);
        if (content == NULL) goto bad_file_content;

        context = g_content_scanner_analyze(scanner, options, content);

        if (g_scan_options_get_print_json(options))
        {
            padding.data = "   ";
            padding.len = 3;

            g_content_scanner_output_to_json(scanner, context, &padding, 0, STDOUT_FILENO);

        }
        else
        {
            full = g_scan_options_get_print_strings(options);

            g_content_scanner_output_to_text(scanner, context, full, STDOUT_FILENO);

        }

        g_object_unref(G_OBJECT(context));
        g_object_unref(G_OBJECT(content));

 bad_file_content:

        g_object_unref(G_OBJECT(scanner));

    }

    g_object_unref(G_OBJECT(options));

    /* Sortie */

    unload_all_core_components(false);

#ifdef TRACK_GOBJECT_LEAKS
    remember_gtypes_for_leaks();
#endif

#ifdef TRACK_GOBJECT_LEAKS
    dump_remaining_gtypes();
#endif

 done:

    return result;

}