summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/analysis/storage/tpmem.c
blob: 8df20b24cf6a5b086bc2a41be3346f514b7ee4c5 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * tpmem.c - équivalent Python du fichier "analysis/storage/tpmem.c"
 *
 * Copyright (C) 2020 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 "tpmem.h"


#include <pygobject.h>


#include <analysis/storage/tpmem.h>
#include <plugins/dt.h>


#include "../../access.h"
#include "../../helpers.h"
#include "../../common/packed.h"



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


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

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



/* -------------------------- TAMPON POUR CODE DESASSEMBLE -------------------------- */


/* Apprend tous les types mémorisés dans un flux. */
static PyObject *py_type_memory_read_types(PyObject *, PyObject *);

/* Crée une nouvelle instance d'objet à partir de son type. */
static PyObject *py_type_memory_create_object(PyObject *, PyObject *);

/* Sauvegarde le type d'un objet instancié. */
static PyObject *py_type_memory_store_object_gtype(PyObject *, PyObject *);

/* Enregistre tous les types mémorisés dans un flux. */
static PyObject *py_type_memory_write_types(PyObject *, PyObject *);



/* ---------------------------------------------------------------------------------- */
/*                          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_type_memory_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_type_memory_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_TYPE_MEMORY, 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_type_memory_init(PyObject *self, PyObject *args, PyObject *kwds)
{
    int ret;                                /* Bilan de lecture des args.  */

#define TYPE_MEMORY_DOC                                             \
    "The TypeMemory remembers all the types of objects involved in" \
    " a serialization process.\n"                                   \
    "\n"                                                            \
    "Instances can be created using the following constructor:\n"   \
    "\n"                                                            \
    "    TypeMemory()"                                              \

    /* Initialisation d'un objet GLib */

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

    return 0;

}



/* ---------------------------------------------------------------------------------- */
/*                            TAMPON POUR CODE DESASSEMBLE                            */
/* ---------------------------------------------------------------------------------- */


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant une mémorisation de types.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Apprend tous les types mémorisés dans un flux.               *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_type_memory_read_types(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    int fd;                                 /* Flux ouvert en lecture      */
    int ret;                                /* Bilan de lecture des args.  */
    GTypeMemory *tpmem;                     /* Mémorisation native         */
    bool status;                            /* Bilan de l'opération        */

#define TYPE_MEMORY_READ_TYPES_METHOD PYTHON_METHOD_DEF         \
(                                                               \
    read_types, "$self, fd",                                    \
    METH_VARARGS, py_type_memory,                               \
    "Read types from a stream.\n"                               \
    "\n"                                                        \
    "This operation is usually handled internally by the"       \
    " Chrysalide's core.\n"                                     \
    "\n"                                                        \
    "The *fd* parameter is an integer representing a valid"     \
    " identifier for a file descriptor opened for reading."     \
    "\n"                                                        \
    "The result is a boolean value indicating the status of"    \
    " the operation: True for success, False for failure."      \
)

    ret = PyArg_ParseTuple(args, "i", &fd);
    if (!ret) return NULL;

    tpmem = G_TYPE_MEMORY(pygobject_get(self));

    status = g_type_memory_read_types(tpmem, fd);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant une mémorisation de types.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Crée une nouvelle instance d'objet à partir de son type.     *
*                                                                             *
*  Retour      : Instance issue de l'opération ou NULL.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_type_memory_create_object(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Instance à retourner        */
    packed_buffer_t *pbuf;                  /* Tampon à consulter          */
    int ret;                                /* Bilan de lecture des args.  */
    GTypeMemory *tpmem;                     /* Mémorisation native         */
    GObject *obj;                           /* Instance retournée          */

#define TYPE_MEMORY_CREATE_OBJECT_METHOD PYTHON_METHOD_DEF          \
(                                                                   \
    create_object, "$self, pbuf",                                   \
    METH_VARARGS, py_type_memory,                                   \
    "Create a new GLib object from serialized data.\n"              \
    "\n"                                                            \
    "The *pbuf* parameter is a pychrysalide.common.PackedBuffer"    \
    " instance providing buffered data to read."                    \
    "\n"                                                            \
    "The result is a Python object linked to a native GLib"         \
    " object instance."                                             \
)

    ret = PyArg_ParseTuple(args, "O&", convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    tpmem = G_TYPE_MEMORY(pygobject_get(self));

    obj = g_type_memory_create_object(tpmem, pbuf);

    result = pygobject_new(obj);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant une mémorisation de types.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Sauvegarde le type d'un objet instancié.                     *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_type_memory_store_object_gtype(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    GObject *obj;                           /* Instance à traiter          */
    packed_buffer_t *pbuf;                  /* Tampon à consulter          */
    int ret;                                /* Bilan de lecture des args.  */
    GTypeMemory *tpmem;                     /* Mémorisation native         */
    bool status;                            /* Bilan de l'opération        */

#define TYPE_MEMORY_STORE_OBJECT_GTYPE_METHOD PYTHON_METHOD_DEF     \
(                                                                   \
    store_object_gtype, "$self, obj, pbuf",                         \
    METH_VARARGS, py_type_memory,                                   \
    "Create a new GLib object from serialized data.\n"              \
    "\n"                                                            \
    "The *obj* parameter is the Python version of the GObject"      \
    " whose type is to process and the *pbuf* parameter is a"       \
    " pychrysalide.common.PackedBuffer instance providing buffered" \
    " data to extend."                                              \
    "\n"                                                            \
    "The result is a boolean value indicating the status of the"    \
    " operation: True for success, False for failure."              \
)

    ret = PyArg_ParseTuple(args, "O!O&", PyGObject_Type, &obj, convert_to_packed_buffer, &pbuf);
    if (!ret) return NULL;

    tpmem = G_TYPE_MEMORY(pygobject_get(self));

    status = g_type_memory_store_object_gtype(tpmem, obj, pbuf);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = classe représentant une mémorisation de types.        *
*                args = arguments fournis à l'appel.                          *
*                                                                             *
*  Description : Enregistre tous les types mémorisés dans un flux.            *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_type_memory_write_types(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    int fd;                                 /* Flux ouvert en lecture      */
    int ret;                                /* Bilan de lecture des args.  */
    GTypeMemory *tpmem;                     /* Mémorisation native         */
    bool status;                            /* Bilan de l'opération        */

#define TYPE_MEMORY_WRITE_TYPES_METHOD PYTHON_METHOD_DEF        \
(                                                               \
    write_types, "$self, fd",                                   \
    METH_VARARGS, py_type_memory,                               \
    "Write types into a stream.\n"                              \
    "\n"                                                        \
    "This operation is usually handled internally by the"       \
    " Chrysalide's core.\n"                                     \
    "\n"                                                        \
    "The *fd* parameter is an integer representing a valid"     \
    " identifier for a file descriptor opened for writing."     \
    "\n"                                                        \
    "The result is a boolean value indicating the status of"    \
    " the operation: True for success, False for failure."      \
)

    ret = PyArg_ParseTuple(args, "i", &fd);
    if (!ret) return NULL;

    tpmem = G_TYPE_MEMORY(pygobject_get(self));

    status = g_type_memory_write_types(tpmem, fd);

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

    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_type_memory_type(void)
{
    static PyMethodDef py_type_memory_methods[] = {
        TYPE_MEMORY_READ_TYPES_METHOD,
        TYPE_MEMORY_CREATE_OBJECT_METHOD,
        TYPE_MEMORY_STORE_OBJECT_GTYPE_METHOD,
        TYPE_MEMORY_WRITE_TYPES_METHOD,
        { NULL }
    };

    static PyGetSetDef py_type_memory_getseters[] = {
        { NULL }
    };

    static PyTypeObject py_type_memory_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.analysis.storage.TypeMemory",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = TYPE_MEMORY_DOC,

        .tp_methods     = py_type_memory_methods,
        .tp_getset      = py_type_memory_getseters,

        .tp_init        = py_type_memory_init,
        .tp_new         = py_type_memory_new

    };

    return &py_type_memory_type;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : module = module dont la définition est à compléter.          *
*                                                                             *
*  Description : Prend en charge l'objet 'pychrysalide.analysis...TypeMemory'.*
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    type = get_python_type_memory_type();

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

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_TYPE_MEMORY, type, &PyGObject_Type))
            return false;

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : arg = argument quelconque à tenter de convertir.             *
*                dst = destination des valeurs récupérées en cas de succès.   *
*                                                                             *
*  Description : Tente de convertir en mémorisation de types.                 *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

int convert_to_type_memory(PyObject *arg, void *dst)
{
    int result;                             /* Bilan à retourner           */

    result = PyObject_IsInstance(arg, (PyObject *)get_python_type_memory_type());

    switch (result)
    {
        case -1:
            /* L'exception est déjà fixée par Python */
            result = 0;
            break;

        case 0:
            PyErr_SetString(PyExc_TypeError, "unable to convert the provided argument to buffer cache");
            break;

        case 1:
            *((GTypeMemory **)dst) = G_TYPE_MEMORY(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}