Rename sources to sources_hash

Use blake2 over md5

Author: kageurufu

.gitignore

@@ -5,8 +5,8 @@ out
 __pycache__/
 .config
 .config.old
+.sources
 klippy/.version
-klippy/.sources
 .history/
 .DS_Store
 ci_build/

klippy/mcu.py

@@ -1191,6 +1191,7 @@ def _mcu_identify(self):
                 raise error(str(e))
         if get_danger_options().log_startup_info:
             logging.info(self._log_info())
+        pconfig = self._printer.lookup_object("configfile")
         ppins = self._printer.lookup_object("pins")
         pin_resolver = ppins.get_pin_resolver(self._name)
         for cname, value in self.get_constants().items():
@@ -1214,25 +1215,25 @@ def _mcu_identify(self):
             )
         app = msgparser.get_app_info()
         version, build_versions = msgparser.get_version_info()
-        sources = msgparser.get_sources_hash()
+        sources_hash = msgparser.get_sources_hash()
         self._get_status_info["app"] = app
         self._get_status_info["mcu_version"] = version
         self._get_status_info["mcu_build_versions"] = build_versions
-        self._get_status_info["mcu_sources"] = sources
+        self._get_status_info["mcu_sources_hash"] = sources_hash
         self._get_status_info["mcu_constants"] = msgparser.get_constants()
         if app in ("Klipper", "Danger-Klipper"):
-            pconfig = self._printer.lookup_object("configfile")
             pconfig.runtime_warning(
                 f"MCU {self._name!r} currently has firmware compiled for {app} (version {version})."
                 f" It is recommended to re-flash for best compatiblity with Kalico"
             )
         elif (
             get_danger_options().warn_on_mismatched_firmware_sources
-            and sources != self._printer.get_start_args().get("sources_hash")
+            and sources_hash
+            != self._printer.get_start_args().get("sources_hash")
         ):
-            pconfig = self._printer.lookup_object("configfile")
             pconfig.runtime_warning(
-                f"MCU {self._name!r} firmware is out of date, it will still work but an update is recommended"
+                f"MCU {self._name!r} firmware is out of date and may not function as intended."
+                f" Please re-flash as soon as possible"
             )
         self.register_response(self._handle_shutdown, "shutdown")
         self.register_response(self._handle_shutdown, "is_shutdown")

klippy/msgproto.py

@@ -488,7 +488,7 @@ def process_identify(self, data, decompress=True):
             self.app = data.get("app", "")
             self.version = data.get("version", "")
             self.build_versions = data.get("build_versions", "")
-            self.sources = data.get("sources", "unknown")
+            self.sources_hash = data.get("sources_hash", "unknown")
         except error as e:
             raise
         except Exception as e:
@@ -505,7 +505,7 @@ def get_version_info(self):
         return self.version, self.build_versions
 
     def get_sources_hash(self):
-        return self.sources
+        return self.sources_hash
 
     def get_messages(self):
         return list(self.messages)

klippy/util.py

@@ -4,17 +4,17 @@
 #
 # This file may be distributed under the terms of the GNU GPLv3 license.
 import fcntl
+import hashlib
 import json
 import logging
 import os
+import pathlib
 import pty
 import signal
 import subprocess
 import termios
 import time
 import traceback
-import pathlib
-import hashlib
 
 ######################################################################
 # Low-level Unix commands
@@ -257,20 +257,19 @@ def get_git_version(from_file=True):
 
 
 def get_firmware_hash():
-    klippy_dir = pathlib.Path(__file__).parent
-    root_dir = klippy_dir.parent
-    hash_cache = klippy_dir / ".sources"
-    sources = sorted(
+    root_dir = pathlib.Path(__file__).parent.parent
+    hash_cache = root_dir / ".sources"
+    source_files = sorted(
         file
         for path in (root_dir / "src", root_dir / "lib")
         for file in path.glob("**/*")
         if file.is_file()
     )
-    last_modified = max(file.stat().st_mtime for file in sources)
+    last_modified = max(file.stat().st_mtime for file in source_files)
     if hash_cache.is_file() and hash_cache.stat().st_mtime >= last_modified:
         return hash_cache.read_text()
-    hash = hashlib.md5()
-    for file in sources:
+    hash = hashlib.blake2b(digest_size=16, usedforsecurity=False)
+    for file in source_files:
         hash.update(b"\x00" + bytes(file.relative_to(root_dir)) + b"\x00")
         hash.update(file.read_bytes())
     digest = hash.hexdigest()

scripts/buildcommands.py

@@ -652,14 +652,14 @@ def update_data_dictionary(self, data):
         data["build_versions"] = self.toolstr
         data["app"] = "Kalico"
         data["license"] = "GNU GPLv3"
-        data["sources"] = self.sources
+        data["sources_hash"] = self.sources
 
     def generate_code(self, options):
         cleanbuild, self.toolstr = tool_versions(options.tools)
         self.version = build_version(options.extra, cleanbuild)
         self.sources = get_firmware_hash()
         sys.stdout.write("Version: %s\n" % (self.version,))
-        sys.stdout.write("Sources: %s\n" % (self.sources,))
+        sys.stdout.write("Sources Hash: %s\n" % (self.sources,))
         return "\n// version: %s\n// build_versions: %s\n// sources: %s\n" % (
             self.version,
             self.toolstr,