Public/CP_Common.ps1

# New-CP365Setup
function New-CP365PhishSimSetup {
    [CmdletBinding(
        SupportsShouldProcess = $true,
                 ConfirmImpact = 'Medium'
    )]

    param()

    begin {
        if (!(Test-SC365ExoConnStatus)) {
            throw [System.Exception] "You're not connected to Exchange Online - please connect prior to using this CmdLet"
        }
        #TODO: Change of Erroraction due to a bug in the ExoPhishSimOverride CmdLets
        #$oldErrorAction = $ErrorActionPreference
        #$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Continue

        Write-verbose "Reading Phishing Simulation Configuration from module ./ExoConfig/CloudCOnfig/PhishSim.json"
        $param = Get-CP365PhishSimConfig
        
        Write-Verbose "Phishing Simulation Configuration read successfully, see $param"
           $name = $param.name
        $comment = $param.comment
            $iPs = $param.PhishSim.IPs.IPv4AllowList
        $domains = $param.PhishSim.domains.AllowedDomains
        $simURLs = $param.PhishSim.SimURLs.SimURLs
    }

    process {

        Write-Verbose "Processing Phishing Simulation Setup"
        try {
            $PhishSimPolicy = 'PhishSimOverridePolicy' #TODO: as long as this throws a bug Get-PhishSimOverridePolicy -ErrorAction SilentlyContinue
            $PhishSimRule = Get-ExoPhishSimOverrideRule -ErrorAction SilentlyContinue
        }
        catch { 
            #Write-Warning "As of Oktober 2026 this CmdLet will fail due to a bug on the underlying Microsoft CmdLet, as long as the list of allowed domains and IP addresses is empty!"
            #Write-Warning "To avoid this error go to the M365 Portal Security --> Policies & Rules --> Thread Protection Rules -->Enhanced Delivery --> Phishing Simulation and add a random domain and a random IP address like 'none.net' and '127.0.0.1'"
            break
        }
        
        $PhishSimRuleID = $PhishSimRule.Identity
        if ($PhishSimRuleID) {
            $SetPhishSimOverrideParam = @{
                    Adddomains = $domains
                    AddsenderIpRanges = $iPs
                    Comment = $comment
            }
            Set-ExoPhishSimOverrideRule -Identity $PhishSimRuleID @SetPhishSimOverrideParam -ErrorAction SilentlyContinue 
        } else {
            $NewPhishSimOverrideParam = @{
                       Domains = $domains
                SenderIpRanges = $iPs
                        Policy = $PhishSimPolicy
            }
            #TODO: This still fails in module-mode
            New-ExoPhishSimOverrideRule  @NewPhishSimOverrideParam -ErrorAction SilentlyContinue 
        }
        $TenantAllowBlockListItems = @{
                  Allow = $true
               Listtype = 'URL'
            ListSubType = 'AdvancedDelivery'
                Entries = $simURLs
        }
        #TODO: Read existing value and change just if not already present
        $ExistingTenantAllowBlockListItems = Get-TenantAllowBlockListItems -ListType 'URL' -ListSubType 'AdvancedDelivery'
        if ($ExistingTenantAllowBlockListItems.Value -eq $simURLs) {
            Write-Warning "Tenant Allow Block List Items $simURLs already exist"
        } else {
            Write-Verbose "Tenant Allow Block List Items $simURLs do not exist, creating them now"
            New-TenantAllowBlockListItems @TenantAllowBlockListItems
        }
        
    }
    end {
        #$ErrorActionPreference = $oldErrorAction
    }
}

# Get-CP365PhishSimSetup

# Remove-CP365PhishSimSetup
<#
.SYNOPSIS
    Removes the configured Cyberpilot phishing simulation settings.
.DESCRIPTION
    Removes matching domains, sender IP ranges and Advanced Delivery URLs
    from the phishing simulation configuration. Unrelated entries and the
    inbound connector are preserved. Rules with no remaining entries are removed.
    Matching entries are removed even if they existed before setup.
.EXAMPLE
    Remove-CP365Setup -WhatIf
.EXAMPLE
    Remove-CP365Setup -Confirm
#>

function Remove-CP365PhishSimSetup {
    [CmdletBinding(
        SupportsShouldProcess = $true,
        ConfirmImpact = 'Medium'
    )]

    param()

    begin {
        if (!(Test-SC365ExoConnStatus)) {
            throw [System.Exception] "You're not connected to Exchange Online - please connect prior to using this CmdLet"
        }
        Write-Verbose "Change of Erroraction preference from $erroractionpreference due to a bug in the ExoPhishSimOverride CmdLets to 'SilentlyContinue'"
        $oldErrorAction = $ErrorActionPreference
        $ErrorActionPreference = [System.Management.Automation.ActionPreference]::SilentlyContinue

          $param = Get-CP365PhishSimConfig
            $iPs = $param.PhishSim.IPs.IPv4AllowList
        $domains = $param.PhishSim.domains.AllowedDomains
        $simURLs = $param.PhishSim.SimURLs.SimURLs
    }

    process {
        Write-Verbose "Removing Phishing Simulation Setup"
        $PhishSimPolicy = Get-PhishSimOverridePolicy
        $PhishSimRules = @(Get-ExoPhishSimOverrideRule)
        foreach ($PhishSimRule in $PhishSimRules) {
            $RemoveDomains = @($PhishSimRule.Domains | Where-Object { $_ -in $domains })
            $RemoveSenderIpRanges = @($PhishSimRule.SenderIpRanges | Where-Object { $_ -in $iPs })

            if ($RemoveDomains.Count -eq 0 -and $RemoveSenderIpRanges.Count -eq 0) {
                Write-Verbose "No Cyberpilot entries found in phishing simulation rule $($PhishSimRule.Identity)"
                continue
            }
            $RemainingDomains = @($PhishSimRule.Domains | Where-Object { $_ -notin $domains })
            $RemainingSenderIpRanges = @($PhishSimRule.SenderIpRanges | Where-Object { $_ -notin $iPs })
            if ($RemainingDomains.Count -eq 0 -and $RemainingSenderIpRanges.Count -eq 0) {
                if ($PSCmdlet.ShouldProcess($PhishSimRule.Identity, 'Remove Cyberpilot phishing simulation override rule')) {
                    Remove-ExoPhishSimOverrideRule -Identity $PhishSimRule.Identity -Confirm:$false -ErrorAction Stop
                }
            } else {
                $SetPhishSimOverrideParam = @{
                    Identity = $PhishSimRule.Identity
                }
                if ($RemoveDomains.Count -gt 0) {
                    $SetPhishSimOverrideParam.RemoveDomains = $RemoveDomains
                }
                if ($RemoveSenderIpRanges.Count -gt 0) {
                    $SetPhishSimOverrideParam.RemoveSenderIpRanges = $RemoveSenderIpRanges
                }
                if ($PSCmdlet.ShouldProcess($PhishSimRule.Identity, 'Remove Cyberpilot domains and sender IP ranges')) {
                    Set-ExoPhishSimOverrideRule @SetPhishSimOverrideParam -Confirm:$false -ErrorAction Stop
                }
            }
        }

        $ExistingTenantAllowBlockListItems = @(
            Get-TenantAllowBlockListItems -ListType URL -ListSubType AdvancedDelivery -ErrorAction Stop |
                Where-Object { $_.Value -in $simURLs }
        )
        if ($ExistingTenantAllowBlockListItems.Count -gt 0) {
            $TenantAllowBlockListItems = @{
                   ListType = 'URL'
                ListSubType = 'AdvancedDelivery'
                        Ids = $ExistingTenantAllowBlockListItems.Identity
            }
            if ($PSCmdlet.ShouldProcess(($ExistingTenantAllowBlockListItems.Value -join ', '), 'Remove Cyberpilot Advanced Delivery URLs')) {
                Remove-TenantAllowBlockListItems @TenantAllowBlockListItems -ErrorAction Stop
            }
        } else {
            Write-Verbose "No Cyberpilot Advanced Delivery URLs found"
        }
    }

    end {
        $ErrorActionPreference = $oldErrorAction
        Write-Verbose "Finished processing Phishing Simulation Setup removal"
    }
}

# SIG # Begin signature block
# MIIQVQYJKoZIhvcNAQcCoIIQRjCCEEICAQExDzANBglghkgBZQMEAgEFADB5Bgor
# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG
# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCBqGL3c06VHT19a
# KY1NGkSnVmg4THf2dpQeZL6UwppaNqCCDJEwggYaMIIEAqADAgECAhBiHW0MUgGe
# O5B5FSCJIRwKMA0GCSqGSIb3DQEBDAUAMFYxCzAJBgNVBAYTAkdCMRgwFgYDVQQK
# Ew9TZWN0aWdvIExpbWl0ZWQxLTArBgNVBAMTJFNlY3RpZ28gUHVibGljIENvZGUg
# U2lnbmluZyBSb290IFI0NjAeFw0yMTAzMjIwMDAwMDBaFw0zNjAzMjEyMzU5NTla
# MFQxCzAJBgNVBAYTAkdCMRgwFgYDVQQKEw9TZWN0aWdvIExpbWl0ZWQxKzApBgNV
# BAMTIlNlY3RpZ28gUHVibGljIENvZGUgU2lnbmluZyBDQSBSMzYwggGiMA0GCSqG
# SIb3DQEBAQUAA4IBjwAwggGKAoIBgQCbK51T+jU/jmAGQ2rAz/V/9shTUxjIztNs
# fvxYB5UXeWUzCxEeAEZGbEN4QMgCsJLZUKhWThj/yPqy0iSZhXkZ6Pg2A2NVDgFi
# gOMYzB2OKhdqfWGVoYW3haT29PSTahYkwmMv0b/83nbeECbiMXhSOtbam+/36F09
# fy1tsB8je/RV0mIk8XL/tfCK6cPuYHE215wzrK0h1SWHTxPbPuYkRdkP05ZwmRmT
# nAO5/arnY83jeNzhP06ShdnRqtZlV59+8yv+KIhE5ILMqgOZYAENHNX9SJDm+qxp
# 4VqpB3MV/h53yl41aHU5pledi9lCBbH9JeIkNFICiVHNkRmq4TpxtwfvjsUedyz8
# rNyfQJy/aOs5b4s+ac7IH60B+Ja7TVM+EKv1WuTGwcLmoU3FpOFMbmPj8pz44MPZ
# 1f9+YEQIQty/NQd/2yGgW+ufflcZ/ZE9o1M7a5Jnqf2i2/uMSWymR8r2oQBMdlyh
# 2n5HirY4jKnFH/9gRvd+QOfdRrJZb1sCAwEAAaOCAWQwggFgMB8GA1UdIwQYMBaA
# FDLrkpr/NZZILyhAQnAgNpFcF4XmMB0GA1UdDgQWBBQPKssghyi47G9IritUpimq
# F6TNDDAOBgNVHQ8BAf8EBAMCAYYwEgYDVR0TAQH/BAgwBgEB/wIBADATBgNVHSUE
# DDAKBggrBgEFBQcDAzAbBgNVHSAEFDASMAYGBFUdIAAwCAYGZ4EMAQQBMEsGA1Ud
# HwREMEIwQKA+oDyGOmh0dHA6Ly9jcmwuc2VjdGlnby5jb20vU2VjdGlnb1B1Ymxp
# Y0NvZGVTaWduaW5nUm9vdFI0Ni5jcmwwewYIKwYBBQUHAQEEbzBtMEYGCCsGAQUF
# BzAChjpodHRwOi8vY3J0LnNlY3RpZ28uY29tL1NlY3RpZ29QdWJsaWNDb2RlU2ln
# bmluZ1Jvb3RSNDYucDdjMCMGCCsGAQUFBzABhhdodHRwOi8vb2NzcC5zZWN0aWdv
# LmNvbTANBgkqhkiG9w0BAQwFAAOCAgEABv+C4XdjNm57oRUgmxP/BP6YdURhw1aV
# cdGRP4Wh60BAscjW4HL9hcpkOTz5jUug2oeunbYAowbFC2AKK+cMcXIBD0ZdOaWT
# syNyBBsMLHqafvIhrCymlaS98+QpoBCyKppP0OcxYEdU0hpsaqBBIZOtBajjcw5+
# w/KeFvPYfLF/ldYpmlG+vd0xqlqd099iChnyIMvY5HexjO2AmtsbpVn0OhNcWbWD
# RF/3sBp6fWXhz7DcML4iTAWS+MVXeNLj1lJziVKEoroGs9Mlizg0bUMbOalOhOfC
# ipnx8CaLZeVme5yELg09Jlo8BMe80jO37PU8ejfkP9/uPak7VLwELKxAMcJszkye
# iaerlphwoKx1uHRzNyE6bxuSKcutisqmKL5OTunAvtONEoteSiabkPVSZ2z76mKn
# zAfZxCl/3dq3dUNw4rg3sTCggkHSRqTqlLMS7gjrhTqBmzu1L90Y1KWN/Y5JKdGv
# spbOrTfOXyXvmPL6E52z1NZJ6ctuMFBQZH3pwWvqURR8AgQdULUvrxjUYbHHj95E
# jza63zdrEcxWLDX6xWls/GDnVNueKjWUH3fTv1Y8Wdho698YADR7TNx8X8z2Bev6
# SivBBOHY+uqiirZtg0y9ShQoPzmCcn63Syatatvx157YK9hlcPmVoa1oDE5/L9Uo
# 2bC5a4CH2RwwggZvMIIE16ADAgECAhBIqMP3CCLHOHtOKuaWNyeFMA0GCSqGSIb3
# DQEBDAUAMFQxCzAJBgNVBAYTAkdCMRgwFgYDVQQKEw9TZWN0aWdvIExpbWl0ZWQx
# KzApBgNVBAMTIlNlY3RpZ28gUHVibGljIENvZGUgU2lnbmluZyBDQSBSMzYwHhcN
# MjYwNDE1MDAwMDAwWhcNMjcwNzE0MjM1OTU5WjBmMQswCQYDVQQGEwJERTEPMA0G
# A1UECAwGQmF5ZXJuMSIwIAYDVQQKDBlTRVBQbWFpbCBEZXV0c2NobGFuZCBHbWJI
# MSIwIAYDVQQDDBlTRVBQbWFpbCBEZXV0c2NobGFuZCBHbWJIMIICIjANBgkqhkiG
# 9w0BAQEFAAOCAg8AMIICCgKCAgEAvAFzE8MbJpvQt+IdIh1M+bKYsJBFDk4b9ySe
# 25IrCi00B9o5XmQtIw42MqyIKbUq1tDARtp9KTQedEP9W+rflAF2l+0Z046Jkiqu
# mU9/enbqWLDyln1aS/p7HOgwZFMhnsR9zH0MfFckiklUmkzJO+vmzYAK7ZmDxajN
# LJs0gkGRU2/BecAx/TSvLXMaKONsKZCyMKQCnwo1mCY/tFl5EgUz7YQFrPORBQGf
# Qke/hkdBfQDqNRsi/J6+KhJWc6LvgQihdRg/INQbQsTxlow18NWvyFsjjueH7kG6
# HR4YKfbv07xgrsIh8xvq9ZJ1SBhLXmkg4SdoQGASjqR6o3keAX+bDRFf+hmlWWJp
# /FqVHR5QomF3vbK2/bbz4jAclYSPx/sPasNJ0YnKFkgmowZ7Ysa0KA0/egBgtI4g
# J+8V7zrqIVEG3rMQh9KCdMnJqP2aM9o4gUzQvE1M4x606liX9EWwdLLS+fe79o+F
# zo5oH4wBE/En6hQQkzseHHu+TXCDd6zUUZ/PlTK0gTaDIRXt6UzPNqJ4RiRCW2pN
# FcPt078qqVTuwKUXoE4ufxGgXKFrZlCYST/9eG1TnW2oq19nz8A333GCsL3gpoNI
# KvfmDyGMMNzvx2aeqn2v6e75z8kH19iGSNZ51xT+WgS9F1aIvjz08/T7XAv7iDPF
# 1/gPIp8CAwEAAaOCAakwggGlMB8GA1UdIwQYMBaAFA8qyyCHKLjsb0iuK1SmKaoX
# pM0MMB0GA1UdDgQWBBS30/Tq+alF3j2BY5up8n5zpAU23DAOBgNVHQ8BAf8EBAMC
# B4AwDAYDVR0TAQH/BAIwADATBgNVHSUEDDAKBggrBgEFBQcDAzBKBgNVHSAEQzBB
# MDUGDCsGAQQBsjEBAgEDAjAlMCMGCCsGAQUFBwIBFhdodHRwczovL3NlY3RpZ28u
# Y29tL0NQUzAIBgZngQwBBAEwSQYDVR0fBEIwQDA+oDygOoY4aHR0cDovL2NybC5z
# ZWN0aWdvLmNvbS9TZWN0aWdvUHVibGljQ29kZVNpZ25pbmdDQVIzNi5jcmwweQYI
# KwYBBQUHAQEEbTBrMEQGCCsGAQUFBzAChjhodHRwOi8vY3J0LnNlY3RpZ28uY29t
# L1NlY3RpZ29QdWJsaWNDb2RlU2lnbmluZ0NBUjM2LmNydDAjBggrBgEFBQcwAYYX
# aHR0cDovL29jc3Auc2VjdGlnby5jb20wHgYDVR0RBBcwFYETc3VwcG9ydEBzZXBw
# bWFpbC5jaDANBgkqhkiG9w0BAQwFAAOCAYEAi7fmb5UYoemWG3CC4K2UZWVrR6GO
# fi8gbJKgjPbKO4zrCrU/x6cOdyp6scKZfUEGFDf8KH6pP4pAQv1Hsbi49gU2kxoU
# WLlCiipn05qJY663DHx9hlStej/ZdEatou0wyCDiG5xD7kmG+1t6iLyyCBgEB88t
# JpzTjI61qXmBTS/FGEOAsB4SDEW1ngA7bc5FOv4IUKA43hp8M+N3GeYFzDqwJELY
# EfVVYheBW3o7q4VrCdfFEuaQihOtvfDfYpP6ANgekNn8HdsMT8rx9D1I50Rli/qQ
# Fo2BOuPyb2SIQPzJvCs5wgi5qgp1nHiN6igumu2Cz7BmGjOazGUgCSUY5QwyE8+F
# +R2tVM+2O15rfX01+e56ZfojBEiEjMwfPHs3fa3V3gokWWNwUMkton/v0R/nl2zj
# mOr2okohOINZEDh9frg21zUCN5ZD8Y4zQWuiJLCvvvBZs0JR4c9xl2k2wtw/QLPh
# GU69zM3smGpRoLE8M6zvUvSU7jXjvefazUniMYIDGjCCAxYCAQEwaDBUMQswCQYD
# VQQGEwJHQjEYMBYGA1UEChMPU2VjdGlnbyBMaW1pdGVkMSswKQYDVQQDEyJTZWN0
# aWdvIFB1YmxpYyBDb2RlIFNpZ25pbmcgQ0EgUjM2AhBIqMP3CCLHOHtOKuaWNyeF
# MA0GCWCGSAFlAwQCAQUAoIGEMBgGCisGAQQBgjcCAQwxCjAIoAKAAKECgAAwGQYJ
# KoZIhvcNAQkDMQwGCisGAQQBgjcCAQQwHAYKKwYBBAGCNwIBCzEOMAwGCisGAQQB
# gjcCARUwLwYJKoZIhvcNAQkEMSIEIK4T/J+sjjWxICU2s2OL1x0nPt+Bfc/R7Dth
# JlfQxFnNMA0GCSqGSIb3DQEBAQUABIICAGaBpSLSiTvH6lE3o3xdzoTpgBoazdfL
# w6qUX6c1OLipKpZPuZdeMCakd1bNN4BZecqBqIYFp13pvpZd3aTCQvpAnAQWNIxq
# 8SdoswxYsZMbUD3w2HUutEHDxO43mTYYWuBpuc8OAIRIL8wmlV9qoEFsXAzNgkKT
# kbuSvTaqdWxnFKm5dYSV6sUu5RSdMflAroRJ3Gj0JZBOTPdmBxDvjWZdhUo0efwO
# yKlqoWAhRdFA7OhRFZV98cmRyqjJ3SQAxAvfdBusBeoOrf4n1ueXPQWyvOWqXN7v
# gRzViYvjTwp28fMiBV9SGK0Yq57O7QLJJGzZkX3DCrMGALUMh3ueS1hWmHpGd6cc
# Ye7F4UgiRSCFuhdgvbpAQhZm+70NxqZj5JjBVYVeKhpWLdBckXy8OeXC3fJxQ6tU
# 8W2eHytYiJ2aP5hVxs9HugYK2Cqw66tyE+uGd4f6PfLK5PeqBBu03xaEOV6BcKW5
# dCCTg+i6F7u9u+OS0aXDX2IjBblfwoBQn60HaMq3xO/aImnkl9z0mqEBjG9xoKO5
# rdUjUl5NPfSAjj8knMDWbT307zCpwWiAjt6YAxXDYepqRmxfMAi5UGqUfAA3rRr0
# bgh5brckQYfE1jeDCruA/4tk/3GWuX+75BmE8VC2lhsuCiWeBepTohu5gsTFYQxd
# f91RLnx66Ip3
# SIG # End signature block