bpo-31933: fix blake2 multi-byte params on big endian platforms (#4250)

oconnor663 · tiran · commit dcfb0e3c04f1 · 2017-11-03T20:02:41.000+01:00
All Blake2 params have to be encoded in little-endian byte order. For the two multi-byte integer params, leaf_length and node_offset, that means that assigning a native-endian integer to them appears to work on little-endian platforms, but gives the wrong result on big-endian. The current libb2 API doesn't make that very clear, and @sneves is working on new API functions in the GH issue above. In the meantime, we can work around the problem by explicitly assigning little-endian values to the parameter block. See BLAKE2/libb2#12.
diff --git a/Lib/test/test_hashlib.py b/Lib/test/test_hashlib.py
@@ -615,6 +615,24 @@ def test_case_blake2b_1(self):
           "ba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d1"+
           "7d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923")
 
+    @requires_blake2
+    def test_case_blake2b_all_parameters(self):
+        # This checks that all the parameters work in general, and also that
+        # parameter byte order doesn't get confused on big endian platforms.
+        self.check('blake2b', b"foo",
+          "920568b0c5873b2f0ab67bedb6cf1b2b",
+          digest_size=16,
+          key=b"bar",
+          salt=b"baz",
+          person=b"bing",
+          fanout=2,
+          depth=3,
+          leaf_size=4,
+          node_offset=5,
+          node_depth=6,
+          inner_size=7,
+          last_node=True)
+
     @requires_blake2
     def test_blake2b_vectors(self):
         for msg, key, md in read_vectors('blake2b'):
@@ -640,6 +658,24 @@ def test_case_blake2s_1(self):
         self.check('blake2s', b"abc",
           "508c5e8c327c14e2e1a72ba34eeb452f37458b209ed63a294d999b4c86675982")
 
+    @requires_blake2
+    def test_case_blake2s_all_parameters(self):
+        # This checks that all the parameters work in general, and also that
+        # parameter byte order doesn't get confused on big endian platforms.
+        self.check('blake2s', b"foo",
+          "bf2a8f7fe3c555012a6f8046e646bc75",
+          digest_size=16,
+          key=b"bar",
+          salt=b"baz",
+          person=b"bing",
+          fanout=2,
+          depth=3,
+          leaf_size=4,
+          node_offset=5,
+          node_depth=6,
+          inner_size=7,
+          last_node=True)
+
     @requires_blake2
     def test_blake2s_vectors(self):
         for msg, key, md in read_vectors('blake2s'):
diff --git a/Misc/NEWS.d/next/Library/2017-11-03-08-36-03.bpo-31933.UrtoMP.rst b/Misc/NEWS.d/next/Library/2017-11-03-08-36-03.bpo-31933.UrtoMP.rst
@@ -0,0 +1,2 @@
+Fix Blake2 params leaf_size and node_offset on big endian platforms. Patch
+by Jack O'Connor.
diff --git a/Modules/_blake2/blake2b_impl.c b/Modules/_blake2/blake2b_impl.c
@@ -162,7 +162,8 @@ py_blake2b_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
             goto error;
         }
     }
-    self->param.leaf_length = (unsigned int)leaf_size;
+    // NB: Simple assignment here would be incorrect on big endian platforms.
+    store32(&(self->param.leaf_length), leaf_size);
 
     if (node_offset_obj != NULL) {
         node_offset = PyLong_AsUnsignedLongLong(node_offset_obj);
@@ -178,7 +179,8 @@ py_blake2b_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
      }
     store48(&(self->param.node_offset), node_offset);
 #else
-    self->param.node_offset = node_offset;
+    // NB: Simple assignment here would be incorrect on big endian platforms.
+    store64(&(self->param.node_offset), node_offset);
 #endif
 
     if (node_depth < 0 || node_depth > 255) {
diff --git a/Modules/_blake2/blake2s_impl.c b/Modules/_blake2/blake2s_impl.c
@@ -162,7 +162,8 @@ py_blake2s_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
             goto error;
         }
     }
-    self->param.leaf_length = (unsigned int)leaf_size;
+    // NB: Simple assignment here would be incorrect on big endian platforms.
+    store32(&(self->param.leaf_length), leaf_size);
 
     if (node_offset_obj != NULL) {
         node_offset = PyLong_AsUnsignedLongLong(node_offset_obj);
@@ -178,7 +179,8 @@ py_blake2s_new_impl(PyTypeObject *type, PyObject *data, int digest_size,
      }
     store48(&(self->param.node_offset), node_offset);
 #else
-    self->param.node_offset = node_offset;
+    // NB: Simple assignment here would be incorrect on big endian platforms.
+    store64(&(self->param.node_offset), node_offset);
 #endif
 
     if (node_depth < 0 || node_depth > 255) {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Fix Blake2 params leaf_size and node_offset on big endian platforms. Patch`
	`2`	`+by Jack O'Connor.`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,8 @@ py_blake2b_new_impl(PyTypeObject type, PyObject data, int digest_size,`
`162`	`162`	`goto error;`
`163`	`163`	`}`
`164`	`164`	`}`
`165`		`- self->param.leaf_length = (unsigned int)leaf_size;`
	`165`	`+ // NB: Simple assignment here would be incorrect on big endian platforms.`
	`166`	`+ store32(&(self->param.leaf_length), leaf_size);`
`166`	`167`
`167`	`168`	`if (node_offset_obj != NULL) {`
`168`	`169`	`node_offset = PyLong_AsUnsignedLongLong(node_offset_obj);`
`@@ -178,7 +179,8 @@ py_blake2b_new_impl(PyTypeObject type, PyObject data, int digest_size,`
`178`	`179`	`}`
`179`	`180`	`store48(&(self->param.node_offset), node_offset);`
`180`	`181`	`#else`
`181`		`- self->param.node_offset = node_offset;`
	`182`	`+ // NB: Simple assignment here would be incorrect on big endian platforms.`
	`183`	`+ store64(&(self->param.node_offset), node_offset);`
`182`	`184`	`#endif`
`183`	`185`
`184`	`186`	`if (node_depth < 0 \|\| node_depth > 255) {`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,8 @@ py_blake2s_new_impl(PyTypeObject type, PyObject data, int digest_size,`
`162`	`162`	`goto error;`
`163`	`163`	`}`
`164`	`164`	`}`
`165`		`- self->param.leaf_length = (unsigned int)leaf_size;`
	`165`	`+ // NB: Simple assignment here would be incorrect on big endian platforms.`
	`166`	`+ store32(&(self->param.leaf_length), leaf_size);`
`166`	`167`
`167`	`168`	`if (node_offset_obj != NULL) {`
`168`	`169`	`node_offset = PyLong_AsUnsignedLongLong(node_offset_obj);`
`@@ -178,7 +179,8 @@ py_blake2s_new_impl(PyTypeObject type, PyObject data, int digest_size,`
`178`	`179`	`}`
`179`	`180`	`store48(&(self->param.node_offset), node_offset);`
`180`	`181`	`#else`
`181`		`- self->param.node_offset = node_offset;`
	`182`	`+ // NB: Simple assignment here would be incorrect on big endian platforms.`
	`183`	`+ store64(&(self->param.node_offset), node_offset);`
`182`	`184`	`#endif`
`183`	`185`
`184`	`186`	`if (node_depth < 0 \|\| node_depth > 255) {`