Skip to content

Latest commit

 

History

History
139 lines (104 loc) · 11.3 KB

README.md

File metadata and controls

139 lines (104 loc) · 11.3 KB
Raw

Azure Sentinel

branch status
master
development

Azure Sentinel is a cloud-native SIEM that provides intelligent security analytics for your entire enterprise at cloud scale. Get limitless cloud speed and scale to help focus on what really matters. Easily collect data from all your cloud or on-premises assets, Office 365, Azure resources, and other clouds. Effectively detect threats with built-in machine learning from Microsoft’s security analytics experts. Automate threat response, using built-in orchestration and automation playbooks. read more

Why this PowerShell Module

At the moment there is no documented API, ARM or PowerShell module to configure Azure Sentinel. After doing some research we were able to find the API's that are currently being used by the Azure Portal and based on that we've written a PowerShell module to manage Azure Sentinel through PowerShell.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

You can install the latest version of AzSentinel module from PowerShell Gallery

Install-Module AzSentinel -Scope CurrentUser -Force

Usage

Parameters

See docs folder for documentation regarding the Functions and the available parameters

JSON format

To create a Azure Sentinel Rule, use the following JSON format.

{
  "analytics": [
    {
      "displayName": "string",
      "description": "string",
      "severity": "High",
      "enabled": true,
      "query": "SecurityEvent | where EventID == \"4688\" | where CommandLine contains \"-noni -ep bypass $\"",
      "queryFrequency": "5H",
      "queryPeriod": "5H",
      "triggerOperator": "GreaterThan",
      "triggerThreshold": 5,
      "suppressionDuration": "6H",
      "suppressionEnabled": false,
      "tactics": [
        "Persistence",
        "LateralMovement",
        "Collection"
      ],
      "playbookName": "string",
      "aggregationKind": "string",
      "createIncident": true,
      "groupingConfiguration": {
        "GroupingConfigurationEnabled": true,
        "reopenClosedIncident": true,
        "lookbackDuration": "PT6H",
        "entitiesMatchingMethod": "string",
        "groupByEntities": [
          "Account",
          "Ip",
          "Host",
          "Url"
        ]
      }
    }
  ]
}

Property values

The following tables describe the values you need to set in the schema.

Name Type Required Allowed Values Example
displayName string true * DisplayName
description string true * Description
severity string true Medium, High, Low, Informational Medium
enabled bool true true, false true
query string true special character need to be escaped by \ SecurityEvent | where EventID == "4688" | where CommandLine contains \"-noni -ep bypass $\"
queryFrequency string true Value must be between 5 minutes and 24 hours 30M
queryPeriod string true Value must be between 5 minutes and 14 days 6H
triggerOperator string true GreaterThan, FewerThan, EqualTo, NotEqualTo GreaterThan
triggerThreshold int true The value must be between 0 and 10000 5
suppressionDuration string true Value must be greater than 5 minutes 1D
suppressionEnabled bool true true, false true
tactics array true InitialAccess, Persistence,Execution,PrivilegeEscalation,DefenseEvasion,CredentialAccess,LateralMovement,Discovery,Collection,Exfiltration,CommandAndControl,Impact true
playbookName string false Enter the Logic App name that you want to configure as playbook trigger LogicApp01
aggregationKind string false SingleAlert, AlertPerRow SingleAlert
createIncident bool false true, false true
GroupingConfigurationEnabled bool false true, false true
reopenClosedIncident bool false true, false true
lookbackDuration string false Value must be between 5 minutes and 24 hours. PT6H
entitiesMatchingMethod string false All, None, Custom All
groupByEntities string false Account, Ip, Host, Url Account

Find us

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contributors

Authors

  • Pouyan Khabazi - Developer and Maintainer - GitHub / Blog

See also the list of contributors who participated in this project.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • Hat tip to anyone whose code was used!