summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/common/hex.c
blob: 6f84c19e2470fad2d4eeb58ae2a490eccc1cdbe9 (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

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


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


#include <common/hex.h>


#include "../access.h"
#include "../helpers.h"



/* Encode des données en chaîne hexadécimale. */
static PyObject *py_hex_encode_hex(PyObject *, PyObject *);

/* Décode un caractère hexadécimal. */
static PyObject *py_hex_decode_hex_digit(PyObject *, PyObject *);



/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = arguments à utiliser pour l'opération.                *
*                                                                             *
*  Description : Encode des données en chaîne hexadécimale.                   *
*                                                                             *
*  Retour      : Chaîne hexadécimale.                                         *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_hex_encode_hex(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    int lower;                              /* Taille des caractères finaux*/
    const char *data;                       /* Données à traiter           */
    Py_ssize_t len;                         /* Quantité de ces données     */
    int ret;                                /* Bilan de lecture des args.  */
    char *buffer;                           /* Tampon de travail           */

#define HEX_ENCODE_HEX_METHOD PYTHON_METHOD_DEF                         \
(                                                                       \
    encode_hex, "data, /, lower = True",                                \
    METH_VARARGS, py_hex,                                               \
    "Convert data to a hex string.\n"                                   \
    "\n"                                                                \
    "The *data* has to be a string or a read-only bytes-like object."   \
    " The *lower* argument defines the case of the result string.\n"    \
    "\n"                                                                \
    "This method may be only usefull for the internal test suite as"    \
    " there is a native Python alternative:\n"                          \
    "\n"                                                                \
    "    b'ABC'.hex()\n"                                                \
    "    '414243'"                                                      \
)

    lower = 1;

    ret = PyArg_ParseTuple(args, "s#|p", &data, &len, &lower);
    if (!ret) return NULL;

    buffer = malloc((len * 2 + 1) * sizeof(char));

    encode_hex(data, len, lower, buffer);

    result = PyUnicode_FromString(buffer);

    free(buffer);

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : self = objet Python concerné par l'appel.                    *
*                args = arguments à utiliser pour l'opération.                *
*                                                                             *
*  Description : Décode un caractère hexadécimal.                             *
*                                                                             *
*  Retour      : Bilan de l'opération : valeur en cas de succès, None sinon.  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static PyObject *py_hex_decode_hex_digit(PyObject *self, PyObject *args)
{
    PyObject *result;                       /* Valeur à retourner          */
    char byte;                              /* Valeur hexadécimale         */
    int ret;                                /* Bilan de lecture des args.  */
    uint8_t value;                          /* Valeur brute transcrite     */
    bool status;                            /* Bilan de l'opération        */

#define HEX_DECODE_HEX_DIGIT_METHOD PYTHON_METHOD_DEF       \
(                                                           \
    decode_hex_digit, "chr",                                \
    METH_VARARGS, py_hex,                                   \
    "Convert a string character to an integer value."       \
    "\n"                                                    \
    "The *chr* can be a string character of length 1.\n"    \
    "\n"                                                    \
    "The result is an integer value on success or *None*"   \
    " in case of failure."                                  \
)

    ret = PyArg_ParseTuple(args, "C", &byte);
    if (!ret) return NULL;

    status = decode_hex_digit((const char *)&byte, &value);

    if (status)
        result = PyLong_FromUnsignedLong(value);

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

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : -                                                            *
*                                                                             *
*  Description : Définit une extension du module 'common' à compléter.        *
*                                                                             *
*  Retour      : Bilan de l'opération.                                        *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool populate_common_module_with_hex(void)
{
    bool result;                            /* Bilan à retourner           */
    PyObject *module;                       /* Module à recompléter        */

    static PyMethodDef py_hex_methods[] = {
        HEX_ENCODE_HEX_METHOD,
        HEX_DECODE_HEX_DIGIT_METHOD,
        { NULL }
    };

    module = get_access_to_python_module("pychrysalide.common");

    result = register_python_module_methods(module, py_hex_methods);

    return result;

}