Skip to content

Latest commit

 

History

History
256 lines (188 loc) · 11.3 KB

README.md

File metadata and controls

256 lines (188 loc) · 11.3 KB
Raw

CloudBots is an automatic remediation solution for public cloud platforms (Azure, AWS, and GCP)

What are CloudGuard CloudBots?

Cloud-Bots is an auto remediation solution for Azure, built on top of the CloudGuard Native Continuous Compliance capabilities.

They can also be used standalone, without CloudGuard, to remedy issues in Azure subscriptions. Details are included how to configure and trigger them.

Flow Diagram

Flow Diagram

The Bots

Refer to this file for a list of the bots, what each one does, and an example of a rule that could be used to trigger it.

Deploy the CloudBots to your Azure accounts

To use the CloudBots in your Azure accounts, you must setup your account and your CloudGuard account.

Setup your Azure subscriptions for CloudBots

Follow these steps to configure your Azure subscriptions to use CloudGuard CloudBots:

  • Install Python and dependent packages needed by the Cloudbots
  • Create a new Azure app registration for CloudBots
  • Optionally, create a SendGrid account to forward email notifications
  • Create a custom role for the CloudBots Function
  • Assign IAM roles for the app registration created above
  • Create an empty Azure function for the CloudBots
  • Deploy the CloudBots in the Azure subscription

  1. Install Dependencies

    Note: If you already have Azure CLI and Azure functions make sure to use the latest versions

    1. Azure CLI, and then login to your Azure account
    2. Azure Functions Core Tools
    3. Python 3.6.X or higher
    4. NodeJS > 8.5
    5. Microsoft .NET core > 2.2

  2. Create Azure App Registration:

    1. In the Azure portal, navigate to App registrations, and the click New registration.
    2. Enter a name for the app (for example, CloudGuardCloudBots), then click Register.
    3. Save the Application (client) ID and Directory (tenant) ID.
    4. Navigate to Certificates & secrets, from the left side menu, and click New client secret and click Add
    5. Save the secret's Value.

  3. Create SendGrid, to be used to send remediation outputs by email (Optional)

    1. In the Azure portal, navigate to SendGrid Accounts.
    2. Click Add, and complete the signup form.
    3. Select the new SendGrid account, and then click Manage.
    4. Select Settings -> API Keys, and then click Create API Key.
    5. Enter a name (for example, CloudGuardCloudBots), select Full Access, then click Create & View.
    6. Save the key value (will be needed in a later step).

  4. Create a custom role for the CloudBots Function

    1. In the Azure Portal, navigate to Subscriptions.
    2. Select the subscription that will use the CloudBots.
    3. Select Access control (IAM) from the menu on the left.
    4. Click Add -> Add custom role

    1. Go to JSON section.

    2. Click on Edit (in the top-right corner of the text box)

    3. Copy the JSON object from the file: CloudGuard-CloudBots-Role.json

    4. In the assignableScopes property, fill in your subscription id in the marked place.

    5. Press Save (in the top-right corner).

    6. Press Review + create (at the bottom).

    7. Check the permissions granted and press Create.

    8. Repeat these steps for each additional Subscription.

  5. Assign Roles

    1. Navigate to Subscriptions.

    2. Select the subscription that will use the CloudBots.

    3. Select Access control (IAM) from the menu on the left.

    4. Click Add -> Add role assignment

    5. Search for the role you created in the last step and press on View.

    6. Press on Select role.

    7. Press on Select members.

    8. Select the App Registration you created earlier.

    9. Press on Review +assign.

    10. Repeat these steps for each additional Subscription.

  6. Create an Azure Function App

    1. Clone the CloudBots Azure code from GitHub (git clone https://github.com/dome9/cloud-bots-azure.git)

    2. Click the "Deploy to Azure" button and fill out the deployment form

    3. Both the Azure Function name and the Storage Account name must be globally unique or deployment will fail (if a new storage account is created)

    1. Once the ARM template deployment is complete, open a command prompt and navigate to the cloud-bots-azure folder

    2. Install the Azure Functions command line tools (https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local?tabs=windows%2Ccsharp%2Cbash)

    3. Run func init

    4. Run func azure functionapp publish functname where the functname is your function name from the "Deploy to Azure" workflow. This will take a few minutes to complete. Be patient - get a coffee!

Deploy to Azure

Multiple Accounts

If you are deploying CloudBots on several Azure subscriptions, repeat step 4 (Assign Roles), above, for each subscription.

Setup your CloudGuard account

On CloudGuard you must add remediation definitions to rules in a compliance ruleset. Refer to the latest CloudGuard documentation on how to do this (https://sc1.checkpoint.com/documents/CloudGuard_Dome9/Documentation/PostureManagement/Remediation.htm#microcontent1).

Configure the Remediation

Follow these steps in your CloudGuard account to tag the compliance rules & rulesets to use bots as a remediation step.

  1. In the CloudGuard web app, navigate to the Remediation page in the Posture Management menu.

  2. Click Create New Remediation, in the upper right.

  3. Select the rules for which the remediation applies, from the given options. The options can be combined, and the effective rules on which the remediation applies are the combination of all the selected options.

    • A Ruleset (mandatory)
    • A specific Rule in the ruleset (optional, if missing, all rules are implied)
    • A specific Entity, by its entity ID (optional, if missing, all entities are implied); this selects all rules involving the selected entities
    • A specific Cloud Account, this applies the remediation to rules in the selected ruleset only when the ruleset is applied to the selected cloud accounts.
    • Select the CloudBot, from the list. If the cloudbot is not in the list, select Custom, and then add the name of the cloudbot, along with the runtime arguments**. The cloudbot must be deployed in the selected cloud account, in the same folder as the other bots.
    • Add a comment and then click Save.

** Example for using a custom bot:

Configure a Continuous Compliance policy

Once the rules in the ruleset have been tagged for remediation, set up a Continuous Compliance policy to run the ruleset, and send findings the Azure function webhook.

  1. Navigate to the Policies page in the Compliance & Governance menu.
  2. Click ADD POLICY (on the right).
  3. Select the account from the list, then click NEXT, this will be the one account in which the bots are deployed.
  4. Select the ruleset from the list, then click NEXT.
  5. Click ADD NOTIFICATION.
  6. Select Send to HTTP Endpoint and enter the URL from the Function App and then click SAVE.

Note: CloudGuard will send event messages to the webhook for new findings. To send events for previous findings, follow these steps:

  1. Navigate to the Policies page.
  2. Find the ruleset and account in the list, and hover over the right of the row, then click on the Send All Alerts icon.
  3. Select the webhook Notification Type option, and the Notification Policy (the one created above), then click SEND. CloudGuard will send event messages to the Azure function webhook.

Update the CloudBots code

See Update CloudBots Function App

Log Collection for Troubleshooting

The cloudbots send log information to CloudGuard, that is used for troubleshooting. By default, this is enabled for all bots. You can disable this in your Azure account. Select the function, and set the environment variable SEND_LOGS to False. This will apply to all bots in the account. By default, this is set to True, enabling logs.

Each account is controlled by the variable for the function configured in that account.