From 8bc76761620397231275ae40c464e9a77777372d Mon Sep 17 00:00:00 2001
From: Jari Nippula <jari.nippula@tii.ae>
Date: Tue, 19 Nov 2024 14:16:40 +0200
Subject: [PATCH] Tools/decrypt_ulog.py: support for .ulge log files

---
 Tools/decrypt_ulog.py | 69 +++++++++++++++++++++++++++++++------------
 1 file changed, 50 insertions(+), 19 deletions(-)

diff --git a/Tools/decrypt_ulog.py b/Tools/decrypt_ulog.py
index f6d888c56b62..982d1a2bcf4e 100755
--- a/Tools/decrypt_ulog.py
+++ b/Tools/decrypt_ulog.py
@@ -1,62 +1,93 @@
 #!/usr/bin/env python3
 
+#from pathlib import Path
+import sys
+
+try:
+    from Crypto.Cipher import ChaCha20
+except ImportError as e:
+    print("Failed to import crypto: " + str(e))
+    print("")
+    print("You may need to install it using:")
+    print("    pip3 install --user pycryptodome")
+    print("")
+    sys.exit(1)
+
 from Crypto.PublicKey import RSA
 from Crypto.Cipher import PKCS1_OAEP
-from Crypto.Cipher import ChaCha20
 from Crypto.Hash import SHA256
-import binascii
+from pathlib import Path
 import argparse
-#from pathlib import Path
-import sys
+#import binascii
+
 
 if __name__ == "__main__":
 
     parser = argparse.ArgumentParser(description="""CLI tool to decrypt an ulog file\n""")
-    parser.add_argument("ulog_file", help=".ulog file", nargs='?', default=None)
-    parser.add_argument("ulog_key", help=".ulogk, encrypted key", nargs='?', default=None)
+    parser.add_argument("ulog_file", help=".ulge/.ulgc, encrypted log file", nargs='?', default=None)
+    parser.add_argument("ulog_key", help=".ulgk, legacy encrypted key (give empty string '' to ignore for .ulge)", nargs='?', default=None)
     parser.add_argument("rsa_key", help=".pem format key for decrypting the ulog key", nargs='?', default=None)
 
     args = parser.parse_args()
 
-    # Only generate a key pair, don't sign
-    if not args.ulog_file or not args.ulog_key or not args.rsa_key:
-        print('Need all arguments, the encrypted ulog file, the key and the key decryption key')
-        sys.exit(1);
+    # Check all arguments are given
+    if not args.rsa_key:
+        print('Need all arguments, the encrypted ulog file, key file (or empty string if not needed) and the key decryption key (.pem)')
+        sys.exit(1)
 
     # Read the private RSA key to decrypt the cahcha key
     with open(args.rsa_key, 'rb') as f:
         r = RSA.importKey(f.read(), passphrase='')
 
-    # Read the encrypted xchacha key and the nonce
-    with open(args.ulog_key, 'rb') as f:
+    if args.ulog_key == "":
+        key_data_filename = args.ulog_file
+        magic = "ULogEnc"
+    else:
+        key_data_filename = args.ulog_key
+        magic = "ULogKey"
+
+    with open(key_data_filename, 'rb') as f:
+        # Read the encrypted xchacha key and the nonce
         ulog_key_header = f.read(22)
 
         # Parse the header
         try:
             # magic
-            if not ulog_key_header.startswith(bytearray("ULogKey".encode())):
+            if not ulog_key_header.startswith(bytearray(magic.encode())):
+                print("Incorrect header magic")
                 raise Exception()
             # version
             if ulog_key_header[7] != 1:
+                print("Unsupported header version")
                 raise Exception()
             # expected key exchange algorithm (RSA_OAEP)
             if ulog_key_header[16] != 4:
+                print("Unsupported key algorithm")
                 raise Exception()
-            key_size = ulog_key_header[19] << 8 | ulog_key_header[18];
-            nonce_size = ulog_key_header[21] << 8 | ulog_key_header[20];
+            key_size = ulog_key_header[19] << 8 | ulog_key_header[18]
+            nonce_size = ulog_key_header[21] << 8 | ulog_key_header[20]
             ulog_key_cipher = f.read(key_size)
             nonce = f.read(nonce_size)
         except:
-            print("Keyfile format error")
-            sys.exit(1);
+            print("Keydata format error")
+            sys.exit(1)
+
+    if magic == "ULogEnc":
+        data_offset = 22 + key_size + nonce_size
+    else:
+        data_offset = 0
 
     # Decrypt the xchacha key
     cipher_rsa = PKCS1_OAEP.new(r,SHA256)
     ulog_key = cipher_rsa.decrypt(ulog_key_cipher)
     #print(binascii.hexlify(ulog_key))
 
-    # Read and decrypt the .ulgc
+    # Read and decrypt the ulog data
     cipher = ChaCha20.new(key=ulog_key, nonce=nonce)
+
+    outfilename = Path(args.ulog_file).stem + ".ulog"
     with open(args.ulog_file, 'rb') as f:
-        with open(args.ulog_file.rstrip(args.ulog_file[-1]), 'wb') as out:
+        if data_offset > 0:
+            f.seek(data_offset)
+        with open(outfilename, 'wb') as out:
             out.write(cipher.decrypt(f.read()))