Cyjax Threat Intelligence IOC Connector

Resource Group

You need to have a resource group created with a subscription you are going to use.

Functions App

You need to have an Azure App registered for this connector to use: 1. Application (Client) ID 2. Tenant ID 3. Client Secret

>**NOTE:** This connector uses Azure Functions to connect to the Cyjax API v2 to pull IOC indicators into Microsoft Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details.

**STEP 1 - App Registration steps for the Application in Microsoft Entra ID** This integration requires an App registration in the Azure portal. Follow the steps in this section to create a new application in Microsoft Entra ID: 1. Sign in to the [Azure portal](https://portal.azure.com/). 2. Search for and select **Microsoft Entra ID**. 3. Under **Manage**, select **App registrations > New registration**. 4. Enter a display **Name** for your application. 5. Select **Register** to complete the initial app registration. 6. When registration finishes, the Azure portal displays the app registration's Overview pane. You see the **Application (client) ID** and **Tenant ID**. The client ID and Tenant ID are required as configuration parameters for the execution of the Cyjax IOC Data Connector. > **Reference link:** [https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app](https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app)

**STEP 2 - Add a client secret for application in Microsoft Entra ID** Sometimes called an application password, a client secret is a string value required for the execution of the Cyjax IOC Data Connector. Follow the steps in this section to create a new Client Secret: 1. In the Azure portal, in **App registrations**, select your application. 2. Select **Certificates & secrets > Client secrets > New client secret**. 3. Add a description for your client secret. 4. Select an expiration for the secret or specify a custom lifetime. Limit is 24 months. 5. Select **Add**. 6. *Record the secret's value for use in your client application code. This secret value is never displayed again after you leave this page.* The secret value is required as configuration parameter for the execution of the Cyjax IOC Data Connector. > **Reference link:** [https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app#add-a-client-secret](https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app#add-a-client-secret)

**STEP 3 - Assign Microsoft Sentinel Contributor Role** Assign the **Microsoft Sentinel Contributor** role to the App Registration to allow it to upload threat intelligence indicators: 1. Go to the **Log Analytics workspace** associated with your Microsoft Sentinel instance. 2. Select **Access control (IAM)** from the left menu. 3. Click **Add > Add role assignment**. 4. Search for **Microsoft Sentinel Contributor** and select it. 5. Under **Members**, select **User, group, or service principal** and search for your App Registration name. 6. Select the app and click **Review + assign**.

**STEP 4 - Obtain Cyjax API Credentials** Contact Cyjax to obtain your API v2 access token (Bearer Token). This token is used to authenticate requests to the Cyjax IOC and enrichment endpoints.

**STEP 5 - Deploy the Cyjax IOC Connector** >**IMPORTANT:** Before deploying the Cyjax IOC connector, have the Cyjax API access token, Azure App Registration credentials (Client ID, Client Secret, Tenant ID), and Workspace ID readily available.

Workspace ID

Option 1 - Azure Resource Manager (ARM) Template

Use this method for automated deployment of the Cyjax IOC Data Connector. 1. Click the **Deploy to Azure** button below. [](https://aka.ms/sentinel-CyjaxIOC-azuredeploy) [](https://aka.ms/sentinel-CyjaxIOC-azuredeploy-gov) 2. Select the preferred **Subscription**, **Resource Group** and **Region**. 3. Enter the below information: a. **FunctionName** - Enter a unique Function App name (max 11 characters) b. **Location** - The location for data collection rules and endpoints deployment c. **WorkspaceID** - Enter the Log Analytics Workspace ID d. **AzureClientID** - Enter Azure Client ID from your App Registration e. **AzureClientSecret** - Enter Azure Client Secret from your App Registration f. **AzureTenantID** - Enter Azure Tenant ID g. **CyjaxBaseURL** - Enter Cyjax API v2 Base URL (default: https://api.cymon.co/v2) h. **CyjaxAccessToken** - Enter Cyjax API Bearer Token i. **LookbackDays** - Number of days to look back on first run (default: 1) j. **EnableEnrichment** - Set to true to enrich IOCs with GeoIP, ASN, and sighting data. Set to false to skip enrichment and reduce API calls and execution time (default: true) k. **IOCQuery** - Optional free-text search query to filter IOCs from the Cyjax API (e.g. a keyword, threat actor, or campaign name). Leave empty to fetch all available IOCs l. **IndicatorType** - Filter IOCs by type. Enter comma-separated values (e.g., URL,Domain,IPv4). Supported types: URL, Domain, IPv4, IPv6, Hostname, Email, FileHash-SHA1, FileHash-SHA256, FileHash-MD5, FileHash-SSDEEP. Leave empty to fetch all types m. **Schedule** - Enter a valid Quartz Cron-Expression (default: every 10 minutes) n. **LogLevel** - Set the log level (default: Info) o. **AppInsightsWorkspaceResourceID** - Enter the Application Insights Workspace Resource ID 4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. 5. Click **Purchase** to deploy.

Option 2 - Manual Deployment of Azure Functions

Use the following step-by-step instructions to deploy the Cyjax IOC data connector manually with Azure Functions (Deployment via Visual Studio Code).

**1. Deploy a Function App** > **NOTE:** You will need to [prepare VS code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development. 1. Download the [Azure Function App](https://aka.ms/sentinel-CyjaxIOC-functionapp) file. Extract archive to your local development computer. 2. Start VS Code. Choose File in the main menu and select Open Folder. 3. Select the top level folder from extracted files. 4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button. If you aren't already signed in, choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose **Sign in to Azure** If you're already signed in, go to the next step. 5. Provide the following information at the prompts: a. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app. b. **Select Subscription:** Choose the subscription to use. c. Select **Create new Function App in Azure** (Don't choose the Advanced option) d. **Enter a globally unique name for the function app:** Type a name that is valid in a URL path. The name you type is validated to make sure that it's unique in Azure Functions. (e.g. CYJAXXXXXX). e. **Select a runtime:** Choose Python 3.12 f. Select a location for new resources. For better performance and lower costs choose the same [region](https://azure.microsoft.com/regions/) where Microsoft Sentinel is located. 6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied. 7. Go to Azure Portal for the Function App configuration.

**2. Configure the Function App** 1. In the Function App, select the Function App Name and select **Configuration**. 2. In the **Application settings** tab, select **+ New application setting**. 3. Add each of the following application settings individually, with their respective values (case-sensitive): - **WorkspaceID** - Your Log Analytics Workspace ID - **AzureClientID** - Azure Client ID from your App Registration - **AzureClientSecret** - Azure Client Secret from your App Registration - **AzureTenantID** - Your Azure Tenant ID - **CyjaxBaseURL** - Cyjax API v2 Base URL (default: https://api.cymon.co/v2) - **CyjaxAccessToken** - Your Cyjax API Bearer Token - **LookbackDays** - Number of days to look back on first run (default: 1) - **EnableEnrichment** - Set to true to enrich IOCs with GeoIP, ASN, and sighting data. Set to false to skip enrichment and reduce API calls and execution time (default: true) - **IOCQuery** - Optional free-text search query to filter IOCs from the Cyjax API (e.g. a keyword, threat actor, or campaign name). Leave empty to fetch all available IOCs (optional) - **IndicatorType** - Filter IOCs by type. Enter comma-separated values (e.g., URL,Domain,IPv4). Supported types: URL, Domain, IPv4, IPv6, Hostname, Email, FileHash-SHA1, FileHash-SHA256, FileHash-MD5, FileHash-SSDEEP. Leave empty to fetch all types (optional) - **Schedule** - Quartz Cron-Expression (default: every 10 minutes) - **LogLevel** - Log level (default: Info) - **AppInsightsWorkspaceResourceID** - Application Insights Workspace Resource ID (optional) - **logAnalyticsUri** (optional) - Use logAnalyticsUri to override the log analytics API endpoint for dedicated cloud. For example, for public cloud, leave the value empty; for Azure GovUS cloud environment, specify the value in the following format: `https://<CustomerId>.ods.opinsights.azure.us`. 4. Once all application settings have been entered, click **Save**.