summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/format/strsym.c
blob: 9c86df4a2b11008ed4eec47637959a781c1b3fa0 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * strsym.c - équivalent Python du fichier "format/strsym.h"
 *
 * Copyright (C) 2018-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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "strsym.h"


#include <malloc.h>
#include <pygobject.h>


#include <i18n.h>


#include <format/strsym.h>
#include <plugins/dt.h>


#include "constants.h"
#include "known.h"
#include "symbol.h"
#include "../access.h"
#include "../helpers.h"
#include "../arch/feeder.h"
#include "../arch/vmpa.h"



/* ------------------------ GLUE POUR CREATION DEPUIS PYTHON ------------------------ */


/* Accompagne la création d'une instance dérivée en Python. */
static PyObject *py_string_symbol_new(PyTypeObject *, PyObject *, PyObject *);

/* Initialise une instance sur la base du dérivé de GObject. */
static int py_string_symbol_init(PyObject *, PyObject *, PyObject *);



/* ----------------------- VITRINE POUR CHAINES DE CARACTERES ----------------------- */


/* Indique si une chaîne de caractères est liée au format. */
static PyObject *py_string_symbol_get_structural(PyObject *, void *);

/* Définit si une chaîne de caractères est liée au format. */
static int py_string_symbol_set_structural(PyObject *, PyObject *, void *);

/* Fournit l'encodage d'une chaîne de caractères. */
static PyObject *py_string_symbol_get_encoding(PyObject *, void *);

/* Fournit la chaîne brute de caractères du symbole. */
static PyObject *py_string_symbol_get_raw(PyObject *, void *);

/* Fournit la chaîne de caractères du symbole. */
static PyObject *py_string_symbol_get_utf8(PyObject *, void *);



/* ---------------------------------------------------------------------------------- */
/*                          GLUE POUR CREATION DEPUIS PYTHON                          */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : type = type du nouvel objet à mettre en place.               *
*                args = éventuelle liste d'arguments.                         *
*                kwds = éventuel dictionnaire de valeurs mises à disposition. *
*                                                                             *
*  Description : Accompagne la création d'une instance dérivée en Python.     *
*                                                                             *
*  Retour      : Nouvel objet Python mis en place ou NULL en cas d'échec.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_string_symbol_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Objet à retourner           */
    PyTypeObject *base;                     /* Type de base à dériver      */
    bool first_time;                        /* Evite les multiples passages*/
    GType gtype;                            /* Nouveau type de processeur  */
    bool status;                            /* Bilan d'un enregistrement   */

    /* Validations diverses */

    base = get_python_string_symbol_type();

    if (type == base)
        goto simple_way;

    /* Mise en place d'un type dédié */

    first_time = (g_type_from_name(type->tp_name) == 0);

    gtype = build_dynamic_type(G_TYPE_STR_SYMBOL, type->tp_name, NULL, NULL, NULL);

    if (first_time)
    {
        status = register_class_for_dynamic_pygobject(gtype, type, base);

        if (!status)
        {
            result = NULL;
            goto exit;
        }

    }

    /* On crée, et on laisse ensuite la main à PyGObject_Type.tp_init() */

 simple_way:

    result = PyType_GenericNew(type, args, kwds);

 exit:

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet à initialiser (théoriquement).                  *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Initialise une instance sur la base du dérivé de GObject.    *
*                                                                             *
*  Retour      : 0.                                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_string_symbol_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    StringEncodingType encoding;            /* Encodage spécifié           */
    GKnownFormat *format;                   /* Format au contenu à relire  */
    mrange_t range;                         /* Version native d'un espace  */
    const char *string;                     /* Chaîne de caractères soumise*/
    vmpa2t *addr;                           /* Emplacement de chaîne       */
    int ret;                                /* Bilan de lecture des args.  */
    GStrSymbol *symbol;                     /* Version GLib du symbole     */

    static char *kwlist[] = { "encoding", "format", "range", "string", "addr", NULL };

#define STRING_SYMBOL_DOC                                                       \
    "StrSymbol is a special symbol object dedicated to strings.\n"              \
    "\n"                                                                        \
    "Instances can be created using one of the following constructors:\n"       \
    "\n"                                                                        \
    "    StrSymbol(encoding, format=pychrysalide.format.KnownFormat,"          \
    " range=pychrysalide.arch.mrange)"                                          \
    "\n"                                                                        \
    "    StrSymbol(encoding, string=string, addr=pychrysalide.arch.vmpa)"       \
    "\n"                                                                        \
    "The first constructor is aimed to be used for read-only strings available" \
    " from the raw data of the analyzed binary. The format provides the raw"    \
    " content, and the memory range specifies the location of the string.\n"    \
    "\n"                                                                        \
    "The second constructor is useful for strings which can not be extracted"   \
    " directly from the original content, such as obfuscted strings. A dynamic" \
    " string is then provided here, and the start point of this string has to"  \
    " be provided.\n"                                                           \
    "\n"                                                                        \
    "In both cases, the encoding remains the first argument, as a"              \
    " pychrysalide.format.StrSymbol.StringEncodingType value."

    /* Récupération des paramètres */

    format = NULL;
    string = NULL;
    addr = NULL;

    ret = PyArg_ParseTupleAndKeywords(args, kwds, "O&|O&O&sO&", kwlist,
                                      convert_to_string_encoding_type, &encoding,
                                      convert_to_known_format, &format,
                                      convert_any_to_mrange, &range,
                                      &string, convert_any_to_vmpa, &addr);
    if (!ret) return -1;

    /* Initialisation d'un objet GLib */

    ret = forward_pygobjet_init(self);
    if (ret == -1) return -1;

    /* Eléments de base */

    symbol = G_STR_SYMBOL(pygobject_get(self));

    if (format != NULL)
        g_string_symbol_init_read_only(symbol, encoding, format, &range);

    else if (string != NULL && addr != NULL)
    {
        g_string_symbol_init_dynamic(symbol, encoding, string, addr);
        clean_vmpa_arg(addr);
    }

    else
    {
        PyErr_SetString(PyExc_ValueError, _("Invalid argument combination."));

        if (addr != NULL)
            clean_vmpa_arg(addr);

        return -1;

    }

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                         VITRINE POUR CHAINES DE CARACTERES                         */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Indique si une chaîne de caractères est liée au format.      *
*                                                                             *
*  Retour      : Indication sur l'emploi de la chaîne.                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_string_symbol_get_structural(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GStrSymbol *symbol;                     /* Elément à consulter         */
    bool status;                            /* Etat à transmettre          */

#define STRING_SYMBOL_STRUCTURAL_ATTRIB PYTHON_GETSET_DEF_FULL                  \
(                                                                               \
    structural, py_string_symbol,                                               \
    "True if the string symbol is linked to the file structure, else False."    \
)

    symbol = G_STR_SYMBOL(pygobject_get(self));

    status = g_string_symbol_is_structural(symbol);

    result = status ? Py_True : Py_False;
    Py_INCREF(result);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                value   = valeur fournie à intégrer ou prendre en compte.    *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Définit si une chaîne de caractères est liée au format.      *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_string_symbol_set_structural(PyObject *self, PyObject *value, void *closure)
{
    int ret;                                /* Bilan d'analyse             */
    GStrSymbol *symbol;                     /* Elément à consulter         */

    ret = PyBool_Check(value);
    if (!ret) return -1;

    symbol = G_STR_SYMBOL(pygobject_get(self));

    g_string_symbol_set_structural(symbol, value == Py_True);

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit l'encodage d'une chaîne de caractères.               *
*                                                                             *
*  Retour      : Type d'encodage utilisé.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_string_symbol_get_encoding(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GStrSymbol *symbol;                     /* Elément à consulter         */
    StringEncodingType encoding;            /* Encodage associé à la chaîne*/

#define STRING_SYMBOL_ENCODING_ATTRIB PYTHON_GET_DEF_FULL       \
(                                                               \
    encoding, py_string_symbol,                                 \
    "Encoding of the string, provided as a"                     \
    " pychrysalide.format.StrSymbol.StringEncodingType value."  \
)

    symbol = G_STR_SYMBOL(pygobject_get(self));
    encoding = g_string_symbol_get_encoding(symbol);

    result = cast_with_constants_group_from_type(get_python_string_symbol_type(), "StringEncodingType", encoding);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la chaîne brute de caractères du symbole.            *
*                                                                             *
*  Retour      : Chaîne de caractères d'origine.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_string_symbol_get_raw(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GStrSymbol *symbol;                     /* Elément à consulter         */
    size_t len;                             /* Taille de la chaîne         */
    const char *data;                       /* Données à manipuler         */

#define STRING_SYMBOL_RAW_ATTRIB PYTHON_GET_DEF_FULL    \
(                                                       \
    raw, py_string_symbol,                              \
    "Raw data of the string, provided as bytes."        \
)

    symbol = G_STR_SYMBOL(pygobject_get(self));
    data = g_string_symbol_get_raw(symbol, &len);

    result = PyBytes_FromStringAndSize(data, len);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la chaîne de caractères du symbole.                  *
*                                                                             *
*  Retour      : Chaîne de caractères, à priori en UTF-8.                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_string_symbol_get_utf8(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GStrSymbol *symbol;                     /* Elément à consulter         */
    size_t len;                             /* Taille de la chaîne         */
    const char *data;                       /* Données à manipuler         */

#define STRING_SYMBOL_UTF8_ATTRIB PYTHON_GET_DEF_FULL   \
(                                                       \
    utf8, py_string_symbol,                             \
    "String content as UTF-8 data."                     \
)

    symbol = G_STR_SYMBOL(pygobject_get(self));
    data = g_string_symbol_get_utf8(symbol, &len);

    result = PyUnicode_FromStringAndSize(data, len);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Fournit un accès à une définition de type à diffuser.        *
*                                                                             *
*  Retour      : Définition d'objet pour Python.                              *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PyTypeObject *get_python_string_symbol_type(void)
{
    static PyMethodDef py_string_symbol_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_string_symbol_getseters[] = {
        STRING_SYMBOL_STRUCTURAL_ATTRIB,
        STRING_SYMBOL_ENCODING_ATTRIB,
        STRING_SYMBOL_RAW_ATTRIB,
        STRING_SYMBOL_UTF8_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_string_symbol_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.format.StrSymbol",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = STRING_SYMBOL_DOC,

        .tp_methods     = py_string_symbol_methods,
        .tp_getset      = py_string_symbol_getseters,

        .tp_init        = py_string_symbol_init,
        .tp_new         = py_string_symbol_new

    };

    return &py_string_symbol_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.format.StrSymbol'.     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool ensure_python_string_symbol_is_registered(void)
{
    PyTypeObject *type;                     /* Type Python 'StrSymbol'     */
    PyObject *module;                       /* Module à recompléter        */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_string_symbol_type();

    if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
    {
        module = get_access_to_python_module("pychrysalide.format");

        dict = PyModule_GetDict(module);

        if (!ensure_python_proxy_feeder_is_registered())
            return false;

        if (!ensure_python_binary_symbol_is_registered())
            return false;

        if (!register_class_for_pygobject(dict, G_TYPE_STR_SYMBOL, type, get_python_binary_symbol_type()))
            return false;

        if (!define_string_symbol_constants(type))
            return false;

    }

    return true;

}