Invoke-FvAdOuAceRemediation.psd1
|
# # Module manifest for module 'Invoke-FvAdOuAceRemediation' # # Generated by: Olamide Olaleye # @{ # Script module or binary module file associated with this manifest. RootModule = 'Invoke-FvAdOuAceRemediation.psm1' # Version number of this module. ModuleVersion = '0.2.0' # Supported PSEditions # CompatiblePSEditions = @() # ID used to uniquely identify this module GUID = '391d869d-2bfb-4b3f-83d7-e688df3f6599' # Author of this module Author = 'Olamide Olaleye' # Company or vendor of this module CompanyName = 'Fountview' # Copyright statement for this module Copyright = '(c) Olamide Olaleye. All rights reserved.' # Description of the functionality provided by this module Description = 'Assesses, reports on, remediates and rolls back over-permissive explicit Everyone/GenericAll ACEs on Active Directory Organizational Units.' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '7.0' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # ClrVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module. # ActiveDirectory (RSAT: AD DS and AD LDS Tools) is deliberately NOT declared here. It is a # Windows-only, in-box RSAT feature - never published to PSGallery - and Sampler's own # package_module_nupkg build task unconditionally walks every entry in this list trying to # resolve and bundle it (Get-Module -ListAvailable -FullyQualifiedName), which throws # "You cannot call a method on a null-valued expression" the moment the module can't be # found on the build agent (e.g. any Linux/macOS runner, or a Windows runner without the # RSAT feature installed). PrivateData.PSData.ExternalModuleDependencies is not a workaround # - the pack task does not consult it. PowerShell's own module auto-loading resolves # ActiveDirectory cmdlets for users who do have RSAT installed; users who don't get a clear, # native "command not recognized" error rather than a broken build. RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = @('Backup-FvAdOuAcl','Get-FvAdOuAce','Get-FvAdOuAceReport','Invoke-FvAdOuAceRemediation','Reset-FvAdOuAce','Restore-FvAdOuAcl') # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = @() # DSC resources to export from this module DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = @('ActiveDirectory', 'Security', 'ACL', 'GPO', 'Audit', 'Remediation') # A URL to the license for this module. LicenseUri = 'https://github.com/Princetimber/adAclRemediation/blob/main/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/Princetimber/adAclRemediation' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '## [0.2.0] - 2026-09-10 ### Added - Initial module: `Get-FvAdOuAce`, `Get-FvAdOuAceReport`, `Backup-FvAdOuAcl`, `Reset-FvAdOuAce`, `Restore-FvAdOuAcl`, and `Invoke-FvAdOuAceRemediation`, assessing, reporting on, remediating and rolling back over-permissive explicit `Everyone`/`GenericAll` (and similarly over-permissive) `Allow` ACEs on Active Directory Organizational Units. - Pester v6 unit test suite (`tests/Unit/Public/`) with every `ActiveDirectory` cmdlet mocked. - `about_Invoke-FvAdOuAceRemediation` help topic documenting the design choices, the two `Reset-FvAdOuAce -RestoreMode` semantics, and every stated assumption. ### Removed - The template''s example logging helpers (`Write-ToLog`, `Invoke-LogRotation`) and example public functions (`Get-Greeting`, `Export-Greeting`) - unused by this module. ### Fixed - Removed `ActiveDirectory` from the module manifest''s `RequiredModules` key. Sampler''s `package_module_nupkg` build task unconditionally walks every entry in that list trying to resolve and bundle it, which fails the CI pack step with "You cannot call a method on a null-valued expression" the moment the module isn''t present on the build agent - true for every hosted GitHub Actions runner, since `ActiveDirectory` is a Windows RSAT feature never published to PSGallery. The dependency is now documented via `PrivateData.PSData.ExternalModuleDependencies` instead; PowerShell''s own module auto-loading still resolves the cmdlets at runtime for users who have RSAT installed. - Restricted the `test` job to Windows only in `ci.yml`, `release.yml` and `azure-pipelines.yml`. The unit tests mock `ActiveDirectory` cmdlets via Pester''s `-ModuleName` mocking, which requires the real cmdlet to exist to shadow it; on a Linux/macOS runner (no RSAT) that fails outright with `CommandNotFoundException` before the mock ever takes effect - confirmed by a real CI run failing 44 of 104 tests on ubuntu-latest/macos-latest. Updated `CLAUDE.md`/`AGENTS.md`/`README.md`, which previously and incorrectly claimed the test suite ran on any platform. - Added an `Install-WindowsFeature -Name RSAT-AD-PowerShell` step ahead of the test run in `ci.yml`, `release.yml` and `azure-pipelines.yml`. Restricting to `windows-latest` (above) was not on its own sufficient: the hosted `windows-latest` image doesn''t ship the `ActiveDirectory` module either, so `Get-ADObject`/`Get-ADDomain` etc. didn''t exist as real commands there and Pester''s mock resolution still failed with `CommandNotFoundException` - confirmed by a second real CI run failing the same way on windows-latest. ' # Prerelease string of this module Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false # External dependent modules of this module. ActiveDirectory (RSAT) is documented # here for readers/tooling that honour this PSData convention; it is intentionally # absent from the top-level RequiredModules key above - see the comment there. ExternalModuleDependencies = @('ActiveDirectory') } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |