Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Introduction

Microsoft Azure, often referred to as Azure is a cloud computing platform run by Microsoft. It offers access, management, and the development of applications and services through global data centers. It also provides a range of capabilities, including software as a service (SaaS), platform as a service (PaaS), and infrastructure as a service (IaaS).

Snare Central is offering a convenient way to collect logs generated by a variety of Azure cloud services and store them in the Snare Central Archive for reporting, analysis and compliance.

This setup guide will cover the basic required setup for the SNARE - Azure cloud log collection to work. Security related setup, charges you may incur, and other intricacies related to Microsoft Azure will not be covered in detail in this guide.

Overview

All applications, whether on-premises or in the cloud, must include logging since it aids in security implementation and debugging. Azure provides services to collect cloud platform logs to ensure optimal application performance.

Snare Central can be configured to collect activity and resource or diagnostic logs from Azure using Log Analytics API.

image-20240115-092102.png

Snare Central needs to request authentication keys from Microsoft Entra ID in order to connect to the Log Analytics API. Once authentication is accepted, required API permissions are granted, and access control is setup, Snare Central will be able to query the target activity and diagnostic logs using the same API.

About Azure platform logs

Below are the types of logs that can be collected from Azure (Snare Central supports the collection some log types, see details here for the supported log types).

Microsoft Entra logs

  • Microsoft Entra logs contain the history of sign-in activity and an audit trail of changes made in Microsoft Entra ID for a particular tenant.

  • Types of activity logs in Microsoft Entra ID: Sign-in logs and Audit logs

Activity logs

  • It provides insight into the operations on each Azure resource and use to determine what, who, and when for any write operations (PUT, POST, DELETE) taken on the resources in your subscription.

  • There's a single activity log for each Azure subscription.

Resource logs

  • Resource logs provide an insight into operations that were performed within an Azure resource, known as the data plane. Examples include getting a secret from a key vault or making a request to a database.

  • Log contents vary according to the Azure service and resource type.

  • Logs aren't collected until they're routed to a destination, to be enabled and configured via Diagnostic settings. While some Azure resource may have some special type of logs (e.g. Azure NSG - Flow logs)

Snare Central and Log Analytics API communication

In order for Snare Central to properly communicate and collect Azure logs using the Log Analytics API, these things need to be created and setup first in the Azure environment:

  • Register Snare Central in Microsoft Entra ID.

  • Create Log Analytics workspace

  • Setting up workspace Access Control (IAM)

  • Export activity and diagnostic logs towards Log Analytics workspace.

Register Snare Central in Microsoft Entra ID

To allow Snare Central to access the Log Analytics API, Snare Central must be registered in Microsoft Entra ID formerly known as Azure Active Directory (AD). This allows the Snare Central to establish an identity and specify the needed permission levels for the API access.

The Log Analytics API uses Microsoft Entra ID to provide authentication services that you can use to setup the necessary permission rights for Snare Central to access them.

 3 important steps when registering an application:

Step 1: App registration

  • Create a dedicated application for Snare Central inside Microsoft Entra ID.

  • Follow steps 1~5 on this user guide, last output screen should look like this:

    az-app-reg.png

  • Target output:
    Application (client) ID - Generated by Microsoft Entra ID, Snare Central will use this value when requesting consent from tenant admins and when requesting app-only tokens from Microsoft Entra ID. Make sure to save this value, it will be used during Snare Central’s Azure Cloud log collection configuration.

Step 2: Key or client secret generation

  • Generate the necessary client secret that will be used by Snare Central’s authentication towards Log Analytics API.

  • Follow steps 6~10 on the same user guide, last output screen should look like this:

    image-20240223-030403.png

  • Target output:
    Client Secret: Make sure to copy and save the text in the “Value” column for the generated credential. Microsoft Entra ID only displays this value at the time of its generation, it will be masked after that. Also, it will be used during Snare Central’s Azure Cloud log collection configuration.
    Note: A user is allowed to create and use multiple client credentials.

Step 3: Setting up APIs permissions

  • Configure and setup the required permissions for Log Analytics API connection and interaction with Snare Central.

  • Follow steps 2~7 on this user guide, step 1 is not needed, since it was already done during App registration and Key or client secret generation.
    Last output screen should look like this:

    image-20240301-041123.png

  • Target output: Permission is set Data.Read, Type is Delegated and Admin consent required is set to No.

Create Log Analytics workspace

When Azure collects logs and data, the information is stored in a workspace. A workspace has a unique workspace ID and resource ID. After you've created a workspace, you can configure the Azure resource(s) to send the activity logs and diagnostic logs to the created workspace.

Snare Central can query and collect logs from the created workspace using the Log Analytics API.

 Creating a Log Analytic workspace

Creating a workspace

  • Note(s):

    • To create a Log Analytics workspace, you need an Azure account with an active subscription.

    • A user may opt to skip this step if the user already has a Log Analytics workspace.

  • Follow steps 1~7 on this user guide.

  • Target output: Workspace resource and unique GUID assign for it - The unique GUID assigned to the workspace will be used during Azure cloud log configuration on Snare Central.

    image-20240301-010739.png

Setting up workspace Access Control (IAM)

 Setting up workspace’s Access Control (IAM)

Setting up Access Control (IAM)

  • Note: Without this setup, Snare Central will not be able to proceed with its connection and collection towards Azure, and Snare Central will encounter an error "The provided credentials have insufficient access to perform the requested operation" if not properly done.

  • Configure the required access control by following the steps below.

  • Go to the Azure portral then search for Log Analytics workspace.

    image-20240229-025326.png

  • Select and click the previously created Log Analytics workspace, at the Log Analytics workspace’s main page, go and click the Access Control (IAM).

    image-20240229-025714.png

  • Click Add Role assignment then select Reader role then click Members.

    image-20240229-030050.png

  • At Members page, click + Select Members then search for the name of the application (which was previously created during App registration) then click Select.

    image-20240229-030318.png

  • Click Review + assign and wait for the modification on Role Assignment to reflect on Role Assignments list.

  • To check the configured Role Assignment, just simply go to the Access Control (IAM) page then Role Assignments, look the configured Role Assignment, it should be present on the list under Reader role.

    image-20240229-031005.png

Export activity and diagnostic logs towards Log Analytics workspace.

 Exporting activity and diagnostic logs towards a workspace

Export activity logs towards Log Analytics workspace

  • This setting allows the activity logs to be dumped into a target log analytics workspace for Snare Central to query and collect those logs using the Log Analytics API.

  • Follow steps below for the required settings.

  • Go to the Azure portral then search for Monitor.

    image-20240226-033537.png

  • At Monitor page, look for Activity log then click it, then click Export Activity Logs.

    image-20240226-033802.png

  • Click Add diagnostic setting, then fill up the necessary info, then select the target Log Categories and select Send to Log Analytics workspace and select the target Log analytics workspace (which was previously created) then Save.

    image-20240226-061826.png

  • Wait for 1-2 minutes for the settings to reflect on Azure side.

  • Target output: All Azure activity logs is expected to be dumped into the selected Log Analytics workspace and Snare Central should be able to collect those activity logs.

Export diagnostic logs towards Log Analytics workspace

  • This setting allows a resource specific log(s) to be dumped into a target log analytics workspace for Snare Central to query and collect those logs using the Log Analytics API.

  • Follow steps below for the required settings.

  • Go to the Azure portral then search for the target resource, example: Firewall.

    image-20240226-055843.png

  • Click the target resource and go its Diagnostic Settings.

    image-20240229-032523.png

  • Click Add diagnostic setting, then fill up the necessary info, then select the target Log Categories and select Send to Log Analytics workspace, choose Azure diagnostics and select the target Log analytics workspace (which was previously created) then Save.

    image-20240226-061539.png

  • Target output: All logs for the selected Azure resource is expected to be dumped into the selected Log Analytics workspace and Snare Central should be able to collect those activity logs.

  • Note: User needs to repeat the above steps for all the resource that needs log collection.

Setting Up Snare Central - Azure Cloud Log Collection

Starting from Snare Central v8.6.0, Azure Cloud Log Collection functionality will be available as long as you have the proper license for it.

This capability requires a license with either Office 365 Logs Collection (IA_CLOUD_O365) or Cloud Logs Collection (IA_CLOUD) license features.

This guide will help you setup up your Snare Central and start collecting supported Azure activity and resource logs in no-time by simply using the intuitive Cloud Log Collection Configuration Web UI of Snare Central.

For more info about the supported Azure Log types, see: Supported Azure Log Types.

 Step by Step Guide for Setting Up Snare Central - Azure Cloud Log Collection

Step 1. Go to Snare Central and navigate to System > Administrative Tools > Cloud Log Collection Configuration.

image-20240226-085125.png

Step 2. Select Azure Cloud and Click ADD CLOUD COLLECTION button.

image-20240226-073826.png

Step 3. Input all the necessary Azure Cloud Collection Configuration Information and click Test Connection Button to check if the configuration is correct and can properly connect to the Log Analytics API.

  • Name: Any name to easily identify this Azure Cloud Log Collector.

  • Enabled: Can be toggled ON/OFF. This will determine if the Azure Cloud Collector will be enabled and start log collection (This can also be toggled ON/OFF easily later after setup).

  • Supported Logs: "Identifies the target log type/s to be collected collector, see supported log types here.

  • Fetch Interval: Log collection interval (in millisecond) for each log collection request, should not be less than 120000 or greater than 900000.

  • Domain: Fetch the Primary domain value on the main page of the Azure portal site.

  • Tenant ID: Fetch the Tenant ID value on the same Azure portal site.

  • Organization ID: The organization or company name or you can fetch the Name value on the same Azure portal site.

  • Subscription ID: Fetch the user’s subscription ID using this user guide.

    image-20240226-072816.png

  • Workspace ID: Fetch the Workspace ID that was generated during Log Analytics workspace creation.

    image-20240226-071927.png

  • Client ID: Fetch the Application (client) ID that was generated during App registration.

    image-20240226-070923.png

  • Client Secret: Fetch the “Value” that was generated during “Key or client secret generation” process.

    image-20240226-071054.png

  • Additional Notes

    • Optional field that you may use to Note any related information to this Azure Cloud Log Collector

      image-20240226-080828.png

    • Test Connection can be used to check whether the input configuration parameters were correct or not.

      image-20240226-080747.png

Step 4. Click ADD button, then you should be able to see the added Azure Cloud Log Collector under the Azure Cloud Collection List.

image-20240226-075244.png

Updating/Deleting - Azure Cloud Log Collection Configuration

If you want to update or delete an existing Azure Cloud - Log Collector that were previously configured, you can simply use the Snare Central’s Cloud Log Collection Configuration Web UI and follow the simple steps below.

 Step by Step Guide for Updating Snare Central - Azure Cloud Log Collection

Step 1. Go to Snare Central and navigate to System > Administrative Tools > Cloud Log Collection Configuration.

image-20240226-085125.png

Step 2. Select Azure Cloud and Click the Azure Cloud Log Collector that you want to update.
Collector details panel will open on the right-hand side.
Click the Edit icon on the top right of the details panel.

image-20240226-080314.png

Step 3. In the Edit screen, you can update the configuration and optionally do a Test Connection to check if the updated configuration can successfully connect to the Log Analytics API, then simply click the SAVE button to save the updated configuration.

image-20240226-080542.png

 Step by Step Guide for Deleting Snare Central - Azure Cloud Log Collection

Step 1. Go to Snare Central and navigate to System > Administrative Tools > Cloud Log Collection Configuration.

image-20240226-085125.png

Step 2. Select Azure Cloud and Click the Azure Cloud Collector that you want to delete.
Collector details panel will open on the right-hand side.

image-20240226-083721.png


Click the Delete icon on the top right of the details panel.

Troubleshooting Guide

This guide will be your resource for resolving common issues and challenges that you may encounter with Azure - Cloud Log Collection.

  1. Azure Cloud icon is gray in System > Administrative Tools > Cloud Log Collection Configuration Web UI.

 Possible Cause and Resolution

When Azure Cloud icon in Cloud Log Providers list is gray, it is possible that Snare Central does not have IA_CLOUD or IA_CLOUD_O365 license.

image-20240229-063028.png

 

You can check it via navigating to Status > Snare Health Checker or simply click the heart icon in the lower left corner of Snare Central and scroll down to Snare Central License and select Show Details to view the License Information.

image-20240229-063649.png

 

If there are no IA_CLOUD or IA_CLOUD_O365 in the License Information, then you needed the correct license with IA_CLOUD or IA_CLOUD_O365. Once you have the correct license, click License Page button.

image-20240229-063757.png

 

In the License Update page, click Browse button and navigate to the correct license then click Load License button.

Wait for a while then navigate to System > Administrative Tools > Cloud Log Collection Configuration and you should be able to see Azure Cloud icon is now green and you should be able to Add Azure Cloud Collection.

image-20240229-064012.png
  1. Azure Cloud Log Collector icon is gray, and the Status is Not Running (Disabled by configuration)

 Possible Cause and Resolution

When your configured Azure Cloud Log Collector icon is gray, it is possible that the log collector is disabled during configuration or toggled off.

image-20240229-071315.png

Select the Azure Cloud Log Collector and check if Status: Not Running (Disabled by configuration)

image-20240229-071627.png

To enable Azure Cloud Log Collector, simply toggle on the Enable button beside its name in Cloud Log Providers or the one in the upper right corner beside the Edit icon, then click Confirm in the pop-up dialog box.

image-20240229-071540.png

Once toggled to ON, the configured Azure Cloud Log Collector icon should be green and enabled. Snare Central will now start collecting Azure activity and platform Logs (assuming that the configuration parameters were valid and working).

  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (Could not generate access token for ….)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and Status is Not Running (Could not generate access token for ….), it is possible that the Client ID or Client Secret is invalid or expired.

image-20240229-072149.png

Go to Azure portal site and check if Tenant ID is correct or the Client ID and Client Secret is not yet expired or check if the value entered in the Snare Central cloud collection configuration is correct.
See App Registration guide above, for the identification of Client ID and Client Secret.

image-20240229-072346.png

If the value entered in the Snare Central Configuration is incorrect, you can simply edit it by clicking the Edit icon on the upper left corner.

  1. Microsoft Cloud Log Collector icon is red, and the Status is Not Running (The provided credentials have insufficient access …)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and Status: Not Running (The provided credentials have insufficient access …), it is possible that the Log Analytics API permission is not properly set, or the Log Analytics workspace’s access control was not properly configured.

image-20240229-080954.png

Go to the Azure portal site, check the assigned application at Application Registration, and verify if the permissions were properly set. See App Registration guide above, to identify whether API has the correct permission.

image-20240229-074816.png

If the permission is correct, then check the Log Analytics workspace’s access control to see if it's properly configured. See Setting up workspace Access Control guide, to identify whether access control is properly configured or not.

image-20240229-075731.png

Update and configure the necessary API permission and workspace’s access control then re-enable the collector by Disabling and Enabling Azure Cloud Log Collector again after 5 minutes (it may take a while for the new settings to reflect on the entire Azure environment).

image-20240229-081148.png
  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (The workspace could not be found for logtype ...)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and Status: Not Running (The workspace could not be found for logtype ...), it is possible that the configured Workspace ID is incorrect or does not exist.

image-20240301-004550.png

Go to Azure portal site and search for the target Log Analytics workspace and check if the Workspace ID value entered in the Snare Central cloud collection configuration is correct.

image-20240301-010828.png

If the Workspace ID value entered in the Snare Central Configuration is incorrect, you can simply edit and update it by clicking the Edit icon on the upper left corner.

If Log Analytics workspace does not exist, you need to create the workspace (See Create Log Analytics workspace guide), update the necessary access control (See Setting up workspace Access Control guide) and edit the Workspace ID on the collector’s configuration.

image-20240301-005620.png
  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (Cannot connect to microsoft API, please check the IP configuration …)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and the Status is Status: Not Running (Cannot connect to microsoft API, please check the IP configuration of the Snare Central.), it is possible that the IP Configuration is incorrect.

image-20240301-011948.png

Go to Snare Central and navigate to System > Administrative Tools > Configuration Wizard > IP Address Configuration then check if the IP Configuration parameters were correct (most of the time the problem lies on the Domain Name Server(s)).

After updating necessary IP Configuration parameter/s, re-enable the collector by Disabling and Enabling Azure Cloud Log Collector again after 1 minutes.

image-20240301-012238.png
  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (Cannot connect to proxy server, ….)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and the Status is Status: Not Running (Cannot connect to proxy server, ….), it is possible that the proxy was enabled in the Snare Central with incorrect settings.

image-20240301-013617.png

Go to Snare Central and navigate to System > Administrative Tools > Configuration Wizard > Network Services then Proxy Settings, check the following:

  • Check if the value of Proxy address and Proxy port were correct.

  • If proxy address and port were correct, check if the proxy server is up and running.

  • If proxy server is OK, check the Snare Central’s firewall settings here, System > Administrative Tools > Configuration Wizard > Firewall Setup (example: if target proxy port was allowed or not), same goes with the firewall settings of the proxy server and port, check if they were properly configured.

After updating necessary Proxy Settings or configured the proper firewall settings, re-enable the collector by Disabling and Enabling Azure Cloud Log Collector again after 1 minute.

image-20240301-042308.png
  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (Invalid proxy credentials...)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and the Status is Status: Not Running (Invalid proxy credentials, please re-configure these parameters.), it is possible that the proxy was enabled in the Snare Central with incorrect settings.

image-20240301-023744.png

Go to Snare Central and navigate to System > Administrative Tools > Configuration Wizard > Network Services then Proxy Settings, check the following.

  • Check if the value of Proxy user and Proxy password were correct.

  1. Azure Cloud Log Collector icon is red, and the Status is Not Running (Invalid proxy type…)

 Possible Cause and Resolution

When the Azure Cloud Log Collector icon is red and the Status is Status: Not Running (Invalid proxy type, please re-configure 'type' based on the actual proxy server type.), it is possible that the proxy was enabled in the Snare Central with incorrect settings.

image-20240301-024648.png

Go to Snare Central and navigate to System > Administrative Tools > Configuration Wizard > Network Services then Proxy Settings, check the following:

  • Check if the value of Proxy type is correct.

 

After updating necessary Proxy Settings, re-enable the collector by Disabling and Enabling Azure Cloud Log Collector again after 1 minute.

image-20240301-043216.png

  • No labels