Add additional arguments validation for AzureFileCopy (#18022)

* Add validation of additional arguments

* Add VerticalBar validation for WindowsFileCopy

* Add error messages

* Add L0 tests for AzureFileCopy

* Update tasks versions

* Update tasks version to sprint 221

Author: LeftTwixWand

Tasks/AzureFileCopyV1/AzureFileCopy.ps1

@@ -136,6 +136,7 @@ try {
     }
 
     Check-ContainerNameAndArgs -containerName $containerName -additionalArguments $additionalArguments
+    Validate-AdditionalArguments $additionalArguments
 
     # Uploading files to container
     Upload-FilesToAzureContainer -sourcePath $sourcePath -storageAccountName $storageAccount -containerName $containerName -blobPrefix $blobPrefix -blobStorageEndpoint $blobStorageEndpoint -storageKey $storageKey `

Tasks/AzureFileCopyV1/Strings/resources.resjson/en-US/resources.resjson

@@ -91,5 +91,6 @@
   "loc.messages.AFC_RootContainerAndDirectory": "'/S' option is not valid for $root containers.",
   "loc.messages.AFC_RedirectResponseInvalidStatusCode": "The HTTP response code: '{0}' is not a valid redirect status code",
   "loc.messages.AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null.",
-  "loc.messages.AFC_UninstallWinRMCustomScriptExtension": "Uninstall WinRM custom script manually and retry deployment."
+  "loc.messages.AFC_UninstallWinRMCustomScriptExtension": "Uninstall WinRM custom script manually and retry deployment.",
+  "loc.messages.AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters": "Additional arguments can't include separator characters '&', ';' and '|'. Please verify input. To learn more about argument validation, please check https://aka.ms/azdo-task-argument-validation"
 }

Tasks/AzureFileCopyV1/Tests/L0.ts

@@ -111,5 +111,8 @@ describe('AzureFileCopy Suite', function () {
         it('Validate AzureFileCopy.Utility Check-ContainerNameAndArgs', (done) => {
             psr.run(path.join(__dirname, 'L0CheckContainerNameAndArgs.ps1'), done);
         });
+        it('Validate AzureFileCopy.Utility Validate-AdditionalArguments', (done) => {
+            psr.run(path.join(__dirname, 'L0ValidateAdditionalArguments.ps1'), done);
+        });
     }   
 });

Tasks/AzureFileCopyV1/Tests/L0ValidateAdditionalArguments.ps1

@@ -0,0 +1,26 @@
+[CmdletBinding()]
+param()
+
+. $PSScriptRoot\..\..\..\Tests\lib\Initialize-Test.ps1
+. $PSScriptRoot\..\Utility.ps1
+
+# Arrange
+
+$invalidAdditionalArgumentsWithSemicolon = "echo 123 ; start notepad.exe"
+$invalidAdditionalArgumentsWithAmpersand = "echo 123 & start notepad.exe"
+$invalidAdditionalArgumentsWithVerticalBar = "echo 123 | start notepad.exe"
+$additionalArgumentsValidationErrorMessage = "AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters *";
+
+# Assert
+
+Assert-Throws {
+   Validate-AdditionalArguments $invalidAdditionalArgumentsWithSemicolon
+} -Message $additionalArgumentsValidationErrorMessage
+
+Assert-Throws {
+    Validate-AdditionalArguments $invalidAdditionalArgumentsWithAmpersand
+ } -Message $additionalArgumentsValidationErrorMessage
+
+Assert-Throws {
+   Validate-AdditionalArguments $invalidAdditionalArgumentsWithVerticalBar
+} -Message $additionalArgumentsValidationErrorMessage

Tasks/AzureFileCopyV1/Tests/MockVariable.ps1

@@ -1,4 +1,3 @@
-
 $validInputSourcePath = Join-Path $env:windir "Source"
 $validInputAzureBlobDestinationType = "AzureBlob"
 $validInputAzureVmsDestinationType = "AzureVms"

Tasks/AzureFileCopyV1/Utility.ps1

@@ -1447,4 +1447,12 @@ function Check-ContainerNameAndArgs
     {
         Write-Warning (Get-vstsLocString -Key "AFC_RootContainerAndDirectory")
     }
+}
+
+function Validate-AdditionalArguments([string]$additionalArguments)
+{
+    if($additionalArguments -match "[&;|]")
+    {
+        ThrowError -errorMessage (Get-VstsLocString -Key "AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters")
+    }
 }

Tasks/AzureFileCopyV1/task.json

@@ -13,7 +13,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 1,
-        "Minor": 219,
+        "Minor": 221,
         "Patch": 0
     },
     "demands": [
@@ -349,6 +349,7 @@
         "AFC_RootContainerAndDirectory": "'/S' option is not valid for $root containers.",
         "AFC_RedirectResponseInvalidStatusCode": "The HTTP response code: '{0}' is not a valid redirect status code",
         "AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null.",
-        "AFC_UninstallWinRMCustomScriptExtension": "Uninstall WinRM custom script manually and retry deployment."
+        "AFC_UninstallWinRMCustomScriptExtension": "Uninstall WinRM custom script manually and retry deployment.",
+        "AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters": "Additional arguments can't include separator characters '&', ';' and '|'. Please verify input. To learn more about argument validation, please check https://aka.ms/azdo-task-argument-validation"
     }
 }

Tasks/AzureFileCopyV1/task.loc.json

@@ -13,7 +13,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 1,
-    "Minor": 219,
+    "Minor": 221,
     "Patch": 0
   },
   "demands": [
@@ -349,6 +349,7 @@
     "AFC_RootContainerAndDirectory": "ms-resource:loc.messages.AFC_RootContainerAndDirectory",
     "AFC_RedirectResponseInvalidStatusCode": "ms-resource:loc.messages.AFC_RedirectResponseInvalidStatusCode",
     "AFC_RedirectResponseLocationHeaderIsNull": "ms-resource:loc.messages.AFC_RedirectResponseLocationHeaderIsNull",
-    "AFC_UninstallWinRMCustomScriptExtension": "ms-resource:loc.messages.AFC_UninstallWinRMCustomScriptExtension"
+    "AFC_UninstallWinRMCustomScriptExtension": "ms-resource:loc.messages.AFC_UninstallWinRMCustomScriptExtension",
+    "AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters": "ms-resource:loc.messages.AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters"
   }
 }

Tasks/AzureFileCopyV2/AzureFileCopy.ps1

@@ -166,6 +166,7 @@ try {
     }
 
     Check-ContainerNameAndArgs -containerName $containerName -additionalArguments $additionalArgumentsForBlobCopy
+    Validate-AdditionalArguments $additionalArguments
 
     # Uploading files to container
     Upload-FilesToAzureContainer -sourcePath $sourcePath `

Tasks/AzureFileCopyV2/Strings/resources.resjson/en-US/resources.resjson

@@ -97,5 +97,6 @@
   "loc.messages.AFC_AzCopyBlobUploadNonZeroExitCode": "AzCopy.exe exited with non-zero exit code while uploading files to blob storage.",
   "loc.messages.AFC_PreexecutionJob_UnableToGetStorageKey": "Unable to fetch storage account key. Error: '{0}'",
   "loc.messages.AFC_UninstallWinRMCustomScriptExtension": "Uninstall WinRM custom script manually and retry deployment.",
+  "loc.messages.AFC_AdditionalArgumentsMustNotIncludeForbiddenCharacters": "Additional arguments can't include separator characters '&', ';' and '|'. Please verify input. To learn more about argument validation, please check https://aka.ms/azdo-task-argument-validation",
   "loc.messages.ExpiredServicePrincipal": "Could not fetch access token for Azure. Verify if the Service Principal used is valid and not expired."
 }