monkey365

0.95.1

collectors/entraid/msgraph/audit/Get-MonkeyAADAudit.ps1

# Monkey365 - the PowerShell Cloud Security Tool for Azure and Microsoft 365 (copyright 2022) by Juan Garrido
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


function Get-MonkeyAADAudit {
<#
        .SYNOPSIS
        Collector to get audit logs from Microsoft Entra ID
 
        .DESCRIPTION
        Collector to get audit logs from Microsoft Entra ID
 
        .INPUTS
 
        .OUTPUTS
 
        .EXAMPLE
 
        .NOTES
            Author : Juan Garrido
            Twitter : @tr1ana
            File Name : Get-MonkeyAADAudit
            Version : 1.0
 
        .LINK
            https://github.com/silverhack/monkey365
    #>

    [CmdletBinding()]
    param(
        [Parameter(Mandatory = $false,HelpMessage = "Background Collector ID")]
        [string]$collectorId
    )
    begin {
        #Collector metadata
        $monkey_metadata = @{
            Id = "aad0002";
            Provider = "EntraID";
            Resource = "EntraID";
            ResourceType = $null;
            resourceName = $null;
            collectorName = "Get-MonkeyAADAudit";
            ApiType = "MSGraph";
            description = "Collector to get audit logs from Microsoft Entra ID";
            Group = @(
                "EntraID"
            );
            Tags = @(

            );
            references = @(
                "https://silverhack.github.io/monkey365/"
            );
            ruleSuffixes = @(
                "aad_audit_logs"
            );
            dependsOn = @(

            );
            enabled = $true;
            supportClientCredential = $true
        }
        #Get Config
        try {
            $aadConf = $O365Object.internal_config.entraId.Provider.msgraph
        }
        catch {
            $msg = @{
                MessageData = ($message.MonkeyInternalConfigError);
                callStack = (Get-PSCallStack | Select-Object -First 1);
                logLevel = 'verbose';
                InformationAction = $O365Object.InformationAction;
                Tags = @('Monkey365ConfigError');
            }
            Write-Verbose @msg
            break
        }
        #set null
        $all_events = $null
    }
    process {
        $msg = @{
            MessageData = ($message.MonkeyGenericTaskMessage -f $collectorId,"Microsoft Entra ID audit log",$O365Object.TenantID);
            callStack = (Get-PSCallStack | Select-Object -First 1);
            logLevel = 'info';
            InformationAction = $InformationAction;
            Tags = @('EntraIDAuditLog');
        }
        Write-Information @msg
        try {
            $enabled = [System.Convert]::ToBoolean($O365Object.internal_config.entraId.auditLog.enabled)
            $DaysAgo = $O365Object.internal_config.entraId.auditLog.AuditLogDaysAgo
        }
        catch {
            $enabled = $false
            $DaysAgo = -15
        }
        if ($enabled) {
            $p = @{
                Days = $DaysAgo;
                APIVersion = $aadConf.api_version;
                InformationAction = $O365Object.InformationAction;
                Verbose = $O365Object.Verbose;
                Debug = $O365Object.Debug;
            }
            $all_events = Get-MonkeyMSGraphAADAuditLog @p
        }
    }
    end {
        if ($all_events) {
            $all_events.PSObject.TypeNames.Insert(0,'Monkey365.EntraID.AuditLogs')
            [pscustomobject]$obj = @{
                Data = $all_events;
                Metadata = $monkey_metadata;
            }
            $returnData.aad_audit_logs = $obj
        }
        else {
            $msg = @{
                MessageData = ($message.MonkeyEmptyResponseMessage -f "Microsoft Entra ID audit Log",$O365Object.TenantID);
                callStack = (Get-PSCallStack | Select-Object -First 1);
                logLevel = "verbose";
                InformationAction = $O365Object.InformationAction;
                Verbose = $O365Object.Verbose;
                Tags = @('EntraIDAuditLogEmptyResponse')
            }
            Write-Verbose @msg
        }
    }
}