Azure Front Door WAF v1.0.0

About the connector

Azure Front Door WAF Service enables you to define, manage, and monitor the global routing for your web traffic by optimizing for best performance and instant global failover for high availability. With Front Door, you can transform your global (multi-region) consumer and enterprise applications into robust, high-performance personalized modern applications, APIs, and content that reach a global audience with Azure.

This document provides information about the Azure Front Door WAF Connector, which facilitates automated interactions, with a Azure Front Door WAF server using FortiSOAR™ playbooks. Add the Azure Front Door WAF Connector as a step in FortiSOAR™ playbooks and perform automated operations with Azure Front Door WAF.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 7.4.1-3167

Azure Front Door WAF Version Tested on: 2020-11-01

Authored By: Fortinet

Certified: Yes

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-azure-front-door-waf

Prerequisites to configuring the connector

• You must have the credentials of Azure Front Door WAF server to connect and perform automated operations.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the Azure Front Door WAF server.

Minimum Permissions Required

• Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Azure Front Door WAF connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

operation: Create or Update Policy

Input parameters

Output

The output contains the following populated JSON schema:

{
    "name": "",
    "id": "",
    "type": "",
    "tags": "",
    "location": "",
    "properties": {
        "resourceState": "",
        "provisioningState": "",
        "policySettings": {
            "enabledState": "",
            "mode": "",
            "redirectUrl": "",
            "customBlockResponseStatusCode": "",
            "customBlockResponseBody": "",
            "requestBodyCheck": ""
        },
        "customRules": {
            "rules": [
                {
                    "name": "",
                    "priority": "",
                    "enabledState": "",
                    "ruleType": "",
                    "rateLimitDurationInMinutes": "",
                    "rateLimitThreshold": "",
                    "matchConditions": [
                        {
                            "matchVariable": "",
                            "selector": "",
                            "operator": "",
                            "negateCondition": "",
                            "matchValue": [],
                            "transforms": []
                        }
                    ],
                    "action": ""
                }
            ]
        },
        "managedRules": {
            "managedRuleSets": [
                {
                    "ruleSetType": "",
                    "ruleSetVersion": "",
                    "ruleSetAction": "",
                    "exclusions": [
                        {
                            "matchVariable": "",
                            "selectorMatchOperator": "",
                            "selector": ""
                        }
                    ],
                    "ruleGroupOverrides": [
                        {
                            "ruleGroupName": "",
                            "exclusions": [
                                {
                                    "matchVariable": "",
                                    "selectorMatchOperator": "",
                                    "selector": ""
                                }
                            ],
                            "rules": [
                                {
                                    "ruleId": "",
                                    "enabledState": "",
                                    "action": "",
                                    "exclusions": [
                                        {
                                            "matchVariable": "",
                                            "selectorMatchOperator": "",
                                            "selector": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "frontendEndpointLinks": [],
        "securityPolicyLinks": []
    },
    "sku": {
        "name": ""
    }
}

operation: Get Policy Details

Input parameters

Output

The output contains the following populated JSON schema:

{
    "name": "",
    "id": "",
    "type": "",
    "tags": "",
    "location": "",
    "properties": {
        "resourceState": "",
        "provisioningState": "",
        "policySettings": {
            "enabledState": "",
            "mode": "",
            "redirectUrl": "",
            "customBlockResponseStatusCode": "",
            "customBlockResponseBody": "",
            "requestBodyCheck": ""
        },
        "customRules": {
            "rules": [
                {
                    "name": "",
                    "priority": "",
                    "enabledState": "",
                    "ruleType": "",
                    "rateLimitDurationInMinutes": "",
                    "rateLimitThreshold": "",
                    "matchConditions": [
                        {
                            "matchVariable": "",
                            "selector": "",
                            "operator": "",
                            "negateCondition": "",
                            "matchValue": [],
                            "transforms": []
                        }
                    ],
                    "action": ""
                }
            ]
        },
        "managedRules": {
            "managedRuleSets": [
                {
                    "ruleSetType": "",
                    "ruleSetVersion": "",
                    "ruleSetAction": "",
                    "exclusions": [
                        {
                            "matchVariable": "",
                            "selectorMatchOperator": "",
                            "selector": ""
                        }
                    ],
                    "ruleGroupOverrides": [
                        {
                            "ruleGroupName": "",
                            "exclusions": [],
                            "rules": [
                                {
                                    "ruleId": "",
                                    "enabledState": "",
                                    "action": "",
                                    "exclusions": []
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "frontendEndpointLinks": [
            {
                "id": ""
            }
        ],
        "securityPolicyLinks": []
    },
    "sku": {
        "name": ""
    }
}

operation: Get Policies List

Input parameters

None.

Output

The output contains the following populated JSON schema:

{
    "value": [
        {
            "name": "",
            "id": "",
            "type": "",
            "tags": "",
            "location": "",
            "sku": {
                "name": ""
            },
            "properties": {
                "resourceState": "",
                "provisioningState": "",
                "policySettings": {
                    "enabledState": "",
                    "mode": "",
                    "redirectUrl": "",
                    "customBlockResponseStatusCode": "",
                    "customBlockResponseBody": ""
                },
                "customRules": {
                    "rules": [
                        {
                            "name": "",
                            "priority": "",
                            "enabledState": "",
                            "ruleType": "",
                            "rateLimitDurationInMinutes": "",
                            "rateLimitThreshold": "",
                            "matchConditions": [
                                {
                                    "matchVariable": "",
                                    "selector": "",
                                    "operator": "",
                                    "negateCondition": "",
                                    "matchValue": [],
                                    "transforms": []
                                }
                            ],
                            "action": ""
                        }
                    ]
                },
                "managedRules": {
                    "managedRuleSets": [
                        {
                            "ruleSetType": "",
                            "ruleSetVersion": "",
                            "exclusions": [
                                {
                                    "matchVariable": "",
                                    "selectorMatchOperator": "",
                                    "selector": ""
                                }
                            ],
                            "ruleGroupOverrides": [
                                {
                                    "ruleGroupName": "",
                                    "rules": [
                                        {
                                            "ruleId": "",
                                            "enabledState": "",
                                            "action": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                "frontendEndpointLinks": [
                    {
                        "id": ""
                    }
                ],
                "securityPolicyLinks": []
            }
        }
    ]
}

operation: Delete Policy

Input parameters

Output

The output contains the following populated JSON schema:

{
    "success": "Deleted Successfully"
}

operation: Block IP

Input parameters

Output

The output contains the following populated JSON schema:

{
    "name": "",
    "id": "",
    "type": "",
    "tags": "",
    "location": "",
    "properties": {
        "resourceState": "",
        "provisioningState": "",
        "policySettings": {
            "enabledState": "",
            "mode": "",
            "redirectUrl": "",
            "customBlockResponseStatusCode": "",
            "customBlockResponseBody": "",
            "requestBodyCheck": ""
        },
        "customRules": {
            "rules": [
                {
                    "name": "",
                    "priority": "",
                    "enabledState": "",
                    "ruleType": "",
                    "rateLimitDurationInMinutes": "",
                    "rateLimitThreshold": "",
                    "matchConditions": [
                        {
                            "matchVariable": "",
                            "selector": "",
                            "operator": "",
                            "negateCondition": "",
                            "matchValue": [],
                            "transforms": []
                        }
                    ],
                    "action": ""
                }
            ]
        },
        "managedRules": {
            "managedRuleSets": [
                {
                    "ruleSetType": "",
                    "ruleSetVersion": "",
                    "ruleSetAction": "",
                    "exclusions": [
                        {
                            "matchVariable": "",
                            "selectorMatchOperator": "",
                            "selector": ""
                        }
                    ],
                    "ruleGroupOverrides": [
                        {
                            "ruleGroupName": "",
                            "exclusions": [
                                {
                                    "matchVariable": "",
                                    "selectorMatchOperator": "",
                                    "selector": ""
                                }
                            ],
                            "rules": [
                                {
                                    "ruleId": "",
                                    "enabledState": "",
                                    "action": "",
                                    "exclusions": [
                                        {
                                            "matchVariable": "",
                                            "selectorMatchOperator": "",
                                            "selector": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "frontendEndpointLinks": [],
        "securityPolicyLinks": []
    },
    "sku": {
        "name": ""
    }
}

operation: Unblock IP

Input parameters

Output

The output contains the following populated JSON schema:

{
    "name": "",
    "id": "",
    "type": "",
    "tags": "",
    "location": "",
    "properties": {
        "resourceState": "",
        "provisioningState": "",
        "policySettings": {
            "enabledState": "",
            "mode": "",
            "redirectUrl": "",
            "customBlockResponseStatusCode": "",
            "customBlockResponseBody": "",
            "requestBodyCheck": ""
        },
        "customRules": {
            "rules": [
                {
                    "name": "",
                    "priority": "",
                    "enabledState": "",
                    "ruleType": "",
                    "rateLimitDurationInMinutes": "",
                    "rateLimitThreshold": "",
                    "matchConditions": [
                        {
                            "matchVariable": "",
                            "selector": "",
                            "operator": "",
                            "negateCondition": "",
                            "matchValue": [],
                            "transforms": []
                        }
                    ],
                    "action": ""
                }
            ]
        },
        "managedRules": {
            "managedRuleSets": [
                {
                    "ruleSetType": "",
                    "ruleSetVersion": "",
                    "ruleSetAction": "",
                    "exclusions": [
                        {
                            "matchVariable": "",
                            "selectorMatchOperator": "",
                            "selector": ""
                        }
                    ],
                    "ruleGroupOverrides": [
                        {
                            "ruleGroupName": "",
                            "exclusions": [
                                {
                                    "matchVariable": "",
                                    "selectorMatchOperator": "",
                                    "selector": ""
                                }
                            ],
                            "rules": [
                                {
                                    "ruleId": "",
                                    "enabledState": "",
                                    "action": "",
                                    "exclusions": [
                                        {
                                            "matchVariable": "",
                                            "selectorMatchOperator": "",
                                            "selector": ""
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "frontendEndpointLinks": [],
        "securityPolicyLinks": []
    },
    "sku": {
        "name": ""
    }
}

Included playbooks

The Sample - Azure Front Door WAF - 1.0.0 playbook collection comes bundled with the Azure Front Door WAF connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Azure Front Door WAF connector.

• Block IP
• Create or Update Policy
• Delete Policy
• Get Policies List
• Get Policy Details
• Unblock IP

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

Getting Access Tokens

You can get authentication tokens to access the security Azure APIs using two methods:

• On behalf of the User – Delegate Permission
• Without a User – Application Permission

For more information see, https://learn.microsoft.com/en-us/rest/api/azure/

Getting Access Tokens using the On behalf of the user – Delegate Permission method

1. Register your app. To register an app refer to App Registration Quickstart.
2. Ensure that the required permissions are granted for the registration of the application.
   For example, for a Microsoft Azure User, following API/Permissions must be granted:
   • user_impersonation
3. The Redirect URL can be directed to any web application in which you want to receive responses from Azure Firewall. If you are unsure about what to set as a redirect URL, you can use https://localhost/myapp.
4. Copy the following URL and replace the TENANT_ID, CLIENT_ID, and REDIRECT_URI with your tenant ID, client ID, and the following redirect URL:
   https://login.microsoftonline.com/TENANT_ID/oauth2/v2.0/authorize?response_type=code&scope=https://management.azure.com/user_impersonation offline_access user.read&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI
5. Enter the above link with the replaced values and you will be prompted to grant 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
6. Enter your client ID in the Client ID parameter field.
7. Enter your client secret in the Client Secret parameter field.
8. Enter your tenant ID in the Tenant ID parameter field.
9. Copy the AUTH_CODE (without the code= prefix) and paste it in your instance configuration in the Authorization Code parameter.
10. Enter your redirect URL in the Redirect URL parameter field. By default, it is set to https://localhost/myapp.

Getting Access Tokens using the Without a User – Application Permission method

1. Register your app. To register an app refer to App Registration Quickstart.
2. Assign the role of Owner to the application registered.
   To assign roles, refer to Assign Azure roles using the Azure portal.
3. Ensure that the required permissions are granted for the registration of the application.
   For example, for a Microsoft Azure User, following API/Permissions must be granted:
   • user_impersonation
4. Enter your client ID in the Client ID parameter field.
5. Enter your client secret in the Client Secret parameter field.
6. Enter your tenant ID in the Tenant ID parameter field.