Skip to content

gh-87138: convert SHA-3 object type to heap type #127670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 8, 2024
Merged

gh-87138: convert SHA-3 object type to heap type #127670

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd2c97f
remove redundant casts
picnixz Dec 4, 2024
a8975ed
convert SHA3 and SHAKE classes to heap types
picnixz Dec 4, 2024
94a6460
Revert "remove redundant casts"
picnixz Dec 8, 2024
e23eeee
remove cosmetics
picnixz Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions Modules/sha3module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ typedef struct {
static SHA3object *
newSHA3object(PyTypeObject *type)
{
SHA3object *newobj;
newobj = (SHA3object *)PyObject_New(SHA3object, type);
SHA3object *newobj = PyObject_GC_New(SHA3object, type);
if (newobj == NULL) {
return NULL;
}
HASHLIB_INIT_MUTEX(newobj);

PyObject_GC_Track(newobj);
return newobj;
}

Expand Down Expand Up @@ -166,15 +166,32 @@ py_sha3_new_impl(PyTypeObject *type, PyObject *data, int usedforsecurity)

/* Internal methods for a hash object */

static int
SHA3_clear(SHA3object *self)
{
if (self->hash_state != NULL) {
Hacl_Hash_SHA3_free(self->hash_state);
self->hash_state = NULL;
}
return 0;
}

static void
SHA3_dealloc(SHA3object *self)
{
Hacl_Hash_SHA3_free(self->hash_state);
PyTypeObject *tp = Py_TYPE(self);
PyObject_Free(self);
PyObject_GC_UnTrack(self);
(void)SHA3_clear(self);
tp->tp_free(self);
Py_DECREF(tp);
}

static int
SHA3_traverse(PyObject *self, visitproc visit, void *arg)
{
Py_VISIT(Py_TYPE(self));
return 0;
}

/* External methods for a hash object */

Expand Down Expand Up @@ -335,6 +352,7 @@ static PyObject *
SHA3_get_capacity_bits(SHA3object *self, void *closure)
{
uint32_t rate = Hacl_Hash_SHA3_block_len(self->hash_state) * 8;
assert(rate <= 1600);
int capacity = 1600 - rate;
return PyLong_FromLong(capacity);
}
Expand Down Expand Up @@ -366,12 +384,14 @@ static PyGetSetDef SHA3_getseters[] = {

#define SHA3_TYPE_SLOTS(type_slots_obj, type_doc, type_methods, type_getseters) \
static PyType_Slot type_slots_obj[] = { \
{Py_tp_clear, SHA3_clear}, \
{Py_tp_dealloc, SHA3_dealloc}, \
{Py_tp_traverse, SHA3_traverse}, \
{Py_tp_doc, (char*)type_doc}, \
{Py_tp_methods, type_methods}, \
{Py_tp_getset, type_getseters}, \
{Py_tp_new, py_sha3_new}, \
{0,0} \
{0, NULL} \
}

// Using _PyType_GetModuleState() on these types is safe since they
Expand All @@ -380,7 +400,8 @@ static PyGetSetDef SHA3_getseters[] = {
static PyType_Spec type_spec_obj = { \
.name = "_sha3." type_name, \
.basicsize = sizeof(SHA3object), \
.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_IMMUTABLETYPE, \
.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_IMMUTABLETYPE \
| Py_TPFLAGS_HAVE_GC, \
.slots = type_slots \
}

Expand Down Expand Up @@ -444,9 +465,7 @@ _SHAKE_digest(SHA3object *self, unsigned long digestlen, int hex)
result = PyBytes_FromStringAndSize((const char *)digest,
digestlen);
}
if (digest != NULL) {
PyMem_Free(digest);
}
PyMem_Free(digest);
return result;
}

Expand Down Expand Up @@ -563,7 +582,7 @@ _sha3_clear(PyObject *module)
static void
_sha3_free(void *module)
{
_sha3_clear((PyObject *)module);
(void)_sha3_clear((PyObject *)module);
}

static int
Expand Down
Loading