implement HMAC.copy() interface

The internal HACL* state can be agilely copied. Stated otherwise, this only adds a thin wrapper around `Hacl_Streaming_HMAC_copy`
python · picnixz · Apr 4, 2025 · Feb 15, 2025 · Mar 11, 2025 · Mar 12, 2025
commit 6227892259f1d0c887833898e5bf19d6a19b4a93
diff --git a/Modules/clinic/hmacmodule.c.h b/Modules/clinic/hmacmodule.c.h
@@ -590,6 +590,79 @@ has_uint32_t_buffer_length(const Py_buffer *buffer)
 
 // --- HMAC object ------------------------------------------------------------
 
+/*
+ * Copy HMAC hash information from 'src' to 'out'.
+ */
+static void
+hmac_copy_hinfo(HMACObject *out, const HMACObject *src)
+{
+    assert(src->name != NULL);
+    out->name = Py_NewRef(src->name);
+    assert(src->kind != Py_hmac_kind_hash_unknown);
+    out->kind = src->kind;
+    assert(src->block_size <= Py_hmac_hash_max_block_size);
+    out->block_size = src->block_size;
+    assert(src->digest_size <= Py_hmac_hash_max_digest_size);
+    out->digest_size = src->digest_size;
+    assert(src->api.compute != NULL);
+    assert(src->api.compute_py != NULL);
+    out->api = src->api;
+}
+
+/*
+ * Copy the HMAC internal state from 'src' to 'out'.
+ *
+ * The internal state of 'out' must not already exist.
+ *
+ * Return 0 on success and -1 on failure.
+ */
+static int
+hmac_copy_state(HMACObject *out, const HMACObject *src)
+{
+    assert(src->state != NULL);
+    out->state = Hacl_Streaming_HMAC_copy(src->state);
+    if (out->state == NULL) {
+        PyErr_NoMemory();
+        return -1;
+    }
+    return 0;
+}
+
+/*[clinic input]
+_hmac.HMAC.copy
+
+    cls: defining_class
+
+Return a copy ("clone") of the HMAC object.
+[clinic start generated code]*/
+
+static PyObject *
+_hmac_HMAC_copy_impl(HMACObject *self, PyTypeObject *cls)
+/*[clinic end generated code: output=a955bfa55b65b215 input=17b2c0ad0b147e36]*/
+{
+    hmacmodule_state *state = get_hmacmodule_state_by_cls(cls);
+    HMACObject *copy = PyObject_GC_New(HMACObject, state->hmac_type);
+    if (copy == NULL) {
+        return NULL;
+    }
+
+    ENTER_HASHLIB(self);
+    /* copy hash information */
+    hmac_copy_hinfo(copy, self);
+    /* copy internal state */
+    int rc = hmac_copy_state(copy, self);
+    LEAVE_HASHLIB(self);
+
+    if (rc < 0) {
+        Py_DECREF(copy);
+        return NULL;
+    }
+
+    HASHLIB_INIT_MUTEX(copy);
+    PyObject_GC_Track(copy);
+    return (PyObject *)copy;
+}
+
 /*
  * Update the HMAC object with the given buffer.
  *
@@ -806,6 +879,7 @@ HMACObject_traverse(PyObject *op, visitproc visit, void *arg)
 }
 
 static PyMethodDef HMACObject_methods[] = {
+    _HMAC_HMAC_COPY_METHODDEF
     _HMAC_HMAC_UPDATE_METHODDEF
     _HMAC_HMAC_DIGEST_METHODDEF
     _HMAC_HMAC_HEXDIGEST_METHODDEF