From c62c0809d221794e9e2f8235268d4d18957152c7 Mon Sep 17 00:00:00 2001
From: George Tsiamasiotis <gtsiam@windowslive.com>
Date: Wed, 18 Sep 2024 09:09:53 +0300
Subject: [PATCH] Security theatre: Use yaml.load() in one place.

CodeQL complains when you use yaml.load() with custom loaders.
This will at least get it to stfu whenever our custom loader is used.
---
 frigate/config.py           | 7 +++----
 frigate/test/test_config.py | 7 ++-----
 frigate/util/builtin.py     | 4 ++++
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/frigate/config.py b/frigate/config.py
index af3ed0753..357f21ec0 100644
--- a/frigate/config.py
+++ b/frigate/config.py
@@ -9,7 +9,6 @@ from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import numpy as np
-import yaml
 from pydantic import (
     BaseModel,
     ConfigDict,
@@ -42,11 +41,11 @@ from frigate.ffmpeg_presets import (
 )
 from frigate.plus import PlusApi
 from frigate.util.builtin import (
-    NoDuplicateKeysLoader,
     deep_merge,
     escape_special_characters,
     generate_color_palette,
     get_ffmpeg_arg_list,
+    load_yaml,
 )
 from frigate.util.config import StreamInfoRetriever, get_relative_coordinates
 from frigate.util.image import create_mask
@@ -1765,7 +1764,7 @@ class FrigateConfig(FrigateBaseModel):
             raw_config = f.read()
 
         if config_file.endswith(YAML_EXT):
-            config = yaml.load(raw_config, NoDuplicateKeysLoader)
+            config = load_yaml(raw_config)
         elif config_file.endswith(".json"):
             config = json.loads(raw_config)
 
@@ -1773,5 +1772,5 @@ class FrigateConfig(FrigateBaseModel):
 
     @classmethod
     def parse_raw(cls, raw_config):
-        config = yaml.load(raw_config, NoDuplicateKeysLoader)
+        config = load_yaml(raw_config)
         return cls.model_validate(config)
diff --git a/frigate/test/test_config.py b/frigate/test/test_config.py
index 1f0ff086d..5a5592b13 100644
--- a/frigate/test/test_config.py
+++ b/frigate/test/test_config.py
@@ -4,14 +4,13 @@ import unittest
 from unittest.mock import patch
 
 import numpy as np
-import yaml
 from pydantic import ValidationError
 
 from frigate.config import BirdseyeModeEnum, FrigateConfig
 from frigate.const import MODEL_CACHE_DIR
 from frigate.detectors import DetectorTypeEnum
 from frigate.plus import PlusApi
-from frigate.util.builtin import NoDuplicateKeysLoader, deep_merge
+from frigate.util.builtin import deep_merge, load_yaml
 
 
 class TestConfig(unittest.TestCase):
@@ -1537,9 +1536,7 @@ class TestConfig(unittest.TestCase):
                 - four
         """
 
-        self.assertRaises(
-            ValueError, lambda: yaml.load(raw_config, NoDuplicateKeysLoader)
-        )
+        self.assertRaises(ValueError, lambda: load_yaml(raw_config))
 
     def test_object_filter_ratios_work(self):
         config = {
diff --git a/frigate/util/builtin.py b/frigate/util/builtin.py
index 059a9203a..42caf8d30 100644
--- a/frigate/util/builtin.py
+++ b/frigate/util/builtin.py
@@ -116,6 +116,10 @@ class NoDuplicateKeysLoader(yaml.loader.SafeLoader):
         return mapping
 
 
+def load_yaml(raw_config: str) -> dict:
+    return yaml.load(raw_config, NoDuplicateKeysLoader)
+
+
 def clean_camera_user_pass(line: str) -> str:
     """Removes user and password from line."""
     rtsp_cleaned = re.sub(REGEX_RTSP_CAMERA_USER_PASS, "://*:*@", line)