Use a regex to filter our invalid culture codes rather than relying on the culture being installed on the operating system (#19821)

* Use a regex to filter our invalid culture codes rather than relying on the culture being installed on the operating system.

* Update to more restrictive regex

Co-authored-by: Nuklon <[email protected]>

---------

Co-authored-by: Nuklon <[email protected]>

Author: AndyButland

src/Umbraco.Web.BackOffice/Controllers/PreviewController.cs

@@ -178,26 +178,31 @@ public ActionResult Frame(int id, string culture)
         return RedirectPermanent($"../../{id}{query}");
     }
 
-    private static bool ValidateProvidedCulture(string culture)
+    /// <summary>
+    /// Validates the provided culture code.
+    /// </summary>
+    /// <remarks>
+    /// Marked as internal to expose for unit tests.
+    /// </remarks>
+    internal static bool ValidateProvidedCulture(string culture)
     {
         if (string.IsNullOrEmpty(culture))
         {
             return true;
         }
 
-        // We can be confident the backoffice will have provided a valid culture in linking to the
-        // preview, so we don't need to check that the culture matches an Umbraco language.
-        // We are only concerned here with protecting against XSS attacks from a fiddled preview
-        // URL, so we can just confirm we have a valid culture.
-        try
-        {
-            CultureInfo.GetCultureInfo(culture, true);
-            return true;
-        }
-        catch (CultureNotFoundException)
+        // Culture codes are expected to match this pattern.
+        if (CultureCodeRegex().IsMatch(culture) is false)
         {
             return false;
         }
+
+        // We can be confident the backoffice will have provided a valid culture in linking to the
+        // preview, so we don't need to check that the culture matches an Umbraco language (or is even a
+        // valid culture code).
+        // We are only concerned here with protecting against XSS attacks from a fiddled preview
+        // URL, so we can proceed if the the regex is matched.
+        return true;
     }
 
     public ActionResult? EnterPreview(int id)
@@ -261,4 +266,7 @@ public ActionResult End(string? redir = null)
 
     [GeneratedRegex("^\\/(?<id>\\d*)(\\?culture=(?<culture>[\\w-]*))?$")]
     private static partial Regex DefaultPreviewRedirectRegex();
+
+    [GeneratedRegex(@"^[a-z]{2,3}[-0-9a-z]*$", RegexOptions.IgnoreCase)]
+    private static partial Regex CultureCodeRegex();
 }

tests/Umbraco.Tests.UnitTests/Umbraco.Web.BackOffice/Controllers/PreviewControllerTests.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using System.Globalization;
+using NUnit.Framework;
+using Umbraco.Cms.Web.BackOffice.Controllers;
+
+namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Web.BackOffice.Controllers;
+
+[TestFixture]
+public class PreviewControllerTests
+{
+    [TestCase("en-US", true)] // A framework culture.
+    [TestCase("en-JP", true)] // A valid culture string, but not one that's in the framework.
+    [TestCase("a!", false)]   // Not a valid culture string.
+    [TestCase("<script>alert(123)</script>", false)]
+    public void ValidateProvidedCulture_Validates_Culture(string culture, bool expectValid)
+    {
+        var result = PreviewController.ValidateProvidedCulture(culture);
+        Assert.AreEqual(expectValid, result);
+    }
+
+    [Test]
+    public void ValidateProvidedCulture_Validates_Culture_For_All_Framework_Cultures()
+    {
+        var cultures = CultureInfo.GetCultures(CultureTypes.AllCultures);
+        foreach (var culture in cultures)
+        {
+            Assert.IsTrue(PreviewController.ValidateProvidedCulture(culture.Name), $"{culture.Name} is not considered a valid culture.");
+            Assert.IsTrue(PreviewController.ValidateProvidedCulture(culture.Name.ToUpperInvariant()), $"{culture.Name.ToUpperInvariant()} is not considered a valid culture.");
+            Assert.IsTrue(PreviewController.ValidateProvidedCulture(culture.Name.ToLowerInvariant()), $"{culture.Name.ToLowerInvariant()} is not considered a valid culture.");
+        }
+    }
+}