Ensure 'Remote debugging' is set to 'Off'
Description
Remote debugging allows an App Service app to be debugged in real-time directly in the Azure environment. When remote debugging is enabled, it opens a communication channel that could potentially be exploited by unauthorized users if not properly secured.
Rationale
Disabling remote debugging on an App Service app is primarily about enhancing security.
Remote debugging opens a communication channel that can be exploited by attackers. By disabling it, you reduce the number of potential entry points for unauthorized access.
If remote debugging is enabled without proper access controls, it can allow unauthorized users to connect to your application, potentially leading to data breaches or malicious code execution.
During a remote debugging session, sensitive information might be exposed. Disabling remote debugging helps ensure that such data remains secure. This minimizes the use of remote access tools to reduce risk.
Impact
You will not be able to connect to your application from a remote location to diagnose and fix issues in real-time. You will not be able to step through code, set breakpoints, or inspect variables and the call stack while the application is running on the server. Remote debugging is particularly useful for diagnosing issues that only occur in the production environment. Without it, you will need to rely on logs and other diagnostic tools.
Audit Procedure
Using Azure Portal
- Login to Azure Portal using https://portal.azure.com
- Go to
App Services - Click on each App
- Under
Settingsection, Click onConfiguration - Under the
General settingstab, check theRemote debuggingoption. Ensure it is set toOff.
Using Azure CLI
To check remote debugging status for an existing app, run the following command:
az webapp config show --resource-group <resource_group_name> --name <app_name> --query remoteDebuggingEnabled
The output should be false if remote debugging is disabled.
Using Azure PowerShell
To check remote debugging status for an existing app, run the following command:
Get-AzWebApp -ResourceGroupName <resource_group_name> -Name <app_name> |Select-Object -ExpandProperty SiteConfig
The output of remoteDebuggingEnabled should be false if remote debugging is disabled.
Expected Result
The remoteDebuggingEnabled setting should return false.
Remediation
Using Azure Portal
- Login to Azure Portal using https://portal.azure.com
- Go to
App Services - Click on each App
- Under
Settingsection, Click onConfiguration - Under the
General settingstab, set theRemote debuggingoption toOff.
Using Azure CLI
To set remote debugging status to off, run the following command:
az webapp config set --resource-group <resource_group_name> --name <app_name> --remote-debugging-enabled false
Using Azure PowerShell
To set remote debugging status to off, run the following command:
Set-AzWebApp -ResourceGroupName <resource_group_name> -Name <app_name> -RemoteDebuggingEnabled $false
Default Value
By default, remote debugging is set to off.
References
- https://learn.microsoft.com/en-us/visualstudio/debugger/remote-debugging-azure-app-service
- https://learn.microsoft.com/en-us/security/benchmark/azure/mcsb-posture-vulnerability-management#pv-2-audit-and-enforce-secure-configurations
- https://learn.microsoft.com/en-us/cli/azure/webapp
- https://learn.microsoft.com/en-us/powershell/module/az.websites/get-azwebapp
- https://learn.microsoft.com/en-us/powershell/module/az.websites/set-azwebapp
Profile
Level 1 | Automated