summaryrefslogtreecommitdiff
path: root/plugins/pychrysa/pychrysa.c
blob: 68ab15be7a0dbbd73082c9540f0e4974b0d9f4b8 (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
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732

/* Chrysalide - Outil d'analyse de fichiers binaires
 * pychrysa.c - plugin permettant des extensions en Python
 *
 * Copyright (C) 2009-2014 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  OpenIDA 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.
 *
 *  OpenIDA 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "pychrysa.h"




#if 0

#include <dirent.h>
#include <pygobject.h>
#include <string.h>
//#include <pygtk/pygtk.h>


#include <config.h>


#include "quirks.h"
#include "analysis/module.h"
#include "arch/module.h"
#include "debug/module.h"
#include "format/module.h"
#include "glibext/module.h"
#include "gtkext/module.h"
#include "gui/module.h"

/*
#include "analysis/py_binary.h"
#include "analysis/py_line.h"
#include "analysis/py_line_code.h"
#include "analysis/roptions.h"
*/
#include "../../src/common/environment.h"
#include "../../src/common/extstr.h"
#include "../../src/plugins/plugin-int.h"





/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = instance représentant le greffon en chargement.     *
*                ref    = espace de référencement global.                     *
*                                                                             *
*  Description : Initialise le greffon permettant l'usage de Python.          *
*                                                                             *
*  Retour      : true.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool init_plugin(GPluginModule *plugin, GObject *ref)
{
    char *paths;                            /* Emplacements de greffons    */
    char *path;                             /* Chemin à fouiller           */
    char *save;                             /* Sauvegarde pour ré-entrance */
    DIR *dir;                               /* Répertoire à parcourir      */
    struct dirent entry;                    /* Elément trouvé              */
    struct dirent *next;                    /* Prochain élément fourni     */
    int ret;                                /* Bilan d'un appel système    */
    char *filename;                         /* Chemin d'accès reconstruit  */




    GPluginModule *pyplugin;



    /* Définition des zones d'influence */

    add_to_env_var("PYTHONPATH", PLUGINS_DIR G_DIR_SEPARATOR_S "python", ";");

    paths = get_env_var("PYTHONPATH");

    /* Intialisations Python */


    //return false;

    define_internal_ref(ref);

    Py_Initialize();

    //pychrysalide_set_gc_threshold(INT_MAX, INT_MAX, INT_MAX);
    //pychrysalide_set_gc_threshold(1, 1, 1);

    initpychrysa();



    /* Chargement des greffons */

    save = NULL;   /* gcc... */

    for (path = strtok_r(paths, ";", &save);
         path != NULL; 
         path = strtok_r(NULL, ";", &save))
    {
        dir = opendir(path);
        if (dir == NULL)
        {
            perror("opendir");
            continue;
        }

        for (ret = readdir_r(dir, &entry, &next);
             ret == 0 && next != NULL;
             ret = readdir_r(dir, &entry, &next))
        {
            if (entry.d_name[0] == '.') continue;
            //if (strcmp(entry.d_name, "test") != 0) continue;

            printf("NAME :: '%s'\n", entry.d_name);
            if (strcmp(entry.d_name, "apkfiles") != 0) continue;

            filename = strdup(entry.d_name);
            filename = stradd(filename, ".");
            filename = stradd(filename, "__init__");

            pyplugin = g_python_plugin_new(entry.d_name, filename);

            if (pyplugin == NULL)
                g_plugin_module_log_variadic_message(plugin, LMT_ERROR, 
                                                     _("No suitable Python plugin found in '%s'"),
                                                     filename);
            else
            {
                g_plugin_module_log_variadic_message(plugin, LMT_PROCESS, 
                                                     _("Loaded Python plugin '<b>%s</b>' from the '<b>%s</b>' directory"),
                                                     g_plugin_module_get_name(G_PLUGIN_MODULE(pyplugin)), path);
                add_plugin_to_main_list(pyplugin);
            }

            free(filename);

        }

         closedir(dir);

    }

    return true;

}







#endif






#include <locale.h>
#include <pygobject.h>





#include <core/core.h>



#include "analysis/module.h"
#include "arch/module.h"
#include "common/module.h"
#include "core/module.h"
#include "format/module.h"
#include "glibext/module.h"
#include "gtkext/module.h"
#include "gui/module.h"



// TODO : à bouger ?
#include "../../src/arch/processor.h"
#include "../../src/format/format.h"








///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////:///////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////:///////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////:///////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////:///////////////////////////
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////:///////////////////////////


#include <stdio.h>
#include <stdbool.h>
#include <string.h>
#include <unistd.h>


#include <config.h>
#include <common/cpp.h>
#include <common/environment.h>
#include <common/extstr.h>
#include <plugins/plugin-def.h>
#include <plugins/plugin-int.h>


#include "plugin.h"
#include "quirks.h"





DEFINE_CHRYSALIDE_ACTIVE_PLUGIN("PyChrysalide", "Provides bindings to Python", "0.1.0", PGA_PLUGIN_INIT);


/* Fournit la révision du programme global. */
static PyObject *py_chrysalide_revision(PyObject *, PyObject *);

/* Fournit la version du programme global. */
static PyObject *py_chrysalide_version(PyObject *, PyObject *);

/* Fournit la version du greffon pour Python. */
static PyObject *py_chrysalide_mod_version(PyObject *, PyObject *);

/* Recherche et fournit si elle existe une valeur globale. */
static PyObject *py_chrysalide_get_global_gobject(PyObject *, PyObject *);

/* Détermine si l'interpréteur lancé est celui pris en compte. */
static bool is_current_abi_suitable(void);

/* Charge autant de greffons composés en Python que possible. */
static bool load_python_plugins(GPluginModule *plugin, GObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Fournit la révision du programme global.                     *
*                                                                             *
*  Retour      : Numéro de révision.                                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_chrysalide_revision(PyObject *self, PyObject *args)
{
    return PyUnicode_FromString("r" XSTR(REVISION));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Fournit la version du programme global.                      *
*                                                                             *
*  Retour      : Numéro de version.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_chrysalide_version(PyObject *self, PyObject *args)
{
    char version[16];
    int major;
    int minor;
    int revision;

    major = REVISION / 1000;
    minor = (REVISION - (major * 1000)) / 100;
    revision = REVISION % 100;

    snprintf(version, sizeof(version), "%d.%d.%d", major, minor, revision);

    return PyUnicode_FromString(version);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = non utilisé ici.                                      *
*                                                                             *
*  Description : Fournit la version du greffon pour Python.                   *
*                                                                             *
*  Retour      : Numéro de version.                                           *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_chrysalide_mod_version(PyObject *self, PyObject *args)
{
    char version[16];

    snprintf(version, sizeof(version), "%s", _chrysalide_plugin.version);

    return PyUnicode_FromString(version);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = NULL car méthode statique.                            *
*                args = contient la clef d'accès à un champ particulier.      *
*                                                                             *
*  Description : Recherche et fournit si elle existe une valeur globale.      *
*                                                                             *
*  Retour      : Object attaché à l'espace de référencement global ou NULL.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_chrysalide_get_global_gobject(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Instance à retourner        */
    const char *key;                        /* Désignation du champ visé   */
    int ret;                                /* Bilan de lecture des args.  */
    void *data;                             /* Donnée quelconque           */

    ret = PyArg_ParseTuple(args, "s", &key);
    if (!ret) Py_RETURN_NONE;

    data = g_object_get_data(get_internal_ref(), key);
    if (data == NULL) Py_RETURN_NONE;

    if (!G_IS_OBJECT(data)) Py_RETURN_NONE;

    result = pygobject_new(G_OBJECT(data));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Détermine si l'interpréteur lancé est celui pris en compte.  *
*                                                                             *
*  Retour      : true si l'exécution peut se poursuivre, false sinon.         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool is_current_abi_suitable(void)
{
    bool result;
    int fds[2];
    int ret;
    char cmds[128];
    char content[64];
    ssize_t got;

#define GRAB_ABI_FLAGS_IN_PYTHON                        \
    "import sys" "\n"                                   \
    "import os" "\n"                                    \
    "os.write(%d, bytes(sys.abiflags, 'UTF-8'))" "\n"

    result = false;

    ret = pipe(fds);
    if (ret == -1)
    {
        perror("pipe()");
        return false;
    }

    snprintf(cmds, sizeof(cmds), GRAB_ABI_FLAGS_IN_PYTHON, fds[1]);

    ret = PyRun_SimpleString(cmds);
    if (ret != 0) goto icas_exit;

    got = read(fds[0], content, sizeof(content));
    if (got < 0)
    {
        perror("read()");
        goto icas_exit;
    }

    content[got] = '\0';

    result = (strcmp(content, LIBPYTHON_ABI_FLAGS) == 0);

 icas_exit:

    if (!result)
        PyErr_SetString(PyExc_SystemError, "the ABI flags of the current interpreter do not match " \
                        "the ones of the Python library used during the module compilation.");

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Point d'entrée pour l'initialisation de Python.              *
*                                                                             *
*  Retour      : ?                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/
#include <gtkext/support.h> // REMME
#include <glibext/delayed.h>

#define PYCHRYSALIDE_DOC                                                                                        \
    "PyChrysalide is a module containing Chrysalide's features and designed for Python users.\n"                \
    "\n"                                                                                                        \
    "The whole API is defined in a single library named 'pychrysalide.so' and can be used in two ways:\n"       \
    "* either from the Chrysalide's GUI, by registering hooks or GLib signals.\n"                               \
    "* or from a shell command line, by setting PYTHONPATH to point to the directory containing the library.\n" \
    "\n"                                                                                                        \
    "In both cases, it is a good start point to have a look at already existing plugins to quickly learn "      \
    "how the API works.\n"                                                                                      \
    "\n"                                                                                                        \
    "These plugins are located in the 'plugins/python' directory."

PyMODINIT_FUNC PyInit_pychrysalide(void)
{
    PyObject *result;                       /* Module Python à retourner   */
    PyObject *pygobj_mod;                   /* Module Python-GObject       */
    bool status;                            /* Bilan des inclusions        */

    static PyMethodDef py_chrysalide_methods[] = {

        { "revision", py_chrysalide_revision,
          METH_NOARGS,
          "revision(/)\n--\n\nProvide the revision number of Chrysalide."
        },
        { "version", py_chrysalide_version,
          METH_NOARGS,
          "version(/)\n--\n\nProvide the version number of Chrysalide."
        },
        { "mod_version", py_chrysalide_mod_version,
          METH_NOARGS,
          "mod_version(/)\n--\n\nProvide the version number of Chrysalide module for Python."
        },
        { "get_global_gobject", py_chrysalide_get_global_gobject,
          METH_VARARGS,
          "get_global_gobject(key, /)\n--\n\nRetrieve if it exists a global GObject registered with the given key."
        },
        { NULL }

    };

    static PyModuleDef py_chrysalide_module = {

        .m_base = PyModuleDef_HEAD_INIT,

        .m_name = "pychrysalide",
        .m_doc = PYCHRYSALIDE_DOC,

        .m_size = -1,

        .m_methods = py_chrysalide_methods

    };



#if 0
    do
    {
        int argc = 0;
        //char *argv[] = { NULL };

    /* Initialisation de GTK */
    g_set_prgname("Chrysalide");
    setlocale (LC_ALL, "");
    gtk_init(&argc, NULL/*&argv-*/);

    } while (0);

    add_pixmap_directory(PACKAGE_DATA_DIR);
    add_pixmap_directory(PACKAGE_SOURCE_DIR G_DIR_SEPARATOR_S "pixmaps");

    /**
     * On évite d'initialiser deux fois...
     */
    if (get_work_queue() != NULL)
        init_work_queue(NULL/* !! */);
#endif

    /**
     * On évite d'initialiser deux fois...
     */
    if (get_work_queue() != NULL)
        init_work_queue(NULL/* !! */);

    ////////////////////////





    if (!is_current_abi_suitable())
        return NULL;

    if (pygobject_init(-1, -1, -1) == NULL)
    {
        PyErr_SetString(PyExc_SystemError, "unable to init GObject in Python.");
        return NULL;
    }

    if (!load_all_basic_components())
    {
        PyErr_SetString(PyExc_SystemError, "unable to load all basic components.");
        return NULL;
    }

    /* Préparatifs préalables aux chargements */

    /**
     * Pour une raison non identifiée, si le module n'est pas préchargé,
     * le flot d'exécution plante dans la fonction insertdict() de Objects/dictobject.c:818.
     */

    pygobj_mod = PyImport_ImportModule("gi.repository.GObject");
    if (pygobj_mod == NULL)
    {
        PyErr_SetString(PyExc_ImportError, "could not import gi.gobject");
        return NULL;
    }

    /* Mise en place des fonctionnalités offertes */

    result = PyModule_Create(&py_chrysalide_module);

    status = register_python_plugin_module(result);

    status &= add_analysis_module_to_python_module(result);
    status &= add_arch_module_to_python_module(result);
    status &= add_common_module_to_python_module(result);
    status &= add_core_module_to_python_module(result);
    status &= add_format_module_to_python_module(result);
    status &= add_glibext_module_to_python_module(result);
    status &= add_gtkext_module_to_python_module(result);
    status &= add_gui_module_to_python_module(result);

    if (!status)
    {
        PyErr_SetString(PyExc_SystemError, "fail to load all PyChrysalide components.");
        return NULL;
    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = instance représentant le greffon Python d'origine.  *
*                ref    = espace de référencement global.                     *
*                                                                             *
*  Description : Charge autant de greffons composés en Python que possible.   *
*                                                                             *
*  Retour      : true.                                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static bool load_python_plugins(GPluginModule *plugin, GObject *ref)
{
    char *paths;                            /* Emplacements de greffons    */
    char *save;                             /* Sauvegarde pour ré-entrance */
    char *path;                             /* Chemin à fouiller           */
    DIR *dir;                               /* Répertoire à parcourir      */
    struct dirent entry;                    /* Elément trouvé              */
    struct dirent *next;                    /* Prochain élément fourni     */
    int ret;                                /* Bilan d'un appel système    */
    char *modname;                          /* Nom du module pour Python   */
    char *filename;                         /* Chemin d'accès reconstruit  */
    GPluginModule *pyplugin;                /* Lien vers un grffon Python  */

    paths = get_env_var("PYTHONPATH");

    save = NULL;   /* gcc... */

    for (path = strtok_r(paths, ";", &save);
         path != NULL; 
         path = strtok_r(NULL, ";", &save))
    {
        dir = opendir(path);
        if (dir == NULL)
        {
            perror("opendir");
            continue;
        }

        g_plugin_module_log_variadic_message(plugin, LMT_INFO, 
                                             _("Looking for Python plugins in '%s'..."),
                                             path);

        for (ret = readdir_r(dir, &entry, &next);
             ret == 0 && next != NULL;
             ret = readdir_r(dir, &entry, &next))
        {
            if (entry.d_type != DT_DIR) continue;
            if (entry.d_name[0] == '.') continue;

            modname = strdup(entry.d_name);
            modname = stradd(modname, ".");
            modname = stradd(modname, "__init__");

            filename = strdup(path);
            filename = stradd(filename, G_DIR_SEPARATOR_S);
            filename = stradd(filename, entry.d_name);

            pyplugin = g_python_plugin_new(modname, filename, ref);

            if (pyplugin == NULL)
                g_plugin_module_log_variadic_message(plugin, LMT_ERROR, 
                                                     _("No suitable Python plugin found in '%s'"),
                                                     filename);
            else
            {
                g_plugin_module_log_variadic_message(plugin, LMT_PROCESS, 
                                                     _("Loaded the Python plugin found in the '<b>%s</b>' directory"),
                                                     filename);
                add_plugin_to_main_list(pyplugin);
            }

            free(filename);
            free(modname);

        }

         closedir(dir);

    }

    return true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à manipuler.                                *
*                ref    = espace de référencement global.                     *
*                                                                             *
*  Description : Prend acte du chargement du greffon.                         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

G_MODULE_EXPORT bool chrysalide_plugin_init(GPluginModule *plugin, GObject *ref)
{
    bool result;                            /* Bilan à retourner           */
    DIR *dir;                               /* Répertoire à parcourir      */

    define_internal_ref(ref);

    /* Définition des zones d'influence */

    dir = opendir(PLUGINS_DIR G_DIR_SEPARATOR_S "python");

    if (dir != NULL)
    {
         closedir(dir);
         add_to_env_var("PYTHONPATH", PLUGINS_DIR G_DIR_SEPARATOR_S "python", ";");
    }
    else
        add_to_env_var("PYTHONPATH", PACKAGE_SOURCE_DIR G_DIR_SEPARATOR_S "plugins" \
                       G_DIR_SEPARATOR_S "python", ";");

    /* Chargement du module pour Python */

    PyImport_AppendInittab("pychrysalide", &PyInit_pychrysalide);

    Py_Initialize();

    PySys_SetArgv(0, (wchar_t *[]) { NULL });

    result = load_python_plugins(plugin, ref);

    return result;

}