Implement support for token authentication in MSDeploy

Tasks/AzureRmWebAppDeploymentV3/azurermwebappdeployment.ts

@@ -20,6 +20,7 @@ import { addReleaseAnnotation } from './operations/ReleaseAnnotationUtility';
 import { PackageUtility } from 'azure-pipelines-tasks-webdeployment-common/packageUtility';
 import { isInputPkgIsFolder, canUseWebDeploy } from 'azure-pipelines-tasks-webdeployment-common/utility';
 import { DeployUsingMSDeploy } from 'azure-pipelines-tasks-webdeployment-common/deployusingmsdeploy';
+import { shouldUseMSDeployTokenAuth} from 'azure-pipelines-tasks-webdeployment-common/msdeployutility';
 
 async function main() {
     let zipDeploymentID: string;
@@ -86,7 +87,7 @@ async function main() {
 
             if(canUseWebDeploy(taskParams.UseWebDeploy)) {
                 tl.debug("Performing the deployment of webapp.");
-                if(!tl.osType().match(/^Win/)){
+                if(tl.getPlatform() !== tl.Platform.Windows){
                     throw Error(tl.loc("PublishusingwebdeployoptionsaresupportedonlywhenusingWindowsagent"));
                 }
 
@@ -95,13 +96,32 @@ async function main() {
                 }
 
                 var msDeployPublishingProfile = await appServiceUtility.getWebDeployPublishingProfile();
+                let authType = "Basic";
+
+                if (await appServiceUtility.isSitePublishingCredentialsEnabled())
+                {
+                    tl.debug("Using Basic authentication.")                        
+                }
+                else if (shouldUseMSDeployTokenAuth())
+                {
+                    tl.debug("Basic authentication is disabled, using token based authentication.");
+                    authType = "Bearer";
+                    msDeployPublishingProfile.userPWD = await appServiceUtility.getAuthToken();
+                    msDeployPublishingProfile.userName = "user"; // arbitrary but not empty
+                } 
+                else
+                {
+                    //deployment would fail in this case
+                    throw new Error(tl.loc("BasicAuthNotSupported"));
+                }
+
                 if (webPackage.toString().toLowerCase().endsWith('.war')) {
-                    await DeployWar(webPackage, taskParams, msDeployPublishingProfile, kuduService, appServiceUtility);
+                    await DeployWar(webPackage, taskParams, msDeployPublishingProfile, kuduService, appServiceUtility, authType);
                 }
                 else {
                     await DeployUsingMSDeploy(webPackage, taskParams.WebAppName, msDeployPublishingProfile, taskParams.RemoveAdditionalFilesFlag,
                     taskParams.ExcludeFilesFromAppDataFlag, taskParams.TakeAppOfflineFlag, taskParams.VirtualApplication, taskParams.SetParametersFile,
-                    taskParams.AdditionalArguments, isFolderBasedDeployment, taskParams.UseWebDeploy);
+                    taskParams.AdditionalArguments, isFolderBasedDeployment, taskParams.UseWebDeploy, authType);
                 }
             }
             else {

Tasks/AzureRmWebAppDeploymentV3/operations/AzureAppServiceUtility.ts

@@ -83,6 +83,17 @@ export class AzureAppServiceUtility {
         }
     }
 
+    public async isSitePublishingCredentialsEnabled(): Promise<boolean> {
+        const utility = new AzureAppServiceUtilityCommon(this._appService);
+        return await utility.isSitePublishingCredentialsEnabled();
+    }
+
+    public async getAuthToken(): Promise<string> {
+        const token = await this._appService._client.getCredentials().getToken();
+        tl.setSecret(token);
+        return token;
+    }
+
     public async getKuduService(): Promise<Kudu> {
 
         const utility = new AzureAppServiceUtilityCommon(this._appService);

Tasks/AzureRmWebAppDeploymentV3/operations/WarDeploymentUtilities.ts

@@ -8,7 +8,7 @@ import { sleepFor } from 'azure-pipelines-tasks-azure-arm-rest/webClient';
 
 import { DeployUsingMSDeploy } from 'azure-pipelines-tasks-webdeployment-common/deployusingmsdeploy';
 
-export async function DeployWar(webPackage, taskParams: TaskParameters, msDeployPublishingProfile, kuduService: Kudu, appServiceUtility: AzureAppServiceUtility): Promise<void> {
+export async function DeployWar(webPackage, taskParams: TaskParameters, msDeployPublishingProfile, kuduService: Kudu, appServiceUtility: AzureAppServiceUtility, authType: string): Promise<void> {
     // get list of files before deploying to the web app.
     await appServiceUtility.pingApplication();
     var listOfFilesBeforeDeployment: any = await kuduService.listDir('/site/wwwroot/webapps/');
@@ -33,7 +33,7 @@ export async function DeployWar(webPackage, taskParams: TaskParameters, msDeploy
     while (retryCount > 0) {
         await DeployUsingMSDeploy(webPackage, taskParams.WebAppName, msDeployPublishingProfile, taskParams.RemoveAdditionalFilesFlag,
             taskParams.ExcludeFilesFromAppDataFlag, taskParams.TakeAppOfflineFlag, taskParams.VirtualApplication, taskParams.SetParametersFile,
-            taskParams.AdditionalArguments, false, taskParams.UseWebDeploy);
+            taskParams.AdditionalArguments, false, taskParams.UseWebDeploy, authType);
 
         // verify if the war file has expanded
         // if not expanded, deploy using msdeploy once more, to make it work.

Tasks/AzureRmWebAppDeploymentV3/package.json

@@ -24,7 +24,7 @@
     "azure-pipelines-task-lib": "^4.4.0",
     "agent-base": "^6.0.2",
     "azure-pipelines-tasks-azure-arm-rest": "3.223.3",
-    "azure-pipelines-tasks-webdeployment-common": "^4.222.2",
+    "azure-pipelines-tasks-webdeployment-common": "4.230.1",
     "decompress-zip": "^0.3.3",
     "ltx": "2.8.0",
     "moment": "^2.29.4",

Tasks/AzureRmWebAppDeploymentV3/task.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 3,
     "Minor": 230,
-    "Patch": 1
+    "Patch": 2
   },
   "releaseNotes": "What's new in Version 3.0: <br/>&nbsp;&nbsp;Supports File Transformations (XDT) <br/>&nbsp;&nbsp;Supports Variable Substitutions(XML, JSON) <br/>Click [here](https://aka.ms/azurermwebdeployreadme) for more information.",
   "minimumAgentVersion": "2.104.1",

Tasks/AzureRmWebAppDeploymentV3/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 3,
     "Minor": 230,
-    "Patch": 1
+    "Patch": 2
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "minimumAgentVersion": "2.104.1",

Tasks/AzureRmWebAppDeploymentV4/deploymentProvider/WindowsWebAppWebDeployProvider.ts

@@ -27,24 +27,21 @@ export class WindowsWebAppWebDeployProvider extends AzureRmWebAppDeploymentProvi
         var deleteApplicationSetting = ParameterParser.parse(removeRunFromZipAppSetting)
         await this.appServiceUtility.updateAndMonitorAppSettings(null, deleteApplicationSetting);
 
-        if(deployUtility.canUseWebDeploy(this.taskParams.UseWebDeploy)) {
-            let deploymentMethodtelemetry = '{"deploymentMethod":"Web Deploy"}';
+        if (deployUtility.canUseWebDeploy(this.taskParams.UseWebDeploy)) {
+            const webDeployUtility = new WebDeployUtility(this.appServiceUtility);
+            const deploymentMethodtelemetry = '{"deploymentMethod":"Web Deploy"}';
             console.log("##vso[telemetry.publish area=TaskDeploymentMethod;feature=AzureWebAppDeployment]" + deploymentMethodtelemetry);
 
             tl.debug("Performing the deployment of webapp.");
 
-            if(!tl.osType().match(/^Win/)) {
+            if (tl.getPlatform() !== tl.Platform.Windows) {
                 throw Error(tl.loc("PublishusingwebdeployoptionsaresupportedonlywhenusingWindowsagent"));
             }
-
-            var msDeployPublishingProfile = await this.appServiceUtility.getWebDeployPublishingProfile();
-            await WebDeployUtility.publishUsingWebDeploy(this.taskParams,
-                WebDeployUtility.constructWebDeployArguments(this.taskParams, msDeployPublishingProfile), this.appServiceUtility
-            );
-
+
+            await webDeployUtility.publishUsingWebDeploy(this.taskParams);            
         }
         else {
-            let deploymentMethodtelemetry = '{"deploymentMethod":"Zip API"}';
+            const deploymentMethodtelemetry = '{"deploymentMethod":"Zip API"}';
             console.log("##vso[telemetry.publish area=TaskDeploymentMethod;feature=AzureWebAppDeployment]" + deploymentMethodtelemetry);
 
             tl.debug("Initiated deployment via kudu service for webapp package : ");

Tasks/AzureRmWebAppDeploymentV4/operations/AzureAppServiceUtility.ts

@@ -127,6 +127,17 @@ export class AzureAppServiceUtility {
 
     }
 
+    public async isSitePublishingCredentialsEnabled(): Promise<boolean> {
+        const utility = new AzureAppServiceUtilityCommon(this._appService);
+        return await utility.isSitePublishingCredentialsEnabled();
+    }
+
+    public async getAuthToken(): Promise<string> {
+        const token = await this._appService._client.getCredentials().getToken();
+        tl.setSecret(token);
+        return token;
+    }
+
     public async getPhysicalPath(virtualApplication: string): Promise<string> {
 
         if(!virtualApplication) {