AzureWAF
The Azure WAF (Web Application Firewall) integration provides centralized protection of your web applications from common exploits and vulnerabilities. It enables you to control policies that are configured in the Azure Firewall management platform, and allows you to add, delete, or update policies, and also to get details of a specific policy or a list of policies.
Network Security · Azure WAF
Details
| ID | AzureWAF |
|---|---|
| Provider | Microsoft |
| Category | Network Security |
| From Version | 5.0.0 |
| Docker Image | demisto/crypto:1.0.0.8931184 |
| Supported Modules | Agentix XSIAM |
README
The Azure WAF (Web Application Firewall) integration provides centralized protection of your web applications from common exploits and vulnerabilities.
It enables you to control policies that are configured in the Azure Firewall management platform, and allows you to add, delete, or update policies,
and also to get details of a specific policy or a list of policies.
In order to connect to the AzureWAF using either Cortex XSOAR Azure App or the Self-Deployed Azure App, use one of the following methods:
- Authorization Code Flow (Recommended).
- Device Code Flow.
- Azure Managed Identities
- Client Credentials Flow.
Self-Deployed Application
To use a self-configured Azure application, you need to add a new Azure App Registration in the Azure Portal.
Required Permissions
The following API permissions are required in Azure:
| API | Permission |
|---|---|
| Azure Service Management | user_impersonation |
| Microsoft Graph | offline_access |
| Microsoft Graph | User.Read |
Authentication Using the Authorization Code Flow (recommended)
Follow these steps for a self-deployed configuration:
- To use a self-configured Azure application, you need to add a new Azure App Registration in the Azure Portal. To add the registration, refer to the following Microsoft article steps 1-8.
- choose the Authorization Code option in the Authentication Type parameter.
- Enter your Client/Application ID in the Application ID parameter.
- Enter your Client Secret in the Client Secret parameter.
- Enter your Tenant ID in the Tenant ID parameter.
- Enter your Application redirect URI in the Application redirect URI parameter.
- Save the instance.
- Run the !azure-waf-generate-login-url command in the War Room and follow the instruction.
- Run the !azure-waf-auth-test command - a ‘Success’ message should be printed to the War Room.
Authentication Using the Device Code Flow
Use the device code flow
to link Azure SQL Management with Cortex XSOAR.
In order to connect to Azure Web Application Firewall using either the Cortex XSOAR Azure or Self Deployed Azure application:
- Fill in the required parameters
- choose the Device Code option in the Authentication Type parameter.
- Run the !azure-waf-auth-start command.
- Follow the instructions that appear.
- Run the !azure-waf-auth-complete command.
At end of the process, you will see a message that you logged in successfully.
Cortex XSOAR Azure app
In order to use the Cortex XSOAR Azure application, use the default application ID (cf22fd73-29f1-4245-8e16-533704926d20) and fill in your subscription ID and default resource group name.
You only need to fill in your subscription ID and resource group name. You can find your resource group and
subscription ID in the Azure Portal. For a more detailed explanation, visit this page.
Azure Managed Identities Authentication
Note: This option is relevant only if the integration is running on Azure VM
Follow one of these steps for authentication based on Azure Managed Identities:
-
To use System Assigned Managed Identity
- In the Authentication Type drop-down list, select Azure Managed Identities and leave the Azure Managed Identities Client ID field empty.
-
To use User Assigned Managed Identity
- Go to Azure Portal -> Managed Identities.
- Select your User Assigned Managed Identity -> copy the Client ID -> paste it in the Azure Managed Identities client id field in the instance configuration.
- In the Authentication Type drop-down list, select Azure Managed Identities.
For more information, see Managed identities for Azure resources.
Client Credentials Flow Authentication
Assign Azure roles using the Azure portal Microsoft article
Note: In the Select members section, assign the application you created earlier.
To configure a Microsoft integration that uses this authorization flow with a self-deployed Azure application:
- In the Authentication Type field, select the Client Credentials option.
- In the Application ID field, enter your Client/Application ID.
- In the Tenant ID field, enter your Tenant ID .
- In the Client Secret field, enter your Client Secret.
- Click Test to validate the URLs, token, and connection
- Save the instance.
Testing authentication and connectivity
If you are using Device Code Flow or Authorization Code Flow, for testing your authentication and connectivity to the AzureWAF service run the !azure-waf-auth-test command.
Configure AzureWAF on Cortex XSOAR/XSIAM
- Navigate to one of the following:
- Cortex XSOAR 8: Settings & Info > Settings > Integrations > Instances
- Cortex XSOAR 6: Settings > Integrations > Servers & Services.
- Cortex XSIAM: Settings > Configurations > Automation & Feed Integrations
- Search for Azure Web Application Firewall.
-
Click Add instance to create and configure a new integration instance.
Parameter Description Required App ID False Default Subscription ID True Default Resource Group Name True Authentication Type Type of authentication - can be Authorization Code Flow (recommended), Device Code Flow, or Azure Managed Identities. True Tenant ID (for authorization code mode) False Client Secret (for authorization code mode) False Client Secret (for authorization code mode) False Application redirect URI (for authorization code mode) False Authorization code for user-auth mode - received from the authorization step. see Detailed Instructions (?) section False Authorization code False Azure Managed Identities Client ID The Managed Identities client ID for authentication - relevant only if the integration is running on Azure VM. False Azure AD endpoint Azure AD endpoint associated with a national cloud. False Trust any certificate (not secure) False Use system proxy settings False - Click Test to validate the URLs, token, and connection.
Commands
You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.
azure-waf-policies-get
Retrieves protection policies within a resource group.
Base Command
azure-waf-policies-get
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. If policy_name is not provided, will retrieve all policies. | Optional |
| resource_group_name | Comma-separated value list of the names of the resource groups. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
| verbose | Whether to retrieve full details of the policy. Possible values are: “true” and “false”. Default is “false”. | Optional |
| limit | Maximum number of policies to fetch. Default is “10”. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.Policy.name | String | Resource name. |
| AzureWAF.Policy.id | String | Resource ID. |
| AzureWAF.Policy.type | String | Resource type. |
| AzureWAF.Policy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.Policy.tags | String | Resource tag. |
| AzureWAF.Policy.location | String | Resource location. |
| AzureWAF.Policy.properties.resourceState | String | Resource status of the policy. |
| AzureWAF.Policy.properties.provisioningState | String | The provisioning state of the application gateway resource. |
| AzureWAF.Policy.properties.policySettings.state | String | The state of the policy. |
| AzureWAF.Policy.properties.policySettings.mode | String | The mode of the policy. |
| AzureWAF.Policy.properties.policySettings.maxRequestBodySizeInKb | Number | Maximum request body size in Kb for WAF. |
| AzureWAF.Policy.properties.policySettings.fileUploadLimitInMb | Number | Maximum file upload size in Mb for WAF. |
| AzureWAF.Policy.properties.policySettings.requestBodyCheck | Boolean | Whether to allow WAF to check the request body. |
| AzureWAF.Policy.properties.customRules.name | String | The name of the resource that is unique within a policy. This name can be used to access the resource. |
| AzureWAF.Policy.properties.customRules.priority | Number | Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. |
| AzureWAF.Policy.properties.customRules.ruleType | String | The rule type. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.variableName | String | Match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.selector | String | The selector of the match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.operator | String | The operator to be matched. |
| AzureWAF.Policy.properties.customRules.matchConditions.negationCondition | Boolean | Whether this is a negate condition. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchValues | String | Match value. |
| AzureWAF.Policy.properties.customRules.action | String | Type of actions. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetType | String | The rule set type to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetVersion | String | The version of the rule set to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.ruleGroupName | String | The managed rule group to override. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.ruleId | String | Identifier for the managed rule. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.state | String | The state of the managed rule. Defaults to disabled if not specified. |
| AzureWAF.Policy.properties.managedRules.exclusions.matchVariable | String | The variable to be excluded. |
| AzureWAF.Policy.properties.managedRules.exclusions.selectorMatchOperator | String | When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. |
| AzureWAF.Policy.properties.managedRules.exclusions.selector | String | When matchVariable is a collection, the operator used to specify which elements in the collection this exclusion applies to. |
Command Example
!azure-waf-policies-get limit=2
Context Example
{
"AzureWAF": {
"Policy": [
{
"etag": "W/\"4bf9c37a-81b7-4c14-a27c-67962c7af825\"",
"id": "/subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy",
"location": "example_location",
"name": "example_policy",
"properties": {
"customRules": [],
"managedRules": {
"exclusions": [],
"managedRuleSets": [
{
"ruleGroupOverrides": [],
"ruleSetType": "OWASP",
"ruleSetVersion": "3.0"
}
]
},
"policySettings": {
"fileUploadLimitInMb": 750,
"maxRequestBodySizeInKb": 128,
"mode": "Detection",
"requestBodyCheck": true,
"state": "Disabled"
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"
}
]
}
}
Human Readable Output
Policy: example_policy
etag id location name type W/”4bf9c37a” /subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy westus example_policy Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies Policy: test_policy
|etag|id|location|name|type|
|—|—|—|—|—|
| W/”4e844e6c” | /subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/test_policy | westus | test_policy | Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies |
Showing 2 policies out of 7
azure-waf-policies-list-all-in-subscription
Retrieves all the WAF policies in a subscription.
Base Command
azure-waf-policies-list-all-in-subscription
Input
| Argument Name | Description | Required |
|---|---|---|
| verbose | Whether to retrieve the full details of the policy. Possible values are “true” and “false”. Default is “false”. | Optional |
| limit | Maximum number of policies to be shown. (This will only affect visualized data, not context.). Default is 10. | Optional |
| subscription_id | Comma-separated list of subscription IDs. Will override the default subscription ID. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.Policy.name | String | Resource name. |
| AzureWAF.Policy.id | String | Resource ID. |
| AzureWAF.Policy.type | String | Resource type. |
| AzureWAF.Policy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.Policy.tags | String | Resource tags. |
| AzureWAF.Policy.location | String | Resource location. |
| AzureWAF.Policy.properties.resourceState | String | Resource status of the policy. |
| AzureWAF.Policy.properties.provisioningState | String | The provisioning state of the application gateway resource. |
| AzureWAF.Policy.properties.policySettings.state | String | The state of the policy. |
| AzureWAF.Policy.properties.policySettings.mode | String | The mode of the policy. |
| AzureWAF.Policy.properties.policySettings.maxRequestBodySizeInKb | Number | Maximum request body size in Kb for WAF. |
| AzureWAF.Policy.properties.policySettings.fileUploadLimitInMb | Number | Maximum file upload size in Mb for WAF. |
| AzureWAF.Policy.properties.policySettings.requestBodyCheck | Boolean | Whether to allow WAF to check the request body. |
| AzureWAF.Policy.properties.customRules.name | String | The name of the resource that is unique within a policy. This name can be used to access the resource. |
| AzureWAF.Policy.properties.customRules.priority | Number | Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. |
| AzureWAF.Policy.properties.customRules.ruleType | String | The rule type. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.variableName | String | Match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.selector | String | The selector of the match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.operator | String | The operator to be matched. |
| AzureWAF.Policy.properties.customRules.matchConditions.negationConditon | Boolean | Whether this is a negate condition. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchValues | String | Match value. |
| AzureWAF.Policy.properties.customRules.action | String | Type of actions. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetType | String | The rule set type to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetVersion | String | The version of the rule set to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.ruleGroupName | String | The managed rule group to override. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.ruleId | String | Identifier for the managed rule. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.state | String | The state of the managed rule. Defaults to disabled if not specified. |
| AzureWAF.Policy.properties.managedRules.exclusions.matchVariable | String | The variable to be excluded. |
| AzureWAF.Policy.properties.managedRules.exclusions.selectorMatchOperator | String | When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. |
| AzureWAF.Policy.properties.managedRules.exclusions.selector | String | When matchVariable is a collection, the operator used to specify which elements in the collection this exclusion applies to. |
Command Example
!azure-waf-policies-list-all-in-subscription limit=2
Context Example
{
"AzureWAF": {
"Policy": [
{
"etag": "W/\"4bf9c37a-81b7-4c14-a27c-67962c7af825\"",
"id": "/subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy",
"location": "westus",
"name": "example_policy",
"properties": {
"customRules": [],
"managedRules": {
"exclusions": [],
"managedRuleSets": [
{
"ruleGroupOverrides": [],
"ruleSetType": "OWASP",
"ruleSetVersion": "3.0"
}
]
},
"policySettings": {
"fileUploadLimitInMb": 750,
"maxRequestBodySizeInKb": 128,
"mode": "Detection",
"requestBodyCheck": true,
"state": "Disabled"
},
"provisioningState": "Succeeded"
},
"type": "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"
}
]
}
}
Human Readable Output
Policy: example_policy
etag id location name type W/”4bf9c37a” /subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy westus example_policy Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies Policy: test_policy_1608641948_
|etag|id|location|name|type|
|—|—|—|—|—|
| W/”422867fc-a697-4978-83f5-20a57ab51511” | /subscriptions/0f907ea4-bc8b-4c11-9d7e-805c2fd144fb/resourceGroups/demisto-sentinel2/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/test_policy_1608641948_ | westus | test_policy_1608641948_ | Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies |
Showing 2 policies out of 6
azure-waf-policy-update-or-create
Creates or updates a policy with a specified rule set name within a resource group.
Base Command
azure-waf-policy-update-or-create
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. If policy_name is not provided, will retrieve all policies. | Required |
| resource_group_name | Comma-separated list of the names of the resource groups. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
| managed_rules | Describes the managedRules structure. | Required |
| resource_id | Resource ID. | Optional |
| location | Describes the resource location. | Optional |
| custom_rules | The custom rules inside the policy. | Optional |
| policy_settings | The policy setting for the policy. | Optional |
| verbose | Whether to retrieve the full details of the policy. Possible values are: “true” and “false”. Default is “false”. Possible values are: true, false. Default is false. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.Policy.name | String | Resource name. |
| AzureWAF.Policy.id | String | Resource ID. |
| AzureWAF.Policy.type | String | Resource type. |
| AzureWAF.Policy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.Policy.tags | String | Resource type. |
| AzureWAF.Policy.location | String | Resource location. |
| AzureWAF.Policy.properties.resourceState | String | Resource status of the policy. |
| AzureWAF.Policy.properties.provisioningState | String | The provisioning state of the application gateway resource. |
| AzureWAF.Policy.properties.policySettings.state | String | The state of the policy. |
| AzureWAF.Policy.properties.policySettings.mode | String | The mode of the policy. |
| AzureWAF.Policy.properties.policySettings.maxRequestBodySizeInKb | Number | Maximum request body size in Kb for WAF. |
| AzureWAF.Policy.properties.policySettings.fileUploadLimitInMb | Number | Maximum file upload size in Mb for WAF. |
| AzureWAF.Policy.properties.policySettings.requestBodyCheck | Boolean | Whether to allow WAF to check the request body. |
| AzureWAF.Policy.properties.customRules.name | String | The name of the resource that is unique within a policy. This name can be used to access the resource. |
| AzureWAF.Policy.properties.customRules.priority | Number | Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. |
| AzureWAF.Policy.properties.customRules.ruleType | String | The rule type. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.variableName | String | Match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchVariables.selector | String | The selector of the match variable. |
| AzureWAF.Policy.properties.customRules.matchConditions.operator | String | The operator to be matched. |
| AzureWAF.Policy.properties.customRules.matchConditions.negationConditon | Boolean | Whether this is a negate condition. |
| AzureWAF.Policy.properties.customRules.matchConditions.matchValues | String | Match value. |
| AzureWAF.Policy.properties.customRules.action | String | Type of actions. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetType | String | Defines the rule set type to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleSetVersion | String | Defines the version of the rule set to use. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.ruleGroupName | String | The managed rule group to override. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.ruleId | String | Identifier for the managed rule. |
| AzureWAF.Policy.properties.managedRules.managedRuleSets.ruleGroupOverrides.rules.state | String | The state of the managed rule. Defaults to disabled if not specified. |
| AzureWAF.Policy.properties.managedRules.exclusions.matchVariable | String | The variable to be excluded. |
| AzureWAF.Policy.properties.managedRules.exclusions.selectorMatchOperator | String | When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. |
| AzureWAF.Policy.properties.managedRules.exclusions.selector | String | When matchVariable is a collection, the operator used to specify which elements in the collection this exclusion applies to. |
Command Example
!azure-waf-policy-update-or-create policy_name="example_policy" resource_group_name="demisto-sentinel2" location="WestUs" managed_rules="{ \"managedRuleSets\": [{\"ruleSetType\": \"OWASP\",\"ruleSetVersion\": \"3.0\"}]}"
Context Example
{
"AzureWAF": {
"Policy": {
"etag": "W/\"f1121c83-d9c1-47a4-912b-6f6731c991a4\"",
"id": "/subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy",
"location": "westus",
"name": "example_policy",
"properties": {
"customRules": [],
"managedRules": {
"exclusions": [],
"managedRuleSets": [
{
"ruleGroupOverrides": [],
"ruleSetType": "OWASP",
"ruleSetVersion": "3.0"
}
]
},
"policySettings": {
"fileUploadLimitInMb": 100,
"maxRequestBodySizeInKb": 128,
"mode": "Detection",
"requestBodyCheck": true,
"state": "Disabled"
},
"provisioningState": "Updating"
},
"type": "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"
}
}
}
Human Readable Output
Policy: example_policy
|etag|id|location|name|type|
|—|—|—|—|—|
| W/”f1121c83” | /subscriptions/example_subscription/resourceGroups/example_resource_group/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/example_policy | westus | example_policy | Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies |
Showing 1 policies out of 1
azure-waf-policy-delete
Deletes a policy.
Base Command
azure-waf-policy-delete
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. If policy_name is not provided, will retrieve all policies. | Required |
| resource_group_name | The name of the resource group. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
Context Output
There is no context output for this command.
Command Example
!azure-waf-policy-delete policy_name="example_policy"
Human Readable Output
Policy example_policy was deleted successfully.
azure-waf-front-door-policies-list
Lists all of the Front Door protection policies within a resource group.
Base Command
azure-waf-front-door-policies-list
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. If policy_name is not provided, will retrieve all policies. | Optional |
| resource_group_name | Comma-separated value list of the names of the resource groups. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
| verbose | Whether to retrieve full details of the policy. Possible values are: “true” and “false”. Default is “false”. | Optional |
| limit | Maximum number of policies to fetch. Default is “10”. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.FrontDoorPolicy.name | String | Resource name. |
| AzureWAF.FrontDoorPolicy.id | String | Resource ID. |
| AzureWAF.FrontDoorPolicy.type | String | Resource type. |
| AzureWAF.FrontDoorPolicy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.FrontDoorPolicy.location | String | Resource location. |
Command Example
!azure-waf-front-door-policies-list limit=2
azure-waf-front-door-policies-list-all-in-subscription
Lists all of the Front Door protection policies within a subscription.
Base Command
azure-waf-front-door-policies-list-all-in-subscription
Input
| Argument Name | Description | Required |
|---|---|---|
| verbose | Whether to retrieve the full details of the policy. Possible values are “true” and “false”. Default is “false”. | Optional |
| limit | Maximum number of policies to fetch. Default is “10”. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.FrontDoorPolicy.name | String | Resource name. |
| AzureWAF.FrontDoorPolicy.id | String | Resource ID. |
| AzureWAF.FrontDoorPolicy.type | String | Resource type. |
| AzureWAF.FrontDoorPolicy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.FrontDoorPolicy.location | String | Resource location. |
Command Example
!azure-waf-front-door-policies-list-all-in-subscription limit=2
azure-waf-front-door-policy-update-or-create
Creates or updates a Front Door policy with a specified rule set name within a resource group.
Base Command
azure-waf-front-door-policy-update-or-create
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. | Required |
| resource_group_name | Comma-separated list of the names of the resource groups. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
| managed_rules | Describes the managedRules structure. | Required |
| custom_rules | The custom rules inside the policy. | Optional |
| policy_settings | Describes settings for the policy. | Optional |
| location | Describes the resource location. | Optional |
| sku | The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. Possible values are: Classic_AzureFrontDoor, Standard_AzureFrontDoor, Premium_AzureFrontDoor. Default is Classic_AzureFrontDoor. | Optional |
| etag | A unique read-only string that changes whenever the resource is updated. | Optional |
| verbose | Whether to retrieve the full details of the policy. Possible values are: “true” and “false”. Default is “false”. | Optional |
| tags | Resource tags. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.FrontDoorPolicy.name | String | Resource name. |
| AzureWAF.FrontDoorPolicy.id | String | Resource ID. |
| AzureWAF.FrontDoorPolicy.type | String | Resource type. |
| AzureWAF.FrontDoorPolicy.etag | String | A unique read-only string that changes whenever the resource is updated. |
| AzureWAF.FrontDoorPolicy.location | String | Resource location. |
Command Example
!azure-waf-front-door-policy-update-or-create policy_name="example_policy" resource_group_name="demisto-sentinel2" location="WestUs" managed_rules="{ \"managedRuleSets\": [{\"ruleSetType\": \"OWASP\",\"ruleSetVersion\": \"3.0\"}]}"
azure-waf-front-door-policy-delete
Deletes a Front Door policy.
Base Command
azure-waf-front-door-policy-delete
Input
| Argument Name | Description | Required |
|---|---|---|
| policy_name | The name of a policy. Used to retrieve a protection policy with a specified name within a resource group. | Required |
| resource_group_name | Comma-separated list of the name of the resource group. If not provided, the instance’s default resource group name will be used. | Optional |
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
Context Output
There is no context output for this command.
Command Example
!azure-waf-front-door-policy-delete policy_name="example_policy"
Human Readable Output
Front Door Policy example_policy was deleted successfully.
azure-waf-auth-start
Run this command to start the authorization process and follow the instructions provided in the command results.
Base Command
azure-waf-auth-start
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
!azure-waf-auth-start
Human Readable Output
Authorization instructions
1. To sign in, use a web browser to open the page: [https://microsoft.com/devicelogin](https://microsoft.com/devicelogin) and enter the code **CKVE788YV** to authenticate. 2. Run the **!azure-waf-auth-complete** command in the War Room.
azure-waf-auth-complete
Run this command to complete the authorization process.
Should be used after running the azure_waf-auth-start command.
Base Command
azure-waf-auth-complete
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
!azure-waf-auth-complete
Human Readable Output
✅ Authorization completed successfully.
azure-waf-auth-reset
Run this command if for some reason you need to rerun the authentication process.
Base Command
azure-waf-auth-reset
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
!azure-waf-auth-reset
Human Readable Output
Authorization was reset successfully. You can now run !azure-waf-auth-start and !azure-waf-auth-complete.
azure-waf-auth-test
Tests connectivity to the Azure Web Application Firewall.
Base Command
azure-waf-auth-test
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
!azure-waf-auth-test
Human Readable Output
✅ Great Success!
azure-waf-generate-login-url
Generate the login url used for Authorization code flow.
Base Command
azure-waf-generate-login-url
Input
There are no input arguments for this command.
Context Output
There is no context output for this command.
Command Example
azure-waf-generate-login-url
Human Readable Output
Authorization instructions
- Click on the login URL to sign in and grant Cortex XSOAR permissions for your Azure Service Management.
You will be automatically redirected to a link with the following structure:
REDIRECT_URI?code=AUTH_CODE&session_state=SESSION_STATE- Copy the
AUTH_CODE(without thecode=prefix, and thesession_stateparameter)
and paste it in your instance configuration under the Authorization code parameter.
azure-waf-subscriptions-list
Gets all subscriptions for a tenant.
Base Command
azure-waf-subscriptions-list
Input
| Argument Name | Description | Required |
| — | — | — |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.Subscription.authorizationSource | String | Subscription authorization source. |
| AzureWAF.Subscription.displayName | String | Subscription display name. |
| AzureWAF.Subscription.id | String | Subscription ID with subscriptions prefix. |
| AzureWAF.Subscription.subscriptionId | String | Subscription ID. |
| AzureWAF.Subscription.locationPlacementId | String | Placmement ID of subscription. |
| AzureWAF.Subscription.tenantId | String | The tenatnt ID of the subscription. |
azure-waf-resource-group-list
Gets all the resource groups for a subscription.
Base Command
azure-waf-resource-group-list
Input
| Argument Name | Description | Required |
|---|---|---|
| subscription_id | The subscription ID. If not provided, the integration default subscription ID will be used. | Optional |
| tag | You can filter by tag names and values. For example, to filter for a tag name and value, tagName=tagValue’. | Optional |
| limit | Maximum number of resource groups to fetch. Default is “50”. Default is 50. | Optional |
Context Output
| Path | Type | Description |
|---|---|---|
| AzureWAF.ResourceGroup.id | String | Resource group ID. |
| AzureWAF.ResourceGroup.location | String | Resource group location. |
| AzureWAF.ResourceGroup.name | String | Resource group name. |
| AzureWAF.ResourceGroup.type | String | Resource group type. |
| AzureWAF.ResourceGroup.properties | String | Resource group properties. |
| AzureWAF.ResourceGroup.tags | String | Resource group tags. |
Configuration parameters
app_id— App IDsubscription_id— Default Subscription ID (required)resource_group_name— Default Resource Group Name (required)auth_type— Authentication Type (required)tenant_id— Tenant IDcredentials— Client Secretredirect_uri— Application redirect URI (for authorization code mode)auth_code— Authorization codemanaged_identities_client_id—azure_ad_endpoint— Azure AD endpointinsecure— Trust any certificate (not secure)proxy— Use system proxy settings
Commands (15)
-
azure-waf-auth-completeRun this command to complete the authorization process. Should be used after running the azure_waf-auth-start command.
-
azure-waf-auth-resetRun this command if for some reason you need to rerun the authentication process.
-
azure-waf-auth-startRun this command to start the authorization process and follow the instructions provided in the command results.
-
azure-waf-auth-testTests connectivity to the Azure Web Application Firewall.
-
azure-waf-front-door-policies-listLists all of the Front Door protection policies within a resource group.
-
azure-waf-front-door-policies-list-all-in-subscriptionLists all of the Front Door protection policies within a subscription.
-
azure-waf-front-door-policy-deleteDeletes a Front Door policy.
-
azure-waf-front-door-policy-update-or-createCreates or updates a Front Door policy with a specified rule set name within a resource group.
-
azure-waf-generate-login-urlGenerate the login url used for Authorization code flow.
-
azure-waf-policies-getRetrieves protection policies within a resource group.
-
azure-waf-policies-list-all-in-subscriptionRetrieves all the WAF policies in a subscription.
-
azure-waf-policy-deleteDeletes a policy.
-
azure-waf-policy-update-or-createCreates or updates a policy with a specified rule set name within a resource group.
-
azure-waf-resource-group-listGets all the resource groups for a subscription.
-
azure-waf-subscriptions-listGets all subscriptions for a tenant.
import contextlib from typing import Any import demistomock as demisto # noqa: F401 import urllib3 from CommonServerPython import * # noqa: F401 from MicrosoftApiModule import * from CommonServerUserPython import * # Disable insecure warnings urllib3.disable_warnings() """ CONSTANTS """ UPSERT_PARAMS = { "resource_id": "id", "policy_settings": "properties.policySettings", "location": "location", "custom_rules": "properties.customRules", "tags": "tags", "managed_rules": "properties.managedRules", } FRONT_DOOR_UPSERT_PARAMS = { "location": "location", "custom_rules": "properties.customRules", "tags": "tags", "managed_rules": "properties.managedRules", "policy_settings": "properties.policySettings", "sku": "sku.name", "etag": "etag", } DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ" API_VERSION_POLICIES = "2025-05-01" API_VERSION_SUBSCRIPTIONS = "2022-12-01" API_VERSION_RESOURCE_GROUPS = "2021-04-01" FRONT_DOOR_API_VERSION = "2022-05-01" BASE_URL = "https://management.azure.com" POLICY_PATH = "providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies" FRONT_DOOR_POLICY_PATH = "providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies" """ CLIENT CLASS """ class AzureWAFClient: @logger def __init__( self, app_id, subscription_id, resource_group_name, verify, proxy, auth_type, tenant_id=None, enc_key=None, auth_code=None, redirect_uri=None, azure_ad_endpoint: str = "https://login.microsoftonline.com", managed_identities_client_id: str = None, ): AUTH_TYPES_DICT: dict = { "Authorization Code": { "grant_type": AUTHORIZATION_CODE, "resource": None, "scope": "https://management.azure.com/.default", }, "Device Code": { "grant_type": DEVICE_CODE, "resource": "https://management.core.windows.net", "scope": "https://management.azure.com/user_impersonation offline_access user.read", }, "Client Credentials": { "grant_type": CLIENT_CREDENTIALS, "resource": None, "scope": "https://management.azure.com/.default", }, } # for dev environment use: if "@" in app_id: app_id, refresh_token = app_id.split("@") integration_context = get_integration_context() integration_context.update(current_refresh_token=refresh_token) set_integration_context(integration_context) base_url = f"{BASE_URL}/subscriptions/{subscription_id}" self.subscription_id = subscription_id self.resource_group_name = resource_group_name client_args = assign_params( self_deployed=True, # We always set the self_deployed key as True because when not using a self # deployed machine, the DEVICE_CODE flow should behave somewhat like a self deployed # flow and most of the same arguments should be set, as we're !not! using OProxy. auth_id=app_id, token_retrieval_url="https://login.microsoftonline.com/organizations/oauth2/v2.0/token" if "Device Code" in auth_type else None, grant_type=AUTH_TYPES_DICT.get(auth_type, {}).get("grant_type"), # disable-secrets-detection base_url=base_url, verify=verify, proxy=proxy, resource=AUTH_TYPES_DICT.get(auth_type, {}).get("resource"), # disable-secrets-detection scope=AUTH_TYPES_DICT.get(auth_type, {}).get("scope"), ok_codes=(200, 201, 202, 204), redirect_uri=redirect_uri, auth_code=auth_code, azure_ad_endpoint=azure_ad_endpoint, tenant_id=tenant_id, enc_key=enc_key, managed_identities_client_id=managed_identities_client_id, managed_identities_resource_uri=Resources.management_azure, command_prefix="azure-waf", ) self.ms_client = MicrosoftClient(**client_args) @logger def http_request( self, method: str, url_suffix: str = None, full_url: str = None, params: dict = None, data: dict = None, resp_type: str = "json", return_empty_response: bool = False, ): if not params: params = {} return self.ms_client.http_request( method=method, url_suffix=url_suffix, full_url=full_url, json_data=data, params=params, resp_type=resp_type, timeout=20, return_empty_response=return_empty_response, ) def get_policy_by_name(self, policy_name: str, subscription_id: str, resource_group_name_list: list) -> list[dict]: base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_name_list: try: res.append( self.http_request( method="GET", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{POLICY_PATH}/{policy_name}", params={"api-version": API_VERSION_POLICIES}, ) ) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def get_policy_list_by_resource_group_name(self, subscription_id: str, resource_group_name_list: list) -> list[dict]: base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_name_list: try: res.append( self.http_request( method="GET", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{POLICY_PATH}", params={"api-version": API_VERSION_POLICIES}, ) ) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def get_policy_list_by_subscription_id(self, subscription_ids) -> list[dict]: res = [] for subscription_id in subscription_ids: base_url = f"{BASE_URL}/subscriptions/{subscription_id}" try: res.append( self.http_request( method="GET", full_url=f"{base_url}/{POLICY_PATH}", params={"api-version": API_VERSION_POLICIES} ) ) except Exception as e: res.append({"properties": f"Listing {subscription_id} threw Exception: {e!s}"}) return res def update_policy_upsert( self, policy_name: str, resource_group_names: list, subscription_id: str, data: dict, ) -> list[dict]: base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_names: try: res.append( self.http_request( method="PUT", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{POLICY_PATH}/{policy_name}", data=data, params={"api-version": API_VERSION_POLICIES}, ) ) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def delete_policy(self, policy_name: str, resource_group_name: str) -> requests.Response: return self.http_request( method="DELETE", return_empty_response=True, resp_type="response", url_suffix=f"/resourceGroups/{resource_group_name}/{POLICY_PATH}/{policy_name}", params={"api-version": API_VERSION_POLICIES}, ) def subscriptions_list(self) -> dict: return self.http_request( method="GET", return_empty_response=True, full_url=f"{BASE_URL}/subscriptions", params={"api-version": API_VERSION_SUBSCRIPTIONS}, ) def resource_group_list(self, subscription_ids: list, tag: str, limit: int) -> list[dict]: params = {"$top": limit, "api-version": API_VERSION_RESOURCE_GROUPS} if tag: params["$filter"] = tag res = [] for subscription_id in subscription_ids: full_url = f"{BASE_URL}/subscriptions/{subscription_id}/resourcegroups" try: res.append( { subscription_id: self.http_request( method="GET", return_empty_response=True, full_url=full_url, params=params ).get("value", {}) } ) except Exception as e: res.append({"properties": f"{subscription_id} threw Exception: {e!s}"}) return res # Front Door WAF Policy Methods def get_front_door_policy_by_name(self, policy_name: str, subscription_id: str, resource_group_name_list: list) -> list[dict]: """ Retrieve a Front Door WAF policy by name from specified resource groups. Args: policy_name (str): The name of the Front Door WAF policy to retrieve. subscription_id (str): The Azure subscription ID. resource_group_name_list (list): List of resource group names to search in. Returns: list[dict]: A list of policy dictionaries or error messages for each resource group. """ base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_name_list: try: res.append( self.http_request( method="GET", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{FRONT_DOOR_POLICY_PATH}/{policy_name}", params={"api-version": FRONT_DOOR_API_VERSION}, ) ) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def get_front_door_policy_list_by_resource_group_name( self, subscription_id: str, resource_group_name_list: list ) -> list[dict]: """ Retrieve all Front Door WAF policies from specified resource groups. Args: subscription_id (str): The Azure subscription ID. resource_group_name_list (list): List of resource group names to retrieve policies from. Returns: list[dict]: A list of policy dictionaries or error messages for each resource group. """ base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_name_list: try: res.append( self.http_request( method="GET", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{FRONT_DOOR_POLICY_PATH}", params={"api-version": FRONT_DOOR_API_VERSION}, ) ) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def get_front_door_policy_list_by_subscription_id(self, subscription_ids: list) -> list[dict]: """ Retrieve all Front Door WAF policies from specified subscriptions. Args: subscription_ids (list): List of Azure subscription IDs to retrieve policies from. Returns: list[dict]: A list of policy dictionaries or error messages for each subscription. """ res = [] for subscription_id in subscription_ids: base_url = f"{BASE_URL}/subscriptions/{subscription_id}" try: res.append( self.http_request( method="GET", full_url=f"{base_url}/{FRONT_DOOR_POLICY_PATH}", params={"api-version": FRONT_DOOR_API_VERSION}, ) ) except Exception as e: res.append({"properties": f"Listing {subscription_id} threw Exception: {e!s}"}) return res def update_front_door_policy_upsert( self, policy_name: str, resource_group_names: list, subscription_id: str, data: dict ) -> list[dict]: """ Create or update a Front Door WAF policy in specified resource groups. Args: policy_name (str): The name of the Front Door WAF policy to create or update. resource_group_names (list): List of resource group names to apply the policy to. subscription_id (str): The Azure subscription ID. data (dict): The policy configuration data. Returns: list[dict]: A list of updated policy dictionaries or error messages for each resource group. """ base_url = f"{BASE_URL}/subscriptions/{subscription_id}" res = [] for resource_group_name in resource_group_names: try: result = self.http_request( method="PUT", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{FRONT_DOOR_POLICY_PATH}/{policy_name}", data=data, params={"api-version": FRONT_DOOR_API_VERSION}, ) res.append(result) except Exception as e: res.append({"properties": f"{resource_group_name} threw Exception: {e!s}"}) return res def delete_front_door_policy(self, policy_name: str, resource_group_name: str, subscription_id: str) -> requests.Response: """ Delete a Front Door WAF policy from a resource group. Args: policy_name (str): The name of the Front Door WAF policy to delete. resource_group_name (str): The resource group name containing the policy. subscription_id (str): The Azure subscription ID. Returns: requests.Response: The HTTP response from the delete operation. """ base_url = f"{BASE_URL}/subscriptions/{subscription_id}" return self.http_request( method="DELETE", return_empty_response=True, resp_type="response", full_url=f"{base_url}/resourceGroups/{resource_group_name}/{FRONT_DOOR_POLICY_PATH}/{policy_name}", params={"api-version": FRONT_DOOR_API_VERSION}, ) """ COMMAND FUNCTIONS """ def test_connection(client: AzureWAFClient, params: dict) -> CommandResults: client.ms_client.get_access_token() # If fails, MicrosoftApiModule returns an error return CommandResults(readable_output="✅ Success!") @logger def start_auth(client: AzureWAFClient) -> CommandResults: result = client.ms_client.start_auth("!azure-waf-auth-complete") return CommandResults(readable_output=result) @logger def complete_auth(client: AzureWAFClient): client.ms_client.get_access_token() return "✅ Authorization completed successfully." def policies_get_command(client: AzureWAFClient, **args) -> CommandResults: """ Gets resource group name (or taking instance's default one), subscription id (or taking instance's default one) and policy name(optional). If a policy name provided, Retrieve the policy by name and resource group. Otherwise, retrieves all policies within the resource group. """ policy_name: str = args.get("policy_name", "") subscription_id: str = args.get("subscription_id", client.subscription_id) resource_group_name_list: list = argToList(args.get("resource_group_name", client.resource_group_name)) verbose = argToBoolean(args.get("verbose", "false")) limit = arg_to_number(args.get("limit", "20")) policies: list[dict] = [] try: if policy_name: policies = client.get_policy_by_name(policy_name, subscription_id, resource_group_name_list) else: raw_policy_list = client.get_policy_list_by_resource_group_name(subscription_id, resource_group_name_list) for policy in raw_policy_list: policies.extend(policy.get("value", [])) # only showing number of policies until reaching the limit provided. policies_num = len(policies) except Exception: raise return CommandResults( readable_output=policies_to_markdown(policies, verbose, limit), # type: ignore outputs=policies[: min(limit, policies_num)], # type: ignore outputs_key_field="id", outputs_prefix="AzureWAF.Policy", raw_response=policies, ) def policies_get_list_by_subscription_command(client: AzureWAFClient, **args) -> CommandResults: """ Retrieve all policies within the subscription id. """ policies: list[dict] = [] verbose = argToBoolean(args.get("verbose", "false")) limit: int = arg_to_number(args.get("limit", "10")) # type: ignore subscription_ids = argToList(args.get("subscription_id", client.subscription_id)) try: results = client.get_policy_list_by_subscription_id(subscription_ids) for res in results: policies.extend(res.get("value", [])) # only showing number of policies until reaching the limit provided. policies_num = len(policies) except DemistoException: raise return CommandResults( readable_output=policies_to_markdown(policies, verbose, limit), outputs=policies[: min(limit, policies_num)], outputs_key_field="id", outputs_prefix="AzureWAF.Policy", raw_response=policies, ) def parse_nested_keys_to_dict(base_dict: dict, keys: list, value: str | dict) -> None: """A recursive function to make a list of type [x,y,z] and value a to a dictionary of type {x:{y:{z:a}}}""" if len(keys) == 1: base_dict[keys[0]] = value else: if keys[0] not in base_dict: base_dict[keys[0]] = {} parse_nested_keys_to_dict(base_dict[keys[0]], keys[1:], value) def policy_upsert_command(client: AzureWAFClient, **args) -> CommandResults: """ Gets a policy name, resource groups (or taking instance's default), location, subscription id (or taking instance's default) and rules. Updates the policy if exists, otherwise creates a new policy. """ policy_name = str(args.get("policy_name", "")) resource_group_names = argToList(args.get("resource_group_name", client.resource_group_name)) subscription_id = args.get("subscription_id", client.subscription_id) managed_rules = args.get("managed_rules", {}) location = args.get("location", "") # location is not required by documentation but is required by the api itself. verbose = argToBoolean(args.get("verbose", "false")) if not policy_name or not managed_rules or not location: raise Exception("In order to add/ update policy, please provide policy_name, location and managed_rules. ") body: dict[str, Any] = {} # creating the body for the request, using pre-defined fields. for param in UPSERT_PARAMS: val = str(args.get(param, "")) with contextlib.suppress(json.decoder.JSONDecodeError): val = json.loads(val) if val: key_hierarchy = UPSERT_PARAMS[param].split(".") parse_nested_keys_to_dict(base_dict=body, keys=key_hierarchy, value=val) updated_policy = client.update_policy_upsert( policy_name=policy_name, resource_group_names=resource_group_names, subscription_id=subscription_id, data=body, ) return CommandResults( readable_output=policies_to_markdown(updated_policy, verbose), outputs=updated_policy, outputs_key_field="id", outputs_prefix="AzureWAF.Policy", raw_response=updated_policy, ) def policy_delete_command(client: AzureWAFClient, **args): """ Gets a policy name, resource group (or taking instance's default) and subscription id (or taking instance's default) and delete the policy from the resource group. """ policy_name = str(args.get("policy_name", "")) subscription_id = args.get("subscription_id", client.subscription_id) resource_group_names = argToList(args.get("resource_group_name", client.resource_group_name)) for resource_group_name in resource_group_names: # policy_path is unique and used as unique id in the product. policy_id = f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/{POLICY_PATH}/{policy_name}" status = client.delete_policy(policy_name, resource_group_name) md = "" context: dict = {} if status.status_code in [200, 202]: if not context: context = {} if old_context := demisto.dt(demisto.context(), f'AzureWAF.Policy(val.id === "{policy_id}")'): if isinstance(old_context, list): old_context = old_context[0] old_context["IsDeleted"] = True context["AzureWAF.Policy(val.id === obj.id)"] = old_context md = f"Policy {policy_name} was deleted successfully." if status.status_code == 204: md = f"Policy {policy_name} was deleted or not found." return CommandResults(outputs=context, readable_output=md) # Front Door WAF Policy Commands def front_door_policies_list_command(client: AzureWAFClient, **args) -> CommandResults: """ List Front Door WAF policies by name or retrieve all policies in resource groups. Args: client (AzureWAFClient): The Azure WAF client instance. **args: Command arguments including: - policy_name (str, optional): Specific policy name to retrieve. - subscription_id (str, optional): Azure subscription ID (defaults to client's subscription). - resource_group_name (str, optional): Resource group name(s) (defaults to client's resource group). - verbose (bool, optional): Whether to include detailed information (default: False). - limit (int, optional): Maximum number of policies to return (default: 10). Returns: CommandResults: Command results containing policy data and markdown output. """ policy_name: str = args.get("policy_name", "") subscription_id: str = args.get("subscription_id", client.subscription_id) resource_group_name_list: list = argToList(args.get("resource_group_name", client.resource_group_name)) verbose = argToBoolean(args.get("verbose", "false")) limit: int = arg_to_number(str(args.get("limit", "10"))) # type: ignore policies: list[dict] = [] try: if policy_name: policies = client.get_front_door_policy_by_name(policy_name, subscription_id, resource_group_name_list) else: raw_policy_list = client.get_front_door_policy_list_by_resource_group_name(subscription_id, resource_group_name_list) for policy in raw_policy_list: policies.extend(policy.get("value", [])) # only showing number of policies until reaching the limit provided. policies_num = len(policies) except Exception: raise return CommandResults( readable_output=policies_to_markdown(policies, verbose, limit), outputs=policies[: min(limit, policies_num)], outputs_key_field="id", outputs_prefix="AzureWAF.FrontDoorPolicy", raw_response=policies, ) def front_door_policies_list_all_in_subscription_command(client: AzureWAFClient, **args) -> CommandResults: """ Retrieve all Front Door WAF policies within specified subscriptions. Args: client (AzureWAFClient): The Azure WAF client instance. **args: Command arguments including: - subscription_id (str, optional): Azure subscription ID(s) (defaults to client's subscription). - verbose (bool, optional): Whether to include detailed information (default: False). - limit (int, optional): Maximum number of policies to return (default: 10). Returns: CommandResults: Command results containing policy data and markdown output. """ policies: list[dict] = [] verbose = argToBoolean(args.get("verbose", "false")) limit: int = arg_to_number(str(args.get("limit", "10"))) # type: ignore subscription_ids = argToList(args.get("subscription_id", client.subscription_id)) try: results = client.get_front_door_policy_list_by_subscription_id(subscription_ids) for res in results: policies.extend(res.get("value", [])) # only showing number of policies until reaching the limit provided. policies_num = len(policies) except DemistoException: raise return CommandResults( readable_output=policies_to_markdown(policies, verbose, limit), outputs=policies[: min(limit, policies_num)], outputs_key_field="id", outputs_prefix="AzureWAF.FrontDoorPolicy", raw_response=policies, ) def front_door_policy_upsert_command(client: AzureWAFClient, **args) -> CommandResults: """ Create or update a Front Door WAF policy. Args: client (AzureWAFClient): The Azure WAF client instance. **args: Command arguments including: - policy_name (str, required): The name of the policy to create or update. - resource_group_name (str, optional): Resource group name(s) (defaults to client's resource group). - subscription_id (str, optional): Azure subscription ID (defaults to client's subscription). - managed_rules (dict, required): Managed rules configuration. - location (str, optional): Azure location (defaults to "Global"). - custom_rules (dict, optional): Custom rules configuration. - policy_settings (dict, optional): Policy settings configuration. - tags (dict, optional): Resource tags. - sku (str, optional): SKU name (default: "Classic_AzureFrontDoor"). - etag (str, optional): Entity tag for concurrency control. - verbose (bool, optional): Whether to include detailed information (default: False). Returns: CommandResults: Command results containing the created/updated policy data and markdown output. """ policy_name = str(args.get("policy_name", "")) resource_group_names = argToList(args.get("resource_group_name", client.resource_group_name)) subscription_id = args.get("subscription_id", client.subscription_id) managed_rules = args.get("managed_rules", {}) sku = args.get("sku", "Classic_AzureFrontDoor") verbose = argToBoolean(args.get("verbose", "false")) if not policy_name or not managed_rules: raise Exception("In order to add/update Front Door policy, please provide policy_name and managed_rules.") body: dict[str, Any] = {} # creating the body for the request, using pre-defined fields. for param in FRONT_DOOR_UPSERT_PARAMS: val = str(args.get(param, "")) with contextlib.suppress(json.decoder.JSONDecodeError): val = json.loads(val) if val: key_hierarchy = FRONT_DOOR_UPSERT_PARAMS[param].split(".") parse_nested_keys_to_dict(base_dict=body, keys=key_hierarchy, value=val) if "location" not in body: body["location"] = "Global" # Set SKU if not already set if "sku" not in body: body["sku"] = {"name": sku} updated_policy = client.update_front_door_policy_upsert( policy_name=policy_name, resource_group_names=resource_group_names, subscription_id=subscription_id, data=body ) return CommandResults( readable_output=policies_to_markdown(updated_policy, verbose), outputs=updated_policy, outputs_key_field="id", outputs_prefix="AzureWAF.FrontDoorPolicy", raw_response=updated_policy, ) def front_door_policy_delete_command(client: AzureWAFClient, **args): """ Delete a Front Door WAF policy from resource groups. Args: client (AzureWAFClient): The Azure WAF client instance. **args: Command arguments including: - policy_name (str, required): The name of the policy to delete. - subscription_id (str, optional): Azure subscription ID (defaults to client's subscription). - resource_group_name (str, optional): Resource group name(s) (defaults to client's resource group). Returns: CommandResults: Command results with deletion status message. """ policy_name = str(args.get("policy_name", "")) subscription_id = args.get("subscription_id", client.subscription_id) resource_group_names = argToList(args.get("resource_group_name", client.resource_group_name)) for resource_group_name in resource_group_names: # policy_path is unique and used as unique id in the product. policy_id = ( f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/{FRONT_DOOR_POLICY_PATH}/{policy_name}" ) status = client.delete_front_door_policy(policy_name, resource_group_name, subscription_id) md = "" context: dict = {} if status.status_code in [200, 202]: if old_context := demisto.dt(demisto.context(), f'AzureWAF.FrontDoorPolicy(val.id === "{policy_id}")'): if isinstance(old_context, list): old_context = old_context[0] old_context["IsDeleted"] = True context["AzureWAF.FrontDoorPolicy(val.id === obj.id)"] = old_context md = f"Front Door Policy {policy_name} was deleted successfully." if status.status_code == 204: if old_context := demisto.dt(demisto.context(), f'AzureWAF.FrontDoorPolicy(val.id === "{policy_id}")'): if isinstance(old_context, list): old_context = old_context[0] old_context["IsDeleted"] = True context["AzureWAF.FrontDoorPolicy(val.id === obj.id)"] = old_context md = f"Front Door policy {policy_name} was deleted or not found." return CommandResults(outputs=context, readable_output=md) def policies_to_markdown(policies: list[dict], verbose: bool = False, limit: int = 10) -> str: """ Formats a list of policies as a single table with columns as fields and rows as different policies. """ if not policies: return "No policies were found." policies_num = len(policies) policies = policies[: min(limit, policies_num)] # Prepare data for table table_data: list[str | dict[str, Any]] = [] for policy in policies: policy_copy = policy.copy() properties = policy_copy.pop("properties", {}) if type(properties) is str: table_data.append({"Name": properties}) continue if verbose: # Include detailed information row = { "Name": policy_copy.get("name", ""), "Location": policy_copy.get("location", ""), "SKU": policy_copy.get("sku", {}).get("name", ""), "Provisioning State": properties.get("provisioningState", ""), "Resource State": properties.get("resourceState", ""), "Policy Mode": properties.get("policySettings", {}).get("mode", ""), "Policy State": properties.get("policySettings", {}).get("state", ""), "Custom Rules": len(properties.get("customRules", {})), "Managed Rule Sets": properties.get("managedRules", {}).get("managedRuleSets", []), "Type": policy_copy.get("type", ""), "Etag": policy_copy.get("etag", ""), "ID": policy_copy.get("id", ""), } else: # Include basic information only row = { "Name": policy_copy.get("name", ""), "Location": policy_copy.get("location", ""), "SKU": policy_copy.get("sku", {}).get("name", ""), "Provisioning State": properties.get("provisioningState", ""), "Type": policy_copy.get("type", ""), "ID": policy_copy.get("id", ""), } table_data.append(row) md = tableToMarkdown("Policies", table_data) md += f"\nShowing {len(policies)} policies out of {policies_num}" return md def subscriptions_to_md(subscriptions: list[dict]) -> str: """ Formats a list of subscription dictionaries as a Markdown table. Args: subscriptions (list[dict]): A list of subscription dictionaries. Each dictionary hold keys for 'subscriptionId', 'tenantId', 'state', and 'displayName'. Returns: str: A Markdown-formatted string representing the subscription data as a table. """ list_md = [] for subscription in subscriptions: sub_md = { key: subscription.get(key) for key in subscription if key in ("subscriptionId", "tenantId", "state", "displayName") } list_md.append(sub_md) return tableToMarkdown("Subscriptions: ", list_md) def format_resource_group_dict(resource_group: dict) -> dict: """ Formats a resource group dictionary by extracting its relevant fields. Args: resource_group (dict): A resource group dictionary. Returns: dict: A dictionary containing the resource group's name, location, tags, and provisioning state (if available). """ formatted_dict = { "name": resource_group.get("name"), "location": resource_group.get("location"), "tags": resource_group.get("tags", {}), } if provisioning_state := demisto.get(resource_group, "properties.provisioningState"): formatted_dict["provisioningState"] = provisioning_state return formatted_dict def resourcegroups_to_md(subscription_ids: list[dict]) -> str: """ Formats a list of resource group dictionaries as a Markdown table. Args: resource_groups (list[dict]): A list of resource group dictionaries. Each dictionary hold keys for 'name', 'location', 'tags', and 'properties.provisioningState'. Returns: str: A Markdown-formatted string representing the resource group data as a table. """ top_md = [] for subscription_id in subscription_ids: subscription_to_resource_groups_dict = {} for subscription_id_key in subscription_id: resource_groups_md = [] for group_resource in subscription_id.get(subscription_id_key, {}): resource_group_md = format_resource_group_dict(group_resource) resource_groups_md.append([resource_group_md]) subscription_to_resource_groups_dict[f"Subscription ID {subscription_id_key}"] = resource_groups_md top_md.append(subscription_to_resource_groups_dict) return tableToMarkdown("Resource Groups: ", top_md) def subscriptions_list_command(client: AzureWAFClient): subscriptions_res = client.subscriptions_list() subscriptions = subscriptions_res.get("value", []) if subscriptions_res else {} return CommandResults( readable_output=subscriptions_to_md(subscriptions), # type: ignore[arg-type] outputs=subscriptions, outputs_key_field="subscriptionId", outputs_prefix="AzureWAF.Subscription", raw_response=subscriptions, ) def resource_group_list_command(client: AzureWAFClient, **args) -> CommandResults: resource_groups: list[dict] = [] subscription_ids = argToList(args.get("subscription_id", client.subscription_id)) tag = args.get("tag", "") limit = args.get("limit", 50) results = client.resource_group_list(subscription_ids, tag, limit) for res in results: for key in res: sub_dict = {key: res.get(key, {})} resource_groups.append(sub_dict) return CommandResults( readable_output=resourcegroups_to_md(resource_groups), outputs=resource_groups, outputs_key_field="subscriptionId", outputs_prefix="AzureWAF.ResourceGroup", raw_response=resource_groups, ) @logger def test_module(client, params): """ Performs basic GET request to check if the API is reachable and authentication is successful. Returns ok if successful. """ params = demisto.params() if params.get("auth_type") == "Device Code": raise Exception( "When using Device Code flow configuration, " "Please enable the integration and run `!azure-waf-auth-start` and `!azure-waf-auth-complete` to " "log in. You can validate the connection by running `!azure-waf-auth-test`\n" "For more details press the (?) button." ) elif params.get("auth_type") == "Authorization Code": raise Exception( "When using Authorization Code flow configuration, " "Please enable the integration and run the !azure-waf-auth-test command in order to test it" ) elif params.get("auth_type") == "Azure Managed Identities": test_connection(client, params) return "ok" elif params.get("auth_type") == "Client Credentials": client.ms_client.get_access_token() return "ok" return None """ MAIN FUNCTION """ def main() -> None: """main function, parses params and runs command functions""" demisto_commands = { "azure-waf-policies-get": policies_get_command, "azure-waf-policies-list-all-in-subscription": policies_get_list_by_subscription_command, "azure-waf-policy-update-or-create": policy_upsert_command, "azure-waf-policy-delete": policy_delete_command, "azure-waf-front-door-policies-list": front_door_policies_list_command, "azure-waf-front-door-policies-list-all-in-subscription": front_door_policies_list_all_in_subscription_command, "azure-waf-front-door-policy-update-or-create": front_door_policy_upsert_command, "azure-waf-front-door-policy-delete": front_door_policy_delete_command, "azure-waf-auth-start": start_auth, "azure-waf-auth-complete": complete_auth, "azure-waf-auth-test": test_connection, "azure-waf-resource-group-list": resource_group_list_command, } params = demisto.params() command = demisto.command() args = demisto.args() client = AzureWAFClient( tenant_id=params.get("tenant_id", ""), auth_type=params.get("auth_type", "Device Code"), auth_code=params.get("auth_code", {}).get("password", ""), redirect_uri=params.get("redirect_uri", ""), enc_key=params.get("credentials", {}).get("password", ""), app_id=params.get("app_id", ""), subscription_id=params.get("subscription_id", ""), resource_group_name=params.get("resource_group_name", ""), verify=not params.get("insecure", False), proxy=params.get("proxy", False), azure_ad_endpoint=params.get("azure_ad_endpoint", "https://login.microsoftonline.com") or "https://login.microsoftonline.com", managed_identities_client_id=get_azure_managed_identities_client_id(params), ) demisto.debug(f"Command being called in Azure WAF is {command}") try: if command == "test-module": return_results(test_module(client, params)) elif command == "azure-waf-auth-test": return_results(test_connection(client, params)) elif command == "azure-waf-generate-login-url": return_results(generate_login_url(client.ms_client)) elif command == "azure-waf-subscriptions-list": return_results(subscriptions_list_command(client)) elif command == "azure-waf-auth-reset": return_results(reset_auth()) else: return_results(demisto_commands[command](client, **args)) # Log exceptions and return errors except Exception as e: demisto.error(traceback.format_exc()) # print the traceback return_error(f"Failed to execute {demisto.command()} command.\nError:\n{e!s}") """ ENTRY POINT """ if __name__ in ("__main__", "__builtin__", "builtins"): main()