summaryrefslogtreecommitdiff
path: root/plugins/kaitai/python/record.c
blob: 4194a9ad3e27c257d50075471d0f294ef390edf5 (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

/* Chrysalide - Outil d'analyse de fichiers binaires
 * record.h - équivalent Python du fichier "plugins/kaitai/record.h"
 *
 * Copyright (C) 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 "record.h"


#include <pygobject.h>


#include <plugins/pychrysalide/access.h>
#include <plugins/pychrysalide/helpers.h>
#include <plugins/pychrysalide/arch/vmpa.h>


#include "parser.h"
#include "../record.h"



CREATE_DYN_ABSTRACT_CONSTRUCTOR(match_record, G_TYPE_MATCH_RECORD, NULL);

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

/* Modifie la référence au créateur de la correspondance. */
static int py_match_record_set_creator(PyObject *, PyObject *, void *);

/* Renvoie vers le lecteur à l'origine de la correspondance. */
static PyObject *py_match_record_get_creator(PyObject *, void *);

/* Fournit le contenu lié à une correspondance établie. */
static PyObject *py_match_record_get_content(PyObject *, void *);

/* Calcule ou fournit la zone couverte par une correspondance. */
static PyObject *py_match_record_get_range(PyObject *, void *);

/* Lit les octets bruts couverts par une correspondance. */
static PyObject *py_match_record_get_raw_bytes(PyObject *, void *);



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

#define MATCH_RECORD_DOC                                                    \
    "MatchRecord is an abstract class providing mainly location and raw"    \
    " data of an area which has matched a part of a binary content."

    /* Initialisation d'un objet GLib */

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

    return 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = correspondance à manipuler.                        *
*                value   = lecteur à l'origine de la correspondance.          *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Modifie la référence au créateur de la correspondance.       *
*                                                                             *
*  Retour      : Bilan de la définition.                                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static int py_match_record_set_creator(PyObject *self, PyObject *value, void *closure)
{
    int result;                             /* Bilan à renvoyer            */
    GMatchRecord *record;                   /* Version GLib de l'objet     */
    GKaitaiParser *parser;                  /* Lecteur à l'origine         */

    record = G_MATCH_RECORD(pygobject_get(self));

    if (!convert_to_kaitai_parser(value, &parser))
        result = -1;

    else
    {
        g_match_record_fix_creator(record, parser);
        result = 0;
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = correspondance à manipuler.                        *
*                closure = adresse non utilisée ici.                          *
*                                                                             *
*  Description : Renvoie vers le lecteur à l'origine de la correspondance.    *
*                                                                             *
*  Retour      : Lecteur à l'origine de la création.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_match_record_get_creator(PyObject *self, void *closure)
{
    PyObject *result;                       /* Instance à retourner        */
    GMatchRecord *record;                   /* Version GLib de l'objet     */
    GKaitaiParser *parser;                  /* Lecteur à l'origine         */

#define MATCH_RECORD_CREATOR_ATTRIB PYTHON_GETSET_DEF_FULL                      \
(                                                                               \
    creator, py_match_record,                                                   \
    "Provide or define the pychrysalide.plugins.kaitai.KaitaiParser instance"   \
    " which has created the record.\n"                                          \
    "\n"                                                                        \
    "This field should not be defined after the record creation in most cases." \
)

    record = G_MATCH_RECORD(pygobject_get(self));

    parser = g_match_record_get_creator(record);

    result = pygobject_new(G_OBJECT(parser));
    g_object_unref(parser);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit le contenu lié à une correspondance établie.         *
*                                                                             *
*  Retour      : Contenu binaire associé.                                     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_match_record_get_content(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GMatchRecord *record;                   /* Conservation à consulter    */
    GBinContent *content;                   /* Contenu associé             */

#define MATCH_RECORD_CONTENT_ATTRIB PYTHON_GET_DEF_FULL     \
(                                                           \
    content, py_match_record,                               \
    "pychrysalide.analysis.BinContent instance linked to"   \
    " the match record."                                    \
)

    record = G_MATCH_RECORD(pygobject_get(self));
    content = g_match_record_get_content(record);

    if (content != NULL)
    {
        result = pygobject_new(G_OBJECT(content));
        g_object_unref(G_OBJECT(content));
    }
    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Calcule ou fournit la zone couverte par une correspondance.  *
*                                                                             *
*  Retour      : Zone de couverture déterminée.                               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_match_record_get_range(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GMatchRecord *record;                   /* Conservation à consulter    */
    mrange_t range;                         /* Couverture courante         */

#define MATCH_RECORD_RANGE_ATTRIB PYTHON_GET_DEF_FULL       \
(                                                           \
    range, py_match_record,                                 \
    "Area of the matched data for the parsed attribute"     \
    " against a given binary content.\n"                    \
    "\n"                                                    \
    "This property is a pychrysalide.arch.mrange instance." \
)

    record = G_MATCH_RECORD(pygobject_get(self));
    g_match_record_get_range(record, &range);

    result = build_from_internal_mrange(&range);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Lit les octets bruts couverts par une correspondance.        *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_match_record_get_raw_bytes(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GMatchRecord *record;                   /* Conservation à consulter    */
    bin_t *out;                             /* Données brutes à transmettre*/
    size_t len;                             /* Quantité de ces données     */

#define MATCH_RECORD_RAW_BYTES_ATTRIB PYTHON_GET_DEF_FULL   \
(                                                           \
    raw_bytes, py_match_record,                             \
    "Raw bytes from the area covered by the record."        \
)

    record = G_MATCH_RECORD(pygobject_get(self));

    g_match_record_read_raw_bytes(record, &out, &len);

    result = PyBytes_FromStringAndSize((char *)out, len);
    free(out);

    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_match_record_type(void)
{
    static PyMethodDef py_match_record_methods[] = {
        { NULL }
    };

    static PyGetSetDef py_match_record_getseters[] = {
        MATCH_RECORD_CREATOR_ATTRIB,
        MATCH_RECORD_CONTENT_ATTRIB,
        MATCH_RECORD_RANGE_ATTRIB,
        MATCH_RECORD_RAW_BYTES_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_match_record_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

        .tp_name        = "pychrysalide.plugins.kaitai.MatchRecord",
        .tp_basicsize   = sizeof(PyGObject),

        .tp_flags       = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

        .tp_doc         = MATCH_RECORD_DOC,

        .tp_methods     = py_match_record_methods,
        .tp_getset      = py_match_record_getseters,

        .tp_init        = py_match_record_init,
        .tp_new         = py_match_record_new,

    };

    return &py_match_record_type;

}


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

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

    type = get_python_match_record_type();

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

        dict = PyModule_GetDict(module);

        if (!register_class_for_pygobject(dict, G_TYPE_MATCH_RECORD, 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 conservation de correspondance.        *
*                                                                             *
*  Retour      : Bilan de l'opération, voire indications supplémentaires.     *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

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

    result = PyObject_IsInstance(arg, (PyObject *)get_python_match_record_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 match record");
            break;

        case 1:
            *((GMatchRecord **)dst) = G_MATCH_RECORD(pygobject_get(arg));
            break;

        default:
            assert(false);
            break;

    }

    return result;

}