fix(file-log): reject file path that has leading/trailing space (#14141)

FTI-6426
Kong · Jan 16, 2025 · ce15c78 · ce15c78 · github-actions · Jan 16, 2025
1 parent a6895f6
commit ce15c78
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 2 deletions.
diff --git a/changelog/unreleased/kong/fix_file_path_not_allowed_whitespace.yml b/changelog/unreleased/kong/fix_file_path_not_allowed_whitespace.yml
@@ -0,0 +1,3 @@
+message: "**file-log**: Fixed an issue where an error would occur when there were spaces at the beginning or end of a path."
+type: bugfix
+scope: Plugin
diff --git a/kong/plugins/file-log/schema.lua b/kong/plugins/file-log/schema.lua
@@ -10,7 +10,7 @@ return {
         fields = {
           { path = { description = "The file path of the output log file. The plugin creates the log file if it doesn't exist yet.", type = "string",
                      required = true,
-                     match = [[^[^*&%%\`]+$]],
+                     match = [[^[^%s*&%%\`][^*&%%\`]*[^%s*&%%\`]$]],
                      err = "not a valid filename",
           }, },
           { reopen = { description = "Determines whether the log file is closed and reopened on every request.", type = "boolean", required = true, default = false }, },

diff --git a/spec/03-plugins/04-file-log/02-schema_spec.lua b/spec/03-plugins/04-file-log/02-schema_spec.lua
@@ -17,7 +17,7 @@ describe("Plugin: file-log (schema)", function()
     },
     ----------------------------------------
     {
-      name = "rejects invalid filename",
+      name = "rejects invalid filename includes *",
       input = {
         path = "/ovo*",
         reopen = true
@@ -30,6 +30,100 @@ describe("Plugin: file-log (schema)", function()
       }
     },
     ----------------------------------------
+    {
+      name = "rejects invalid filename includes `",
+      input = {
+        path = "/ovo`",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    ----------------------------------------
+    {
+      name = "rejects invalid filename includes &",
+      input = {
+        path = "test&thing",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    ----------------------------------------
+    {
+      name = "rejects invalid filename includes %",
+      input = {
+        path = "test%thing",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    ----------------------------------------
+    {
+      name = "rejects invalid filename includes \\",
+      input = {
+        path = "test\\thing",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    ----------------------------------------
+    {
+      name = "beginning spaces are not allowed",
+      input = {
+        path = " /ovo",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    -- ----------------------------------------
+    {
+      name = "trailing spaces are not allowed",
+      input = {
+        path = "/ovo  ",
+        reopen = true
+      },
+      output = nil,
+      error = {
+        config = {
+          path = "not a valid filename"
+        }
+      }
+    },
+    ----------------------------------------
+    {
+      name = "accept valid filename that includes space",
+      input = {
+        path = "/o vo.loga",
+        reopen = true
+      },
+      output = true,
+      error = nil,
+    },
+    ------------------------------------
     {
       name = "accepts valid filename",
       input = {