summaryrefslogtreecommitdiff
path: root/plugins/dex/python/format.c
blob: c1e4c40ca2da74b06e57c521e4110257d7bce224 (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

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


#include <assert.h>
#include <pygobject.h>


#include <i18n.h>
#include <plugins/pychrysalide/helpers.h>
#include <plugins/pychrysalide/analysis/binary.h>
#include <plugins/pychrysalide/analysis/content.h>
#include <plugins/pychrysalide/format/executable.h>


#include "constants.h"
#include "translate.h"
#include "../class.h"
#include "../dex-int.h"
#include "../format.h"



/* Crée un nouvel objet Python de type 'DexFormat'. */
static PyObject *py_dex_format_new(PyTypeObject *, PyObject *, PyObject *);

/* Fournit la table des ressources associée au format Dex. */
static PyObject *py_dex_format_get_pool(PyObject *, void *);



/******************************************************************************
*                                                                             *
*  Paramètres  : type = type de l'objet à instancier.                         *
*                args = arguments fournis à l'appel.                          *
*                kwds = arguments de type key=val fournis.                    *
*                                                                             *
*  Description : Crée un nouvel objet Python de type 'DexFormat'.             *
*                                                                             *
*  Retour      : Instance Python mise en place.                               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_dex_format_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *result;                       /* Instance à retourner        */
    GBinContent *content;                   /* Instance GLib du contenu    */
    int ret;                                /* Bilan de lecture des args.  */
    GExeFormat *format;                     /* Création GLib à transmettre */

#define DEX_FORMAT_DOC                                                  \
    "DexFormat deals with DEX format.\n"                                \
    "\n"                                                                \
    "Instances can be created using the following constructor:\n"       \
    "\n"                                                                \
    "    DexFormat(content)"                                            \
    "\n"                                                                \
    "Where content is a pychrysalide.analysis.BinContent object."       \

    ret = PyArg_ParseTuple(args, "O&", convert_to_binary_content, &content);
    if (!ret) return NULL;

    format = g_dex_format_new(content);

    if (format == NULL)
    {
        result = Py_None;
        Py_INCREF(result);
    }

    else
    {
        result = pygobject_new(G_OBJECT(format));
        g_object_unref(format);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet représentant un format de fichier Dex.          *
*                args = arguments fournis pour l'opération.                   *
*                                                                             *
*  Description : Procède à la lecture d'une liste de types DEX.               *
*                                                                             *
*  Retour      : Instance mise en place.                                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_dex_format_read_type_list(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Bilan à retourner           */
    unsigned int offset;                    /* Position de l'élément visé  */
    int ret;                                /* Bilan de lecture des args.  */
    GDexFormat *format;                     /* Format de fichier Dex       */
    vmpa2t addr;                            /* Tête de lecture générique   */
    type_list list;                         /* Elément à transmettre       */
    bool status;                            /* Bilan de l'opération        */
    uint32_t i;                             /* Boucle de parcours          */

#define DEX_POOL_READ_TYPE_LIST_METHOD PYTHON_METHOD_DEF                                        \
(                                                                                               \
    read_type_list, "$self, offset, /",                                                         \
    METH_VARARGS, py_dex_format,                                                                \
    "Provide the raw data of a given type list as an array of pychrysalide.PyStructObject"      \
    " instances."                                                                               \
    "\n"                                                                                        \
    "All the items are fields extracted from the Dex *type_list* structure:\n"                  \
    "* type_idx: index into the *type_ids* list.\n"                                             \
    "\n"                                                                                        \
    "In case of error, the function returns None."                                              \
)

    ret = PyArg_ParseTuple(args, "I", &offset);
    if (!ret) return NULL;

    format = G_DEX_FORMAT(pygobject_get(self));

    init_vmpa(&addr, offset, VMPA_NO_VIRTUAL);

    status = read_dex_type_list(format, &addr, &list);

    if (status)
    {
        result = PyTuple_New(list.size);

        for (i = 0; i < list.size; i++)
        {
#ifndef NDEBUG
            ret = PyTuple_SetItem(result, i, translate_dex_type_item_to_python(&list.list[i]));
            assert(ret == 0);
#else
            PyTuple_SetItem(result, i, translate_dex_type_item_to_python(&list.list[i]));
#endif
        }

    }
    else
    {
        result = Py_None;
        Py_INCREF(result);
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self    = objet Python concerné par l'appel.                 *
*                closure = non utilisé ici.                                   *
*                                                                             *
*  Description : Fournit la table des ressources associée au format Dex.      *
*                                                                             *
*  Retour      : Table de ressources mise en place ou None si aucune.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_dex_format_get_pool(PyObject *self, void *closure)
{
    PyObject *result;                       /* Valeur à retourner          */
    GDexFormat *format;                     /* Version native              */
    GDexPool *pool;                         /* Table de ressources associée*/

#define DEX_FORMAT_POOL_ATTRIB PYTHON_GET_DEF_FULL      \
(                                                       \
    pool, py_dex_format,                                \
    "Resource pool of the Dex format."                  \
)

    format = G_DEX_FORMAT(pygobject_get(self));

    pool = g_dex_format_get_pool(format);

    result = pygobject_new(G_OBJECT(pool));

    g_object_unref(G_OBJECT(pool));

    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_dex_format_type(void)
{
    static PyMethodDef py_dex_format_methods[] = {
        DEX_POOL_READ_TYPE_LIST_METHOD,
        { NULL }
    };

    static PyGetSetDef py_dex_format_getseters[] = {
        DEX_FORMAT_POOL_ATTRIB,
        { NULL }
    };

    static PyTypeObject py_dex_format_type = {

        PyVarObject_HEAD_INIT(NULL, 0)

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

        .tp_flags       = Py_TPFLAGS_DEFAULT,

        .tp_doc         = DEX_FORMAT_DOC,

        .tp_methods     = py_dex_format_methods,
        .tp_getset      = py_dex_format_getseters,
        .tp_new         = py_dex_format_new

    };

    return &py_dex_format_type;

}


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

bool register_python_dex_format(PyObject *module)
{
    PyTypeObject *type;                     /* Type Python 'DexFormat'     */
    PyObject *dict;                         /* Dictionnaire du module      */

    type = get_python_dex_format_type();

    dict = PyModule_GetDict(module);

    if (!register_class_for_pygobject(dict, G_TYPE_DEX_FORMAT, type, get_python_executable_format_type()))
        return false;

    if (!define_python_dex_format_common_constants(type))
        return false;

    return true;

}