Skip to content

bpo-1635741: port blake2 module to multi-phase init #21856

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 11 commits into from
Sep 2, 2020
+119 −118
Merged

bpo-1635741: port blake2 module to multi-phase init #21856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
dce777f
port blake2
koubaa Aug 10, 2020
88d58ff
blurb
koubaa Aug 13, 2020
00a468c
decref the type
koubaa Aug 13, 2020
0be5d6c
respond to review
koubaa Aug 13, 2020
abb51fe
add comment
koubaa Aug 21, 2020
6f6a254
fix use-after-free
Aug 28, 2020
4b2e87f
add traverse, clear, and free slots
koubaa Aug 28, 2020
c0533a5
fix some typos
koubaa Aug 28, 2020
033e59d
pep7 & improve dealloc
koubaa Aug 29, 2020
1fe0fa2
fix issues
koubaa Aug 29, 2020
d63f02c
update news
koubaa Sep 1, 2020
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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2020-08-13-07-18-05.bpo-1635741.FC13e7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Port the :mod:`_blake2` extension module to the multi-phase initialization API (:pep:`489`).
57 changes: 17 additions & 40 deletions Modules/_blake2/blake2b_impl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#endif


extern PyTypeObject PyBlake2_BLAKE2bType;
extern PyType_Spec blake2b_type_spec;

typedef struct {
PyObject_HEAD
Expand Down Expand Up @@ -391,47 +391,24 @@ py_blake2b_dealloc(PyObject *self)
PyThread_free_lock(obj->lock);
obj->lock = NULL;
}

PyTypeObject *type = Py_TYPE(self);
PyObject_Del(self);
Py_DECREF(type);
}

static PyType_Slot blake2b_type_slots[] = {
{Py_tp_dealloc, py_blake2b_dealloc},
{Py_tp_doc, (char *)py_blake2b_new__doc__},
{Py_tp_methods, py_blake2b_methods},
{Py_tp_getset, py_blake2b_getsetters},
{Py_tp_new, py_blake2b_new},
{0,0}
};

PyTypeObject PyBlake2_BLAKE2bType = {
PyVarObject_HEAD_INIT(NULL, 0)
"_blake2.blake2b", /* tp_name */
sizeof(BLAKE2bObject), /* tp_basicsize */
0, /* tp_itemsize */
py_blake2b_dealloc, /* tp_dealloc */
0, /*tp_vectorcall_offset*/
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_as_async */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT, /* tp_flags */
py_blake2b_new__doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
py_blake2b_methods, /* tp_methods */
0, /* tp_members */
py_blake2b_getsetters, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
py_blake2b_new, /* tp_new */
PyType_Spec blake2b_type_spec = {
.name = "_blake2.blake2b",
.basicsize = sizeof(BLAKE2bObject),
.flags = Py_TPFLAGS_DEFAULT,
.slots = blake2b_type_slots
};
121 changes: 84 additions & 37 deletions Modules/_blake2/blake2module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,62 +12,81 @@

#include "impl/blake2.h"

extern PyTypeObject PyBlake2_BLAKE2bType;
extern PyTypeObject PyBlake2_BLAKE2sType;

extern PyType_Spec blake2b_type_spec;
extern PyType_Spec blake2s_type_spec;

PyDoc_STRVAR(blake2mod__doc__,
"_blake2b provides BLAKE2b for hashlib\n"
);

typedef struct {
PyTypeObject* blake2b_type;
PyTypeObject* blake2s_type;
} Blake2State;

static inline Blake2State*
blake2_get_state(PyObject *module)
{
void *state = PyModule_GetState(module);
assert(state != NULL);
return (Blake2State *)state;
}

static struct PyMethodDef blake2mod_functions[] = {
{NULL, NULL}
};

static struct PyModuleDef blake2_module = {
PyModuleDef_HEAD_INIT,
"_blake2",
blake2mod__doc__,
-1,
blake2mod_functions,
NULL,
NULL,
NULL,
NULL
};
static int
_blake2_traverse(PyObject *module, visitproc visit, void *arg)
{
Blake2State *state = blake2_get_state(module);
Py_VISIT(state->blake2b_type);
Py_VISIT(state->blake2s_type);
return 0;
}

static int
_blake2_clear(PyObject *module)
{
Blake2State *state = blake2_get_state(module);
Py_CLEAR(state->blake2b_type);
Py_CLEAR(state->blake2s_type);
return 0;
}

static void
_blake2_free(void *module)
{
_blake2_clear((PyObject *)module);
}

#define ADD_INT(d, name, value) do { \
PyObject *x = PyLong_FromLong(value); \
if (!x) { \
Py_DECREF(m); \
return NULL; \
} \
if (!x) \
return -1; \
if (PyDict_SetItemString(d, name, x) < 0) { \
Py_DECREF(m); \
return NULL; \
Py_DECREF(x); \
return -1; \
} \
Py_DECREF(x); \
} while(0)


PyMODINIT_FUNC
PyInit__blake2(void)
static int
blake2_exec(PyObject *m)
{
PyObject *m;
PyObject *d;
Blake2State* st = blake2_get_state(m);

m = PyModule_Create(&blake2_module);
if (m == NULL)
return NULL;
st->blake2b_type = (PyTypeObject *)PyType_FromModuleAndSpec(
m, &blake2b_type_spec, NULL);

if (NULL == st->blake2b_type)
return -1;
/* BLAKE2b */
Py_SET_TYPE(&PyBlake2_BLAKE2bType, &PyType_Type);
if (PyModule_AddType(m, &PyBlake2_BLAKE2bType) < 0) {
return NULL;
if (PyModule_AddType(m, st->blake2b_type) < 0) {
return -1;
}

d = PyBlake2_BLAKE2bType.tp_dict;
PyObject *d = st->blake2b_type->tp_dict;
ADD_INT(d, "SALT_SIZE", BLAKE2B_SALTBYTES);
ADD_INT(d, "PERSON_SIZE", BLAKE2B_PERSONALBYTES);
ADD_INT(d, "MAX_KEY_SIZE", BLAKE2B_KEYBYTES);
Expand All @@ -79,12 +98,17 @@ PyInit__blake2(void)
PyModule_AddIntConstant(m, "BLAKE2B_MAX_DIGEST_SIZE", BLAKE2B_OUTBYTES);

/* BLAKE2s */
Py_SET_TYPE(&PyBlake2_BLAKE2sType, &PyType_Type);
if (PyModule_AddType(m, &PyBlake2_BLAKE2sType) < 0) {
return NULL;
st->blake2s_type = (PyTypeObject *)PyType_FromModuleAndSpec(
m, &blake2s_type_spec, NULL);

if (NULL == st->blake2s_type)
return -1;

if (PyModule_AddType(m, st->blake2s_type) < 0) {
return -1;
}

d = PyBlake2_BLAKE2sType.tp_dict;
d = st->blake2s_type->tp_dict;
ADD_INT(d, "SALT_SIZE", BLAKE2S_SALTBYTES);
ADD_INT(d, "PERSON_SIZE", BLAKE2S_PERSONALBYTES);
ADD_INT(d, "MAX_KEY_SIZE", BLAKE2S_KEYBYTES);
Expand All @@ -95,5 +119,28 @@ PyInit__blake2(void)
PyModule_AddIntConstant(m, "BLAKE2S_MAX_KEY_SIZE", BLAKE2S_KEYBYTES);
PyModule_AddIntConstant(m, "BLAKE2S_MAX_DIGEST_SIZE", BLAKE2S_OUTBYTES);

return m;
return 0;
}

static PyModuleDef_Slot _blake2_slots[] = {
{Py_mod_exec, blake2_exec},
{0, NULL}
};

static struct PyModuleDef blake2_module = {
PyModuleDef_HEAD_INIT,
"_blake2",
.m_doc = blake2mod__doc__,
.m_size = sizeof(Blake2State),
.m_methods = blake2mod_functions,
.m_slots = _blake2_slots,
.m_traverse = _blake2_traverse,
.m_clear = _blake2_clear,
.m_free = _blake2_free,
};

PyMODINIT_FUNC
PyInit__blake2(void)
{
return PyModuleDef_Init(&blake2_module);
}
58 changes: 17 additions & 41 deletions Modules/_blake2/blake2s_impl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
#include "impl/blake2s-ref.c"
#endif


extern PyTypeObject PyBlake2_BLAKE2sType;
extern PyType_Spec blake2s_type_spec;

typedef struct {
PyObject_HEAD
Expand Down Expand Up @@ -391,47 +390,24 @@ py_blake2s_dealloc(PyObject *self)
PyThread_free_lock(obj->lock);
obj->lock = NULL;
}

PyTypeObject *type = Py_TYPE(self);
PyObject_Del(self);
Py_DECREF(type);
}

static PyType_Slot blake2s_type_slots[] = {
{Py_tp_dealloc, py_blake2s_dealloc},
{Py_tp_doc, (char *)py_blake2s_new__doc__},
{Py_tp_methods, py_blake2s_methods},
{Py_tp_getset, py_blake2s_getsetters},
{Py_tp_new, py_blake2s_new},
{0,0}
};

PyTypeObject PyBlake2_BLAKE2sType = {
PyVarObject_HEAD_INIT(NULL, 0)
"_blake2.blake2s", /* tp_name */
sizeof(BLAKE2sObject), /* tp_basicsize */
0, /* tp_itemsize */
py_blake2s_dealloc, /* tp_dealloc */
0, /*tp_vectorcall_offset*/
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_as_async */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT, /* tp_flags */
py_blake2s_new__doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
py_blake2s_methods, /* tp_methods */
0, /* tp_members */
py_blake2s_getsetters, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
py_blake2s_new, /* tp_new */
PyType_Spec blake2s_type_spec = {
.name = "_blake2.blake2s",
.basicsize = sizeof(BLAKE2sObject),
.flags = Py_TPFLAGS_DEFAULT,
.slots = blake2s_type_slots
};