align clinic signatures of HACL* hash functions with OpenSSL ones

Author: picnixz

Lib/test/test_hashlib.py

@@ -249,6 +249,11 @@ def test_usedforsecurity_false(self):
             self._hashlib.new("md5", usedforsecurity=False)
             self._hashlib.openssl_md5(usedforsecurity=False)
 
+    def test_clinic_signature(self):
+        for constructor in self.hash_constructors:
+            with self.subTest(constructor):
+                constructor(data=b'')
+
     def test_unknown_hash(self):
         self.assertRaises(ValueError, hashlib.new, 'spam spam spam spam spam')
         self.assertRaises(TypeError, hashlib.new, 1)
@@ -718,7 +723,6 @@ def check_blake2(self, constructor, salt_size, person_size, key_size,
         self.assertRaises(ValueError, constructor, node_offset=-1)
         self.assertRaises(OverflowError, constructor, node_offset=max_offset+1)
 
-        self.assertRaises(TypeError, constructor, data=b'')
         self.assertRaises(TypeError, constructor, string=b'')
         self.assertRaises(TypeError, constructor, '')
 

Misc/NEWS.d/next/Library/2025-05-26-14-04-39.gh-issue-134696.P04xUa.rst

@@ -0,0 +1,5 @@
+Built-in HACL* and OpenSSL implementations of hash function constructors
+now correctly accept the same *documented* named arguments. For instance,
+:func:`~hashlib.md5` could be previously invoked as ``md5(data=data)``
+or ``md5(string=string)`` depending on the underlying implementation
+but these calls were not compatible. Patch by Bénédikt Tran.

Modules/_hashopenssl.c

@@ -1024,7 +1024,7 @@ py_evp_fromname(PyObject *module, const char *digestname, PyObject *data_obj,
 _hashlib.new as EVP_new
 
     name as name_obj: object
-    string as data_obj: object(c_default="NULL") = b''
+    data as data_obj: object(c_default="NULL") = b''
     *
     usedforsecurity: bool = True
 
@@ -1039,7 +1039,7 @@ The MD5 and SHA1 algorithms are always supported.
 static PyObject *
 EVP_new_impl(PyObject *module, PyObject *name_obj, PyObject *data_obj,
              int usedforsecurity)
-/*[clinic end generated code: output=ddd5053f92dffe90 input=c24554d0337be1b0]*/
+/*[clinic end generated code: output=ddd5053f92dffe90 input=fc1f4513bde332d1]*/
 {
     char *name;
     if (!PyArg_Parse(name_obj, "s", &name)) {
@@ -1053,7 +1053,7 @@ EVP_new_impl(PyObject *module, PyObject *name_obj, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_md5
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1064,7 +1064,7 @@ Returns a md5 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_md5_impl(PyObject *module, PyObject *data_obj,
                           int usedforsecurity)
-/*[clinic end generated code: output=87b0186440a44f8c input=990e36d5e689b16e]*/
+/*[clinic end generated code: output=87b0186440a44f8c input=541743b9302c3a1d]*/
 {
     return py_evp_fromname(module, Py_hash_md5, data_obj, usedforsecurity);
 }
@@ -1073,7 +1073,7 @@ _hashlib_openssl_md5_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha1
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1084,7 +1084,7 @@ Returns a sha1 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha1_impl(PyObject *module, PyObject *data_obj,
                            int usedforsecurity)
-/*[clinic end generated code: output=6813024cf690670d input=948f2f4b6deabc10]*/
+/*[clinic end generated code: output=6813024cf690670d input=5cbd1a022f397432]*/
 {
     return py_evp_fromname(module, Py_hash_sha1, data_obj, usedforsecurity);
 }
@@ -1093,7 +1093,7 @@ _hashlib_openssl_sha1_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha224
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1104,7 +1104,7 @@ Returns a sha224 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha224_impl(PyObject *module, PyObject *data_obj,
                              int usedforsecurity)
-/*[clinic end generated code: output=a2dfe7cc4eb14ebb input=f9272821fadca505]*/
+/*[clinic end generated code: output=a2dfe7cc4eb14ebb input=9d70f1b767e0da1a]*/
 {
     return py_evp_fromname(module, Py_hash_sha224, data_obj, usedforsecurity);
 }
@@ -1113,7 +1113,7 @@ _hashlib_openssl_sha224_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha256
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1124,7 +1124,7 @@ Returns a sha256 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha256_impl(PyObject *module, PyObject *data_obj,
                              int usedforsecurity)
-/*[clinic end generated code: output=1f874a34870f0a68 input=549fad9d2930d4c5]*/
+/*[clinic end generated code: output=1f874a34870f0a68 input=6baf2fb84aa40b28]*/
 {
     return py_evp_fromname(module, Py_hash_sha256, data_obj, usedforsecurity);
 }
@@ -1133,7 +1133,7 @@ _hashlib_openssl_sha256_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha384
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1144,7 +1144,7 @@ Returns a sha384 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha384_impl(PyObject *module, PyObject *data_obj,
                              int usedforsecurity)
-/*[clinic end generated code: output=58529eff9ca457b2 input=48601a6e3bf14ad7]*/
+/*[clinic end generated code: output=58529eff9ca457b2 input=416c85fc491fd51a]*/
 {
     return py_evp_fromname(module, Py_hash_sha384, data_obj, usedforsecurity);
 }
@@ -1153,7 +1153,7 @@ _hashlib_openssl_sha384_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha512
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1164,7 +1164,7 @@ Returns a sha512 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha512_impl(PyObject *module, PyObject *data_obj,
                              int usedforsecurity)
-/*[clinic end generated code: output=2c744c9e4a40d5f6 input=c5c46a2a817aa98f]*/
+/*[clinic end generated code: output=2c744c9e4a40d5f6 input=db07e145351f0eb3]*/
 {
     return py_evp_fromname(module, Py_hash_sha512, data_obj, usedforsecurity);
 }
@@ -1175,7 +1175,7 @@ _hashlib_openssl_sha512_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_sha3_224
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1186,15 +1186,15 @@ Returns a sha3-224 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha3_224_impl(PyObject *module, PyObject *data_obj,
                                int usedforsecurity)
-/*[clinic end generated code: output=144641c1d144b974 input=e3a01b2888916157]*/
+/*[clinic end generated code: output=144641c1d144b974 input=8473784706f2bcfa]*/
 {
     return py_evp_fromname(module, Py_hash_sha3_224, data_obj, usedforsecurity);
 }
 
 /*[clinic input]
 _hashlib.openssl_sha3_256
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1205,15 +1205,15 @@ Returns a sha3-256 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha3_256_impl(PyObject *module, PyObject *data_obj,
                                int usedforsecurity)
-/*[clinic end generated code: output=c61f1ab772d06668 input=e2908126c1b6deed]*/
+/*[clinic end generated code: output=c61f1ab772d06668 input=2c0433e4af5389af]*/
 {
     return py_evp_fromname(module, Py_hash_sha3_256, data_obj , usedforsecurity);
 }
 
 /*[clinic input]
 _hashlib.openssl_sha3_384
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1224,15 +1224,15 @@ Returns a sha3-384 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha3_384_impl(PyObject *module, PyObject *data_obj,
                                int usedforsecurity)
-/*[clinic end generated code: output=f68e4846858cf0ee input=ec0edf5c792f8252]*/
+/*[clinic end generated code: output=f68e4846858cf0ee input=15cf1a0f31210933]*/
 {
     return py_evp_fromname(module, Py_hash_sha3_384, data_obj , usedforsecurity);
 }
 
 /*[clinic input]
 _hashlib.openssl_sha3_512
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1243,7 +1243,7 @@ Returns a sha3-512 hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_sha3_512_impl(PyObject *module, PyObject *data_obj,
                                int usedforsecurity)
-/*[clinic end generated code: output=2eede478c159354a input=64e2cc0c094d56f4]*/
+/*[clinic end generated code: output=2eede478c159354a input=3c49cbee1c406eb8]*/
 {
     return py_evp_fromname(module, Py_hash_sha3_512, data_obj , usedforsecurity);
 }
@@ -1253,7 +1253,7 @@ _hashlib_openssl_sha3_512_impl(PyObject *module, PyObject *data_obj,
 /*[clinic input]
 _hashlib.openssl_shake_128
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1264,15 +1264,15 @@ Returns a shake-128 variable hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_shake_128_impl(PyObject *module, PyObject *data_obj,
                                 int usedforsecurity)
-/*[clinic end generated code: output=bc49cdd8ada1fa97 input=6c9d67440eb33ec8]*/
+/*[clinic end generated code: output=bc49cdd8ada1fa97 input=ee01cb8679a1e230]*/
 {
     return py_evp_fromname(module, Py_hash_shake_128, data_obj , usedforsecurity);
 }
 
 /*[clinic input]
 _hashlib.openssl_shake_256
 
-    string as data_obj: object(py_default="b''") = NULL
+    data as data_obj: object(py_default="b''") = NULL
     *
     usedforsecurity: bool = True
 
@@ -1283,7 +1283,7 @@ Returns a shake-256 variable hash object; optionally initialized with a string
 static PyObject *
 _hashlib_openssl_shake_256_impl(PyObject *module, PyObject *data_obj,
                                 int usedforsecurity)
-/*[clinic end generated code: output=358d213be8852df7 input=479cbe9fefd4a9f8]*/
+/*[clinic end generated code: output=358d213be8852df7 input=92e304b3733f14c8]*/
 {
     return py_evp_fromname(module, Py_hash_shake_256, data_obj , usedforsecurity);
 }

Modules/blake2module.c

@@ -656,7 +656,6 @@ py_blake2b_or_s_new(PyTypeObject *type, PyObject *data, int digest_size,
 @classmethod
 _blake2.blake2b.__new__ as py_blake2b_new
     data: object(c_default="NULL") = b''
-    /
     *
     digest_size: int(c_default="HACL_HASH_BLAKE2B_OUT_BYTES") = _blake2.blake2b.MAX_DIGEST_SIZE
     key: Py_buffer(c_default="NULL", py_default="b''") = None
@@ -680,7 +679,7 @@ py_blake2b_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
                     int fanout, int depth, unsigned long leaf_size,
                     unsigned long long node_offset, int node_depth,
                     int inner_size, int last_node, int usedforsecurity)
-/*[clinic end generated code: output=32bfd8f043c6896f input=8fee2b7b11428b2d]*/
+/*[clinic end generated code: output=32bfd8f043c6896f input=02d342d22847290e]*/
 {
     return py_blake2b_or_s_new(type, data, digest_size, key, salt, person, fanout, depth, leaf_size, node_offset, node_depth, inner_size, last_node, usedforsecurity);
 }
@@ -689,7 +688,6 @@ py_blake2b_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
 @classmethod
 _blake2.blake2s.__new__ as py_blake2s_new
     data: object(c_default="NULL") = b''
-    /
     *
     digest_size: int(c_default="HACL_HASH_BLAKE2S_OUT_BYTES") = _blake2.blake2s.MAX_DIGEST_SIZE
     key: Py_buffer(c_default="NULL", py_default="b''") = None
@@ -713,7 +711,7 @@ py_blake2s_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
                     int fanout, int depth, unsigned long leaf_size,
                     unsigned long long node_offset, int node_depth,
                     int inner_size, int last_node, int usedforsecurity)
-/*[clinic end generated code: output=556181f73905c686 input=8165a11980eac7f3]*/
+/*[clinic end generated code: output=556181f73905c686 input=d88d8c06e859b073]*/
 {
     return py_blake2b_or_s_new(type, data, digest_size, key, salt, person, fanout, depth, leaf_size, node_offset, node_depth, inner_size, last_node, usedforsecurity);
 }