feat: add alias name validation

WeihanLi · Nov 24, 2024 · 02dffe1 · 02dffe1
1 parent 8b95094
commit 02dffe1
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 1 deletion.
diff --git a/src/dotnet-exec/Commands/AliasCommand.cs b/src/dotnet-exec/Commands/AliasCommand.cs
@@ -6,6 +6,7 @@ internal sealed class AliasCommand : Command
 {
     internal static readonly Argument<string> AliasNameArg = new("aliasName", "Alias Name");
     internal static readonly Argument<string> AliasValueArg = new("aliasValue", "Alias Value");
+
     public AliasCommand() : base("alias", "Alias management")
     {
         AddCommand(new AliasListCommand());

diff --git a/src/dotnet-exec/Helper.cs b/src/dotnet-exec/Helper.cs
@@ -16,6 +16,7 @@
 using System.Reflection;
 using System.Text;
 using System.Text.Json;
+using System.Text.RegularExpressions;
 using WeihanLi.Common.Models;
 
 namespace Exec;
@@ -39,6 +40,13 @@ public static class Helper
 
     private const string EnableDebugEnvName = "DOTNET_EXEC_DEBUG_ENABLED";
     public const string EnableWebReferenceEnvName = "DOTNET_EXEC_WEB_REF_ENABLED";
+
+    private static readonly Regex AliasNameRegex = new(@"^\w+[\w\-:\.]*$");
+    public static bool IsValidAliasName(string aliasName)
+    {
+        return aliasName is { Length: > 0 and <= 64 } && AliasNameRegex.IsMatch(aliasName);
+    }
+
     public static bool DebugModelEnabled(string[] args)
     {
         if (args.Contains("--debug"))
@@ -226,6 +234,13 @@ public static void Initialize(this Command command, IServiceProvider serviceProv
                             "set" => async (InvocationContext context) =>
                             {
                                 var aliasName = context.ParseResult.GetValueForArgument(AliasCommand.AliasNameArg);
+
+                                if (IsValidAliasName(aliasName))
+                                {
+                                    Console.WriteLine("Invalid alias name, alias name max length is  64 and only allow characters,numbers and `-`/`_`/`:`/`.` ");
+                                    return;
+                                }
+
                                 var aliasValue = context.ParseResult.GetValueForArgument(AliasCommand.AliasValueArg);
                                 if (!appConfiguration.Aliases.TryGetValue(aliasName, out var currentValue) || currentValue == aliasValue)
                                 {

diff --git a/src/dotnet-exec/Services/Middleware/AliasOptionsPreConfigureMiddleware.cs b/src/dotnet-exec/Services/Middleware/AliasOptionsPreConfigureMiddleware.cs
@@ -10,7 +10,9 @@ internal sealed class AliasOptionsPreConfigureMiddleware
 {
     public Task InvokeAsync(ExecOptions context, Func<ExecOptions, Task> next)
     {
-        if (appConfiguration.Aliases.TryGetValue(context.Script, out var aliasValue))
+        if (Helper.IsValidAliasName(context.Script)
+            && appConfiguration.Aliases.TryGetValue(context.Script, out var aliasValue)
+            )
         {
             context.Script = aliasValue;
             logger.LogDebug("Script replaced to alias value : {AliasValue}", aliasValue);

diff --git a/tests/UnitTest/HelperTest.cs b/tests/UnitTest/HelperTest.cs
@@ -0,0 +1,28 @@
+// Copyright (c) 2022-2024 Weihan Li. All rights reserved.
+// Licensed under the Apache license version 2.0 http://www.apache.org/licenses/LICENSE-2.0
+
+namespace UnitTest;
+public class HelperTest
+{
+    [Theory]
+    [InlineData("new-guid")]
+    [InlineData("new_guid")]
+    [InlineData("now")]
+    [InlineData("date")]
+    [InlineData("test:123")]
+    [InlineData("test.test123")]
+    public void AliasNameValidTest(string alias)
+    {
+        Assert.True(Helper.IsValidAliasName(alias));
+    }
+
+    [Theory]
+    [InlineData("")]
+    [InlineData("https://google.com")]
+    [InlineData("https://github.com/WeihanLi/dotnet-exec/blob/main/tests/IntegrationTest/CodeSamples/ConfigurationManagerSample.cs")]
+    [InlineData("dotnet-exec_blob_main_tests_IntegrationTest_CodeSamples_ConfigurationManagerSample.cs")]
+    public void AliasNameRegexInvalidTest(string alias)
+    {
+        Assert.False(Helper.IsValidAliasName(alias));
+    }
+}