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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
|
/* Chrysalide - Outil d'analyse de fichiers binaires
* scope.c - équivalent Python du fichier "plugins/kaitai/scope.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 "scope.h"
#include <assert.h>
#include <pygobject.h>
#include <plugins/pychrysalide/access.h>
#include <plugins/pychrysalide/helpers.h>
#include "record.h"
#include "parsers/meta.h"
#include "../record.h"
#include "../parsers/meta.h"
/* Rassemblement de données d'un paquet */
typedef struct _py_kaitai_scope_t
{
PyObject_HEAD /* A laisser en premier */
kaitai_scope_t *native; /* Tampon de données lié */
} py_kaitai_scope_t;
/* Libère de la mémoire un objet Python 'py_kaitai_scope_t'. */
static void py_kaitai_scope_dealloc(py_kaitai_scope_t *);
/* Initialise un objet Python de type 'py_kaitai_scope_t'. */
static int py_kaitai_scope_init(py_kaitai_scope_t *, PyObject *, PyObject *);
/* Conserve le souvenir de la dernière correspondance effectuée. */
static PyObject *py_kaitai_scope_remember_last_record(PyObject *, PyObject *);
/* Recherche la définition d'un type nouveau pour Kaitai. */
static PyObject *py_kaitai_scope_find_sub_type(PyObject *, PyObject *);
/* Retourne le souvenir d'une correspondance racine. */
static PyObject *py_kaitai_scope_get_root_record(PyObject *, void *);
/* Retourne le souvenir de la correspondance parente effectuée. */
static PyObject *py_kaitai_scope_get_parent_record(PyObject *, void *);
/* Retourne le souvenir de la dernière correspondance effectuée. */
static PyObject *py_kaitai_scope_get_last_record(PyObject *, void *);
/******************************************************************************
* *
* Paramètres : self = tampon de données à supprimer. *
* *
* Description : Libère de la mémoire un objet Python 'py_kaitai_scope_t'. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void py_kaitai_scope_dealloc(py_kaitai_scope_t *self)
{
reset_record_scope(self->native);
Py_TYPE(self)->tp_free((PyObject *)self);
}
/******************************************************************************
* *
* Paramètres : self = instance d'objet à initialiser. *
* args = arguments passés pour l'appel. *
* kwds = mots clefs éventuellement fournis en complément. *
* *
* Description : Initialise un objet Python de type 'py_kaitai_scope_t'. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
static int py_kaitai_scope_init(py_kaitai_scope_t *self, PyObject *args, PyObject *kwds)
{
int result; /* Bilan à retourner */
GKaitaiMeta *meta; /* Informations globale */
int ret; /* Bilan de lecture des args. */
#define KAITAI_SCOPE_DOC \
"The KaitaiScope object stores a local environment which freezes" \
" a particular state of the Kaitai parser. It allows the dynamic" \
" resolving of values contained in a Kaitai expression.\n" \
"\n" \
"Instances can be created using the following constructor:\n" \
"\n" \
" KaitaiScope(meta)" \
"\n" \
"Where *meta* is a pychrysalide.plugins.kaitai.parsers.KaitaiMeta" \
" instance pointing to global information about the Kaitai" \
" definition."
ret = PyArg_ParseTuple(args, "O&", convert_to_kaitai_meta, &meta);
if (!ret) return -1;
self->native = malloc(sizeof(kaitai_scope_t));
init_record_scope(self->native, meta);
result = 0;
return result;
}
/******************************************************************************
* *
* Paramètres : self = environnement local à manipuler. *
* args = arguments fournis pour la conduite de l'opération. *
* *
* Description : Conserve le souvenir de la dernière correspondance effectuée.*
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_kaitai_scope_remember_last_record(PyObject *self, PyObject *args)
{
PyObject *result; /* Bilan à faire remonter */
GMatchRecord *record; /* Correspondance à utiliser */
int ret; /* Bilan de lecture des args. */
py_kaitai_scope_t *locals; /* Instance à manipuler */
#define KAITAI_SCOPE_REMEMBER_LAST_RECORD_METHOD PYTHON_METHOD_DEF \
( \
remember_last_record, "$self, record, /", \
METH_VARARGS, py_kaitai_scope, \
"Store a record as the last parsed record.\n" \
"\n" \
"This *record* is expected to be a" \
" pychrysalide.plugins.kaitai.MatchRecord instance." \
)
ret = PyArg_ParseTuple(args, "O&", convert_to_match_record, &record);
if (!ret) return NULL;
locals = (py_kaitai_scope_t *)self;
remember_last_record(locals->native, record);
result = Py_None;
Py_INCREF(result);
return result;
}
/******************************************************************************
* *
* Paramètres : self = environnement local à manipuler. *
* args = arguments fournis pour la conduite de l'opération. *
* *
* Description : Recherche la définition d'un type nouveau pour Kaitai. *
* *
* Retour : Type prêt à emploi ou NULL si non trouvé. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_kaitai_scope_find_sub_type(PyObject *self, PyObject *args)
{
PyObject *result; /* Bilan à faire remonter */
const char *name; /* Désignation à retrouver */
int ret; /* Bilan de lecture des args. */
py_kaitai_scope_t *locals; /* Instance à manipuler */
GKaitaiType *type; /* Définition à identifier */
#define KAITAI_SCOPE_FIND_SUB_TYPE_METHOD PYTHON_METHOD_DEF \
( \
find_sub_type, "$self, name, /", \
METH_VARARGS, py_kaitai_scope, \
"Retrieve the type structure linked to a given name.\n" \
"\n" \
"This *name* has to be a string.\n" \
"\n" \
"The result is a known" \
" pychrysalide.plugins.kaitai.parsers.KaitaiType instance" \
" or *None* if the name has not been registered during" \
" the parsing." \
)
ret = PyArg_ParseTuple(args, "s", &name);
if (!ret) return NULL;
locals = (py_kaitai_scope_t *)self;
type = find_sub_type(locals->native, name);
result = pygobject_new(G_OBJECT(type));
g_object_unref(G_OBJECT(type));
return result;
}
/******************************************************************************
* *
* Paramètres : self = environnement local à consulter. *
* closure = adresse non utilisée ici. *
* *
* Description : Retourne le souvenir d'une correspondance racine. *
* *
* Retour : Dernière correspondance établie ou None. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_kaitai_scope_get_root_record(PyObject *self, void *closure)
{
PyObject *result; /* Conversion à retourner */
py_kaitai_scope_t *locals; /* Instance à manipuler */
GMatchRecord *record; /* Correspondance à convertir */
#define KAITAI_SCOPE_ROOT_RECORD_ATTRIB PYTHON_GET_DEF_FULL \
( \
root_record, py_kaitai_scope, \
"Provide the first record for a parsed content.\n" \
"\n" \
"The result is a pychrysalide.plugins.kaitai.MatchRecord" \
" instance or *None*." \
)
locals = (py_kaitai_scope_t *)self;
record = get_root_record(locals->native);
if (record != NULL)
{
result = pygobject_new(G_OBJECT(record));
g_object_unref(G_OBJECT(record));
}
else
{
result = Py_None;
Py_INCREF(result);
}
return result;
}
/******************************************************************************
* *
* Paramètres : self = environnement local à consulter. *
* closure = adresse non utilisée ici. *
* *
* Description : Retourne le souvenir de la correspondance parente effectuée. *
* *
* Retour : Dernière correspondance établie ou None. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_kaitai_scope_get_parent_record(PyObject *self, void *closure)
{
PyObject *result; /* Conversion à retourner */
py_kaitai_scope_t *locals; /* Instance à manipuler */
GMatchRecord *record; /* Correspondance à convertir */
#define KAITAI_SCOPE_PARENT_RECORD_ATTRIB PYTHON_GET_DEF_FULL \
( \
parent_record, py_kaitai_scope, \
"Provide the current parent record for a parsed content.\n" \
"\n" \
"The result is a pychrysalide.plugins.kaitai.MatchRecord" \
" instance or *None*." \
)
locals = (py_kaitai_scope_t *)self;
record = get_parent_record(locals->native);
if (record != NULL)
{
result = pygobject_new(G_OBJECT(record));
g_object_unref(G_OBJECT(record));
}
else
{
result = Py_None;
Py_INCREF(result);
}
return result;
}
/******************************************************************************
* *
* Paramètres : self = environnement local à consulter. *
* closure = adresse non utilisée ici. *
* *
* Description : Retourne le souvenir de la dernière correspondance effectuée.*
* *
* Retour : Dernière correspondance établie ou None. *
* *
* Remarques : - *
* *
******************************************************************************/
static PyObject *py_kaitai_scope_get_last_record(PyObject *self, void *closure)
{
PyObject *result; /* Conversion à retourner */
py_kaitai_scope_t *locals; /* Instance à manipuler */
GMatchRecord *record; /* Correspondance à convertir */
#define KAITAI_SCOPE_LAST_RECORD_ATTRIB PYTHON_GET_DEF_FULL \
( \
last_record, py_kaitai_scope, \
"Provide the last createdrecord for a parsed content.\n" \
"\n" \
"The result is a pychrysalide.plugins.kaitai.MatchRecord" \
" instance or *None*." \
)
locals = (py_kaitai_scope_t *)self;
record = get_last_record(locals->native);
if (record != NULL)
{
result = pygobject_new(G_OBJECT(record));
g_object_unref(G_OBJECT(record));
}
else
{
result = Py_None;
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_kaitai_scope_type(void)
{
static PyMethodDef py_kaitai_scope_methods[] = {
KAITAI_SCOPE_REMEMBER_LAST_RECORD_METHOD,
KAITAI_SCOPE_FIND_SUB_TYPE_METHOD,
{ NULL }
};
static PyGetSetDef py_kaitai_scope_getseters[] = {
KAITAI_SCOPE_ROOT_RECORD_ATTRIB,
KAITAI_SCOPE_PARENT_RECORD_ATTRIB,
KAITAI_SCOPE_LAST_RECORD_ATTRIB,
{ NULL }
};
static PyTypeObject py_kaitai_scope_type = {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "pychrysalide.plugins.kaitai.KaitaiScope",
.tp_basicsize = sizeof(py_kaitai_scope_t),
.tp_dealloc = (destructor)py_kaitai_scope_dealloc,
.tp_flags = Py_TPFLAGS_DEFAULT,
.tp_doc = KAITAI_SCOPE_DOC,
.tp_methods = py_kaitai_scope_methods,
.tp_getset = py_kaitai_scope_getseters,
.tp_init = (initproc)py_kaitai_scope_init,
.tp_new = PyType_GenericNew,
};
return &py_kaitai_scope_type;
}
/******************************************************************************
* *
* Paramètres : module = module dont la définition est à compléter. *
* *
* Description : Prend en charge l'objet 'pychrysalide.common.PackedBuffer'. *
* *
* Retour : Bilan de l'opération. *
* *
* Remarques : - *
* *
******************************************************************************/
bool ensure_python_kaitai_scope_is_registered(void)
{
PyTypeObject *type; /* Type Python 'PackedBuffer' */
PyObject *module; /* Module à recompléter */
type = get_python_kaitai_scope_type();
if (!PyType_HasFeature(type, Py_TPFLAGS_READY))
{
if (PyType_Ready(type) != 0)
return false;
module = get_access_to_python_module("pychrysalide.plugins.kaitai");
if (!register_python_module_object(module, type))
return false;
}
return true;
}
/******************************************************************************
* *
* Paramètres : locals = structure interne à copier en objet Python. *
* *
* Description : Convertit une structure 'kaitai_scope_t' en objet Python. *
* *
* Retour : Object Python résultant de la conversion opérée. *
* *
* Remarques : - *
* *
******************************************************************************/
PyObject *build_from_internal_kaitai_scope(const kaitai_scope_t *locals)
{
PyObject *result; /* Instance à retourner */
PyTypeObject *type; /* Type à instancier */
type = get_python_kaitai_scope_type();
result = PyObject_CallObject((PyObject *)type, NULL);
copy_record_scope(((py_kaitai_scope_t *)result)->native, locals);
return result;
}
/******************************************************************************
* *
* 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 environnement local pour Kaitai. *
* *
* Retour : Bilan de l'opération, voire indications supplémentaires. *
* *
* Remarques : - *
* *
******************************************************************************/
int convert_to_kaitai_scope(PyObject *arg, void *dst)
{
int result; /* Bilan à retourner */
result = PyObject_IsInstance(arg, (PyObject *)get_python_kaitai_scope_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 Kaitai scope");
break;
case 1:
*((kaitai_scope_t **)dst) = ((py_kaitai_scope_t *)arg)->native;
break;
default:
assert(false);
break;
}
return result;
}
|
