summaryrefslogtreecommitdiff
path: root/src/plugins/plugin.c
blob: 968cf652c6ad4f9de6d811dbcd8459e87911090b (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

/* OpenIDA - Outil d'analyse de fichiers binaires
 * plugin.c - interactions avec un greffon donné
 *
 * Copyright (C) 2009-2012 Cyrille Bagard
 *
 *  This file is part of OpenIDA.
 *
 *  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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


#include "plugin.h"


#include <gmodule.h>
#include <libgen.h>
#include <malloc.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>


#include "plugin-int.h"



/* Initialise la classe des greffons. */
static void g_plugin_module_class_init(GPluginModuleClass *);

/* Initialise une instance de greffon. */
static void g_plugin_module_init(GPluginModule *);

/* Supprime toutes les références externes. */
static void g_plugin_module_dispose(GPluginModule *);

/* Procède à la libération totale de la mémoire. */
static void g_plugin_module_finalize(GPluginModule *);


/* Indique le type défini pour un greffon. */
G_DEFINE_TYPE(GPluginModule, g_plugin_module, G_TYPE_OBJECT);



/******************************************************************************
*                                                                             *
*  Paramètres  : class = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des greffons.                           *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_plugin_module_class_init(GPluginModuleClass *class)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(class);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_plugin_module_dispose;
    object->finalize = (GObjectFinalizeFunc)g_plugin_module_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = instance à initialiser.                             *
*                                                                             *
*  Description : Initialise une instance de greffon.                          *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_plugin_module_init(GPluginModule *plugin)
{

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_plugin_module_dispose(GPluginModule *plugin)
{
    if (plugin->exit != NULL)
        plugin->exit(plugin);

    if (plugin->module != NULL)
        g_module_close(plugin->module);

    G_OBJECT_CLASS(g_plugin_module_parent_class)->dispose(G_OBJECT(plugin));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = instance d'objet GLib à traiter.                    *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_plugin_module_finalize(GPluginModule *plugin)
{
    if (plugin->name != NULL)
        free(plugin->name);
    if (plugin->filename != NULL)
        free(plugin->filename);

    G_OBJECT_CLASS(g_plugin_module_parent_class)->finalize(G_OBJECT(plugin));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : filename = nom du fichier à charger.                         *
*                                                                             *
*  Description : Crée un module pour un greffon donné.                        *
*                                                                             *
*  Retour      : Adresse de la structure mise en place.                       *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GPluginModule *g_plugin_module_new(const gchar *filename)
{
    GPluginModule *result;                  /* Structure à retourner       */
    get_plugin_name_fc get_name;            /* Nom du greffon              */
    get_plugin_action_fc __get_type;        /* Type(s) de greffon          */
    get_plugin_action_fc get_action;        /* Actions du greffon          */
    char *dir;                              /* Répertoire modifiable       */

    result = g_object_new(G_TYPE_PLUGIN_MODULE, NULL);

    result->module = g_module_open(filename, G_MODULE_BIND_LAZY);
    if (result->module == NULL)
    {
        log_variadic_message(LMT_ERROR, 
                             _("Error while loading the plugin candidate '%s' : %s"),
                             filename, g_module_error());
        goto bad_plugin;
    }

    if (!g_module_symbol(result->module, "get_plugin_name", (gpointer *)&get_name))
    {
        log_variadic_message(LMT_ERROR, 
                             _("No 'get_plugin_name' entry in plugin candidate '%s'"),
                             filename);
        goto bad_plugin;
    }

    result->name = get_name();
    result->filename = strdup(filename);

    if (!g_module_symbol(result->module, "init_plugin", (gpointer *)&result->init))
        result->init = NULL;

    if (!g_module_symbol(result->module, "exit_plugin", (gpointer *)&result->exit))
        result->exit = NULL;

    /*


    if (!g_module_symbol(result->module, "get_plugin_type", (gpointer *)&__get_type))
    {
        printf("No 'get_plugin_type' symbol found in the plugin '%s'\n", filename);
        goto bad_plugin;
    }

    result->type = __get_type();


    printf("Plugin type :: 0x%08x\n", result->type);
    */



    if (!g_module_symbol(result->module, "get_plugin_action", (gpointer *)&get_action))
    {
        printf("Err plugin get_action sym\n");
        //g_object_destroy(result);
        return NULL;
    }

    result->get_action = get_action;

    if (g_plugin_module_get_action(result) & (PGA_BINARY_ACTIONS | /* FIXME : supprimer le reste */ PGA_DISASSEMBLE | PGA_DISASS_PROCESS | PGA_CODE_PROCESS))
    {
        if (!g_module_symbol(result->module, "execute_action_on_binary", (gpointer *)&result->exec_on_bin))
        {
            printf("Err plugin disass sym\n");
            //g_object_destroy(result);
            return NULL;
        }


    }






    dir = strdup(filename);
    dir = dirname(dir);

    log_variadic_message(LMT_PROCESS, _("Loaded the '<b>%s</b>' from the '<b>%s</b>' directory"),
                         strrchr(filename, G_DIR_SEPARATOR) + 1, dir);

    free(dir);

    return result;

 bad_plugin:

    g_object_unref(G_OBJECT(result));

    return NULL;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à consulter.                                *
*                                                                             *
*  Description : Fournit le nom associé au greffon.                           *
*                                                                             *
*  Retour      : Désignation humaine.                                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

const char *g_plugin_module_get_name(const GPluginModule *plugin)
{
    return plugin->name;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à consulter.                                *
*                msg    = message à faire apparaître à l'écran.               *
*                                                                             *
*  Description : Présente dans le journal un message simple.                  *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_plugin_module_log_simple_message(const GPluginModule *plugin, LogMessageType type, const char *msg)
{
    size_t len;                             /* Taille tampon disponible    */
    char *buffer;                           /* Tampon du msg reconstitué   */

    len = 1 + strlen(plugin->name) + 2 + strlen(msg) + 1;
    buffer = calloc(len, sizeof(char));

    strcpy(buffer, "[");
    strcat(buffer, plugin->name);
    strcat(buffer, "] ");
    strcat(buffer, msg);

    log_simple_message(type, buffer);

    free(buffer);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à consulter.                                *
*                type   = espèce du message à ajouter.                        *
*                fmt    = format du message à faire apparaître à l'écran.     *
*                ...    = éventuels arguments venant compléter le message.    *
*                                                                             *
*  Description : Présente dans le journal un message complexe.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_plugin_module_log_variadic_message(const GPluginModule *plugin, LogMessageType type, const char *fmt, ...)
{
    size_t len;                             /* Taille tampon disponible    */
    char *buffer;                           /* Tampon du msg reconstitué   */
    int ret;                                /* Bilan d'une impression      */
    char *ptr;                              /* Nouvelle allocation         */
    va_list ap;                             /* Liste d'arguments variable  */

    len = VARIADIC_LOG_BUFSIZE;
    buffer = calloc(len, sizeof(char));

    while (buffer != NULL)
    {
        va_start(ap, fmt);
        ret = vsnprintf(buffer, len, fmt, ap);
        va_end(ap);

        if (ret >= 0 && ret < len) break;

        else
        {
            if (ret > -1) len += 1;     /* glibc 2.1 */
            else len *= 2;              /* glibc 2.0 */

            if ((ptr = realloc(buffer, len)) == NULL)
            {
                free(buffer);
                buffer = NULL;
            }
            else buffer = ptr;

        }

    }

    g_plugin_module_log_simple_message(plugin, type, buffer);

    free(buffer);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à consulter.                                *
*                                                                             *
*  Description : Indique les opérations offertes par un greffon donné.        *
*                                                                             *
*  Retour      : Action(s) offerte(s) par le greffon.                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

PluginAction g_plugin_module_get_action(const GPluginModule *plugin)
{
    return plugin->get_action(plugin);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin   = greffon de prise en charge à utiliser.            *
*                filename = éventuel nom de fichier associé ou NULL. [OUT]    *
*                data     = données chargées. [OUT]                           *
*                length   = quantité de ces données. [OUT]                    *
*                                                                             *
*  Description : Identifie un format à associer à un contenu binaire.         *
*                                                                             *
*  Retour      : Bilan de la recherche de correspondances.                    *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

MatchingFormatAction g_plugin_module_is_matching(const GPluginModule *plugin, char **filename, bin_t **data, off_t *length)
{
    MatchingFormatAction result;            /* Valeur à retourner          */
    char *old_filename;                     /* Ancien nom de fichier       */
    bin_t *old_data;                        /* Ancien contenu binaire      */

    if (plugin->is_matching == NULL)
        return MFA_NONE;

    old_filename = *filename;
    old_data = *data;

    result = plugin->is_matching(plugin, filename, data, length);

    return result;

}






/******************************************************************************
*                                                                             *
*  Paramètres  : plugin = greffon à consulter.                                *
*                binary = binaire dont le contenu est à traiter.              *
*                action = action attendue.                                    *
*                                                                             *
*  Description : Exécute une action définie sur un binaire chargé.            *
*                                                                             *
*  Retour      : true si une action a été menée, false sinon.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_plugin_module_execute_action_on_binary(const GPluginModule *plugin, GLoadedBinary *binary, PluginAction action)
{
    return plugin->exec_on_bin(plugin, binary, action);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : plugin   = greffon à consulter.                              *
*                debugger = débogueur à l'origine de l'opération.             *
*                action   = action attendue.                                  *
*                                                                             *
*  Description : Exécute une action relative à un débogueur.                  *
*                                                                             *
*  Retour      : true si une action a été menée, false sinon.                 *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_plugin_module_handle_debugger(const GPluginModule *plugin, GBinaryDebugger *debugger, PluginAction action)
{
    return plugin->handle_debugger(plugin, debugger, action);

}