/* Chrysalide - Outil d'analyse de fichiers binaires * secstorage.c - équivalent Python du fichier "glibext/secstorage.c" * * Copyright (C) 2025 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 "secstorage.h" #include #include #include #include "../access.h" #include "../convert.h" #include "../helpers.h" /* ------------------------ GLUE POUR CREATION DEPUIS PYTHON ------------------------ */ CREATE_DYN_CONSTRUCTOR(secret_storage, G_TYPE_SECRET_STORAGE); /* Initialise une instance sur la base du dérivé de GObject. */ static int py_secret_storage_init(PyObject *, PyObject *, PyObject *); /* ------------------------- CONNEXION AVEC L'API DE PYTHON ------------------------- */ /* Définit un mot de passe pour protéger une clef maître. */ static PyObject *py_secret_storage_set_password(PyObject *, PyObject *); /* Déverrouille la clef de chiffrement maître. */ static PyObject *py_secret_storage_unlock(PyObject *, PyObject *); /* Verrouille la clef de chiffrement maître. */ static PyObject *py_secret_storage_lock(PyObject *, PyObject *); /* Chiffre des données avec la clef de chiffrement maître. */ static PyObject *py_secret_storage_encrypt_data(PyObject *, PyObject *); /* Déchiffre des données avec la clef de chiffrement maître. */ static PyObject *py_secret_storage_decrypt_data(PyObject *, PyObject *); /* Détermine si une clef de chiffrement protégée est en place. */ static PyObject *py_secret_storage_has_key(PyObject *, void *); /* Détermine si la clef de chiffrement maître est vérouillée. */ static PyObject *py_secret_storage_is_locked(PyObject *, void *); /* ---------------------------------------------------------------------------------- */ /* GLUE POUR CREATION DEPUIS PYTHON */ /* ---------------------------------------------------------------------------------- */ /****************************************************************************** * * * Paramètres : self = objet à initialiser (théoriquement). * * args = arguments fournis à l'appel. * * kwds = arguments de type key=val fournis. * * * * Description : Initialise une instance sur la base du dérivé de GObject. * * * * Retour : 0. * * * * Remarques : - * * * ******************************************************************************/ static int py_secret_storage_init(PyObject *self, PyObject *args, PyObject *kwds) { GSettings *settings; /* Configuration à considérer */ int ret; /* Bilan de lecture des args. */ GSecretStorage *storage; /* Stockage natif à manipuler */ #define SECRET_STORAGE_DOC \ "SecretStorage acts as guardian for secrets using ecryption," \ " mainly for sensitive information stored as configuration" \ " parameters.\n" \ "\n" \ "Instances can be created using the following constructor:\n" \ "\n" \ " SecretStorage(settings)" \ "\n" \ "The *settings* arguement must point to a GSettings intance;" \ " the main configuration settings are used by default." \ settings = NULL; ret = PyArg_ParseTuple(args, "|O&", convert_to_gsettings, &settings); if (!ret) return -1; /* Initialisation d'un objet GLib */ ret = forward_pygobjet_init(self); if (ret == -1) return -1; /* Eléments de base */ storage = G_SECRET_STORAGE(pygobject_get(self)); if (!g_secret_storage_create(storage, settings)) return -1; return 0; } /* ---------------------------------------------------------------------------------- */ /* CONNEXION AVEC L'API DE PYTHON */ /* ---------------------------------------------------------------------------------- */ /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * args = arguments fournis à l'appel. * * * * Description : Définit un mot de passe pour protéger une clef maître. * * * * Retour : Bilan de la mise en place. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_set_password(PyObject *self, PyObject *args) { PyObject *result; /* Conversion à retourner */ const char *passwd; /* Mot de passe associé */ int ret; /* Bilan de lecture des args. */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de situation */ #define SECRET_STORAGE_SET_PASSWORD_METHOD PYTHON_METHOD_DEF \ ( \ set_password, "/, password=''", \ METH_VARARGS, py_secret_storage, \ "Create a master key used for protecting secrets. This key is" \ " itself protected by the provided password.\n" \ "\n" \ "The supplied *password* has to be a string.\n" \ "\n" \ "The result is a boolean status: *True* if the operation successed,"\ " *False* otherwise." \ ) passwd = ""; ret = PyArg_ParseTuple(args, "|s", &passwd); if (!ret) return NULL; storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_set_password(storage, passwd); result = status ? Py_True : Py_False; Py_INCREF(result); return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * args = arguments fournis à l'appel. * * * * Description : Déverrouille la clef de chiffrement maître. * * * * Retour : Bilan de l'opération. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_unlock(PyObject *self, PyObject *args) { PyObject *result; /* Conversion à retourner */ const char *passwd; /* Mot de passe associé */ int ret; /* Bilan de lecture des args. */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de situation */ #define SECRET_STORAGE_UNLOCK_METHOD PYTHON_METHOD_DEF \ ( \ unlock, "/, password=''", \ METH_VARARGS, py_secret_storage, \ "Decrypt in memory the master key used for protecting secrets.\n" \ "\n" \ "The supplied *password* is the primary password used to protect" \ " this key.\n" \ "\n" \ "The result is a boolean status: *True* if the operation successed" \ " or if the master key is already unlocked, *False* otherwise." \ ) passwd = ""; ret = PyArg_ParseTuple(args, "|s", &passwd); if (!ret) return NULL; storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_unlock(storage, passwd); result = status ? Py_True : Py_False; Py_INCREF(result); return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * args = arguments fournis à l'appel. * * * * Description : Verrouille la clef de chiffrement maître. * * * * Retour : - * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_lock(PyObject *self, PyObject *args) { PyObject *result; /* Conversion à retourner */ GSecretStorage *storage; /* Stockage sécurisé visé */ #define SECRET_STORAGE_LOCK_METHOD PYTHON_METHOD_DEF \ ( \ lock, "", \ METH_NOARGS, py_secret_storage, \ "Clear from memory the master key used for protecting secrets." \ ) storage = G_SECRET_STORAGE(pygobject_get(self)); g_secret_storage_lock(storage); result = Py_None; Py_INCREF(result); return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * args = arguments fournis à l'appel. * * * * Description : Chiffre des données avec la clef de chiffrement maître. * * * * Retour : Bilan de l'opération. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_encrypt_data(PyObject *self, PyObject *args) { PyObject *result; /* Conversion à retourner */ const char *data_in; /* Données d'entrée à chiffrer */ Py_ssize_t size_in; /* Quantité de ces données */ int ret; /* Bilan de lecture des args. */ sized_binary_t in; /* Données à chiffer */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de situation */ sized_binary_t out; /* Données chiffrées */ #define SECRET_STORAGE_ENCRYPT_DATA_METHOD PYTHON_METHOD_DEF \ ( \ encrypt_data, "data", \ METH_VARARGS, py_secret_storage, \ "Encrypt data using an unlocked the master key.\n" \ "\n" \ "The *data* arguement points to bytes to process." \ "\n" \ "The result is either encrypted *data* as bytes in case of success,"\ " or *None* in case of failure." \ ) ret = PyArg_ParseTuple(args, "s#", &data_in, &size_in); if (!ret) return NULL; in.static_data = data_in; in.size = size_in; storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_encrypt_data(storage, &in, &out); if (status) { result = PyBytes_FromStringAndSize(out.static_data, out.size); exit_sized_binary(&out); } else { result = Py_None; Py_INCREF(result); } return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * args = arguments fournis à l'appel. * * * * Description : Déchiffre des données avec la clef de chiffrement maître. * * * * Retour : Bilan de l'opération. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_decrypt_data(PyObject *self, PyObject *args) { PyObject *result; /* Conversion à retourner */ const char *data_in; /* Données d'entrée à chiffrer */ Py_ssize_t size_in; /* Quantité de ces données */ int ret; /* Bilan de lecture des args. */ sized_binary_t in; /* Données à chiffer */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de situation */ sized_binary_t out; /* Données chiffrées */ #define SECRET_STORAGE_DECRYPT_DATA_METHOD PYTHON_METHOD_DEF \ ( \ decrypt_data, "data", \ METH_VARARGS, py_secret_storage, \ "Decrypt data using an unlocked the master key.\n" \ "\n" \ "The *data* arguement points to bytes to process." \ "\n" \ "The result is either decrypted *data* as bytes in case of success,"\ " or *None* in case of failure." \ ) ret = PyArg_ParseTuple(args, "s#", &data_in, &size_in); if (!ret) return NULL; in.static_data = data_in; in.size = size_in; storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_decrypt_data(storage, &in, &out); if (status) { result = PyBytes_FromStringAndSize(out.static_data, out.size); exit_sized_binary(&out); } else { result = Py_None; Py_INCREF(result); } return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * closure = non utilisé ici. * * * * Description : Détermine si une clef de chiffrement protégée est en place. * * * * Retour : Bilan de l'analyse. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_has_key(PyObject *self, void *closure) { PyObject *result; /* Instance Python à retourner */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de consultation */ #define PY_SECRET_STORAGE_HAS_KEY_ATTRIB PYTHON_HAS_DEF_FULL \ ( \ key, py_secret_storage, \ "Indicate if a master key used for protecting secrets seems to have"\ " been defined. Without any unlocking attempt, the test only relies"\ " on the length of saved master data.\n" \ "\n" \ "The returned status is a boolean status: *True* if the master key" \ " seems to exist, *False* otherwise." \ ) storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_has_key(storage); result = status ? Py_True : Py_False; Py_INCREF(result); return result; } /****************************************************************************** * * * Paramètres : self = objet Python concerné par l'appel. * * closure = non utilisé ici. * * * * Description : Détermine si la clef de chiffrement maître est vérouillée. * * * * Retour : Bilan de la détermination. * * * * Remarques : - * * * ******************************************************************************/ static PyObject *py_secret_storage_is_locked(PyObject *self, void *closure) { PyObject *result; /* Instance Python à retourner */ GSecretStorage *storage; /* Stockage sécurisé visé */ bool status; /* Bilan de consultation */ #define SECRET_STORAGE_IS_LOCKED_ATTRIB PYTHON_IS_DEF_FULL \ ( \ locked, py_secret_storage, \ "Indicate if the master key used for protecting secrets is" \ " currently decrypted in memory.\n" \ "\n" \ "The *settings* arguement must point to a GSettings intance; the" \ " main configuration settings are used by default.\n" \ "\n" \ "The returned status is a boolean status: *True* if the master key" \ " is unlocked and ready for use, *False* otherwise." \ ) storage = G_SECRET_STORAGE(pygobject_get(self)); status = g_secret_storage_is_locked(storage); result = status ? Py_True : Py_False; 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_secret_storage_type(void) { static PyMethodDef py_secret_storage_methods[] = { SECRET_STORAGE_SET_PASSWORD_METHOD, SECRET_STORAGE_UNLOCK_METHOD, SECRET_STORAGE_LOCK_METHOD, SECRET_STORAGE_ENCRYPT_DATA_METHOD, SECRET_STORAGE_DECRYPT_DATA_METHOD, { NULL } }; static PyGetSetDef py_secret_storage_getseters[] = { PY_SECRET_STORAGE_HAS_KEY_ATTRIB, SECRET_STORAGE_IS_LOCKED_ATTRIB, { NULL } }; static PyTypeObject py_secret_storage_type = { PyVarObject_HEAD_INIT(NULL, 0) .tp_name = "pychrysalide.glibext.SecretStorage", .tp_basicsize = sizeof(PyGObject), .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, .tp_doc = SECRET_STORAGE_DOC, .tp_methods = py_secret_storage_methods, .tp_getset = py_secret_storage_getseters, .tp_init = py_secret_storage_init, .tp_new = py_secret_storage_new, }; return &py_secret_storage_type; } /****************************************************************************** * * * Paramètres : module = module dont la définition est à compléter. * * * * Description : Prend en charge l'objet 'pychrysalide.glibext.SecretStorage'.* * * * Retour : Bilan de l'opération. * * * * Remarques : - * * * ******************************************************************************/ bool ensure_python_secret_storage_is_registered(void) { PyTypeObject *type; /* Type Python 'SecretStorage' */ PyObject *module; /* Module à recompléter */ PyObject *dict; /* Dictionnaire du module */ type = get_python_secret_storage_type(); if (!PyType_HasFeature(type, Py_TPFLAGS_READY)) { module = get_access_to_python_module("pychrysalide.glibext"); dict = PyModule_GetDict(module); if (!register_class_for_pygobject(dict, G_TYPE_SECRET_STORAGE, type)) return false; } return true; } /****************************************************************************** * * * 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 gardien des secrets avec stockage. * * * * Retour : Bilan de l'opération, voire indications supplémentaires. * * * * Remarques : - * * * ******************************************************************************/ int convert_to_secret_storage(PyObject *arg, void *dst) { int result; /* Bilan à retourner */ result = PyObject_IsInstance(arg, (PyObject *)get_python_secret_storage_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 secret storage"); break; case 1: *((GSecretStorage **)dst) = G_SECRET_STORAGE(pygobject_get(arg)); break; default: assert(false); break; } return result; }