Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 194 additions & 0 deletions build/Update-MtEamClassification.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
<#
.SYNOPSIS
Updates the generated Enterprise Access Model role classification table.

.DESCRIPTION
Downloads the EntraOps directory-role classification during maintenance, projects
it to the role ID and EAM tier used by Maester, validates the result, and
writes the generated table into the module's internal source. Permanent-role
checks use that table without downloading classification data at runtime.
Run manually when updating the snapshot, review the generated diff, and commit
it with the module. Ordinary module builds do not download or refresh the data.
For reproducibility, pass a commit-pinned raw URL with -SourceUrl.

.EXAMPLE
./build/Update-MtEamClassification.ps1
#>

[CmdletBinding()]
param (
# Path to the generated classification source file.
[string] $ClassificationPath = "$PSScriptRoot/../powershell/internal/Get-MtEamClassification.ps1",

# Source URL used only when updating the checked-in table.
[string] $SourceUrl = 'https://raw.githubusercontent.com/Cloud-Architekt/AzurePrivilegedIAM/main/Classification/Classification_EntraIdDirectoryRoles.json',

# Minimum expected row count, guarding against a partial or unrelated response.
[int] $MinimumRoleCount = 100
)

$ErrorActionPreference = 'Stop'

function Get-EamClassificationData {
[CmdletBinding()]
[OutputType([System.Collections.Generic.List[hashtable]])]
param(
[Parameter(Mandatory)]
[string] $Json,

[Parameter(Mandatory)]
[int] $MinimumRoleCount
)

$rows = ConvertFrom-Json -InputObject $Json
$rows = @($rows)
if ($rows.Count -lt $MinimumRoleCount) {
throw "Only $($rows.Count) EAM role classifications found; expected at least $MinimumRoleCount. Possible parsing issue."
}

$validTiers = @('ControlPlane', 'ManagementPlane', 'UserAccess', 'Unclassified')
$seenRoleIds = @{}
$classification = [System.Collections.Generic.List[hashtable]]::new()

foreach ($row in $rows) {
$roleId = ([string]$row.RoleId).Trim().ToLowerInvariant()
$tier = ([string]$row.Classification.EAMTierLevelName).Trim()

$roleGuid = [guid]::Empty
if (-not [guid]::TryParse($roleId, [ref]$roleGuid)) {
throw "Role classification contains an invalid RoleId '$roleId'."
}
$roleId = $roleGuid.ToString('D')
if ([string]::IsNullOrWhiteSpace($tier) -or $tier -notin $validTiers) {
throw "Role '$roleId' contains an unknown or empty EAM tier '$tier'."
}
if ($seenRoleIds.ContainsKey($roleId)) {
throw "Role classification contains duplicate RoleId '$roleId'."
}

$seenRoleIds[$roleId] = $true
$classification.Add(@{
RoleId = $roleId
Tier = $tier
})
}

return $classification
Comment thread
github-advanced-security[bot] marked this conversation as resolved.
Fixed
}

function Get-ClassificationFileContent {
[CmdletBinding()]
[OutputType([string])]
param(
[Parameter(Mandatory)]
[System.Collections.Generic.List[hashtable]] $Classification,

[Parameter(Mandatory)]
[string] $SourceUrl,

[Parameter(Mandatory)]
[string] $SourceSha256
)

$entries = $Classification | Sort-Object RoleId | ForEach-Object {
" '$($_.RoleId)' = '$($_.Tier)'"
}
$entryBlock = $entries -join "`n"

return @"
Comment thread
github-advanced-security[bot] marked this conversation as resolved.
Fixed
# Auto-generated by build/Update-MtEamClassification.ps1. Do not edit manually.
# Source: $SourceUrl
# Source SHA-256: $SourceSha256
# Source rows: $($Classification.Count)
<#
Classification derived from Cloud-Architekt/AzurePrivilegedIAM (MIT License).
Copyright (c) 2024 Thomas Naunheim

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
#>

function Initialize-MtEamClassification {
[CmdletBinding()]
param()

if (`$null -ne `$script:MtEamClassification) {
return
}

`$script:MtEamClassification = @{
# BEGIN AUTO-GENERATED EAM CLASSIFICATION
$entryBlock
# END AUTO-GENERATED EAM CLASSIFICATION
}
}

function Get-MtEamClassification {
<#
.SYNOPSIS
Returns the checked-in EntraOps Enterprise Access Model classification table.
#>
[CmdletBinding()]
[OutputType([hashtable])]
param()

Initialize-MtEamClassification
return `$script:MtEamClassification
}
"@
}

Write-Verbose 'Fetching EAM role classifications from GitHub...'
try {
$response = Invoke-WebRequest -Uri $SourceUrl -UseBasicParsing -ErrorAction Stop
} catch {
throw "Failed to download EAM role classifications from $SourceUrl. Error: $_"
}

if ($response.StatusCode -ne 200) {
throw "Unexpected HTTP status code $($response.StatusCode) from $SourceUrl"
}
if ([string]::IsNullOrWhiteSpace($response.Content) -or $response.Content.Length -lt 10000) {
throw "Downloaded EAM classification appears empty or too short ($($response.Content.Length) chars). Aborting."
}

$classification = Get-EamClassificationData -Json $response.Content -MinimumRoleCount $MinimumRoleCount
$sourceBytes = [System.Text.Encoding]::UTF8.GetBytes($response.Content)
$sha256 = [System.Security.Cryptography.SHA256]::Create()
try {
$sourceHash = (-join ($sha256.ComputeHash($sourceBytes) | ForEach-Object { $_.ToString('x2') }))
} finally {
$sha256.Dispose()
}
$generatedContent = Get-ClassificationFileContent -Classification $classification -SourceUrl $SourceUrl -SourceSha256 $sourceHash

$resolvedPath = $ClassificationPath
if (Test-Path -LiteralPath $ClassificationPath) {
$resolvedPath = (Resolve-Path -LiteralPath $ClassificationPath).ProviderPath
} else {
$parent = Split-Path -Parent $ClassificationPath
if (-not (Test-Path -LiteralPath $parent)) {
throw "Classification output directory '$parent' was not found."
}
$resolvedPath = [System.IO.Path]::GetFullPath($ClassificationPath)
}

$utf8Bom = [System.Text.UTF8Encoding]::new($true)
[System.IO.File]::WriteAllText($resolvedPath, $generatedContent.TrimEnd() + "`n", $utf8Bom)

Write-Verbose "Updated $resolvedPath with $($classification.Count) roles; source SHA-256: $sourceHash"
198 changes: 198 additions & 0 deletions powershell/internal/Get-MtEamClassification.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
# Auto-generated by build/Update-MtEamClassification.ps1. Do not edit manually.
# Source: https://raw.githubusercontent.com/Cloud-Architekt/AzurePrivilegedIAM/00dce78c522935da86faba6c0b3a73fec2dd0c7a/Classification/Classification_EntraIdDirectoryRoles.json
# Source SHA-256: 36de9d95f6ed1949684667de4a05b3e3859d2ed9af41c77dc0fda0fffc08b672
# Source rows: 145
<#
Classification derived from Cloud-Architekt/AzurePrivilegedIAM (MIT License).
Copyright (c) 2024 Thomas Naunheim

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
#>

function Initialize-MtEamClassification {
[CmdletBinding()]
param()

if ($null -ne $script:MtEamClassification) {
return
}

$script:MtEamClassification = @{
# BEGIN AUTO-GENERATED EAM CLASSIFICATION
'024906de-61e5-49c8-8572-40335f1e0e10' = 'ManagementPlane'
'02d5655b-c1cf-4e5f-98da-5fb919085bf6' = 'ManagementPlane'
'0526716b-113d-4c15-b2c8-68e3c22b9f80' = 'ControlPlane'
'0964bb5e-9bdb-4d7b-ac29-58e794862a40' = 'ManagementPlane'
'0b00bede-4072-4d22-b441-e7df02a1ef63' = 'ControlPlane'
'0ec3f692-38d6-4d14-9e69-0377ca7797ad' = 'ManagementPlane'
'0f971eea-41eb-4569-a71e-57bb8a3eff1e' = 'ControlPlane'
'1076ac91-f3d9-41a7-a339-dcdf5f480acc' = 'ManagementPlane'
'10dae51f-b6af-4016-8d66-8c2a99b929b3' = 'UserAccess'
'112ca1a2-15ad-4102-995e-45b0bc479a6a' = 'UserAccess'
'11451d60-acb2-45eb-a7d6-43d0f0125c13' = 'ControlPlane'
'11648597-926c-4cf3-9c36-bcebb0ba8dcc' = 'ManagementPlane'
'124577f8-48ed-456a-839f-13b419002e33' = 'ManagementPlane'
'1501b917-7653-4ff9-a4b5-203eaf33784f' = 'ManagementPlane'
'158c047a-c907-4556-b7ef-446551a6b5f7' = 'ControlPlane'
'1707125e-0aa2-4d4d-8655-a7c786c76a25' = 'ManagementPlane'
'17315797-102d-40b4-93e0-432062caca18' = 'ManagementPlane'
'194ae4cb-b126-40b2-bd5b-6091b380977d' = 'ControlPlane'
'1981f584-96e9-4a6f-95b0-f522373f8fae' = 'ControlPlane'
'1a7d78b6-429f-476b-b8eb-35fb715fffd4' = 'ManagementPlane'
'1d336d2c-4ae8-42ef-9711-b3604ce3fc2c' = 'ControlPlane'
'1fe13547-53f6-408d-ac04-7f8eed167b38' = 'ControlPlane'
'25a516ed-2fa0-40ea-a2d0-12923a21473a' = 'ControlPlane'
'25df335f-86eb-4119-b717-0ff02de207e9' = 'ManagementPlane'
'27460883-1df1-4691-b032-3b79643e5e63' = 'ManagementPlane'
'281fe777-fb20-4fbb-b7a3-ccebce5b0d96' = 'ManagementPlane'
'29232cdf-9323-42fd-ade2-1d097af3e4de' = 'ManagementPlane'
'2af84b1e-32c8-42b7-82bc-daa82404023b' = 'UserAccess'
'2b499bcd-da44-4968-8aec-78e1674fa64d' = 'ControlPlane'
'2b745bdf-0803-4d80-aa65-822c4493daac' = 'ManagementPlane'
'2ea5ce4c-b2d8-4668-bd81-3680bd2d227a' = 'ControlPlane'
'2fe872fb-daa8-4afc-8f6c-53c4565cfef4' = 'ManagementPlane'
'31392ffb-586c-42d1-9346-e59415a2cc4e' = 'ManagementPlane'
'31e939ad-9672-4796-9c2e-873181342d2d' = 'ManagementPlane'
'32696413-001a-46ae-978c-ce0f6b3620d2' = 'ControlPlane'
'38a96431-2bdf-4b4c-8b6e-5d3d8abac1a4' = 'ManagementPlane'
'3a2c62db-5318-420d-8d74-23affee5d9d5' = 'ControlPlane'
'3d762c5a-1b6c-493f-843e-55a3b42923d4' = 'ManagementPlane'
'3edaf663-341e-4475-9f94-5c398ef6c070' = 'ControlPlane'
'3f04f91a-4ad7-4bd3-bcfa-49882ea1a88a' = 'ManagementPlane'
'3f1acade-1e04-4fbc-9b69-f0302cd84aef' = 'ManagementPlane'
'422218e4-db15-4ef9-bbe0-8afb41546d79' = 'ControlPlane'
'44367163-eba1-44c3-98af-f5787879f96a' = 'ManagementPlane'
'45d8d3c5-c802-45c6-b32a-1d70b5e1e86e' = 'ControlPlane'
'49eb8f75-97e9-4e37-9b2b-6c3ebfcffa31' = 'ManagementPlane'
'4a5d8f65-41da-4de4-8968-e035b65339cf' = 'ManagementPlane'
'4ba39ca4-527c-499a-b93d-d9b492c50246' = 'ControlPlane'
'4d6ac14f-3453-41d0-bef9-a3e0c569773a' = 'ControlPlane'
'507f53e4-4e52-4077-abd3-d2e1558b6ea2' = 'ManagementPlane'
'58a13ea3-c632-46ae-9ee0-9c0d43cd7f3d' = 'ControlPlane'
'58f930cc-fcf4-4152-852c-1d7dbf502139' = 'ControlPlane'
'59d46f88-662b-457b-bceb-5c3809e5908f' = 'ControlPlane'
'5b784334-f94b-471a-a387-e7219fc49ca2' = 'ControlPlane'
'5c4f9dcd-47dc-4cf7-8c9a-9e4207cbfc91' = 'ManagementPlane'
'5d6b6bb7-de71-4623-b4af-96380a352509' = 'ControlPlane'
'5f2222b1-57c3-48ba-8ad5-d4759f1fde6f' = 'ControlPlane'
'62e90394-69f5-4237-9190-012177145e10' = 'ControlPlane'
'644ef478-e28f-4e28-b9dc-3fdde9aa0b1f' = 'ManagementPlane'
'69091246-20e8-4a56-aa4d-066075b2a7a8' = 'ManagementPlane'
'6b942400-691f-4bf0-9d12-d8a254a2baf5' = 'ControlPlane'
'6e591065-9bad-43ed-90f3-e9424366d2f0' = 'ControlPlane'
'729827e3-9c14-49f7-bb1b-9608f156bbb8' = 'ControlPlane'
'744ec460-397e-42ad-a462-8b3f9747a02c' = 'ControlPlane'
'7495fdc4-34c4-4d15-a289-98788ce399fd' = 'ManagementPlane'
'74ef975b-6605-40af-a5d2-b9539d836353' = 'ManagementPlane'
'75934031-6c7e-415a-99d7-48dbd49e875e' = 'ManagementPlane'
'75941009-915a-4869-abe7-691bff18279e' = 'ManagementPlane'
'7698a772-787b-4ac8-901f-60d6b08affd2' = 'ControlPlane'
'78b0ccd1-afc2-4f92-9116-b41aedd09592' = 'ManagementPlane'
'790c1fb9-7f7d-4f88-86a1-ef1f95c05c1b' = 'ManagementPlane'
'7be44c8a-adaf-4e2a-84d6-ab2649e08a13' = 'ControlPlane'
'810a2642-a034-447f-a5e8-41beaa378541' = 'ManagementPlane'
'8329153b-31d0-4727-b945-745eb3bc5f31' = 'ControlPlane'
'8424c6f0-a189-499e-bbd0-26c1753c96d4' = 'ControlPlane'
'843318fb-79a6-4168-9e6f-aa9a07481cc4' = 'ManagementPlane'
'87761b17-1ed2-4af3-9acd-92a150038160' = 'ManagementPlane'
'8835291a-918c-4fd7-a9ce-faa49f0cf7d9' = 'ManagementPlane'
'88d8e3e3-8f55-4a1e-953a-9b9898b8876b' = 'ManagementPlane'
'892c5842-a9a6-463a-8041-72aa08ca3cf6' = 'ControlPlane'
'8ac3fc64-6eca-42ea-9e69-59f4c7b60eb2' = 'ControlPlane'
'8c8b803f-96e1-4129-9349-20738d9f9652' = 'ManagementPlane'
'92b086b3-e367-4ef2-b869-1de128fb986e' = 'ManagementPlane'
'92ed04bf-c94a-4b82-9729-b799a7a4c178' = 'ControlPlane'
'9360feb5-f418-4baa-8175-e2a00bac4301' = 'ControlPlane'
'95e79109-95c0-4d8e-aee3-d01accf2d47b' = 'UserAccess'
'963797fb-eb3b-4cde-8ce3-5878b3f32a3f' = 'ManagementPlane'
'966707d0-3269-4727-9be2-8c3a10f19b9d' = 'ControlPlane'
'99009c4a-3b3f-4957-82a9-9d35e12db77e' = 'ManagementPlane'
'9b895d92-2cd3-44c7-9d02-a6ac2d5ea5c3' = 'ControlPlane'
'9c094953-4995-41c8-84c8-3ebb9b32c93f' = 'Unclassified'
'9c6df0f2-1e7c-4dc3-b195-66dfbd24aa8f' = 'ManagementPlane'
'9c99539d-8186-4804-835f-fd51ef9e2dcd' = 'ManagementPlane'
'9d3e04ba-3ee4-4d1b-a3a7-9aef423a09be' = 'ManagementPlane'
'9d70768a-0cbc-4b4c-aea3-2e124b2477f4' = 'ManagementPlane'
'9f06204d-73c1-4d4c-880a-6edb90606fd8' = 'ControlPlane'
'a0b1b346-4d3e-4e8b-98f8-753987be4970' = 'UserAccess'
'a92aed5d-d78a-4d16-b381-09adb37eb3b0' = 'ControlPlane'
'a9ea8996-122f-4c74-9520-8edcd192826c' = 'ManagementPlane'
'aa38014f-0993-46e9-9b45-30501a20909d' = 'ManagementPlane'
'aaf43236-0c0d-4d5f-883a-6955382ac081' = 'ControlPlane'
'ac16e43d-7b2d-40e0-ac05-243ff356ab5b' = 'ManagementPlane'
'ac434307-12b9-4fa1-a708-88bf58caabc1' = 'ControlPlane'
'adb2368d-a9be-41b5-8667-d96778e081b0' = 'ControlPlane'
'af78dc32-cf4d-46f9-ba4e-4428526346b5' = 'ControlPlane'
'b0f54661-2d74-4c50-afa3-1ec803f12efe' = 'ControlPlane'
'b1be1c3e-b65d-4f19-8427-f6fa0d97feb9' = 'ControlPlane'
'b5a8dcf3-09d5-43a9-a639-8e29ef291470' = 'ControlPlane'
'b6a27b2b-f905-4b2e-81b5-0d90e0ef1fdb' = 'ControlPlane'
'b8e31d83-1534-480f-9b10-0338ded51b7e' = 'ControlPlane'
'baf37b3a-610e-45da-9e62-d9d1e5e8914b' = 'ManagementPlane'
'be2f45a1-457d-42af-a067-6ec1fa63bc45' = 'ControlPlane'
'c34f683f-4d5a-4403-affd-6615e00e3a7f' = 'Unclassified'
'c430b396-e693-46cc-96f3-db01bf8bb62a' = 'ManagementPlane'
'c4e39bd9-1100-46d3-8c65-fb160da0071f' = 'ControlPlane'
'cf1c38e5-3621-4004-a7cb-879624dced7c' = 'ManagementPlane'
'd2562ede-74db-457e-a7b6-544e236ebb61' = 'ControlPlane'
'd29b2b05-8046-44ba-8758-1e26182fcf32' = 'ControlPlane'
'd35481f7-cda1-4fa2-8344-5a21f7f3724d' = 'ControlPlane'
'd37c8bed-0711-4417-ba38-b4abe66ce4c2' = 'ManagementPlane'
'd405c6df-0af8-4e3b-95e4-4d06e542189e' = 'Unclassified'
'db506228-d27e-4b7d-95e5-295956d6615f' = 'ControlPlane'
'dd13091a-6207-4fc0-82ba-3641e056ab95' = 'ManagementPlane'
'e00e864a-17c5-4a4b-9c06-f5b95a8d5bd8' = 'ControlPlane'
'e07494ad-1654-4dd2-922e-6f81a71bf00f' = 'ManagementPlane'
'e0a4caa6-fe82-443f-b92f-d87341d17b2e' = 'ManagementPlane'
'e300d9e7-4a2b-4295-9eff-f1c78b36cc98' = 'ManagementPlane'
'e3973bdf-4987-49ae-837a-ba8e231c7286' = 'ManagementPlane'
'e48398e2-f4bb-4074-8f31-4586725e205b' = 'ManagementPlane'
'e6d1a23a-da11-4be4-9570-befc86d067a7' = 'ControlPlane'
'e8611ab8-c189-46e8-94e1-60213ab1f814' = 'ControlPlane'
'e8cef6f1-e4bd-4ea8-bc07-4b8d950f4477' = 'ManagementPlane'
'e93e3737-fa85-474a-aee4-7d3fb86510f3' = 'ManagementPlane'
'eb1f4a8d-243a-41f0-9fbd-c7cdf6c5ef7c' = 'ManagementPlane'
'ecb2c6bf-0ab6-418e-bd87-7986f8d63bbe' = 'ControlPlane'
'ee67aa9c-e510-4759-b906-227085a7fd4d' = 'ManagementPlane'
'f023fd81-a637-4b56-95fd-791ac0226033' = 'ManagementPlane'
'f28a1f50-f6e7-4571-818b-6a12f2af6b6c' = 'ManagementPlane'
'f2ef992c-3afb-46b9-b7cf-a126ee74c451' = 'ControlPlane'
'f42252d9-5400-4d7b-b9ef-cc582dbb8577' = 'ControlPlane'
'f70938a0-fc10-4177-9e90-2178f8765737' = 'ManagementPlane'
'fc8ad4e2-40e4-4724-8317-bcda7503ecbf' = 'ControlPlane'
'fcf91098-03e3-41a9-b5ba-6f0ec8188a12' = 'ManagementPlane'
'fdd7a751-b60b-444a-984c-02652fe8fa1c' = 'ControlPlane'
'fe930be7-5e62-47db-91af-98c3a49a38b1' = 'ControlPlane'
'ffd52fa5-98dc-465c-991d-fc073eb59f8f' = 'ControlPlane'
# END AUTO-GENERATED EAM CLASSIFICATION
}
}

function Get-MtEamClassification {
<#
.SYNOPSIS
Returns the checked-in EntraOps Enterprise Access Model classification table.
#>
[CmdletBinding()]
[OutputType([hashtable])]
param()

Initialize-MtEamClassification
return $script:MtEamClassification
}
Loading
Loading