Fixed #50 - Correctly encode filename length in RequestFileTransfer

Author: pylessard

test/client/test_request_file_transfer.py

@@ -12,7 +12,7 @@ def __init__(self, *args, **kwargs):
 
     def test_add_file_success(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x01\x0b" + "my_file.txt".encode('ascii') + b"\x52\x04\x00\x00\x02\x22\x00\x00\x01\x11")
+        self.assertEqual(request, b"\x38\x01\x00\x0b" + "my_file.txt".encode('ascii') + b"\x52\x04\x00\x00\x02\x22\x00\x00\x01\x11")
         self.conn.fromuserqueue.put(b"\x78\x01\x02\xab\xcd\x52")	# Positive response
 
     def _test_add_file_success(self):
@@ -134,7 +134,7 @@ def _test_add_file_extra_bytes_response_zero_padding_not_ok(self):
 
     def test_delete_file_success(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x02\x0b" + "my_file.txt".encode('ascii'))
+        self.assertEqual(request, b"\x38\x02\x00\x0b" + "my_file.txt".encode('ascii'))
         self.conn.fromuserqueue.put(b"\x78\x02")    # Positive response
 
     def _test_delete_file_success(self):
@@ -221,7 +221,7 @@ def _test_delete_file_extra_bytes_response_zero_padding_not_ok(self):
 
     def test_replace_file_success(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x03\x0b" + "my_file.txt".encode('ascii') + b"\x52\x04\x00\x00\x02\x22\x00\x00\x01\x11")
+        self.assertEqual(request, b"\x38\x03\x00\x0b" + "my_file.txt".encode('ascii') + b"\x52\x04\x00\x00\x02\x22\x00\x00\x01\x11")
         self.conn.fromuserqueue.put(b"\x78\x03\x02\xab\xcd\x52")    # Positive response
 
     def _test_replace_file_success(self):
@@ -360,7 +360,7 @@ def _test_replace_file_extra_bytes_response_zero_padding_not_ok(self):
 
     def test_read_file_success(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x04\x0b" + "my_file.txt".encode('ascii') + b"\x52")
+        self.assertEqual(request, b"\x38\x04\x00\x0b" + "my_file.txt".encode('ascii') + b"\x52")
         self.conn.fromuserqueue.put(b"\x78\x04\x02\xab\xcd\x52\x00\x02\x98\x76\x12\x34")    # Positive response
 
     def _test_read_file_success(self):
@@ -504,7 +504,7 @@ def _test_read_file_extra_bytes_response_zero_padding_not_ok(self):
 
     def test_read_dir_success(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x05\x0c" + "/path/to/dir".encode('ascii'))
+        self.assertEqual(request, b"\x38\x05\x00\x0c" + "/path/to/dir".encode('ascii'))
         self.conn.fromuserqueue.put(b"\x78\x05\x02\xab\xcd\x00\x00\x02\x12\x34")    # Positive response
 
     def _test_read_dir_success(self):
@@ -660,7 +660,7 @@ def _test_wrong_service_reply_no_exception(self):
 
     def test_default_dfi(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x01\x0b" + "my_file.txt".encode('ascii') + b"\x00\x04\x00\x00\x02\x22\x00\x00\x01\x11")
+        self.assertEqual(request, b"\x38\x01\x00\x0b" + "my_file.txt".encode('ascii') + b"\x00\x04\x00\x00\x02\x22\x00\x00\x01\x11")
         self.conn.fromuserqueue.put(b"\x78\x01\x02\xab\xcd\x00")    # Positive response
 
     def _test_default_dfi(self):
@@ -670,23 +670,23 @@ def _test_default_dfi(self):
 
     def test_default_filesize_width(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x01\x0b" + "my_file.txt".encode('ascii') + b"\x00\x02\x02\x22\x01\x11")
+        self.assertEqual(request, b"\x38\x01\x00\x0b" + "my_file.txt".encode('ascii') + b"\x00\x02\x02\x22\x01\x11")
         self.conn.fromuserqueue.put(b"\x78\x01\x02\xab\xcd\x00")    # Positive response
 
     def _test_default_filesize_width(self):
         self.udsclient.request_file_transfer(moop=1, path="my_file.txt", filesize = Filesize(uncompressed=0x222, compressed=0x111))
 
     def test_filesize_no_compressed_size(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x01\x0b" + "my_file.txt".encode('ascii') + b"\x00\x04\x00\x00\x02\x22\x00\x00\x02\x22")
+        self.assertEqual(request, b"\x38\x01\x00\x0b" + "my_file.txt".encode('ascii') + b"\x00\x04\x00\x00\x02\x22\x00\x00\x02\x22")
         self.conn.fromuserqueue.put(b"\x78\x01\x02\xab\xcd\x00")    # Positive response
 
     def _test_filesize_no_compressed_size(self):
         self.udsclient.request_file_transfer(moop=1, path="my_file.txt", filesize = Filesize(uncompressed=0x222, width=4))
 
     def test_filesize_numerical(self):
         request = self.conn.touserqueue.get(timeout=0.2)
-        self.assertEqual(request, b"\x38\x01\x0b" + "my_file.txt".encode('ascii') + b"\x00\x02\x01\x00\x01\x00")
+        self.assertEqual(request, b"\x38\x01\x00\x0b" + "my_file.txt".encode('ascii') + b"\x00\x02\x01\x00\x01\x00")
         self.conn.fromuserqueue.put(b"\x78\x01\x02\xab\xcd\x00")    # Positive response
 
     def _test_filesize_numerical(self):
@@ -704,7 +704,7 @@ def _test_bad_param(self):
         good_filesize = Filesize(uncompressed=0x222, compressed=0x111, width=4)
         good_dfi = DataFormatIdentifier(compression=5, encryption=2)
         with self.assertRaises(ValueError):
-            self.udsclient.request_file_transfer(moop=1, path="a"*256, dfi=good_dfi, filesize = good_filesize)
+            self.udsclient.request_file_transfer(moop=1, path="a"*(2**16), dfi=good_dfi, filesize = good_filesize)
 
         with self.assertRaises(ValueError):
             self.udsclient.request_file_transfer(moop=1, path="", dfi=good_dfi, filesize = good_filesize)

udsoncan/services/RequestFileTransfer.py

@@ -80,8 +80,8 @@ def make_request(cls, moop, path, dfi = None, filesize = None):
             raise ValueError('Path must be a string longer than 0 character')
 
         path_ascii = path.encode('ascii')
-        if len(path_ascii) > 0xFF:
-            raise ValueError('Path length must be smaller or equal than 255 bytes when encoded in ASCII')
+        if len(path_ascii) > 0xFFFF:
+            raise ValueError('Path length must be smaller or equal than 65535  bytes (16 bits) when encoded in ASCII')
 
         use_dfi = moop in [cls.ModeOfOperation.AddFile, cls.ModeOfOperation.ReplaceFile, cls.ModeOfOperation.ReadFile]
         use_filesize = moop in [cls.ModeOfOperation.AddFile, cls.ModeOfOperation.ReplaceFile]
@@ -112,7 +112,7 @@ def make_request(cls, moop, path, dfi = None, filesize = None):
                 raise ValueError('Filesize is not needed with ModeOfOperation=%d' % moop)               
 
         data = moop.to_bytes(1, 'big')
-        data += len(path_ascii).to_bytes(1, 'big')
+        data += len(path_ascii).to_bytes(2, 'big')
         data += path_ascii
         if use_dfi:
             data += dfi.get_byte()